purecloud-platform-client-v2 205.0.0 → 207.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +102 -3
- package/dist/node/purecloud-platform-client-v2.js +1241 -133
- package/dist/web-amd/purecloud-platform-client-v2.js +1241 -133
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +384 -137
- package/dist/web-cjs/purecloud-platform-client-v2.js +384 -137
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +1242 -275
- package/package.json +1 -1
- package/src/purecloud-platform-client-v2/ApiClient.js +40 -18
- package/src/purecloud-platform-client-v2/api/AgentAssistantsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AgentCopilotApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AgentUIApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AlertingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +7 -6
- package/src/purecloud-platform-client-v2/api/ArchitectApi.js +2 -2
- package/src/purecloud-platform-client-v2/api/AuditApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/BillingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/CarrierServicesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ChatApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/CoachingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ContentManagementApi.js +2 -3
- package/src/purecloud-platform-client-v2/api/ConversationsApi.js +9 -5
- 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/EmployeeEngagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EventsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +232 -1
- package/src/purecloud-platform-client-v2/api/FaxApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/FlowsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GamificationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GeolocationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GreetingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GroupsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/IdentityProviderApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/InfrastructureAsCodeApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/JourneyApi.js +191 -4
- package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +1 -19
- 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 +1 -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 +1 -1
- 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 +48 -1
- package/src/purecloud-platform-client-v2/api/OutboundApi.js +101 -1
- package/src/purecloud-platform-client-v2/api/PresenceApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ProcessAutomationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/QualityApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RecordingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RoutingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ScreenRecordingApi.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 +311 -1
- package/src/purecloud-platform-client-v2/api/TeamsApi.js +7 -3
- package/src/purecloud-platform-client-v2/api/TelephonyApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TextbotsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TokensApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UploadsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsageApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsersApi.js +27 -1
- package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/VoicemailApi.js +56 -1
- package/src/purecloud-platform-client-v2/api/WebChatApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +2 -2
- 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 +60 -1
- package/src/purecloud-platform-client-v2/configuration.js +81 -0
- package/src/purecloud-platform-client-v2/index.js +1 -1
package/dist/web-cjs/bundle.js
CHANGED
|
@@ -868,18 +868,30 @@ axios.Cancel=axios.CanceledError;// Expose all/spread
|
|
|
868
868
|
axios.all=function all(promises){return Promise.all(promises);};axios.spread=spread;// Expose isAxiosError
|
|
869
869
|
axios.isAxiosError=isAxiosError;// Expose mergeConfig
|
|
870
870
|
axios.mergeConfig=mergeConfig;axios.AxiosHeaders=AxiosHeaders$1;axios.formToJSON=function(thing){return formDataToJSON(utils$1.isHTMLForm(thing)?new FormData(thing):thing);};axios.getAdapter=adapters.getAdapter;axios.HttpStatusCode=HttpStatusCode$1;axios["default"]=axios;// this module should only have a default export
|
|
871
|
-
var axios$1=axios;var logLevelEnum={level:{LNone:'none',LError:'error',LDebug:'debug',LTrace:'trace'}};var logFormatEnum={formats:{JSON:'json',TEXT:'text'}};var Logger=/*#__PURE__*/function(){function Logger(){_classCallCheck(this,Logger);this.log_level=logLevelEnum.level.LNone;this.log_format=logFormatEnum.formats.TEXT;this.log_to_console=true;this.log_file_path;this.log_response_body=false;this.log_request_body=false;this.setLogger();}return _createClass(Logger,[{key:"logLevelEnum",get:function get(){return logLevelEnum;}},{key:"logFormatEnum",get:function get(){return logFormatEnum;}},{key:"setLogger",value:function setLogger(){}},{key:"log",value:function log(level,statusCode,method,url,requestHeaders,responseHeaders,requestBody,responseBody){var content=this.formatLog(level,statusCode,method,url,requestHeaders,responseHeaders,requestBody,responseBody);if(typeof window!=='undefined'){var shouldLog=this.calculateLogLevel(level);if(shouldLog>0&&this.log_to_console===true){if(this.log_format===this.logFormatEnum.formats.JSON){console.log(content);}else{console.log("".concat(level.toUpperCase(),": ").concat(content));}}}else{if(this.logger.transports.length>0)this.logger.log(level,content);}}},{key:"calculateLogLevel",value:function calculateLogLevel(level){switch(this.log_level){case this.logLevelEnum.level.LError:if(level!==this.logLevelEnum.level.LError){return-1;}return 1;case this.logLevelEnum.level.LDebug:if(level===this.logLevelEnum.level.LTrace){return-1;}return 1;case this.logLevelEnum.level.LTrace:return 1;default:return-1;}}},{key:"formatLog",value:function formatLog(level,statusCode,method,url,requestHeaders,responseHeaders,requestBody,responseBody){var result;var localRequestHeaders=requestHeaders?JSON.parse(JSON.stringify(requestHeaders)):null;var localResponseHeaders=responseHeaders?JSON.parse(JSON.stringify(responseHeaders)):null;var localRequestBody=requestBody?JSON.parse(JSON.stringify(requestBody)):null;var localResponseBody=responseBody?JSON.parse(JSON.stringify(responseBody)):null;if(requestHeaders)localRequestHeaders['Authorization']='[REDACTED]';if(!this.log_request_body)localRequestBody=undefined;if(!this.log_response_body)localResponseBody=undefined;if(this.log_format&&this.log_format===logFormatEnum.formats.JSON){result={level:level,date:new Date().toISOString(),method:method,url:decodeURIComponent(url),correlationId:localResponseHeaders?localResponseHeaders['inin-correlation-id']?localResponseHeaders['inin-correlation-id']:'':'',statusCode:statusCode};if(localRequestHeaders)result.requestHeaders=localRequestHeaders;if(localResponseHeaders)result.responseHeaders=localResponseHeaders;if(localRequestBody)result.requestBody=localRequestBody;if(localResponseBody)result.responseBody=localResponseBody;}else{result="".concat(new Date().toISOString(),"\n=== REQUEST === \n").concat(this.formatValue('URL',decodeURIComponent(url))).concat(this.formatValue('Method',method)).concat(this.formatValue('Headers',this.formatHeaderString(localRequestHeaders))).concat(this.formatValue('Body',localRequestBody?JSON.stringify(localRequestBody,null,2):''),"\n=== RESPONSE ===\n").concat(this.formatValue('Status',statusCode)).concat(this.formatValue('Headers',this.formatHeaderString(localResponseHeaders))).concat(this.formatValue('CorrelationId',localResponseHeaders?localResponseHeaders['inin-correlation-id']?localResponseHeaders['inin-correlation-id']:'':'')).concat(this.formatValue('Body',localResponseBody?JSON.stringify(localResponseBody,null,2):''));}return result;}},{key:"formatHeaderString",value:function formatHeaderString(headers){var headerString='';if(!headers)return headerString;for(var _i=0,_Object$entries=Object.entries(headers);_i<_Object$entries.length;_i++){var _Object$entries$_i=_slicedToArray(_Object$entries[_i],2),key=_Object$entries$_i[0],value=_Object$entries$_i[1];headerString+="\n\t".concat(key,": ").concat(value);}return headerString;}},{key:"formatValue",value:function formatValue(key,value){if(!value||value===''||value==='{}')return'';return"".concat(key,": ").concat(value,"\n");}},{key:"getLogLevel",value:function getLogLevel(level){switch(level){case'error':return logLevelEnum.level.LError;case'debug':return logLevelEnum.level.LDebug;case'trace':return logLevelEnum.level.LTrace;default:return logLevelEnum.level.LNone;}}},{key:"getLogFormat",value:function getLogFormat(format){switch(format){case'json':return logFormatEnum.formats.JSON;default:return logFormatEnum.formats.TEXT;}}}]);}();var Configuration=/*#__PURE__*/function(){function Configuration(){_classCallCheck(this,Configuration);if(!Configuration.instance){Configuration.instance=this;}if(typeof window!=='undefined'){this.configPath='';}else{var os=require('os');var path=require('path');this.configPath=path.join(os.homedir(),'.genesyscloudjavascript','config');}this.refresh_access_token=true;this.refresh_token_wait_max=10;this.live_reload_config=true;this.host;this.environment;this.basePath;this.authUrl;this.config;this.logger=new Logger();this.setEnvironment();this.liveLoadConfig();}return _createClass(Configuration,[{key:"instance",get:/**
|
|
871
|
+
var axios$1=axios;var logLevelEnum={level:{LNone:'none',LError:'error',LDebug:'debug',LTrace:'trace'}};var logFormatEnum={formats:{JSON:'json',TEXT:'text'}};var Logger=/*#__PURE__*/function(){function Logger(){_classCallCheck(this,Logger);this.log_level=logLevelEnum.level.LNone;this.log_format=logFormatEnum.formats.TEXT;this.log_to_console=true;this.log_file_path;this.log_response_body=false;this.log_request_body=false;this.setLogger();}return _createClass(Logger,[{key:"logLevelEnum",get:function get(){return logLevelEnum;}},{key:"logFormatEnum",get:function get(){return logFormatEnum;}},{key:"setLogger",value:function setLogger(){}},{key:"log",value:function log(level,statusCode,method,url,requestHeaders,responseHeaders,requestBody,responseBody){var content=this.formatLog(level,statusCode,method,url,requestHeaders,responseHeaders,requestBody,responseBody);if(typeof window!=='undefined'){var shouldLog=this.calculateLogLevel(level);if(shouldLog>0&&this.log_to_console===true){if(this.log_format===this.logFormatEnum.formats.JSON){console.log(content);}else{console.log("".concat(level.toUpperCase(),": ").concat(content));}}}else{if(this.logger.transports.length>0)this.logger.log(level,content);}}},{key:"calculateLogLevel",value:function calculateLogLevel(level){switch(this.log_level){case this.logLevelEnum.level.LError:if(level!==this.logLevelEnum.level.LError){return-1;}return 1;case this.logLevelEnum.level.LDebug:if(level===this.logLevelEnum.level.LTrace){return-1;}return 1;case this.logLevelEnum.level.LTrace:return 1;default:return-1;}}},{key:"formatLog",value:function formatLog(level,statusCode,method,url,requestHeaders,responseHeaders,requestBody,responseBody){var result;var localRequestHeaders=requestHeaders?JSON.parse(JSON.stringify(requestHeaders)):null;var localResponseHeaders=responseHeaders?JSON.parse(JSON.stringify(responseHeaders)):null;var localRequestBody=requestBody?JSON.parse(JSON.stringify(requestBody)):null;var localResponseBody=responseBody?JSON.parse(JSON.stringify(responseBody)):null;if(requestHeaders)localRequestHeaders['Authorization']='[REDACTED]';if(!this.log_request_body)localRequestBody=undefined;if(!this.log_response_body)localResponseBody=undefined;if(this.log_format&&this.log_format===logFormatEnum.formats.JSON){result={level:level,date:new Date().toISOString(),method:method,url:decodeURIComponent(url),correlationId:localResponseHeaders?localResponseHeaders['inin-correlation-id']?localResponseHeaders['inin-correlation-id']:'':'',statusCode:statusCode};if(localRequestHeaders)result.requestHeaders=localRequestHeaders;if(localResponseHeaders)result.responseHeaders=localResponseHeaders;if(localRequestBody)result.requestBody=localRequestBody;if(localResponseBody)result.responseBody=localResponseBody;}else{result="".concat(new Date().toISOString(),"\n=== REQUEST === \n").concat(this.formatValue('URL',decodeURIComponent(url))).concat(this.formatValue('Method',method)).concat(this.formatValue('Headers',this.formatHeaderString(localRequestHeaders))).concat(this.formatValue('Body',localRequestBody?JSON.stringify(localRequestBody,null,2):''),"\n=== RESPONSE ===\n").concat(this.formatValue('Status',statusCode)).concat(this.formatValue('Headers',this.formatHeaderString(localResponseHeaders))).concat(this.formatValue('CorrelationId',localResponseHeaders?localResponseHeaders['inin-correlation-id']?localResponseHeaders['inin-correlation-id']:'':'')).concat(this.formatValue('Body',localResponseBody?JSON.stringify(localResponseBody,null,2):''));}return result;}},{key:"formatHeaderString",value:function formatHeaderString(headers){var headerString='';if(!headers)return headerString;for(var _i=0,_Object$entries=Object.entries(headers);_i<_Object$entries.length;_i++){var _Object$entries$_i=_slicedToArray(_Object$entries[_i],2),key=_Object$entries$_i[0],value=_Object$entries$_i[1];headerString+="\n\t".concat(key,": ").concat(value);}return headerString;}},{key:"formatValue",value:function formatValue(key,value){if(!value||value===''||value==='{}')return'';return"".concat(key,": ").concat(value,"\n");}},{key:"getLogLevel",value:function getLogLevel(level){switch(level){case'error':return logLevelEnum.level.LError;case'debug':return logLevelEnum.level.LDebug;case'trace':return logLevelEnum.level.LTrace;default:return logLevelEnum.level.LNone;}}},{key:"getLogFormat",value:function getLogFormat(format){switch(format){case'json':return logFormatEnum.formats.JSON;default:return logFormatEnum.formats.TEXT;}}}]);}();var Configuration=/*#__PURE__*/function(){function Configuration(){_classCallCheck(this,Configuration);if(!Configuration.instance){Configuration.instance=this;}if(typeof window!=='undefined'){this.configPath='';}else{var os=require('os');var path=require('path');this.configPath=path.join(os.homedir(),'.genesyscloudjavascript','config');}this.refresh_access_token=true;this.refresh_token_wait_max=10;this.live_reload_config=true;this.host;this.environment;this.basePath;this.authUrl;this.config;this.gateway=undefined;this.logger=new Logger();this.setEnvironment();this.liveLoadConfig();}return _createClass(Configuration,[{key:"instance",get:/**
|
|
872
872
|
* Singleton getter
|
|
873
873
|
*/function get(){return Configuration.instance;}/**
|
|
874
874
|
* Singleton setter
|
|
875
875
|
*/,set:function set(value){Configuration.instance=value;}},{key:"liveLoadConfig",value:function liveLoadConfig(){// If in browser, don't read config file, use default values
|
|
876
|
-
this.configPath='';}},{key:"setConfigPath",value:function setConfigPath(path){if(path&&path!==this.configPath){this.configPath=path;this.liveLoadConfig();}}},{key:"updateConfigFromFile",value:function updateConfigFromFile(){}},{key:"updateConfigValues",value:function updateConfigValues(){this.logger.log_level=this.logger.getLogLevel(this.getConfigString('logging','log_level'));this.logger.log_format=this.logger.getLogFormat(this.getConfigString('logging','log_format'));this.logger.log_to_console=this.getConfigBoolean('logging','log_to_console')!==undefined?this.getConfigBoolean('logging','log_to_console'):this.logger.log_to_console;this.logger.log_file_path=this.getConfigString('logging','log_file_path')!==undefined?this.getConfigString('logging','log_file_path'):this.logger.log_file_path;this.logger.log_response_body=this.getConfigBoolean('logging','log_response_body')!==undefined?this.getConfigBoolean('logging','log_response_body'):this.logger.log_response_body;this.logger.log_request_body=this.getConfigBoolean('logging','log_request_body')!==undefined?this.getConfigBoolean('logging','log_request_body'):this.logger.log_request_body;this.refresh_access_token=this.getConfigBoolean('reauthentication','refresh_access_token')!==undefined?this.getConfigBoolean('reauthentication','refresh_access_token'):this.refresh_access_token;this.refresh_token_wait_max=this.getConfigInt('reauthentication','refresh_token_wait_max')!==undefined?this.getConfigInt('reauthentication','refresh_token_wait_max'):this.refresh_token_wait_max;this.live_reload_config=this.getConfigBoolean('general','live_reload_config')!==undefined?this.getConfigBoolean('general','live_reload_config'):this.live_reload_config;this.host=this.getConfigString('general','host')!==undefined?this.getConfigString('general','host'):this.host;this.setEnvironment();// Update logging configs
|
|
877
|
-
this.logger.setLogger();}
|
|
876
|
+
this.configPath='';}},{key:"setConfigPath",value:function setConfigPath(path){if(path&&path!==this.configPath){this.configPath=path;this.liveLoadConfig();}}},{key:"updateConfigFromFile",value:function updateConfigFromFile(){}},{key:"updateConfigValues",value:function updateConfigValues(){this.logger.log_level=this.logger.getLogLevel(this.getConfigString('logging','log_level'));this.logger.log_format=this.logger.getLogFormat(this.getConfigString('logging','log_format'));this.logger.log_to_console=this.getConfigBoolean('logging','log_to_console')!==undefined?this.getConfigBoolean('logging','log_to_console'):this.logger.log_to_console;this.logger.log_file_path=this.getConfigString('logging','log_file_path')!==undefined?this.getConfigString('logging','log_file_path'):this.logger.log_file_path;this.logger.log_response_body=this.getConfigBoolean('logging','log_response_body')!==undefined?this.getConfigBoolean('logging','log_response_body'):this.logger.log_response_body;this.logger.log_request_body=this.getConfigBoolean('logging','log_request_body')!==undefined?this.getConfigBoolean('logging','log_request_body'):this.logger.log_request_body;this.refresh_access_token=this.getConfigBoolean('reauthentication','refresh_access_token')!==undefined?this.getConfigBoolean('reauthentication','refresh_access_token'):this.refresh_access_token;this.refresh_token_wait_max=this.getConfigInt('reauthentication','refresh_token_wait_max')!==undefined?this.getConfigInt('reauthentication','refresh_token_wait_max'):this.refresh_token_wait_max;this.live_reload_config=this.getConfigBoolean('general','live_reload_config')!==undefined?this.getConfigBoolean('general','live_reload_config'):this.live_reload_config;this.host=this.getConfigString('general','host')!==undefined?this.getConfigString('general','host'):this.host;if(this.getConfigString('gateway','host')!==undefined){var gateway={host:this.getConfigString('gateway','host')};if(this.getConfigString('gateway','protocol')!==undefined)gateway.protocol=this.getConfigString('gateway','protocol');if(this.getConfigInt('gateway','port')!==undefined)gateway.port=this.getConfigInt('gateway','port');if(this.getConfigString('gateway','path_params_login')!==undefined)gateway.path_params_login=this.getConfigString('gateway','path_params_login');if(this.getConfigString('gateway','path_params_api')!==undefined)gateway.path_params_api=this.getConfigString('gateway','path_params_api');if(this.getConfigString('gateway','username')!==undefined)gateway.username=this.getConfigString('gateway','username');if(this.getConfigString('gateway','password')!==undefined)gateway.password=this.getConfigString('gateway','password');this.setGateway(gateway);}else{this.setGateway();}this.setEnvironment();// Update logging configs
|
|
877
|
+
this.logger.setLogger();}/**
|
|
878
|
+
* @description Sets the gateway used by the session
|
|
879
|
+
* @param {object} gateway - Gateway Configuration interface
|
|
880
|
+
* @param {string} gateway.host - The address of the gateway.
|
|
881
|
+
* @param {string} gateway.protocol - (optional) The protocol to use. It will default to "https" if the parameter is not defined or empty.
|
|
882
|
+
* @param {number} gateway.port - (optional) The port to target. This parameter can be defined if a non default port is used and needs to be specified in the url (value must be greater or equal to 0).
|
|
883
|
+
* @param {string} gateway.path_params_login - (optional) An arbitrary string to be appended to the gateway url path for Login requests.
|
|
884
|
+
* @param {string} gateway.path_params_api - (optional) An arbitrary string to be appended to the gateway url path for API requests.
|
|
885
|
+
* @param {string} gateway.username - (optional) Not used at this stage (for a possible future use).
|
|
886
|
+
* @param {string} gateway.password - (optional) Not used at this stage (for a possible future use).
|
|
887
|
+
*/},{key:"setGateway",value:function setGateway(gateway){if(gateway){this.gateway={host:''};if(gateway.protocol)this.gateway.protocol=gateway.protocol;else this.gateway.protocol='https';if(gateway.host)this.gateway.host=gateway.host;else this.gateway.host='';if(gateway.port&&gateway.port>-1)this.gateway.port=gateway.port;else this.gateway.port=-1;if(gateway.path_params_login){this.gateway.path_params_login=gateway.path_params_login;// Strip trailing slash
|
|
888
|
+
this.gateway.path_params_login=this.gateway.path_params_login.replace(/\/+$/,'');}else this.gateway.path_params_login='';if(gateway.path_params_api){this.gateway.path_params_api=gateway.path_params_api;// Strip trailing slash
|
|
889
|
+
this.gateway.path_params_api=this.gateway.path_params_api.replace(/\/+$/,'');}else this.gateway.path_params_api='';if(gateway.username)this.gateway.username=gateway.username;if(gateway.password)this.gateway.password=gateway.password;}else{this.gateway=undefined;}}},{key:"setEnvironment",value:function setEnvironment(env){// Default value
|
|
878
890
|
if(env)this.environment=env;else this.environment=this.host?this.host:'mypurecloud.com';// Strip trailing slash
|
|
879
891
|
this.environment=this.environment.replace(/\/+$/,'');// Strip protocol and subdomain
|
|
880
|
-
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];}}}]);}();/**
|
|
892
|
+
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:"getConfUrl",value:function getConfUrl(pathType,regionUrl){if(!this.gateway)return regionUrl;if(!this.gateway.host)return regionUrl;var url=this.gateway.protocol+'://'+this.gateway.host;if(this.gateway.port>-1)url=url+':'+this.gateway.port.toString();if(pathType==='login'){if(this.gateway.path_params_login){if(this.gateway.path_params_login.startsWith('/'))url=url+this.gateway.path_params_login;else url=url+'/'+this.gateway.path_params_login;}}else{if(this.gateway.path_params_api){if(this.gateway.path_params_api.startsWith('/'))url=url+this.gateway.path_params_api;else url=url+'/'+this.gateway.path_params_api;}}return url;}},{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];}}}]);}();/**
|
|
881
893
|
* @module purecloud-platform-client-v2/ApiClient
|
|
882
|
-
* @version
|
|
894
|
+
* @version 207.0.0
|
|
883
895
|
*/var ApiClient=/*#__PURE__*/function(){/**
|
|
884
896
|
* Manages low level client-server communications, parameter marshalling, etc. There should not be any need for an
|
|
885
897
|
* application to use this class directly - the *Api and model classes provide the public API for the service. The
|
|
@@ -948,6 +960,16 @@ var tempState=this.authData.state;this.authData=localStorage.getItem("".concat(t
|
|
|
948
960
|
* @description Sets the environment used by the session
|
|
949
961
|
* @param {string} environment - (Optional, default "mypurecloud.com") Environment the session use, e.g. mypurecloud.ie, mypurecloud.com.au, etc.
|
|
950
962
|
*/},{key:"setEnvironment",value:function setEnvironment(environment){this.config.setEnvironment(environment);}/**
|
|
963
|
+
* @description Sets the gateway used by the session
|
|
964
|
+
* @param {object} gateway - Gateway Configuration interface
|
|
965
|
+
* @param {string} gateway.host - The address of the gateway.
|
|
966
|
+
* @param {string} gateway.protocol - (optional) The protocol to use. It will default to "https" if the parameter is not defined or empty.
|
|
967
|
+
* @param {string} gateway.port - (optional) The port to target. This parameter can be defined if a non default port is used and needs to be specified in the url (value must be greater than 0).
|
|
968
|
+
* @param {string} gateway.path_params_login - (optional) An arbitrary string to be appended to the gateway url path for Login requests.
|
|
969
|
+
* @param {string} gateway.path_params_api - (optional) An arbitrary string to be appended to the gateway url path for API requests.
|
|
970
|
+
* @param {string} gateway.username - (optional) Not used at this stage (for a possible future use).
|
|
971
|
+
* @param {string} gateway.password - (optional) Not used at this stage (for a possible future use).
|
|
972
|
+
*/},{key:"setGateway",value:function setGateway(gateway){this.config.setGateway(gateway);}/**
|
|
951
973
|
* @description Initiates the implicit grant login flow. Will attempt to load the token from local storage, if enabled.
|
|
952
974
|
* @param {string} clientId - The client ID of an OAuth Implicit Grant client
|
|
953
975
|
* @param {string} redirectUri - The redirect URI of the OAuth Implicit Grant client
|
|
@@ -963,35 +985,35 @@ _this2._testTokenAccess().then(function(){if(!_this2.authData.state&&opts.state)
|
|
|
963
985
|
* @description Initiates the client credentials login flow. Only available in node apps.
|
|
964
986
|
* @param {string} clientId - The client ID of an OAuth Implicit Grant client
|
|
965
987
|
* @param {string} clientSecret - The client secret of an OAuth Implicit Grant client
|
|
966
|
-
*/},{key:"loginClientCredentialsGrant",value:function loginClientCredentialsGrant(clientId,clientSecret){var _this3=this;this.clientId=clientId;var authHeader=Buffer.from("".concat(clientId,":").concat(clientSecret)).toString('base64');return new Promise(function(resolve,reject){// Block browsers from using client credentials
|
|
967
|
-
if(typeof window!=='undefined'){reject(new Error('The client credentials grant is not supported in a browser.'));return;}var headers={'Authorization':"Basic ".concat(authHeader)};axios$1({method:"POST",url:"
|
|
968
|
-
_this3.config.logger.log('trace',response.status,'POST',"
|
|
988
|
+
*/},{key:"loginClientCredentialsGrant",value:function loginClientCredentialsGrant(clientId,clientSecret){var _this3=this;this.clientId=clientId;var authHeader=Buffer.from("".concat(clientId,":").concat(clientSecret)).toString('base64');var loginBasePath=this.config.getConfUrl('login',"https://login.".concat(this.config.environment));return new Promise(function(resolve,reject){// Block browsers from using client credentials
|
|
989
|
+
if(typeof window!=='undefined'){reject(new Error('The client credentials grant is not supported in a browser.'));return;}var headers={'Authorization':"Basic ".concat(authHeader)};axios$1({method:"POST",url:"".concat(loginBasePath,"/oauth/token"),headers:headers,data:'grant_type=client_credentials',httpsAgent:_this3.proxyAgent}).then(function(response){// Logging
|
|
990
|
+
_this3.config.logger.log('trace',response.status,'POST',"".concat(loginBasePath,"/oauth/token"),headers,response.headers,{grant_type:'client_credentials'},undefined);_this3.config.logger.log('debug',response.status,'POST',"".concat(loginBasePath,"/oauth/token"),headers,undefined,{grant_type:'client_credentials'},undefined);// Save access token
|
|
969
991
|
_this3.setAccessToken(response.data['access_token']);// Set expiry time
|
|
970
992
|
_this3.authData.tokenExpiryTime=new Date().getTime()+response.data['expires_in']*1000;_this3.authData.tokenExpiryTimeString=new Date(_this3.authData.tokenExpiryTime).toUTCString();// Return auth data
|
|
971
993
|
resolve(_this3.authData);})["catch"](function(error){// Log error
|
|
972
|
-
if(error.response){_this3.config.logger.log('error',error.response.status,'POST',"
|
|
994
|
+
if(error.response){_this3.config.logger.log('error',error.response.status,'POST',"".concat(loginBasePath,"/oauth/token"),headers,error.response.headers,{grant_type:'client_credentials'},error.response.data);}reject(error);});});}/**
|
|
973
995
|
* @description Initiates the Saml2Bearerflow. Only available in node apps.
|
|
974
996
|
* @param {string} clientId - The client ID of an OAuth Implicit Grant client
|
|
975
997
|
* @param {string} clientSecret - The client secret of an OAuth Implicit Grant client
|
|
976
998
|
* @param {string} orgName - The orgName of an OAuth Implicit Grant client
|
|
977
999
|
* @param {string} assertion - The saml2bearer assertion
|
|
978
|
-
*/},{key:"loginSaml2BearerGrant",value:function loginSaml2BearerGrant(clientId,clientSecret,orgName,assertion){var _this4=this;this.clientId=clientId;return new Promise(function(resolve,reject){if(typeof window!=='undefined'){reject(new Error('The saml2bearer grant is not supported in a browser.'));return;}var encodedData=Buffer.from(clientId+':'+clientSecret).toString('base64');var request=_this4._formAuthRequest(encodedData,{grant_type:'urn:ietf:params:oauth:grant-type:saml2-bearer',orgName:orgName,assertion:assertion});request.proxy=_this4.proxy;var bodyParam={grant_type:'urn:ietf:params:oauth:grant-type:saml2-bearer',orgName:orgName,assertion:assertion};// Handle response
|
|
1000
|
+
*/},{key:"loginSaml2BearerGrant",value:function loginSaml2BearerGrant(clientId,clientSecret,orgName,assertion){var _this4=this;this.clientId=clientId;var loginBasePath=this.config.getConfUrl('login',"https://login.".concat(this.config.environment));return new Promise(function(resolve,reject){if(typeof window!=='undefined'){reject(new Error('The saml2bearer grant is not supported in a browser.'));return;}var encodedData=Buffer.from(clientId+':'+clientSecret).toString('base64');var request=_this4._formAuthRequest(encodedData,{grant_type:'urn:ietf:params:oauth:grant-type:saml2-bearer',orgName:orgName,assertion:assertion});request.proxy=_this4.proxy;var bodyParam={grant_type:'urn:ietf:params:oauth:grant-type:saml2-bearer',orgName:orgName,assertion:assertion};// Handle response
|
|
979
1001
|
request.then(function(response){// Logging
|
|
980
|
-
_this4.config.logger.log('trace',response.status,'POST',"
|
|
1002
|
+
_this4.config.logger.log('trace',response.status,'POST',"".concat(loginBasePath,"/oauth/token"),request.headers,response.headers,bodyParam,undefined);_this4.config.logger.log('debug',response.status,'POST',"".concat(loginBasePath,"/oauth/token"),request.headers,undefined,bodyParam,undefined);// Get access token from response
|
|
981
1003
|
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
|
|
982
1004
|
resolve(_this4.authData);})["catch"](function(error){// Log error
|
|
983
|
-
if(error.response){_this4.config.logger.log('error',error.response.status,'POST',"
|
|
1005
|
+
if(error.response){_this4.config.logger.log('error',error.response.status,'POST',"".concat(loginBasePath,"/oauth/token"),request.headers,error.response.headers,bodyParam,error.response.data);}reject(error);});});}/**
|
|
984
1006
|
* @description Completes the PKCE Code Authorization.
|
|
985
1007
|
* @param {string} clientId - The client ID of an OAuth Code Authorization Grant client
|
|
986
1008
|
* @param {string} codeVerifier - code verifier used to generate the code challenge
|
|
987
1009
|
* @param {string} authCode - Authorization code
|
|
988
1010
|
* @param {string} redirectUri - Authorized redirect URI for your Code Authorization client
|
|
989
|
-
*/},{key:"authorizePKCEGrant",value:function authorizePKCEGrant(clientId,codeVerifier,authCode,redirectUri){var _this5=this;this.clientId=clientId;return new Promise(function(resolve,reject){var request=axios$1({method:"POST",url:"
|
|
1011
|
+
*/},{key:"authorizePKCEGrant",value:function authorizePKCEGrant(clientId,codeVerifier,authCode,redirectUri){var _this5=this;this.clientId=clientId;var loginBasePath=this.config.getConfUrl('login',"https://login.".concat(this.config.environment));return new Promise(function(resolve,reject){var request=axios$1({method:"POST",url:"".concat(loginBasePath,"/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=_this5.proxy;var bodyParam={grant_type:'authorization_code',code:authCode,code_verifier:codeVerifier,client_id:clientId,redirect_uri:redirectUri};// Handle response
|
|
990
1012
|
request.then(function(response){// Logging
|
|
991
|
-
_this5.config.logger.log('trace',response.status,'POST',"
|
|
1013
|
+
_this5.config.logger.log('trace',response.status,'POST',"".concat(loginBasePath,"/oauth/token"),request.headers,response.headers,bodyParam,undefined);_this5.config.logger.log('debug',response.status,'POST',"".concat(loginBasePath,"/oauth/token"),request.headers,undefined,bodyParam,undefined);// Get access token from response
|
|
992
1014
|
var access_token=response.data.access_token;_this5.setAccessToken(access_token);_this5.authData.tokenExpiryTime=new Date().getTime()+response.data['expires_in']*1000;_this5.authData.tokenExpiryTimeString=new Date(_this5.authData.tokenExpiryTime).toUTCString();// Return auth data
|
|
993
1015
|
resolve(_this5.authData);})["catch"](function(error){// Log error
|
|
994
|
-
if(error.response){_this5.config.logger.log('error',error.response.status,'POST',"
|
|
1016
|
+
if(error.response){_this5.config.logger.log('error',error.response.status,'POST',"".concat(loginBasePath,"/oauth/token"),request.headers,error.response.headers,bodyParam,error.response.data);}reject(error);});});}/**
|
|
995
1017
|
* @description Generate a random string used as PKCE Code Verifier - length = 43 to 128.
|
|
996
1018
|
* @param {number} nChar - code length
|
|
997
1019
|
*/},{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
|
|
@@ -1057,15 +1079,15 @@ _this8._handleCodeAuthorizationResponse(request,bodyParam,resolve,reject);});}/*
|
|
|
1057
1079
|
* @param {object} bodyParam - Input body data for authorization request
|
|
1058
1080
|
* @param {function} resolve - Promise resolve callback
|
|
1059
1081
|
* @param {function} reject - Promise reject callback
|
|
1060
|
-
*/},{key:"_handleCodeAuthorizationResponse",value:function _handleCodeAuthorizationResponse(request,bodyParam,resolve,reject){var _this9=this;request.then(function(response){// Logging
|
|
1061
|
-
_this9.config.logger.log('trace',response.status,'POST',"
|
|
1082
|
+
*/},{key:"_handleCodeAuthorizationResponse",value:function _handleCodeAuthorizationResponse(request,bodyParam,resolve,reject){var _this9=this;var loginBasePath=this.config.getConfUrl('login',"https://login.".concat(this.config.environment));request.then(function(response){// Logging
|
|
1083
|
+
_this9.config.logger.log('trace',response.status,'POST',"".concat(loginBasePath,"/oauth/token"),request.headers,response.headers,bodyParam,undefined);_this9.config.logger.log('debug',response.status,'POST',"".concat(loginBasePath,"/oauth/token"),request.headers,undefined,bodyParam,undefined);// Get access token from response
|
|
1062
1084
|
var access_token=response.data.access_token;var refresh_token=response.data.refresh_token;_this9.setAccessToken(access_token);_this9.authData.refreshToken=refresh_token;_this9.authData.tokenExpiryTime=new Date().getTime()+response.data['expires_in']*1000;_this9.authData.tokenExpiryTimeString=new Date(_this9.authData.tokenExpiryTime).toUTCString();// Return auth data
|
|
1063
1085
|
resolve(_this9.authData);})["catch"](function(error){// Log error
|
|
1064
|
-
if(error.response){_this9.config.logger.log('error',error.response.status,'POST',"
|
|
1086
|
+
if(error.response){_this9.config.logger.log('error',error.response.status,'POST',"".concat(loginBasePath,"/oauth/token"),request.headers,error.response.headers,bodyParam,error.response.data);}reject(error);});}/**
|
|
1065
1087
|
* @description Utility function to create the request for auth requests
|
|
1066
1088
|
* @param {string} encodedData - Base64 encoded client and clientSecret pair
|
|
1067
1089
|
* @param {object} data - data to url form encode
|
|
1068
|
-
*/},{key:"_formAuthRequest",value:function _formAuthRequest(encodedData,data){var request=axios$1({method:"POST",url:"
|
|
1090
|
+
*/},{key:"_formAuthRequest",value:function _formAuthRequest(encodedData,data){var loginBasePath=this.config.getConfUrl('login',"https://login.".concat(this.config.environment));var request=axios$1({method:"POST",url:"".concat(loginBasePath,"/oauth/token"),headers:{'Authorization':'Basic '+encodedData,'Content-Type':'application/x-www-form-urlencoded'},data:qs__default["default"].stringify(data)});return request;}/**
|
|
1069
1091
|
* @description Handles an expired access token. Only available in node apps.
|
|
1070
1092
|
* @param {string} statusCode - The status code of a request
|
|
1071
1093
|
*/},{key:"_handleExpiredAccessToken",value:function _handleExpiredAccessToken(){var _this10=this;return new Promise(function(resolve,reject){if(typeof window!=='undefined'){reject(new Error('This method is not supported in a browser.'));return;}if(!_this10.refreshInProgress){_this10.refreshInProgress=true;_this10.refreshCodeAuthorizationGrant(_this10.clientId,_this10.clientSecret,_this10.authData.refreshToken).then(function(){_this10.refreshInProgress=false;resolve();})["catch"](function(err){// Handle failure response
|
|
@@ -1104,7 +1126,7 @@ this.setAccessToken(this.authentications['PureCloud OAuth'].accessToken);}/**
|
|
|
1104
1126
|
* @description Constructs a URL to the auth server
|
|
1105
1127
|
* @param {string} path - The path for the URL
|
|
1106
1128
|
* @param {object} query - An object of key/value pairs to use for querystring keys/values
|
|
1107
|
-
*/},{key:"_buildAuthUrl",value:function _buildAuthUrl(path,query){if(!query)query={};return Object.keys(query).reduce(function(url,key){return!query[key]?url:"".concat(url,"&").concat(key,"=").concat(query[key]);},"".concat(
|
|
1129
|
+
*/},{key:"_buildAuthUrl",value:function _buildAuthUrl(path,query){if(!query)query={};var loginBasePath=this.config.getConfUrl('login',this.config.authUrl);return Object.keys(query).reduce(function(url,key){return!query[key]?url:"".concat(url,"&").concat(key,"=").concat(query[key]);},"".concat(loginBasePath,"/").concat(path,"?"));}/**
|
|
1108
1130
|
* Returns a string representation for an actual parameter.
|
|
1109
1131
|
* @param param The actual parameter.
|
|
1110
1132
|
* @returns {String} The string representation of <code>param</code>.
|
|
@@ -1123,7 +1145,7 @@ this.setAccessToken(this.authentications['PureCloud OAuth'].accessToken);}/**
|
|
|
1123
1145
|
* @param {String} path The path to append to the base URL.
|
|
1124
1146
|
* @param {Object} pathParams The parameter values to append.
|
|
1125
1147
|
* @returns {String} The encoded path with parameter values substituted.
|
|
1126
|
-
*/},{key:"buildUrl",value:function buildUrl(path,pathParams){var _this12=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=_this12.paramToString(pathParams[key]);}else{value=fullMatch;}return encodeURIComponent(value);});return url;}/**
|
|
1148
|
+
*/},{key:"buildUrl",value:function buildUrl(path,pathParams){var _this12=this;if(!path.match(/^\//)){path="/".concat(path);}var url=this.config.getConfUrl('api',this.config.basePath)+path;url=url.replace(/\{([\w-]+)\}/g,function(fullMatch,key){var value;if(pathParams.hasOwnProperty(key)){value=_this12.paramToString(pathParams[key]);}else{value=fullMatch;}return encodeURIComponent(value);});return url;}/**
|
|
1127
1149
|
* Checks whether the given content type represents JSON.<br>
|
|
1128
1150
|
* JSON content type examples:<br>
|
|
1129
1151
|
* <ul>
|
|
@@ -1191,7 +1213,7 @@ resolve(data);})["catch"](function(error){var data=error;if(error.response&&erro
|
|
|
1191
1213
|
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);});}});}}]);}();var AgentAssistantsApi=/*#__PURE__*/function(){/**
|
|
1192
1214
|
* AgentAssistants service.
|
|
1193
1215
|
* @module purecloud-platform-client-v2/api/AgentAssistantsApi
|
|
1194
|
-
* @version
|
|
1216
|
+
* @version 207.0.0
|
|
1195
1217
|
*//**
|
|
1196
1218
|
* Constructs a new AgentAssistantsApi.
|
|
1197
1219
|
* @alias module:purecloud-platform-client-v2/api/AgentAssistantsApi
|
|
@@ -1292,7 +1314,7 @@ if(queueId===undefined||queueId===null){throw'Missing the required parameter "qu
|
|
|
1292
1314
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putAssistantQueue';}return this.apiClient.callApi('/api/v2/assistants/{assistantId}/queues/{queueId}','PUT',{'assistantId':assistantId,'queueId':queueId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var AgentCopilotApi=/*#__PURE__*/function(){/**
|
|
1293
1315
|
* AgentCopilot service.
|
|
1294
1316
|
* @module purecloud-platform-client-v2/api/AgentCopilotApi
|
|
1295
|
-
* @version
|
|
1317
|
+
* @version 207.0.0
|
|
1296
1318
|
*//**
|
|
1297
1319
|
* Constructs a new AgentCopilotApi.
|
|
1298
1320
|
* @alias module:purecloud-platform-client-v2/api/AgentCopilotApi
|
|
@@ -1314,7 +1336,7 @@ if(assistantId===undefined||assistantId===null){throw'Missing the required param
|
|
|
1314
1336
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putAssistantCopilot';}return this.apiClient.callApi('/api/v2/assistants/{assistantId}/copilot','PUT',{'assistantId':assistantId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var AgentUIApi=/*#__PURE__*/function(){/**
|
|
1315
1337
|
* AgentUI service.
|
|
1316
1338
|
* @module purecloud-platform-client-v2/api/AgentUIApi
|
|
1317
|
-
* @version
|
|
1339
|
+
* @version 207.0.0
|
|
1318
1340
|
*//**
|
|
1319
1341
|
* Constructs a new AgentUIApi.
|
|
1320
1342
|
* @alias module:purecloud-platform-client-v2/api/AgentUIApi
|
|
@@ -1348,7 +1370,7 @@ if(agentId===undefined||agentId===null){throw'Missing the required parameter "ag
|
|
|
1348
1370
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putUsersAgentuiAgentsAutoanswerAgentIdSettings';}return this.apiClient.callApi('/api/v2/users/agentui/agents/autoanswer/{agentId}/settings','PUT',{'agentId':agentId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var AlertingApi=/*#__PURE__*/function(){/**
|
|
1349
1371
|
* Alerting service.
|
|
1350
1372
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
1351
|
-
* @version
|
|
1373
|
+
* @version 207.0.0
|
|
1352
1374
|
*//**
|
|
1353
1375
|
* Constructs a new AlertingApi.
|
|
1354
1376
|
* @alias module:purecloud-platform-client-v2/api/AlertingApi
|
|
@@ -1505,7 +1527,7 @@ if(ruleId===undefined||ruleId===null){throw'Missing the required parameter "rule
|
|
|
1505
1527
|
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']);}}]);}();var AnalyticsApi=/*#__PURE__*/function(){/**
|
|
1506
1528
|
* Analytics service.
|
|
1507
1529
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
1508
|
-
* @version
|
|
1530
|
+
* @version 207.0.0
|
|
1509
1531
|
*//**
|
|
1510
1532
|
* Constructs a new AnalyticsApi.
|
|
1511
1533
|
* @alias module:purecloud-platform-client-v2/api/AnalyticsApi
|
|
@@ -1729,7 +1751,8 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
1729
1751
|
* @param {Number} opts.pageSize (default to 25)
|
|
1730
1752
|
* @param {Array.<String>} opts.id A list of user IDs to fetch by bulk
|
|
1731
1753
|
* @param {Object} opts.state Only list users of this state
|
|
1732
|
-
|
|
1754
|
+
* @param {Boolean} opts.deletedOnly Only list deleted dashboards that are still recoverable
|
|
1755
|
+
*/},{key:"getAnalyticsReportingDashboardsUsers",value:function getAnalyticsReportingDashboardsUsers(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/analytics/reporting/dashboards/users','GET',{},{'sortBy':opts['sortBy'],'pageNumber':opts['pageNumber'],'pageSize':opts['pageSize'],'id':this.apiClient.buildCollectionParam(opts['id'],'multi'),'state':opts['state'],'deletedOnly':opts['deletedOnly']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
1733
1756
|
* Get all view export requests for a user
|
|
1734
1757
|
*
|
|
1735
1758
|
* @param {Object} opts Optional parameters
|
|
@@ -1763,9 +1786,10 @@ if(dashboardAccessFilter===undefined||dashboardAccessFilter===null){throw'Missin
|
|
|
1763
1786
|
* @param {Number} opts.pageSize (default to 50)
|
|
1764
1787
|
* @param {Boolean} opts.publicOnly If true, retrieve only public dashboards
|
|
1765
1788
|
* @param {Boolean} opts.favoriteOnly If true, retrieve only favorite dashboards
|
|
1789
|
+
* @param {Boolean} opts.deletedOnly If true, retrieve only deleted dashboards that are still recoverable
|
|
1766
1790
|
* @param {String} opts.name retrieve dashboards that match with given name
|
|
1767
1791
|
*/},{key:"getAnalyticsReportingSettingsUserDashboards",value:function getAnalyticsReportingSettingsUserDashboards(userId,opts){opts=opts||{};// verify the required parameter 'userId' is set
|
|
1768
|
-
if(userId===undefined||userId===null){throw'Missing the required parameter "userId" when calling getAnalyticsReportingSettingsUserDashboards';}return this.apiClient.callApi('/api/v2/analytics/reporting/settings/users/{userId}/dashboards','GET',{'userId':userId},{'sortBy':opts['sortBy'],'pageNumber':opts['pageNumber'],'pageSize':opts['pageSize'],'publicOnly':opts['publicOnly'],'favoriteOnly':opts['favoriteOnly'],'name':opts['name']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
1792
|
+
if(userId===undefined||userId===null){throw'Missing the required parameter "userId" when calling getAnalyticsReportingSettingsUserDashboards';}return this.apiClient.callApi('/api/v2/analytics/reporting/settings/users/{userId}/dashboards','GET',{'userId':userId},{'sortBy':opts['sortBy'],'pageNumber':opts['pageNumber'],'pageSize':opts['pageSize'],'publicOnly':opts['publicOnly'],'favoriteOnly':opts['favoriteOnly'],'deletedOnly':opts['deletedOnly'],'name':opts['name']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
1769
1793
|
* Get status for async query for resolution aggregates
|
|
1770
1794
|
*
|
|
1771
1795
|
* @param {String} jobId jobId
|
|
@@ -2009,7 +2033,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
2009
2033
|
* @param {Object} body query
|
|
2010
2034
|
*/},{key:"postAnalyticsRatelimitsAggregatesQuery",value:function postAnalyticsRatelimitsAggregatesQuery(body){// verify the required parameter 'body' is set
|
|
2011
2035
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postAnalyticsRatelimitsAggregatesQuery';}return this.apiClient.callApi('/api/v2/analytics/ratelimits/aggregates/query','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
2012
|
-
* Bulk delete dashboards owned by other user(s)
|
|
2036
|
+
* Bulk soft delete dashboards owned by other user(s)
|
|
2013
2037
|
*
|
|
2014
2038
|
* @param {Array.<String>} body List of userIds
|
|
2015
2039
|
*/},{key:"postAnalyticsReportingDashboardsUsersBulkRemove",value:function postAnalyticsReportingDashboardsUsersBulkRemove(body){// verify the required parameter 'body' is set
|
|
@@ -2019,7 +2043,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
2019
2043
|
* @param {Object} body ReportingExportJobRequest
|
|
2020
2044
|
*/},{key:"postAnalyticsReportingExports",value:function postAnalyticsReportingExports(body){// verify the required parameter 'body' is set
|
|
2021
2045
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postAnalyticsReportingExports';}return this.apiClient.callApi('/api/v2/analytics/reporting/exports','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
2022
|
-
* Bulk
|
|
2046
|
+
* Bulk soft delete dashboard configurations
|
|
2023
2047
|
*
|
|
2024
2048
|
* @param {Object} body
|
|
2025
2049
|
*/},{key:"postAnalyticsReportingSettingsDashboardsBulkRemove",value:function postAnalyticsReportingSettingsDashboardsBulkRemove(body){// verify the required parameter 'body' is set
|
|
@@ -2063,7 +2087,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
2063
2087
|
* Query for task management aggregates
|
|
2064
2088
|
*
|
|
2065
2089
|
* @param {Object} body query
|
|
2066
|
-
* postAnalyticsTaskmanagementAggregatesQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2067
2090
|
*/},{key:"postAnalyticsTaskmanagementAggregatesQuery",value:function postAnalyticsTaskmanagementAggregatesQuery(body){// verify the required parameter 'body' is set
|
|
2068
2091
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postAnalyticsTaskmanagementAggregatesQuery';}return this.apiClient.callApi('/api/v2/analytics/taskmanagement/aggregates/query','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
2069
2092
|
* Query for team activity observations
|
|
@@ -2126,7 +2149,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
2126
2149
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putAnalyticsDataretentionSettings';}return this.apiClient.callApi('/api/v2/analytics/dataretention/settings','PUT',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var ArchitectApi=/*#__PURE__*/function(){/**
|
|
2127
2150
|
* Architect service.
|
|
2128
2151
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
2129
|
-
* @version
|
|
2152
|
+
* @version 207.0.0
|
|
2130
2153
|
*//**
|
|
2131
2154
|
* Constructs a new ArchitectApi.
|
|
2132
2155
|
* @alias module:purecloud-platform-client-v2/api/ArchitectApi
|
|
@@ -2616,7 +2639,7 @@ if(flowId===undefined||flowId===null){throw'Missing the required parameter "flow
|
|
|
2616
2639
|
*/},{key:"getFlowVersion",value:function getFlowVersion(flowId,versionId,opts){opts=opts||{};// verify the required parameter 'flowId' is set
|
|
2617
2640
|
if(flowId===undefined||flowId===null){throw'Missing the required parameter "flowId" when calling getFlowVersion';}// verify the required parameter 'versionId' is set
|
|
2618
2641
|
if(versionId===undefined||versionId===null){throw'Missing the required parameter "versionId" when calling getFlowVersion';}return this.apiClient.callApi('/api/v2/flows/{flowId}/versions/{versionId}','GET',{'flowId':flowId,'versionId':versionId},{'deleted':opts['deleted']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
2619
|
-
*
|
|
2642
|
+
* Get flow version configuration
|
|
2620
2643
|
*
|
|
2621
2644
|
* @param {String} flowId Flow ID
|
|
2622
2645
|
* @param {String} versionId Version ID
|
|
@@ -3218,7 +3241,7 @@ if(milestoneId===undefined||milestoneId===null){throw'Missing the required param
|
|
|
3218
3241
|
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']);}}]);}();var AuditApi=/*#__PURE__*/function(){/**
|
|
3219
3242
|
* Audit service.
|
|
3220
3243
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
3221
|
-
* @version
|
|
3244
|
+
* @version 207.0.0
|
|
3222
3245
|
*//**
|
|
3223
3246
|
* Constructs a new AuditApi.
|
|
3224
3247
|
* @alias module:purecloud-platform-client-v2/api/AuditApi
|
|
@@ -3268,7 +3291,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
3268
3291
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postAuditsQueryRealtimeRelated';}return this.apiClient.callApi('/api/v2/audits/query/realtime/related','POST',{},{'expand':this.apiClient.buildCollectionParam(opts['expand'],'multi')},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var AuthorizationApi=/*#__PURE__*/function(){/**
|
|
3269
3292
|
* Authorization service.
|
|
3270
3293
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
3271
|
-
* @version
|
|
3294
|
+
* @version 207.0.0
|
|
3272
3295
|
*//**
|
|
3273
3296
|
* Constructs a new AuthorizationApi.
|
|
3274
3297
|
* @alias module:purecloud-platform-client-v2/api/AuthorizationApi
|
|
@@ -3591,7 +3614,7 @@ if(subjectId===undefined||subjectId===null){throw'Missing the required parameter
|
|
|
3591
3614
|
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']);}}]);}();var BillingApi=/*#__PURE__*/function(){/**
|
|
3592
3615
|
* Billing service.
|
|
3593
3616
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
3594
|
-
* @version
|
|
3617
|
+
* @version 207.0.0
|
|
3595
3618
|
*//**
|
|
3596
3619
|
* Constructs a new BillingApi.
|
|
3597
3620
|
* @alias module:purecloud-platform-client-v2/api/BillingApi
|
|
@@ -3615,7 +3638,7 @@ if(endDate===undefined||endDate===null){throw'Missing the required parameter "en
|
|
|
3615
3638
|
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']);}}]);}();var CarrierServicesApi=/*#__PURE__*/function(){/**
|
|
3616
3639
|
* CarrierServices service.
|
|
3617
3640
|
* @module purecloud-platform-client-v2/api/CarrierServicesApi
|
|
3618
|
-
* @version
|
|
3641
|
+
* @version 207.0.0
|
|
3619
3642
|
*//**
|
|
3620
3643
|
* Constructs a new CarrierServicesApi.
|
|
3621
3644
|
* @alias module:purecloud-platform-client-v2/api/CarrierServicesApi
|
|
@@ -3635,7 +3658,7 @@ if(phoneNumber===undefined||phoneNumber===null){throw'Missing the required param
|
|
|
3635
3658
|
*/},{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']);}}]);}();var ChatApi=/*#__PURE__*/function(){/**
|
|
3636
3659
|
* Chat service.
|
|
3637
3660
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
3638
|
-
* @version
|
|
3661
|
+
* @version 207.0.0
|
|
3639
3662
|
*//**
|
|
3640
3663
|
* Constructs a new ChatApi.
|
|
3641
3664
|
* @alias module:purecloud-platform-client-v2/api/ChatApi
|
|
@@ -3860,7 +3883,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
3860
3883
|
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']);}}]);}();var CoachingApi=/*#__PURE__*/function(){/**
|
|
3861
3884
|
* Coaching service.
|
|
3862
3885
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
3863
|
-
* @version
|
|
3886
|
+
* @version 207.0.0
|
|
3864
3887
|
*//**
|
|
3865
3888
|
* Constructs a new CoachingApi.
|
|
3866
3889
|
* @alias module:purecloud-platform-client-v2/api/CoachingApi
|
|
@@ -4013,7 +4036,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
4013
4036
|
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']);}}]);}();var ContentManagementApi=/*#__PURE__*/function(){/**
|
|
4014
4037
|
* ContentManagement service.
|
|
4015
4038
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
4016
|
-
* @version
|
|
4039
|
+
* @version 207.0.0
|
|
4017
4040
|
*//**
|
|
4018
4041
|
* Constructs a new ContentManagementApi.
|
|
4019
4042
|
* @alias module:purecloud-platform-client-v2/api/ContentManagementApi
|
|
@@ -4117,12 +4140,11 @@ if(shareId===undefined||shareId===null){throw'Missing the required parameter "sh
|
|
|
4117
4140
|
* This method requires the download sharing URI obtained in the get document response (downloadSharingUri). Documents may be shared between users in the same workspace. Documents may also be shared between any user by creating a content management share.
|
|
4118
4141
|
* @param {String} sharedId Shared ID
|
|
4119
4142
|
* @param {Object} opts Optional parameters
|
|
4120
|
-
* @param {Boolean} opts.redirect Turn on or off redirect (default to true)
|
|
4121
4143
|
* @param {Object} opts.disposition Request how the share content will be downloaded: attached as a file or inline. Default is attachment. (default to attachment)
|
|
4122
4144
|
* @param {String} opts.contentType The requested format for the specified document. If supported, the document will be returned in that format. Example contentType=audio/wav
|
|
4123
4145
|
* @param {Object} opts.expand Expand some document fields
|
|
4124
4146
|
*/},{key:"getContentmanagementSharedSharedId",value:function getContentmanagementSharedSharedId(sharedId,opts){opts=opts||{};// verify the required parameter 'sharedId' is set
|
|
4125
|
-
if(sharedId===undefined||sharedId===null){throw'Missing the required parameter "sharedId" when calling getContentmanagementSharedSharedId';}return this.apiClient.callApi('/api/v2/contentmanagement/shared/{sharedId}','GET',{'sharedId':sharedId},{'
|
|
4147
|
+
if(sharedId===undefined||sharedId===null){throw'Missing the required parameter "sharedId" when calling getContentmanagementSharedSharedId';}return this.apiClient.callApi('/api/v2/contentmanagement/shared/{sharedId}','GET',{'sharedId':sharedId},{'disposition':opts['disposition'],'contentType':opts['contentType'],'expand':opts['expand']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
4126
4148
|
* Gets a list of shares. You must specify at least one filter (e.g. entityId).
|
|
4127
4149
|
* Failing to specify a filter will return 400.
|
|
4128
4150
|
* @param {Object} opts Optional parameters
|
|
@@ -4296,7 +4318,7 @@ if(tagId===undefined||tagId===null){throw'Missing the required parameter "tagId"
|
|
|
4296
4318
|
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']);}}]);}();var ConversationsApi=/*#__PURE__*/function(){/**
|
|
4297
4319
|
* Conversations service.
|
|
4298
4320
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
4299
|
-
* @version
|
|
4321
|
+
* @version 207.0.0
|
|
4300
4322
|
*//**
|
|
4301
4323
|
* Constructs a new ConversationsApi.
|
|
4302
4324
|
* @alias module:purecloud-platform-client-v2/api/ConversationsApi
|
|
@@ -5210,7 +5232,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
5210
5232
|
* @param {String} conversationId conversationId
|
|
5211
5233
|
* @param {String} participantId participantId
|
|
5212
5234
|
* @param {Object} body Parking update request
|
|
5213
|
-
* patchConversationsEmailParticipantParkingstate is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
5214
5235
|
*/},{key:"patchConversationsEmailParticipantParkingstate",value:function patchConversationsEmailParticipantParkingstate(conversationId,participantId,body){// verify the required parameter 'conversationId' is set
|
|
5215
5236
|
if(conversationId===undefined||conversationId===null){throw'Missing the required parameter "conversationId" when calling patchConversationsEmailParticipantParkingstate';}// verify the required parameter 'participantId' is set
|
|
5216
5237
|
if(participantId===undefined||participantId===null){throw'Missing the required parameter "participantId" when calling patchConversationsEmailParticipantParkingstate';}// verify the required parameter 'body' is set
|
|
@@ -5436,9 +5457,10 @@ if(conversationId===undefined||conversationId===null){throw'Missing the required
|
|
|
5436
5457
|
if(suggestionId===undefined||suggestionId===null){throw'Missing the required parameter "suggestionId" when calling postConversationSuggestionEngagement';}// verify the required parameter 'body' is set
|
|
5437
5458
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postConversationSuggestionEngagement';}return this.apiClient.callApi('/api/v2/conversations/{conversationId}/suggestions/{suggestionId}/engagement','POST',{'conversationId':conversationId,'suggestionId':suggestionId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
5438
5459
|
* Suggestion feedback.
|
|
5439
|
-
*
|
|
5460
|
+
* Google Agent Assist offering within Genesys will no longer be supported
|
|
5440
5461
|
* @param {String} conversationId Conversation ID
|
|
5441
5462
|
* @param {Object} body SuggestionFeedback
|
|
5463
|
+
* @deprecated
|
|
5442
5464
|
*/},{key:"postConversationSuggestionsFeedback",value:function postConversationSuggestionsFeedback(conversationId,body){// verify the required parameter 'conversationId' is set
|
|
5443
5465
|
if(conversationId===undefined||conversationId===null){throw'Missing the required parameter "conversationId" when calling postConversationSuggestionsFeedback';}// verify the required parameter 'body' is set
|
|
5444
5466
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postConversationSuggestionsFeedback';}return this.apiClient.callApi('/api/v2/conversations/{conversationId}/suggestions/feedback','POST',{'conversationId':conversationId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
@@ -5754,9 +5776,11 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
5754
5776
|
* Send an inbound message to an Open Messaging integration. In order to call this endpoint you will need OAuth token generated using OAuth client credentials authorized with at least messaging scope. This will either generate a new Conversation, or be a part of an existing conversation. See https://developer.genesys.cloud/api/digital/openmessaging/ for example usage.
|
|
5755
5777
|
* @param {String} integrationId integrationId
|
|
5756
5778
|
* @param {Object} body NormalizedMessage
|
|
5757
|
-
|
|
5779
|
+
* @param {Object} opts Optional parameters
|
|
5780
|
+
* @param {Boolean} opts.prefetchConversationId Indicates whether or not to prefetch conversationId (default to false)
|
|
5781
|
+
*/},{key:"postConversationsMessageInboundOpenMessage",value:function postConversationsMessageInboundOpenMessage(integrationId,body,opts){opts=opts||{};// verify the required parameter 'integrationId' is set
|
|
5758
5782
|
if(integrationId===undefined||integrationId===null){throw'Missing the required parameter "integrationId" when calling postConversationsMessageInboundOpenMessage';}// verify the required parameter 'body' is set
|
|
5759
|
-
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postConversationsMessageInboundOpenMessage';}return this.apiClient.callApi('/api/v2/conversations/messages/{integrationId}/inbound/open/message','POST',{'integrationId':integrationId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
5783
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postConversationsMessageInboundOpenMessage';}return this.apiClient.callApi('/api/v2/conversations/messages/{integrationId}/inbound/open/message','POST',{'integrationId':integrationId},{'prefetchConversationId':opts['prefetchConversationId']},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
5760
5784
|
* Send an inbound Open Receipt Message
|
|
5761
5785
|
* Send an inbound open Receipt to an Open Messaging integration. In order to call this endpoint you will need OAuth token generated using OAuth client credentials authorized with at least messaging scope. This will either generate a new Conversation, or be a part of an existing conversation. See https://developer.genesys.cloud/api/digital/openmessaging/ for example usage.
|
|
5762
5786
|
* @param {String} integrationId integrationId
|
|
@@ -6023,7 +6047,7 @@ if(conversationId===undefined||conversationId===null){throw'Missing the required
|
|
|
6023
6047
|
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']);}}]);}();var DataExtensionsApi=/*#__PURE__*/function(){/**
|
|
6024
6048
|
* DataExtensions service.
|
|
6025
6049
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
6026
|
-
* @version
|
|
6050
|
+
* @version 207.0.0
|
|
6027
6051
|
*//**
|
|
6028
6052
|
* Constructs a new DataExtensionsApi.
|
|
6029
6053
|
* @alias module:purecloud-platform-client-v2/api/DataExtensionsApi
|
|
@@ -6044,7 +6068,7 @@ if(coretypeName===undefined||coretypeName===null){throw'Missing the required par
|
|
|
6044
6068
|
*/},{key:"getDataextensionsLimits",value:function getDataextensionsLimits(){return this.apiClient.callApi('/api/v2/dataextensions/limits','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var DownloadsApi=/*#__PURE__*/function(){/**
|
|
6045
6069
|
* Downloads service.
|
|
6046
6070
|
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
6047
|
-
* @version
|
|
6071
|
+
* @version 207.0.0
|
|
6048
6072
|
*//**
|
|
6049
6073
|
* Constructs a new DownloadsApi.
|
|
6050
6074
|
* @alias module:purecloud-platform-client-v2/api/DownloadsApi
|
|
@@ -6063,7 +6087,7 @@ if(coretypeName===undefined||coretypeName===null){throw'Missing the required par
|
|
|
6063
6087
|
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']);}}]);}();var EmailsApi=/*#__PURE__*/function(){/**
|
|
6064
6088
|
* Emails service.
|
|
6065
6089
|
* @module purecloud-platform-client-v2/api/EmailsApi
|
|
6066
|
-
* @version
|
|
6090
|
+
* @version 207.0.0
|
|
6067
6091
|
*//**
|
|
6068
6092
|
* Constructs a new EmailsApi.
|
|
6069
6093
|
* @alias module:purecloud-platform-client-v2/api/EmailsApi
|
|
@@ -6081,7 +6105,7 @@ if(downloadId===undefined||downloadId===null){throw'Missing the required paramet
|
|
|
6081
6105
|
*/},{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']);}}]);}();var EmployeeEngagementApi=/*#__PURE__*/function(){/**
|
|
6082
6106
|
* EmployeeEngagement service.
|
|
6083
6107
|
* @module purecloud-platform-client-v2/api/EmployeeEngagementApi
|
|
6084
|
-
* @version
|
|
6108
|
+
* @version 207.0.0
|
|
6085
6109
|
*//**
|
|
6086
6110
|
* Constructs a new EmployeeEngagementApi.
|
|
6087
6111
|
* @alias module:purecloud-platform-client-v2/api/EmployeeEngagementApi
|
|
@@ -6119,7 +6143,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
6119
6143
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postEmployeeengagementRecognitions';}return this.apiClient.callApi('/api/v2/employeeengagement/recognitions','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var EventsApi=/*#__PURE__*/function(){/**
|
|
6120
6144
|
* Events service.
|
|
6121
6145
|
* @module purecloud-platform-client-v2/api/EventsApi
|
|
6122
|
-
* @version
|
|
6146
|
+
* @version 207.0.0
|
|
6123
6147
|
*//**
|
|
6124
6148
|
* Constructs a new EventsApi.
|
|
6125
6149
|
* @alias module:purecloud-platform-client-v2/api/EventsApi
|
|
@@ -6144,7 +6168,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
6144
6168
|
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']);}}]);}();var ExternalContactsApi=/*#__PURE__*/function(){/**
|
|
6145
6169
|
* ExternalContacts service.
|
|
6146
6170
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
6147
|
-
* @version
|
|
6171
|
+
* @version 207.0.0
|
|
6148
6172
|
*//**
|
|
6149
6173
|
* Constructs a new ExternalContactsApi.
|
|
6150
6174
|
* @alias module:purecloud-platform-client-v2/api/ExternalContactsApi
|
|
@@ -6175,6 +6199,11 @@ if(schemaId===undefined||schemaId===null){throw'Missing the required parameter "
|
|
|
6175
6199
|
* deleteExternalcontactsExternalsource is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
6176
6200
|
*/},{key:"deleteExternalcontactsExternalsource",value:function deleteExternalcontactsExternalsource(externalSourceId){// verify the required parameter 'externalSourceId' is set
|
|
6177
6201
|
if(externalSourceId===undefined||externalSourceId===null){throw'Missing the required parameter "externalSourceId" when calling deleteExternalcontactsExternalsource';}return this.apiClient.callApi('/api/v2/externalcontacts/externalsources/{externalSourceId}','DELETE',{'externalSourceId':externalSourceId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
6202
|
+
* Delete settings for CSV import
|
|
6203
|
+
*
|
|
6204
|
+
* @param {String} settingsId Settings id
|
|
6205
|
+
*/},{key:"deleteExternalcontactsImportCsvSetting",value:function deleteExternalcontactsImportCsvSetting(settingsId){// verify the required parameter 'settingsId' is set
|
|
6206
|
+
if(settingsId===undefined||settingsId===null){throw'Missing the required parameter "settingsId" when calling deleteExternalcontactsImportCsvSetting';}return this.apiClient.callApi('/api/v2/externalcontacts/import/csv/settings/{settingsId}','DELETE',{'settingsId':settingsId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
6178
6207
|
* Delete an external organization
|
|
6179
6208
|
*
|
|
6180
6209
|
* @param {String} externalOrganizationId External Organization ID
|
|
@@ -6288,6 +6317,28 @@ if(externalSourceId===undefined||externalSourceId===null){throw'Missing the requ
|
|
|
6288
6317
|
* @param {Boolean} opts.active Filter by active status of external source
|
|
6289
6318
|
* getExternalcontactsExternalsources is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
6290
6319
|
*/},{key:"getExternalcontactsExternalsources",value:function getExternalcontactsExternalsources(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/externalcontacts/externalsources','GET',{},{'cursor':opts['cursor'],'limit':opts['limit'],'name':opts['name'],'active':opts['active']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
6320
|
+
* Get settings for CSV import
|
|
6321
|
+
*
|
|
6322
|
+
* @param {String} settingsId Settings id
|
|
6323
|
+
*/},{key:"getExternalcontactsImportCsvSetting",value:function getExternalcontactsImportCsvSetting(settingsId){// verify the required parameter 'settingsId' is set
|
|
6324
|
+
if(settingsId===undefined||settingsId===null){throw'Missing the required parameter "settingsId" when calling getExternalcontactsImportCsvSetting';}return this.apiClient.callApi('/api/v2/externalcontacts/import/csv/settings/{settingsId}','GET',{'settingsId':settingsId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
6325
|
+
* Retrieve all settings for organization filtered by externalSettingsId if provided
|
|
6326
|
+
*
|
|
6327
|
+
* @param {Object} opts Optional parameters
|
|
6328
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
6329
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
6330
|
+
* @param {String} opts.externalSettingsId External Settings Id to filter the list.
|
|
6331
|
+
*/},{key:"getExternalcontactsImportCsvSettings",value:function getExternalcontactsImportCsvSettings(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/externalcontacts/import/csv/settings','GET',{},{'after':opts['after'],'pageSize':opts['pageSize'],'externalSettingsId':opts['externalSettingsId']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
6332
|
+
* Get details for CSV upload
|
|
6333
|
+
*
|
|
6334
|
+
* @param {String} uploadId Upload id
|
|
6335
|
+
*/},{key:"getExternalcontactsImportCsvUploadDetails",value:function getExternalcontactsImportCsvUploadDetails(uploadId){// verify the required parameter 'uploadId' is set
|
|
6336
|
+
if(uploadId===undefined||uploadId===null){throw'Missing the required parameter "uploadId" when calling getExternalcontactsImportCsvUploadDetails';}return this.apiClient.callApi('/api/v2/externalcontacts/import/csv/uploads/{uploadId}/details','GET',{'uploadId':uploadId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
6337
|
+
* Get preview for CSV upload
|
|
6338
|
+
*
|
|
6339
|
+
* @param {String} uploadId Upload id
|
|
6340
|
+
*/},{key:"getExternalcontactsImportCsvUploadPreview",value:function getExternalcontactsImportCsvUploadPreview(uploadId){// verify the required parameter 'uploadId' is set
|
|
6341
|
+
if(uploadId===undefined||uploadId===null){throw'Missing the required parameter "uploadId" when calling getExternalcontactsImportCsvUploadPreview';}return this.apiClient.callApi('/api/v2/externalcontacts/import/csv/uploads/{uploadId}/preview','GET',{'uploadId':uploadId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
6291
6342
|
* Fetch an external organization
|
|
6292
6343
|
*
|
|
6293
6344
|
* @param {String} externalOrganizationId External Organization ID
|
|
@@ -6532,6 +6583,21 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
6532
6583
|
* @param {Array.<String>} opts.expand which field, if any, to expand
|
|
6533
6584
|
*/},{key:"postExternalcontactsIdentifierlookup",value:function postExternalcontactsIdentifierlookup(identifier,opts){opts=opts||{};// verify the required parameter 'identifier' is set
|
|
6534
6585
|
if(identifier===undefined||identifier===null){throw'Missing the required parameter "identifier" when calling postExternalcontactsIdentifierlookup';}return this.apiClient.callApi('/api/v2/externalcontacts/identifierlookup','POST',{},{'expand':this.apiClient.buildCollectionParam(opts['expand'],'multi')},{},{},identifier,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
6586
|
+
* Create CSV import job
|
|
6587
|
+
*
|
|
6588
|
+
* @param {Object} body ImportRequest
|
|
6589
|
+
*/},{key:"postExternalcontactsImportCsvJobs",value:function postExternalcontactsImportCsvJobs(body){// verify the required parameter 'body' is set
|
|
6590
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postExternalcontactsImportCsvJobs';}return this.apiClient.callApi('/api/v2/externalcontacts/import/csv/jobs','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
6591
|
+
* Create settings for CSV import
|
|
6592
|
+
*
|
|
6593
|
+
* @param {Object} body Settings
|
|
6594
|
+
*/},{key:"postExternalcontactsImportCsvSettings",value:function postExternalcontactsImportCsvSettings(body){// verify the required parameter 'body' is set
|
|
6595
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postExternalcontactsImportCsvSettings';}return this.apiClient.callApi('/api/v2/externalcontacts/import/csv/settings','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
6596
|
+
* Get url for CSV upload
|
|
6597
|
+
*
|
|
6598
|
+
* @param {Object} body UploadRequest
|
|
6599
|
+
*/},{key:"postExternalcontactsImportCsvUploads",value:function postExternalcontactsImportCsvUploads(body){// verify the required parameter 'body' is set
|
|
6600
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postExternalcontactsImportCsvUploads';}return this.apiClient.callApi('/api/v2/externalcontacts/import/csv/uploads','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
6535
6601
|
* Merge two contacts into a new contact record
|
|
6536
6602
|
* Two curated contacts cannot be merged. Refer to the Contact Merging article on the Developer Center for details
|
|
6537
6603
|
* @param {Object} body MergeRequest
|
|
@@ -6597,6 +6663,13 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
6597
6663
|
*/},{key:"putExternalcontactsExternalsource",value:function putExternalcontactsExternalsource(externalSourceId,body){// verify the required parameter 'externalSourceId' is set
|
|
6598
6664
|
if(externalSourceId===undefined||externalSourceId===null){throw'Missing the required parameter "externalSourceId" when calling putExternalcontactsExternalsource';}// verify the required parameter 'body' is set
|
|
6599
6665
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putExternalcontactsExternalsource';}return this.apiClient.callApi('/api/v2/externalcontacts/externalsources/{externalSourceId}','PUT',{'externalSourceId':externalSourceId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
6666
|
+
* Update settings for CSV import
|
|
6667
|
+
*
|
|
6668
|
+
* @param {String} settingsId Settings id
|
|
6669
|
+
* @param {Object} body Settings
|
|
6670
|
+
*/},{key:"putExternalcontactsImportCsvSetting",value:function putExternalcontactsImportCsvSetting(settingsId,body){// verify the required parameter 'settingsId' is set
|
|
6671
|
+
if(settingsId===undefined||settingsId===null){throw'Missing the required parameter "settingsId" when calling putExternalcontactsImportCsvSetting';}// verify the required parameter 'body' is set
|
|
6672
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putExternalcontactsImportCsvSetting';}return this.apiClient.callApi('/api/v2/externalcontacts/import/csv/settings/{settingsId}','PUT',{'settingsId':settingsId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
6600
6673
|
* Update an external organization
|
|
6601
6674
|
*
|
|
6602
6675
|
* @param {String} externalOrganizationId External Organization ID
|
|
@@ -6636,7 +6709,7 @@ if(relationshipId===undefined||relationshipId===null){throw'Missing the required
|
|
|
6636
6709
|
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']);}}]);}();var FaxApi=/*#__PURE__*/function(){/**
|
|
6637
6710
|
* Fax service.
|
|
6638
6711
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
6639
|
-
* @version
|
|
6712
|
+
* @version 207.0.0
|
|
6640
6713
|
*//**
|
|
6641
6714
|
* Constructs a new FaxApi.
|
|
6642
6715
|
* @alias module:purecloud-platform-client-v2/api/FaxApi
|
|
@@ -6685,7 +6758,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
6685
6758
|
*/},{key:"putFaxSettings",value:function putFaxSettings(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/fax/settings','PUT',{},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var FlowsApi=/*#__PURE__*/function(){/**
|
|
6686
6759
|
* Flows service.
|
|
6687
6760
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
6688
|
-
* @version
|
|
6761
|
+
* @version 207.0.0
|
|
6689
6762
|
*//**
|
|
6690
6763
|
* Constructs a new FlowsApi.
|
|
6691
6764
|
* @alias module:purecloud-platform-client-v2/api/FlowsApi
|
|
@@ -6733,7 +6806,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
6733
6806
|
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']);}}]);}();var GamificationApi=/*#__PURE__*/function(){/**
|
|
6734
6807
|
* Gamification service.
|
|
6735
6808
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
6736
|
-
* @version
|
|
6809
|
+
* @version 207.0.0
|
|
6737
6810
|
*//**
|
|
6738
6811
|
* Constructs a new GamificationApi.
|
|
6739
6812
|
* @alias module:purecloud-platform-client-v2/api/GamificationApi
|
|
@@ -7273,7 +7346,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
7273
7346
|
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']);}}]);}();var GeneralDataProtectionRegulationApi=/*#__PURE__*/function(){/**
|
|
7274
7347
|
* GeneralDataProtectionRegulation service.
|
|
7275
7348
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
7276
|
-
* @version
|
|
7349
|
+
* @version 207.0.0
|
|
7277
7350
|
*//**
|
|
7278
7351
|
* Constructs a new GeneralDataProtectionRegulationApi.
|
|
7279
7352
|
* @alias module:purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
@@ -7308,7 +7381,7 @@ if(searchValue===undefined||searchValue===null){throw'Missing the required param
|
|
|
7308
7381
|
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']);}}]);}();var GeolocationApi=/*#__PURE__*/function(){/**
|
|
7309
7382
|
* Geolocation service.
|
|
7310
7383
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
7311
|
-
* @version
|
|
7384
|
+
* @version 207.0.0
|
|
7312
7385
|
*//**
|
|
7313
7386
|
* Constructs a new GeolocationApi.
|
|
7314
7387
|
* @alias module:purecloud-platform-client-v2/api/GeolocationApi
|
|
@@ -7342,7 +7415,7 @@ if(clientId===undefined||clientId===null){throw'Missing the required parameter "
|
|
|
7342
7415
|
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']);}}]);}();var GreetingsApi=/*#__PURE__*/function(){/**
|
|
7343
7416
|
* Greetings service.
|
|
7344
7417
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
7345
|
-
* @version
|
|
7418
|
+
* @version 207.0.0
|
|
7346
7419
|
*//**
|
|
7347
7420
|
* Constructs a new GreetingsApi.
|
|
7348
7421
|
* @alias module:purecloud-platform-client-v2/api/GreetingsApi
|
|
@@ -7449,7 +7522,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
7449
7522
|
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']);}}]);}();var GroupsApi=/*#__PURE__*/function(){/**
|
|
7450
7523
|
* Groups service.
|
|
7451
7524
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
7452
|
-
* @version
|
|
7525
|
+
* @version 207.0.0
|
|
7453
7526
|
*//**
|
|
7454
7527
|
* Constructs a new GroupsApi.
|
|
7455
7528
|
* @alias module:purecloud-platform-client-v2/api/GroupsApi
|
|
@@ -7582,7 +7655,7 @@ if(groupId===undefined||groupId===null){throw'Missing the required parameter "gr
|
|
|
7582
7655
|
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']);}}]);}();var IdentityProviderApi=/*#__PURE__*/function(){/**
|
|
7583
7656
|
* IdentityProvider service.
|
|
7584
7657
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
7585
|
-
* @version
|
|
7658
|
+
* @version 207.0.0
|
|
7586
7659
|
*//**
|
|
7587
7660
|
* Constructs a new IdentityProviderApi.
|
|
7588
7661
|
* @alias module:purecloud-platform-client-v2/api/IdentityProviderApi
|
|
@@ -7738,7 +7811,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
7738
7811
|
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']);}}]);}();var InfrastructureAsCodeApi=/*#__PURE__*/function(){/**
|
|
7739
7812
|
* InfrastructureAsCode service.
|
|
7740
7813
|
* @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
7741
|
-
* @version
|
|
7814
|
+
* @version 207.0.0
|
|
7742
7815
|
*//**
|
|
7743
7816
|
* Constructs a new InfrastructureAsCodeApi.
|
|
7744
7817
|
* @alias module:purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
@@ -7792,7 +7865,7 @@ if(jobId===undefined||jobId===null){throw'Missing the required parameter "jobId"
|
|
|
7792
7865
|
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']);}}]);}();var IntegrationsApi=/*#__PURE__*/function(){/**
|
|
7793
7866
|
* Integrations service.
|
|
7794
7867
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
7795
|
-
* @version
|
|
7868
|
+
* @version 207.0.0
|
|
7796
7869
|
*//**
|
|
7797
7870
|
* Constructs a new IntegrationsApi.
|
|
7798
7871
|
* @alias module:purecloud-platform-client-v2/api/IntegrationsApi
|
|
@@ -8417,7 +8490,7 @@ if(ucIntegrationId===undefined||ucIntegrationId===null){throw'Missing the requir
|
|
|
8417
8490
|
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']);}}]);}();var JourneyApi=/*#__PURE__*/function(){/**
|
|
8418
8491
|
* Journey service.
|
|
8419
8492
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
8420
|
-
* @version
|
|
8493
|
+
* @version 207.0.0
|
|
8421
8494
|
*//**
|
|
8422
8495
|
* Constructs a new JourneyApi.
|
|
8423
8496
|
* @alias module:purecloud-platform-client-v2/api/JourneyApi
|
|
@@ -8629,6 +8702,26 @@ if(viewId===undefined||viewId===null){throw'Missing the required parameter "view
|
|
|
8629
8702
|
*/},{key:"getJourneyViewVersion",value:function getJourneyViewVersion(viewId,versionId){// verify the required parameter 'viewId' is set
|
|
8630
8703
|
if(viewId===undefined||viewId===null){throw'Missing the required parameter "viewId" when calling getJourneyViewVersion';}// verify the required parameter 'versionId' is set
|
|
8631
8704
|
if(versionId===undefined||versionId===null){throw'Missing the required parameter "versionId" when calling getJourneyViewVersion';}return this.apiClient.callApi('/api/v2/journey/views/{viewId}/versions/{versionId}','GET',{'viewId':viewId,'versionId':versionId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
8705
|
+
* Get a Chart by ID
|
|
8706
|
+
* returns the latest version
|
|
8707
|
+
* @param {String} viewId viewId
|
|
8708
|
+
* @param {String} journeyViewVersion Journey View Version
|
|
8709
|
+
* @param {String} chartId chartId
|
|
8710
|
+
*/},{key:"getJourneyViewVersionChart",value:function getJourneyViewVersionChart(viewId,journeyViewVersion,chartId){// verify the required parameter 'viewId' is set
|
|
8711
|
+
if(viewId===undefined||viewId===null){throw'Missing the required parameter "viewId" when calling getJourneyViewVersionChart';}// verify the required parameter 'journeyViewVersion' is set
|
|
8712
|
+
if(journeyViewVersion===undefined||journeyViewVersion===null){throw'Missing the required parameter "journeyViewVersion" when calling getJourneyViewVersionChart';}// verify the required parameter 'chartId' is set
|
|
8713
|
+
if(chartId===undefined||chartId===null){throw'Missing the required parameter "chartId" when calling getJourneyViewVersionChart';}return this.apiClient.callApi('/api/v2/journey/views/{viewId}/versions/{journeyViewVersion}/charts/{chartId}','GET',{'viewId':viewId,'journeyViewVersion':journeyViewVersion,'chartId':chartId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
8714
|
+
* Get a Chart by ID and version
|
|
8715
|
+
*
|
|
8716
|
+
* @param {String} viewId viewId
|
|
8717
|
+
* @param {String} journeyViewVersion Journey View Version
|
|
8718
|
+
* @param {String} chartId chartId
|
|
8719
|
+
* @param {String} chartVersion chartVersion
|
|
8720
|
+
*/},{key:"getJourneyViewVersionChartVersion",value:function getJourneyViewVersionChartVersion(viewId,journeyViewVersion,chartId,chartVersion){// verify the required parameter 'viewId' is set
|
|
8721
|
+
if(viewId===undefined||viewId===null){throw'Missing the required parameter "viewId" when calling getJourneyViewVersionChartVersion';}// verify the required parameter 'journeyViewVersion' is set
|
|
8722
|
+
if(journeyViewVersion===undefined||journeyViewVersion===null){throw'Missing the required parameter "journeyViewVersion" when calling getJourneyViewVersionChartVersion';}// verify the required parameter 'chartId' is set
|
|
8723
|
+
if(chartId===undefined||chartId===null){throw'Missing the required parameter "chartId" when calling getJourneyViewVersionChartVersion';}// verify the required parameter 'chartVersion' is set
|
|
8724
|
+
if(chartVersion===undefined||chartVersion===null){throw'Missing the required parameter "chartVersion" when calling getJourneyViewVersionChartVersion';}return this.apiClient.callApi('/api/v2/journey/views/{viewId}/versions/{journeyViewVersion}/charts/{chartId}/versions/{chartVersion}','GET',{'viewId':viewId,'journeyViewVersion':journeyViewVersion,'chartId':chartId,'chartVersion':chartVersion},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
8632
8725
|
* Get the job for a journey view version.
|
|
8633
8726
|
* used for long descriptions
|
|
8634
8727
|
* @param {String} viewId Journey View Id
|
|
@@ -8647,6 +8740,17 @@ if(jobId===undefined||jobId===null){throw'Missing the required parameter "jobId"
|
|
|
8647
8740
|
if(viewId===undefined||viewId===null){throw'Missing the required parameter "viewId" when calling getJourneyViewVersionJobResults';}// verify the required parameter 'journeyViewVersion' is set
|
|
8648
8741
|
if(journeyViewVersion===undefined||journeyViewVersion===null){throw'Missing the required parameter "journeyViewVersion" when calling getJourneyViewVersionJobResults';}// verify the required parameter 'jobId' is set
|
|
8649
8742
|
if(jobId===undefined||jobId===null){throw'Missing the required parameter "jobId" when calling getJourneyViewVersionJobResults';}return this.apiClient.callApi('/api/v2/journey/views/{viewId}/versions/{journeyViewVersion}/jobs/{jobId}/results','GET',{'viewId':viewId,'journeyViewVersion':journeyViewVersion,'jobId':jobId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
8743
|
+
* Get the chart result associated with a journey view job.
|
|
8744
|
+
*
|
|
8745
|
+
* @param {String} viewId Journey View Id
|
|
8746
|
+
* @param {String} journeyVersionId Journey View Version
|
|
8747
|
+
* @param {String} jobId JobId
|
|
8748
|
+
* @param {String} chartId ChartId
|
|
8749
|
+
*/},{key:"getJourneyViewVersionJobResultsChart",value:function getJourneyViewVersionJobResultsChart(viewId,journeyVersionId,jobId,chartId){// verify the required parameter 'viewId' is set
|
|
8750
|
+
if(viewId===undefined||viewId===null){throw'Missing the required parameter "viewId" when calling getJourneyViewVersionJobResultsChart';}// verify the required parameter 'journeyVersionId' is set
|
|
8751
|
+
if(journeyVersionId===undefined||journeyVersionId===null){throw'Missing the required parameter "journeyVersionId" when calling getJourneyViewVersionJobResultsChart';}// verify the required parameter 'jobId' is set
|
|
8752
|
+
if(jobId===undefined||jobId===null){throw'Missing the required parameter "jobId" when calling getJourneyViewVersionJobResultsChart';}// verify the required parameter 'chartId' is set
|
|
8753
|
+
if(chartId===undefined||chartId===null){throw'Missing the required parameter "chartId" when calling getJourneyViewVersionJobResultsChart';}return this.apiClient.callApi('/api/v2/journey/views/{viewId}/versions/{journeyVersionId}/jobs/{jobId}/results/charts/{chartId}','GET',{'viewId':viewId,'journeyVersionId':journeyVersionId,'jobId':jobId,'chartId':chartId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
8650
8754
|
* Get the latest job of a journey view version.
|
|
8651
8755
|
* used for long descriptions
|
|
8652
8756
|
* @param {String} viewId Journey View Id
|
|
@@ -8666,12 +8770,10 @@ if(journeyVersionId===undefined||journeyVersionId===null){throw'Missing the requ
|
|
|
8666
8770
|
* Get an Event Definition
|
|
8667
8771
|
*
|
|
8668
8772
|
* @param {String} eventDefinitionId Event Definition ID
|
|
8669
|
-
* getJourneyViewsEventdefinition is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
8670
8773
|
*/},{key:"getJourneyViewsEventdefinition",value:function getJourneyViewsEventdefinition(eventDefinitionId){// verify the required parameter 'eventDefinitionId' is set
|
|
8671
8774
|
if(eventDefinitionId===undefined||eventDefinitionId===null){throw'Missing the required parameter "eventDefinitionId" when calling getJourneyViewsEventdefinition';}return this.apiClient.callApi('/api/v2/journey/views/eventdefinitions/{eventDefinitionId}','GET',{'eventDefinitionId':eventDefinitionId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
8672
8775
|
* Get a list of Event Definitions
|
|
8673
8776
|
*
|
|
8674
|
-
* getJourneyViewsEventdefinitions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
8675
8777
|
*/},{key:"getJourneyViewsEventdefinitions",value:function getJourneyViewsEventdefinitions(){return this.apiClient.callApi('/api/v2/journey/views/eventdefinitions','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
8676
8778
|
* Get the jobs for an organization.
|
|
8677
8779
|
*
|
|
@@ -8716,6 +8818,17 @@ if(outcomeId===undefined||outcomeId===null){throw'Missing the required parameter
|
|
|
8716
8818
|
* @param {Object} opts.body
|
|
8717
8819
|
*/},{key:"patchJourneySegment",value:function patchJourneySegment(segmentId,opts){opts=opts||{};// verify the required parameter 'segmentId' is set
|
|
8718
8820
|
if(segmentId===undefined||segmentId===null){throw'Missing the required parameter "segmentId" when calling patchJourneySegment';}return this.apiClient.callApi('/api/v2/journey/segments/{segmentId}','PATCH',{'segmentId':segmentId},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
8821
|
+
* Update the job for a journey view version. Only the status can be changed and only to Cancelled
|
|
8822
|
+
* used for long descriptions
|
|
8823
|
+
* @param {String} viewId Journey View Id
|
|
8824
|
+
* @param {String} journeyVersionId Journey View Version
|
|
8825
|
+
* @param {String} jobId JobId
|
|
8826
|
+
* @param {Object} body journeyViewJob
|
|
8827
|
+
*/},{key:"patchJourneyViewVersionJob",value:function patchJourneyViewVersionJob(viewId,journeyVersionId,jobId,body){// verify the required parameter 'viewId' is set
|
|
8828
|
+
if(viewId===undefined||viewId===null){throw'Missing the required parameter "viewId" when calling patchJourneyViewVersionJob';}// verify the required parameter 'journeyVersionId' is set
|
|
8829
|
+
if(journeyVersionId===undefined||journeyVersionId===null){throw'Missing the required parameter "journeyVersionId" when calling patchJourneyViewVersionJob';}// verify the required parameter 'jobId' is set
|
|
8830
|
+
if(jobId===undefined||jobId===null){throw'Missing the required parameter "jobId" when calling patchJourneyViewVersionJob';}// verify the required parameter 'body' is set
|
|
8831
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling patchJourneyViewVersionJob';}return this.apiClient.callApi('/api/v2/journey/views/{viewId}/versions/{journeyVersionId}/jobs/{jobId}','PATCH',{'viewId':viewId,'journeyVersionId':journeyVersionId,'jobId':jobId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
8719
8832
|
* Query for journey aggregates asynchronously
|
|
8720
8833
|
*
|
|
8721
8834
|
* @param {Object} body query
|
|
@@ -8812,11 +8925,19 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
8812
8925
|
* True indicates a valid encoding
|
|
8813
8926
|
* @param {Object} opts Optional parameters
|
|
8814
8927
|
* @param {Array.<Object>} opts.body
|
|
8815
|
-
|
|
8816
|
-
|
|
8928
|
+
*/},{key:"postJourneyViewsEncodingsValidate",value:function postJourneyViewsEncodingsValidate(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/journey/views/encodings/validate','POST',{},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
8929
|
+
* Update a Journey View by ID and version
|
|
8930
|
+
* does not create a new version
|
|
8931
|
+
* @param {String} viewId viewId
|
|
8932
|
+
* @param {String} versionId versionId
|
|
8933
|
+
* @param {Object} body JourneyView
|
|
8934
|
+
*/},{key:"putJourneyViewVersion",value:function putJourneyViewVersion(viewId,versionId,body){// verify the required parameter 'viewId' is set
|
|
8935
|
+
if(viewId===undefined||viewId===null){throw'Missing the required parameter "viewId" when calling putJourneyViewVersion';}// verify the required parameter 'versionId' is set
|
|
8936
|
+
if(versionId===undefined||versionId===null){throw'Missing the required parameter "versionId" when calling putJourneyViewVersion';}// verify the required parameter 'body' is set
|
|
8937
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putJourneyViewVersion';}return this.apiClient.callApi('/api/v2/journey/views/{viewId}/versions/{versionId}','PUT',{'viewId':viewId,'versionId':versionId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var KnowledgeApi=/*#__PURE__*/function(){/**
|
|
8817
8938
|
* Knowledge service.
|
|
8818
8939
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
8819
|
-
* @version
|
|
8940
|
+
* @version 207.0.0
|
|
8820
8941
|
*//**
|
|
8821
8942
|
* Constructs a new KnowledgeApi.
|
|
8822
8943
|
* @alias module:purecloud-platform-client-v2/api/KnowledgeApi
|
|
@@ -8907,7 +9028,6 @@ if(importId===undefined||importId===null){throw'Missing the required parameter "
|
|
|
8907
9028
|
*
|
|
8908
9029
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
8909
9030
|
* @param {String} sourceId Source ID
|
|
8910
|
-
* deleteKnowledgeKnowledgebaseSourcesSalesforceSourceId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
8911
9031
|
*/},{key:"deleteKnowledgeKnowledgebaseSourcesSalesforceSourceId",value:function deleteKnowledgeKnowledgebaseSourcesSalesforceSourceId(knowledgeBaseId,sourceId){// verify the required parameter 'knowledgeBaseId' is set
|
|
8912
9032
|
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling deleteKnowledgeKnowledgebaseSourcesSalesforceSourceId';}// verify the required parameter 'sourceId' is set
|
|
8913
9033
|
if(sourceId===undefined||sourceId===null){throw'Missing the required parameter "sourceId" when calling deleteKnowledgeKnowledgebaseSourcesSalesforceSourceId';}return this.apiClient.callApi('/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/sources/salesforce/{sourceId}','DELETE',{'knowledgeBaseId':knowledgeBaseId,'sourceId':sourceId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
@@ -8915,7 +9035,6 @@ if(sourceId===undefined||sourceId===null){throw'Missing the required parameter "
|
|
|
8915
9035
|
*
|
|
8916
9036
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
8917
9037
|
* @param {String} sourceId Source ID
|
|
8918
|
-
* deleteKnowledgeKnowledgebaseSourcesServicenowSourceId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
8919
9038
|
*/},{key:"deleteKnowledgeKnowledgebaseSourcesServicenowSourceId",value:function deleteKnowledgeKnowledgebaseSourcesServicenowSourceId(knowledgeBaseId,sourceId){// verify the required parameter 'knowledgeBaseId' is set
|
|
8920
9039
|
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling deleteKnowledgeKnowledgebaseSourcesServicenowSourceId';}// verify the required parameter 'sourceId' is set
|
|
8921
9040
|
if(sourceId===undefined||sourceId===null){throw'Missing the required parameter "sourceId" when calling deleteKnowledgeKnowledgebaseSourcesServicenowSourceId';}return this.apiClient.callApi('/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/sources/servicenow/{sourceId}','DELETE',{'knowledgeBaseId':knowledgeBaseId,'sourceId':sourceId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
@@ -8923,7 +9042,6 @@ if(sourceId===undefined||sourceId===null){throw'Missing the required parameter "
|
|
|
8923
9042
|
*
|
|
8924
9043
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
8925
9044
|
* @param {String} syncJobId Synchronization job ID
|
|
8926
|
-
* deleteKnowledgeKnowledgebaseSynchronizeJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
8927
9045
|
*/},{key:"deleteKnowledgeKnowledgebaseSynchronizeJob",value:function deleteKnowledgeKnowledgebaseSynchronizeJob(knowledgeBaseId,syncJobId){// verify the required parameter 'knowledgeBaseId' is set
|
|
8928
9046
|
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling deleteKnowledgeKnowledgebaseSynchronizeJob';}// verify the required parameter 'syncJobId' is set
|
|
8929
9047
|
if(syncJobId===undefined||syncJobId===null){throw'Missing the required parameter "syncJobId" when calling deleteKnowledgeKnowledgebaseSynchronizeJob';}return this.apiClient.callApi('/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/synchronize/jobs/{syncJobId}','DELETE',{'knowledgeBaseId':knowledgeBaseId,'syncJobId':syncJobId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
@@ -8960,7 +9078,6 @@ if(sessionId===undefined||sessionId===null){throw'Missing the required parameter
|
|
|
8960
9078
|
* Get sync options available for a knowledge-connect integration
|
|
8961
9079
|
*
|
|
8962
9080
|
* @param {String} integrationId Integration ID
|
|
8963
|
-
* getKnowledgeIntegrationOptions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
8964
9081
|
*/},{key:"getKnowledgeIntegrationOptions",value:function getKnowledgeIntegrationOptions(integrationId){// verify the required parameter 'integrationId' is set
|
|
8965
9082
|
if(integrationId===undefined||integrationId===null){throw'Missing the required parameter "integrationId" when calling getKnowledgeIntegrationOptions';}return this.apiClient.callApi('/api/v2/knowledge/integrations/{integrationId}/options','GET',{'integrationId':integrationId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
8966
9083
|
* Get knowledge base
|
|
@@ -9260,13 +9377,11 @@ if(languageCode===undefined||languageCode===null){throw'Missing the required par
|
|
|
9260
9377
|
* @param {Array.<String>} opts.status If specified, retrieves operations with specified operation status, comma separated values expected.
|
|
9261
9378
|
* @param {String} opts.interval Retrieves the operations modified in specified date and time range. If the after and before cursor parameters are within this interval, it would return valid data, otherwise it throws an error.The dates in the interval are represented in ISO-8601 format: YYYY-MM-DDThh:mm:ssZ/YYYY-MM-DDThh:mm:ssZ
|
|
9262
9379
|
* @param {Array.<String>} opts.sourceId If specified, retrieves operations associated with source ids, comma separated values expected.
|
|
9263
|
-
* getKnowledgeKnowledgebaseOperations is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
9264
9380
|
*/},{key:"getKnowledgeKnowledgebaseOperations",value:function getKnowledgeKnowledgebaseOperations(knowledgeBaseId,opts){opts=opts||{};// verify the required parameter 'knowledgeBaseId' is set
|
|
9265
9381
|
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseOperations';}return this.apiClient.callApi('/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/operations','GET',{'knowledgeBaseId':knowledgeBaseId},{'before':opts['before'],'after':opts['after'],'pageSize':opts['pageSize'],'userId':this.apiClient.buildCollectionParam(opts['userId'],'multi'),'type':this.apiClient.buildCollectionParam(opts['type'],'multi'),'status':this.apiClient.buildCollectionParam(opts['status'],'multi'),'interval':opts['interval'],'sourceId':this.apiClient.buildCollectionParam(opts['sourceId'],'multi')},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
9266
9382
|
* Get ids of operation creator users and oauth clients
|
|
9267
9383
|
*
|
|
9268
9384
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
9269
|
-
* getKnowledgeKnowledgebaseOperationsUsersQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
9270
9385
|
*/},{key:"getKnowledgeKnowledgebaseOperationsUsersQuery",value:function getKnowledgeKnowledgebaseOperationsUsersQuery(knowledgeBaseId){// verify the required parameter 'knowledgeBaseId' is set
|
|
9271
9386
|
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseOperationsUsersQuery';}return this.apiClient.callApi('/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/operations/users/query','GET',{'knowledgeBaseId':knowledgeBaseId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
9272
9387
|
* Get parse job report
|
|
@@ -9286,7 +9401,6 @@ if(parseJobId===undefined||parseJobId===null){throw'Missing the required paramet
|
|
|
9286
9401
|
* @param {Object} opts.type If specified, retrieves integration sources with specified integration type.
|
|
9287
9402
|
* @param {Array.<String>} opts.expand The specified entity attributes will be filled. Comma separated values expected.
|
|
9288
9403
|
* @param {Array.<String>} opts.ids If specified, retrieves integration sources with specified IDs.
|
|
9289
|
-
* getKnowledgeKnowledgebaseSources is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
9290
9404
|
*/},{key:"getKnowledgeKnowledgebaseSources",value:function getKnowledgeKnowledgebaseSources(knowledgeBaseId,opts){opts=opts||{};// verify the required parameter 'knowledgeBaseId' is set
|
|
9291
9405
|
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseSources';}return this.apiClient.callApi('/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/sources','GET',{'knowledgeBaseId':knowledgeBaseId},{'type':opts['type'],'expand':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'ids':this.apiClient.buildCollectionParam(opts['ids'],'multi')},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
9292
9406
|
* Get Salesforce Knowledge integration source
|
|
@@ -9295,7 +9409,6 @@ if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the requir
|
|
|
9295
9409
|
* @param {String} sourceId Source ID
|
|
9296
9410
|
* @param {Object} opts Optional parameters
|
|
9297
9411
|
* @param {Array.<String>} opts.expand The specified entity attributes will be filled. Comma separated values expected.
|
|
9298
|
-
* getKnowledgeKnowledgebaseSourcesSalesforceSourceId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
9299
9412
|
*/},{key:"getKnowledgeKnowledgebaseSourcesSalesforceSourceId",value:function getKnowledgeKnowledgebaseSourcesSalesforceSourceId(knowledgeBaseId,sourceId,opts){opts=opts||{};// verify the required parameter 'knowledgeBaseId' is set
|
|
9300
9413
|
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseSourcesSalesforceSourceId';}// verify the required parameter 'sourceId' is set
|
|
9301
9414
|
if(sourceId===undefined||sourceId===null){throw'Missing the required parameter "sourceId" when calling getKnowledgeKnowledgebaseSourcesSalesforceSourceId';}return this.apiClient.callApi('/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/sources/salesforce/{sourceId}','GET',{'knowledgeBaseId':knowledgeBaseId,'sourceId':sourceId},{'expand':this.apiClient.buildCollectionParam(opts['expand'],'multi')},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
@@ -9305,7 +9418,6 @@ if(sourceId===undefined||sourceId===null){throw'Missing the required parameter "
|
|
|
9305
9418
|
* @param {String} sourceId Source ID
|
|
9306
9419
|
* @param {Object} opts Optional parameters
|
|
9307
9420
|
* @param {Array.<String>} opts.expand The specified entity attributes will be filled. Comma separated values expected.
|
|
9308
|
-
* getKnowledgeKnowledgebaseSourcesServicenowSourceId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
9309
9421
|
*/},{key:"getKnowledgeKnowledgebaseSourcesServicenowSourceId",value:function getKnowledgeKnowledgebaseSourcesServicenowSourceId(knowledgeBaseId,sourceId,opts){opts=opts||{};// verify the required parameter 'knowledgeBaseId' is set
|
|
9310
9422
|
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseSourcesServicenowSourceId';}// verify the required parameter 'sourceId' is set
|
|
9311
9423
|
if(sourceId===undefined||sourceId===null){throw'Missing the required parameter "sourceId" when calling getKnowledgeKnowledgebaseSourcesServicenowSourceId';}return this.apiClient.callApi('/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/sources/servicenow/{sourceId}','GET',{'knowledgeBaseId':knowledgeBaseId,'sourceId':sourceId},{'expand':this.apiClient.buildCollectionParam(opts['expand'],'multi')},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
@@ -9313,7 +9425,6 @@ if(sourceId===undefined||sourceId===null){throw'Missing the required parameter "
|
|
|
9313
9425
|
*
|
|
9314
9426
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
9315
9427
|
* @param {String} syncJobId Synchronization job ID
|
|
9316
|
-
* getKnowledgeKnowledgebaseSynchronizeJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
9317
9428
|
*/},{key:"getKnowledgeKnowledgebaseSynchronizeJob",value:function getKnowledgeKnowledgebaseSynchronizeJob(knowledgeBaseId,syncJobId){// verify the required parameter 'knowledgeBaseId' is set
|
|
9318
9429
|
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseSynchronizeJob';}// verify the required parameter 'syncJobId' is set
|
|
9319
9430
|
if(syncJobId===undefined||syncJobId===null){throw'Missing the required parameter "syncJobId" when calling getKnowledgeKnowledgebaseSynchronizeJob';}return this.apiClient.callApi('/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/synchronize/jobs/{syncJobId}','GET',{'knowledgeBaseId':knowledgeBaseId,'syncJobId':syncJobId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
@@ -9515,7 +9626,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
9515
9626
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
9516
9627
|
* @param {String} syncJobId Synchronization job ID
|
|
9517
9628
|
* @param {Object} body
|
|
9518
|
-
* patchKnowledgeKnowledgebaseSynchronizeJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
9519
9629
|
*/},{key:"patchKnowledgeKnowledgebaseSynchronizeJob",value:function patchKnowledgeKnowledgebaseSynchronizeJob(knowledgeBaseId,syncJobId,body){// verify the required parameter 'knowledgeBaseId' is set
|
|
9520
9630
|
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling patchKnowledgeKnowledgebaseSynchronizeJob';}// verify the required parameter 'syncJobId' is set
|
|
9521
9631
|
if(syncJobId===undefined||syncJobId===null){throw'Missing the required parameter "syncJobId" when calling patchKnowledgeKnowledgebaseSynchronizeJob';}// verify the required parameter 'body' is set
|
|
@@ -9829,7 +9939,6 @@ if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the requir
|
|
|
9829
9939
|
*
|
|
9830
9940
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
9831
9941
|
* @param {Object} body
|
|
9832
|
-
* postKnowledgeKnowledgebaseSourcesSalesforce is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
9833
9942
|
*/},{key:"postKnowledgeKnowledgebaseSourcesSalesforce",value:function postKnowledgeKnowledgebaseSourcesSalesforce(knowledgeBaseId,body){// verify the required parameter 'knowledgeBaseId' is set
|
|
9834
9943
|
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseSourcesSalesforce';}// verify the required parameter 'body' is set
|
|
9835
9944
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postKnowledgeKnowledgebaseSourcesSalesforce';}return this.apiClient.callApi('/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/sources/salesforce','POST',{'knowledgeBaseId':knowledgeBaseId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
@@ -9837,7 +9946,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
9837
9946
|
*
|
|
9838
9947
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
9839
9948
|
* @param {String} sourceId Source ID
|
|
9840
|
-
* postKnowledgeKnowledgebaseSourcesSalesforceSourceIdSync is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
9841
9949
|
*/},{key:"postKnowledgeKnowledgebaseSourcesSalesforceSourceIdSync",value:function postKnowledgeKnowledgebaseSourcesSalesforceSourceIdSync(knowledgeBaseId,sourceId){// verify the required parameter 'knowledgeBaseId' is set
|
|
9842
9950
|
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseSourcesSalesforceSourceIdSync';}// verify the required parameter 'sourceId' is set
|
|
9843
9951
|
if(sourceId===undefined||sourceId===null){throw'Missing the required parameter "sourceId" when calling postKnowledgeKnowledgebaseSourcesSalesforceSourceIdSync';}return this.apiClient.callApi('/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/sources/salesforce/{sourceId}/sync','POST',{'knowledgeBaseId':knowledgeBaseId,'sourceId':sourceId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
@@ -9845,7 +9953,6 @@ if(sourceId===undefined||sourceId===null){throw'Missing the required parameter "
|
|
|
9845
9953
|
*
|
|
9846
9954
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
9847
9955
|
* @param {Object} body
|
|
9848
|
-
* postKnowledgeKnowledgebaseSourcesServicenow is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
9849
9956
|
*/},{key:"postKnowledgeKnowledgebaseSourcesServicenow",value:function postKnowledgeKnowledgebaseSourcesServicenow(knowledgeBaseId,body){// verify the required parameter 'knowledgeBaseId' is set
|
|
9850
9957
|
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseSourcesServicenow';}// verify the required parameter 'body' is set
|
|
9851
9958
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postKnowledgeKnowledgebaseSourcesServicenow';}return this.apiClient.callApi('/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/sources/servicenow','POST',{'knowledgeBaseId':knowledgeBaseId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
@@ -9853,7 +9960,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
9853
9960
|
*
|
|
9854
9961
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
9855
9962
|
* @param {String} sourceId Source ID
|
|
9856
|
-
* postKnowledgeKnowledgebaseSourcesServicenowSourceIdSync is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
9857
9963
|
*/},{key:"postKnowledgeKnowledgebaseSourcesServicenowSourceIdSync",value:function postKnowledgeKnowledgebaseSourcesServicenowSourceIdSync(knowledgeBaseId,sourceId){// verify the required parameter 'knowledgeBaseId' is set
|
|
9858
9964
|
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseSourcesServicenowSourceIdSync';}// verify the required parameter 'sourceId' is set
|
|
9859
9965
|
if(sourceId===undefined||sourceId===null){throw'Missing the required parameter "sourceId" when calling postKnowledgeKnowledgebaseSourcesServicenowSourceIdSync';}return this.apiClient.callApi('/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/sources/servicenow/{sourceId}/sync','POST',{'knowledgeBaseId':knowledgeBaseId,'sourceId':sourceId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
@@ -9861,7 +9967,6 @@ if(sourceId===undefined||sourceId===null){throw'Missing the required parameter "
|
|
|
9861
9967
|
*
|
|
9862
9968
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
9863
9969
|
* @param {Object} body
|
|
9864
|
-
* postKnowledgeKnowledgebaseSynchronizeJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
9865
9970
|
*/},{key:"postKnowledgeKnowledgebaseSynchronizeJobs",value:function postKnowledgeKnowledgebaseSynchronizeJobs(knowledgeBaseId,body){// verify the required parameter 'knowledgeBaseId' is set
|
|
9866
9971
|
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseSynchronizeJobs';}// verify the required parameter 'body' is set
|
|
9867
9972
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postKnowledgeKnowledgebaseSynchronizeJobs';}return this.apiClient.callApi('/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/synchronize/jobs','POST',{'knowledgeBaseId':knowledgeBaseId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
@@ -9883,7 +9988,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
9883
9988
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
9884
9989
|
* @param {String} sourceId Source ID
|
|
9885
9990
|
* @param {Object} body
|
|
9886
|
-
* putKnowledgeKnowledgebaseSourcesSalesforceSourceId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
9887
9991
|
*/},{key:"putKnowledgeKnowledgebaseSourcesSalesforceSourceId",value:function putKnowledgeKnowledgebaseSourcesSalesforceSourceId(knowledgeBaseId,sourceId,body){// verify the required parameter 'knowledgeBaseId' is set
|
|
9888
9992
|
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling putKnowledgeKnowledgebaseSourcesSalesforceSourceId';}// verify the required parameter 'sourceId' is set
|
|
9889
9993
|
if(sourceId===undefined||sourceId===null){throw'Missing the required parameter "sourceId" when calling putKnowledgeKnowledgebaseSourcesSalesforceSourceId';}// verify the required parameter 'body' is set
|
|
@@ -9893,14 +9997,13 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
9893
9997
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
9894
9998
|
* @param {String} sourceId Source ID
|
|
9895
9999
|
* @param {Object} body
|
|
9896
|
-
* putKnowledgeKnowledgebaseSourcesServicenowSourceId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
9897
10000
|
*/},{key:"putKnowledgeKnowledgebaseSourcesServicenowSourceId",value:function putKnowledgeKnowledgebaseSourcesServicenowSourceId(knowledgeBaseId,sourceId,body){// verify the required parameter 'knowledgeBaseId' is set
|
|
9898
10001
|
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling putKnowledgeKnowledgebaseSourcesServicenowSourceId';}// verify the required parameter 'sourceId' is set
|
|
9899
10002
|
if(sourceId===undefined||sourceId===null){throw'Missing the required parameter "sourceId" when calling putKnowledgeKnowledgebaseSourcesServicenowSourceId';}// verify the required parameter 'body' is set
|
|
9900
10003
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putKnowledgeKnowledgebaseSourcesServicenowSourceId';}return this.apiClient.callApi('/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/sources/servicenow/{sourceId}','PUT',{'knowledgeBaseId':knowledgeBaseId,'sourceId':sourceId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var LanguageUnderstandingApi=/*#__PURE__*/function(){/**
|
|
9901
10004
|
* LanguageUnderstanding service.
|
|
9902
10005
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
9903
|
-
* @version
|
|
10006
|
+
* @version 207.0.0
|
|
9904
10007
|
*//**
|
|
9905
10008
|
* Constructs a new LanguageUnderstandingApi.
|
|
9906
10009
|
* @alias module:purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
@@ -10160,7 +10263,7 @@ if(domainVersionId===undefined||domainVersionId===null){throw'Missing the requir
|
|
|
10160
10263
|
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']);}}]);}();var LanguagesApi=/*#__PURE__*/function(){/**
|
|
10161
10264
|
* Languages service.
|
|
10162
10265
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
10163
|
-
* @version
|
|
10266
|
+
* @version 207.0.0
|
|
10164
10267
|
*//**
|
|
10165
10268
|
* Constructs a new LanguagesApi.
|
|
10166
10269
|
* @alias module:purecloud-platform-client-v2/api/LanguagesApi
|
|
@@ -10215,7 +10318,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
10215
10318
|
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']);}}]);}();var LearningApi=/*#__PURE__*/function(){/**
|
|
10216
10319
|
* Learning service.
|
|
10217
10320
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
10218
|
-
* @version
|
|
10321
|
+
* @version 207.0.0
|
|
10219
10322
|
*//**
|
|
10220
10323
|
* Constructs a new LearningApi.
|
|
10221
10324
|
* @alias module:purecloud-platform-client-v2/api/LearningApi
|
|
@@ -10486,7 +10589,7 @@ if(moduleId===undefined||moduleId===null){throw'Missing the required parameter "
|
|
|
10486
10589
|
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']);}}]);}();var LicenseApi=/*#__PURE__*/function(){/**
|
|
10487
10590
|
* License service.
|
|
10488
10591
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
10489
|
-
* @version
|
|
10592
|
+
* @version 207.0.0
|
|
10490
10593
|
*//**
|
|
10491
10594
|
* Constructs a new LicenseApi.
|
|
10492
10595
|
* @alias module:purecloud-platform-client-v2/api/LicenseApi
|
|
@@ -10540,7 +10643,7 @@ if(featureName===undefined||featureName===null){throw'Missing the required param
|
|
|
10540
10643
|
*/},{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']);}}]);}();var LocationsApi=/*#__PURE__*/function(){/**
|
|
10541
10644
|
* Locations service.
|
|
10542
10645
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
10543
|
-
* @version
|
|
10646
|
+
* @version 207.0.0
|
|
10544
10647
|
*//**
|
|
10545
10648
|
* Constructs a new LocationsApi.
|
|
10546
10649
|
* @alias module:purecloud-platform-client-v2/api/LocationsApi
|
|
@@ -10599,7 +10702,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
10599
10702
|
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']);}}]);}();var LogCaptureApi=/*#__PURE__*/function(){/**
|
|
10600
10703
|
* LogCapture service.
|
|
10601
10704
|
* @module purecloud-platform-client-v2/api/LogCaptureApi
|
|
10602
|
-
* @version
|
|
10705
|
+
* @version 207.0.0
|
|
10603
10706
|
*//**
|
|
10604
10707
|
* Constructs a new LogCaptureApi.
|
|
10605
10708
|
* @alias module:purecloud-platform-client-v2/api/LogCaptureApi
|
|
@@ -10649,7 +10752,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
10649
10752
|
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']);}}]);}();var MessagingApi=/*#__PURE__*/function(){/**
|
|
10650
10753
|
* Messaging service.
|
|
10651
10754
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
10652
|
-
* @version
|
|
10755
|
+
* @version 207.0.0
|
|
10653
10756
|
*//**
|
|
10654
10757
|
* Constructs a new MessagingApi.
|
|
10655
10758
|
* @alias module:purecloud-platform-client-v2/api/MessagingApi
|
|
@@ -10739,7 +10842,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
10739
10842
|
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']);}}]);}();var MobileDevicesApi=/*#__PURE__*/function(){/**
|
|
10740
10843
|
* MobileDevices service.
|
|
10741
10844
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
10742
|
-
* @version
|
|
10845
|
+
* @version 207.0.0
|
|
10743
10846
|
*//**
|
|
10744
10847
|
* Constructs a new MobileDevicesApi.
|
|
10745
10848
|
* @alias module:purecloud-platform-client-v2/api/MobileDevicesApi
|
|
@@ -10778,7 +10881,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
10778
10881
|
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']);}}]);}();var NotificationsApi=/*#__PURE__*/function(){/**
|
|
10779
10882
|
* Notifications service.
|
|
10780
10883
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
10781
|
-
* @version
|
|
10884
|
+
* @version 207.0.0
|
|
10782
10885
|
*//**
|
|
10783
10886
|
* Constructs a new NotificationsApi.
|
|
10784
10887
|
* @alias module:purecloud-platform-client-v2/api/NotificationsApi
|
|
@@ -10835,7 +10938,7 @@ if(channelId===undefined||channelId===null){throw'Missing the required parameter
|
|
|
10835
10938
|
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']);}}]);}();var OAuthApi=/*#__PURE__*/function(){/**
|
|
10836
10939
|
* OAuth service.
|
|
10837
10940
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
10838
|
-
* @version
|
|
10941
|
+
* @version 207.0.0
|
|
10839
10942
|
*//**
|
|
10840
10943
|
* Constructs a new OAuthApi.
|
|
10841
10944
|
* @alias module:purecloud-platform-client-v2/api/OAuthApi
|
|
@@ -10920,7 +11023,7 @@ if(clientId===undefined||clientId===null){throw'Missing the required parameter "
|
|
|
10920
11023
|
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']);}}]);}();var ObjectsApi=/*#__PURE__*/function(){/**
|
|
10921
11024
|
* Objects service.
|
|
10922
11025
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
10923
|
-
* @version
|
|
11026
|
+
* @version 207.0.0
|
|
10924
11027
|
*//**
|
|
10925
11028
|
* Constructs a new ObjectsApi.
|
|
10926
11029
|
* @alias module:purecloud-platform-client-v2/api/ObjectsApi
|
|
@@ -10991,7 +11094,7 @@ if(divisionId===undefined||divisionId===null){throw'Missing the required paramet
|
|
|
10991
11094
|
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']);}}]);}();var OperationalEventsApi=/*#__PURE__*/function(){/**
|
|
10992
11095
|
* OperationalEvents service.
|
|
10993
11096
|
* @module purecloud-platform-client-v2/api/OperationalEventsApi
|
|
10994
|
-
* @version
|
|
11097
|
+
* @version 207.0.0
|
|
10995
11098
|
*//**
|
|
10996
11099
|
* Constructs a new OperationalEventsApi.
|
|
10997
11100
|
* @alias module:purecloud-platform-client-v2/api/OperationalEventsApi
|
|
@@ -11009,7 +11112,7 @@ if(eventDefinitionId===undefined||eventDefinitionId===null){throw'Missing the re
|
|
|
11009
11112
|
*/},{key:"getUsageEventsDefinitions",value:function getUsageEventsDefinitions(){return this.apiClient.callApi('/api/v2/usage/events/definitions','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var OrganizationApi=/*#__PURE__*/function(){/**
|
|
11010
11113
|
* Organization service.
|
|
11011
11114
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
11012
|
-
* @version
|
|
11115
|
+
* @version 207.0.0
|
|
11013
11116
|
*//**
|
|
11014
11117
|
* Constructs a new OrganizationApi.
|
|
11015
11118
|
* @alias module:purecloud-platform-client-v2/api/OrganizationApi
|
|
@@ -11134,7 +11237,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
11134
11237
|
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']);}}]);}();var OrganizationAuthorizationApi=/*#__PURE__*/function(){/**
|
|
11135
11238
|
* OrganizationAuthorization service.
|
|
11136
11239
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
11137
|
-
* @version
|
|
11240
|
+
* @version 207.0.0
|
|
11138
11241
|
*//**
|
|
11139
11242
|
* Constructs a new OrganizationAuthorizationApi.
|
|
11140
11243
|
* @alias module:purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
@@ -11285,6 +11388,9 @@ if(trusteeOrgId===undefined||trusteeOrgId===null){throw'Missing the required par
|
|
|
11285
11388
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
11286
11389
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
11287
11390
|
*/},{key:"getOrgauthorizationTrustees",value:function getOrgauthorizationTrustees(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/orgauthorization/trustees','GET',{},{'pageSize':opts['pageSize'],'pageNumber':opts['pageNumber']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
11391
|
+
* Get Customer Care organization ids.
|
|
11392
|
+
*
|
|
11393
|
+
*/},{key:"getOrgauthorizationTrusteesCare",value:function getOrgauthorizationTrusteesCare(){return this.apiClient.callApi('/api/v2/orgauthorization/trustees/care','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
11288
11394
|
* Get organization authorization trust with Customer Care, if one exists.
|
|
11289
11395
|
*
|
|
11290
11396
|
*/},{key:"getOrgauthorizationTrusteesDefault",value:function getOrgauthorizationTrusteesDefault(){return this.apiClient.callApi('/api/v2/orgauthorization/trustees/default','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
@@ -11375,6 +11481,14 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
11375
11481
|
* @param {String} opts.sortOrder Sort order (default to descending)
|
|
11376
11482
|
*/},{key:"postOrgauthorizationTrusteesAudits",value:function postOrgauthorizationTrusteesAudits(body,opts){opts=opts||{};// verify the required parameter 'body' is set
|
|
11377
11483
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postOrgauthorizationTrusteesAudits';}return this.apiClient.callApi('/api/v2/orgauthorization/trustees/audits','POST',{},{'pageSize':opts['pageSize'],'pageNumber':opts['pageNumber'],'sortBy':opts['sortBy'],'sortOrder':opts['sortOrder']},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
11484
|
+
* Create a new organization authorization trust with Customer Care. This is required to grant your regional Customer Care organization access to your organization.
|
|
11485
|
+
*
|
|
11486
|
+
* @param {Object} opts Optional parameters
|
|
11487
|
+
* @param {Boolean} opts.assignDefaultRole Assign Admin role to default pairing with Customer Care
|
|
11488
|
+
* @param {Boolean} opts.autoExpire Automatically expire pairing after 30 days
|
|
11489
|
+
* @param {Boolean} opts.assignFullAccess Grant Customer Care full access to the organization
|
|
11490
|
+
* @param {Boolean} opts.allowTrustedUserAccess Make Customer Care a Trusted User
|
|
11491
|
+
*/},{key:"postOrgauthorizationTrusteesCare",value:function postOrgauthorizationTrusteesCare(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/orgauthorization/trustees/care','POST',{},{'assignDefaultRole':opts['assignDefaultRole'],'autoExpire':opts['autoExpire'],'assignFullAccess':opts['assignFullAccess'],'allowTrustedUserAccess':opts['allowTrustedUserAccess']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
11378
11492
|
* Create a new organization authorization trust with Customer Care. This is required to grant your regional Customer Care organization access to your organization.
|
|
11379
11493
|
*
|
|
11380
11494
|
* @param {Object} opts Optional parameters
|
|
@@ -11457,7 +11571,7 @@ if(trustorOrgId===undefined||trustorOrgId===null){throw'Missing the required par
|
|
|
11457
11571
|
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']);}}]);}();var OutboundApi=/*#__PURE__*/function(){/**
|
|
11458
11572
|
* Outbound service.
|
|
11459
11573
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
11460
|
-
* @version
|
|
11574
|
+
* @version 207.0.0
|
|
11461
11575
|
*//**
|
|
11462
11576
|
* Constructs a new OutboundApi.
|
|
11463
11577
|
* @alias module:purecloud-platform-client-v2/api/OutboundApi
|
|
@@ -12214,6 +12328,16 @@ if(campaignId===undefined||campaignId===null){throw'Missing the required paramet
|
|
|
12214
12328
|
*/},{key:"postOutboundCampaignCallbackSchedule",value:function postOutboundCampaignCallbackSchedule(campaignId,body){// verify the required parameter 'campaignId' is set
|
|
12215
12329
|
if(campaignId===undefined||campaignId===null){throw'Missing the required parameter "campaignId" when calling postOutboundCampaignCallbackSchedule';}// verify the required parameter 'body' is set
|
|
12216
12330
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postOutboundCampaignCallbackSchedule';}return this.apiClient.callApi('/api/v2/outbound/campaigns/{campaignId}/callback/schedule','POST',{'campaignId':campaignId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
12331
|
+
* Start the campaign
|
|
12332
|
+
*
|
|
12333
|
+
* @param {String} campaignId Campaign ID
|
|
12334
|
+
*/},{key:"postOutboundCampaignStart",value:function postOutboundCampaignStart(campaignId){// verify the required parameter 'campaignId' is set
|
|
12335
|
+
if(campaignId===undefined||campaignId===null){throw'Missing the required parameter "campaignId" when calling postOutboundCampaignStart';}return this.apiClient.callApi('/api/v2/outbound/campaigns/{campaignId}/start','POST',{'campaignId':campaignId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
12336
|
+
* Stop the campaign
|
|
12337
|
+
*
|
|
12338
|
+
* @param {String} campaignId Campaign ID
|
|
12339
|
+
*/},{key:"postOutboundCampaignStop",value:function postOutboundCampaignStop(campaignId){// verify the required parameter 'campaignId' is set
|
|
12340
|
+
if(campaignId===undefined||campaignId===null){throw'Missing the required parameter "campaignId" when calling postOutboundCampaignStop';}return this.apiClient.callApi('/api/v2/outbound/campaigns/{campaignId}/stop','POST',{'campaignId':campaignId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
12217
12341
|
* Create Campaign Rule
|
|
12218
12342
|
*
|
|
12219
12343
|
* @param {Object} body CampaignRule
|
|
@@ -12366,6 +12490,16 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
12366
12490
|
* @param {Array.<Object>} body import template(s) to add
|
|
12367
12491
|
*/},{key:"postOutboundImporttemplatesBulkAdd",value:function postOutboundImporttemplatesBulkAdd(body){// verify the required parameter 'body' is set
|
|
12368
12492
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postOutboundImporttemplatesBulkAdd';}return this.apiClient.callApi('/api/v2/outbound/importtemplates/bulk/add','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
12493
|
+
* Start the campaign
|
|
12494
|
+
* Documented permissions are applicable based on campaign type.
|
|
12495
|
+
* @param {String} messagingCampaignId The Messaging Campaign ID
|
|
12496
|
+
*/},{key:"postOutboundMessagingcampaignStart",value:function postOutboundMessagingcampaignStart(messagingCampaignId){// verify the required parameter 'messagingCampaignId' is set
|
|
12497
|
+
if(messagingCampaignId===undefined||messagingCampaignId===null){throw'Missing the required parameter "messagingCampaignId" when calling postOutboundMessagingcampaignStart';}return this.apiClient.callApi('/api/v2/outbound/messagingcampaigns/{messagingCampaignId}/start','POST',{'messagingCampaignId':messagingCampaignId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
12498
|
+
* Stop the campaign
|
|
12499
|
+
* Documented permissions are applicable based on campaign type.
|
|
12500
|
+
* @param {String} messagingCampaignId The Messaging Campaign ID
|
|
12501
|
+
*/},{key:"postOutboundMessagingcampaignStop",value:function postOutboundMessagingcampaignStop(messagingCampaignId){// verify the required parameter 'messagingCampaignId' is set
|
|
12502
|
+
if(messagingCampaignId===undefined||messagingCampaignId===null){throw'Missing the required parameter "messagingCampaignId" when calling postOutboundMessagingcampaignStop';}return this.apiClient.callApi('/api/v2/outbound/messagingcampaigns/{messagingCampaignId}/stop','POST',{'messagingCampaignId':messagingCampaignId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
12369
12503
|
* Create a Messaging Campaign
|
|
12370
12504
|
*
|
|
12371
12505
|
* @param {Object} body Messaging Campaign
|
|
@@ -12544,7 +12678,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
12544
12678
|
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']);}}]);}();var PresenceApi=/*#__PURE__*/function(){/**
|
|
12545
12679
|
* Presence service.
|
|
12546
12680
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
12547
|
-
* @version
|
|
12681
|
+
* @version 207.0.0
|
|
12548
12682
|
*//**
|
|
12549
12683
|
* Constructs a new PresenceApi.
|
|
12550
12684
|
* @alias module:purecloud-platform-client-v2/api/PresenceApi
|
|
@@ -12717,7 +12851,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
12717
12851
|
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']);}}]);}();var ProcessAutomationApi=/*#__PURE__*/function(){/**
|
|
12718
12852
|
* ProcessAutomation service.
|
|
12719
12853
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
12720
|
-
* @version
|
|
12854
|
+
* @version 207.0.0
|
|
12721
12855
|
*//**
|
|
12722
12856
|
* Constructs a new ProcessAutomationApi.
|
|
12723
12857
|
* @alias module:purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
@@ -12780,7 +12914,7 @@ if(triggerId===undefined||triggerId===null){throw'Missing the required parameter
|
|
|
12780
12914
|
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']);}}]);}();var QualityApi=/*#__PURE__*/function(){/**
|
|
12781
12915
|
* Quality service.
|
|
12782
12916
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
12783
|
-
* @version
|
|
12917
|
+
* @version 207.0.0
|
|
12784
12918
|
*//**
|
|
12785
12919
|
* Constructs a new QualityApi.
|
|
12786
12920
|
* @alias module:purecloud-platform-client-v2/api/QualityApi
|
|
@@ -13257,7 +13391,7 @@ if(customerSurveyUrl===undefined||customerSurveyUrl===null){throw'Missing the re
|
|
|
13257
13391
|
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']);}}]);}();var RecordingApi=/*#__PURE__*/function(){/**
|
|
13258
13392
|
* Recording service.
|
|
13259
13393
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
13260
|
-
* @version
|
|
13394
|
+
* @version 207.0.0
|
|
13261
13395
|
*//**
|
|
13262
13396
|
* Constructs a new RecordingApi.
|
|
13263
13397
|
* @alias module:purecloud-platform-client-v2/api/RecordingApi
|
|
@@ -13669,7 +13803,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
13669
13803
|
*/},{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']);}}]);}();var ResponseManagementApi=/*#__PURE__*/function(){/**
|
|
13670
13804
|
* ResponseManagement service.
|
|
13671
13805
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
13672
|
-
* @version
|
|
13806
|
+
* @version 207.0.0
|
|
13673
13807
|
*//**
|
|
13674
13808
|
* Constructs a new ResponseManagementApi.
|
|
13675
13809
|
* @alias module:purecloud-platform-client-v2/api/ResponseManagementApi
|
|
@@ -13790,7 +13924,7 @@ if(responseAssetId===undefined||responseAssetId===null){throw'Missing the requir
|
|
|
13790
13924
|
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']);}}]);}();var RoutingApi=/*#__PURE__*/function(){/**
|
|
13791
13925
|
* Routing service.
|
|
13792
13926
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
13793
|
-
* @version
|
|
13927
|
+
* @version 207.0.0
|
|
13794
13928
|
*//**
|
|
13795
13929
|
* Constructs a new RoutingApi.
|
|
13796
13930
|
* @alias module:purecloud-platform-client-v2/api/RoutingApi
|
|
@@ -14794,7 +14928,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
14794
14928
|
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']);}}]);}();var SCIMApi=/*#__PURE__*/function(){/**
|
|
14795
14929
|
* SCIM service.
|
|
14796
14930
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
14797
|
-
* @version
|
|
14931
|
+
* @version 207.0.0
|
|
14798
14932
|
*//**
|
|
14799
14933
|
* Constructs a new SCIMApi.
|
|
14800
14934
|
* @alias module:purecloud-platform-client-v2/api/SCIMApi
|
|
@@ -15019,7 +15153,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
15019
15153
|
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']);}}]);}();var ScreenRecordingApi=/*#__PURE__*/function(){/**
|
|
15020
15154
|
* ScreenRecording service.
|
|
15021
15155
|
* @module purecloud-platform-client-v2/api/ScreenRecordingApi
|
|
15022
|
-
* @version
|
|
15156
|
+
* @version 207.0.0
|
|
15023
15157
|
*//**
|
|
15024
15158
|
* Constructs a new ScreenRecordingApi.
|
|
15025
15159
|
* @alias module:purecloud-platform-client-v2/api/ScreenRecordingApi
|
|
@@ -15034,7 +15168,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
15034
15168
|
*/return _createClass(ScreenRecordingApi,[{key:"postScreenrecordingToken",value:function postScreenrecordingToken(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/screenrecording/token','POST',{},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var ScriptsApi=/*#__PURE__*/function(){/**
|
|
15035
15169
|
* Scripts service.
|
|
15036
15170
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
15037
|
-
* @version
|
|
15171
|
+
* @version 207.0.0
|
|
15038
15172
|
*//**
|
|
15039
15173
|
* Constructs a new ScriptsApi.
|
|
15040
15174
|
* @alias module:purecloud-platform-client-v2/api/ScriptsApi
|
|
@@ -15170,7 +15304,7 @@ if(scriptId===undefined||scriptId===null){throw'Missing the required parameter "
|
|
|
15170
15304
|
*/},{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']);}}]);}();var SearchApi=/*#__PURE__*/function(){/**
|
|
15171
15305
|
* Search service.
|
|
15172
15306
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
15173
|
-
* @version
|
|
15307
|
+
* @version 207.0.0
|
|
15174
15308
|
*//**
|
|
15175
15309
|
* Constructs a new SearchApi.
|
|
15176
15310
|
* @alias module:purecloud-platform-client-v2/api/SearchApi
|
|
@@ -15330,7 +15464,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
15330
15464
|
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']);}}]);}();var SettingsApi=/*#__PURE__*/function(){/**
|
|
15331
15465
|
* Settings service.
|
|
15332
15466
|
* @module purecloud-platform-client-v2/api/SettingsApi
|
|
15333
|
-
* @version
|
|
15467
|
+
* @version 207.0.0
|
|
15334
15468
|
*//**
|
|
15335
15469
|
* Constructs a new SettingsApi.
|
|
15336
15470
|
* @alias module:purecloud-platform-client-v2/api/SettingsApi
|
|
@@ -15380,7 +15514,7 @@ if(agentId===undefined||agentId===null){throw'Missing the required parameter "ag
|
|
|
15380
15514
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putUsersAgentuiAgentsAutoanswerAgentIdSettings';}return this.apiClient.callApi('/api/v2/users/agentui/agents/autoanswer/{agentId}/settings','PUT',{'agentId':agentId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var SpeechTextAnalyticsApi=/*#__PURE__*/function(){/**
|
|
15381
15515
|
* SpeechTextAnalytics service.
|
|
15382
15516
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
15383
|
-
* @version
|
|
15517
|
+
* @version 207.0.0
|
|
15384
15518
|
*//**
|
|
15385
15519
|
* Constructs a new SpeechTextAnalyticsApi.
|
|
15386
15520
|
* @alias module:purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
@@ -15679,7 +15813,7 @@ if(topicId===undefined||topicId===null){throw'Missing the required parameter "to
|
|
|
15679
15813
|
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']);}}]);}();var StationsApi=/*#__PURE__*/function(){/**
|
|
15680
15814
|
* Stations service.
|
|
15681
15815
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
15682
|
-
* @version
|
|
15816
|
+
* @version 207.0.0
|
|
15683
15817
|
*//**
|
|
15684
15818
|
* Constructs a new StationsApi.
|
|
15685
15819
|
* @alias module:purecloud-platform-client-v2/api/StationsApi
|
|
@@ -15711,7 +15845,7 @@ if(stationId===undefined||stationId===null){throw'Missing the required parameter
|
|
|
15711
15845
|
*/},{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']);}}]);}();var SuggestApi=/*#__PURE__*/function(){/**
|
|
15712
15846
|
* Suggest service.
|
|
15713
15847
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
15714
|
-
* @version
|
|
15848
|
+
* @version 207.0.0
|
|
15715
15849
|
*//**
|
|
15716
15850
|
* Constructs a new SuggestApi.
|
|
15717
15851
|
* @alias module:purecloud-platform-client-v2/api/SuggestApi
|
|
@@ -15751,7 +15885,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
15751
15885
|
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']);}}]);}();var TaskManagementApi=/*#__PURE__*/function(){/**
|
|
15752
15886
|
* TaskManagement service.
|
|
15753
15887
|
* @module purecloud-platform-client-v2/api/TaskManagementApi
|
|
15754
|
-
* @version
|
|
15888
|
+
* @version 207.0.0
|
|
15755
15889
|
*//**
|
|
15756
15890
|
* Constructs a new TaskManagementApi.
|
|
15757
15891
|
* @alias module:purecloud-platform-client-v2/api/TaskManagementApi
|
|
@@ -15779,6 +15913,20 @@ if(schemaId===undefined||schemaId===null){throw'Missing the required parameter "
|
|
|
15779
15913
|
* @param {String} worktypeId Worktype id
|
|
15780
15914
|
*/},{key:"deleteTaskmanagementWorktype",value:function deleteTaskmanagementWorktype(worktypeId){// verify the required parameter 'worktypeId' is set
|
|
15781
15915
|
if(worktypeId===undefined||worktypeId===null){throw'Missing the required parameter "worktypeId" when calling deleteTaskmanagementWorktype';}return this.apiClient.callApi('/api/v2/taskmanagement/worktypes/{worktypeId}','DELETE',{'worktypeId':worktypeId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
15916
|
+
* Delete a rule
|
|
15917
|
+
*
|
|
15918
|
+
* @param {String} worktypeId Worktype id
|
|
15919
|
+
* @param {String} ruleId ruleId
|
|
15920
|
+
*/},{key:"deleteTaskmanagementWorktypeFlowsOnattributechangeRule",value:function deleteTaskmanagementWorktypeFlowsOnattributechangeRule(worktypeId,ruleId){// verify the required parameter 'worktypeId' is set
|
|
15921
|
+
if(worktypeId===undefined||worktypeId===null){throw'Missing the required parameter "worktypeId" when calling deleteTaskmanagementWorktypeFlowsOnattributechangeRule';}// verify the required parameter 'ruleId' is set
|
|
15922
|
+
if(ruleId===undefined||ruleId===null){throw'Missing the required parameter "ruleId" when calling deleteTaskmanagementWorktypeFlowsOnattributechangeRule';}return this.apiClient.callApi('/api/v2/taskmanagement/worktypes/{worktypeId}/flows/onattributechange/rules/{ruleId}','DELETE',{'worktypeId':worktypeId,'ruleId':ruleId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
15923
|
+
* Delete a rule
|
|
15924
|
+
*
|
|
15925
|
+
* @param {String} worktypeId Worktype id
|
|
15926
|
+
* @param {String} ruleId ruleId
|
|
15927
|
+
*/},{key:"deleteTaskmanagementWorktypeFlowsOncreateRule",value:function deleteTaskmanagementWorktypeFlowsOncreateRule(worktypeId,ruleId){// verify the required parameter 'worktypeId' is set
|
|
15928
|
+
if(worktypeId===undefined||worktypeId===null){throw'Missing the required parameter "worktypeId" when calling deleteTaskmanagementWorktypeFlowsOncreateRule';}// verify the required parameter 'ruleId' is set
|
|
15929
|
+
if(ruleId===undefined||ruleId===null){throw'Missing the required parameter "ruleId" when calling deleteTaskmanagementWorktypeFlowsOncreateRule';}return this.apiClient.callApi('/api/v2/taskmanagement/worktypes/{worktypeId}/flows/oncreate/rules/{ruleId}','DELETE',{'worktypeId':worktypeId,'ruleId':ruleId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
15782
15930
|
* Delete a status
|
|
15783
15931
|
*
|
|
15784
15932
|
* @param {String} worktypeId Worktype id
|
|
@@ -15913,6 +16061,36 @@ if(schemaId===undefined||schemaId===null){throw'Missing the required parameter "
|
|
|
15913
16061
|
* @param {Array.<String>} opts.expands Which fields, if any, to expand.
|
|
15914
16062
|
*/},{key:"getTaskmanagementWorktype",value:function getTaskmanagementWorktype(worktypeId,opts){opts=opts||{};// verify the required parameter 'worktypeId' is set
|
|
15915
16063
|
if(worktypeId===undefined||worktypeId===null){throw'Missing the required parameter "worktypeId" when calling getTaskmanagementWorktype';}return this.apiClient.callApi('/api/v2/taskmanagement/worktypes/{worktypeId}','GET',{'worktypeId':worktypeId},{'expands':this.apiClient.buildCollectionParam(opts['expands'],'multi')},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
16064
|
+
* Get an attribute change rule
|
|
16065
|
+
*
|
|
16066
|
+
* @param {String} worktypeId Worktype id
|
|
16067
|
+
* @param {String} ruleId ruleId
|
|
16068
|
+
*/},{key:"getTaskmanagementWorktypeFlowsOnattributechangeRule",value:function getTaskmanagementWorktypeFlowsOnattributechangeRule(worktypeId,ruleId){// verify the required parameter 'worktypeId' is set
|
|
16069
|
+
if(worktypeId===undefined||worktypeId===null){throw'Missing the required parameter "worktypeId" when calling getTaskmanagementWorktypeFlowsOnattributechangeRule';}// verify the required parameter 'ruleId' is set
|
|
16070
|
+
if(ruleId===undefined||ruleId===null){throw'Missing the required parameter "ruleId" when calling getTaskmanagementWorktypeFlowsOnattributechangeRule';}return this.apiClient.callApi('/api/v2/taskmanagement/worktypes/{worktypeId}/flows/onattributechange/rules/{ruleId}','GET',{'worktypeId':worktypeId,'ruleId':ruleId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
16071
|
+
* Get all attribute-change rules for a worktype
|
|
16072
|
+
*
|
|
16073
|
+
* @param {String} worktypeId Worktype id
|
|
16074
|
+
* @param {Object} opts Optional parameters
|
|
16075
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
16076
|
+
* @param {Number} opts.pageSize Limit the number of entities to return. It is not guaranteed that the requested number of entities will be filled in a single request. If an `after` key is returned as part of the response it is possible that more entities that match the filter criteria exist. Maximum of 200. (default to 25)
|
|
16077
|
+
*/},{key:"getTaskmanagementWorktypeFlowsOnattributechangeRules",value:function getTaskmanagementWorktypeFlowsOnattributechangeRules(worktypeId,opts){opts=opts||{};// verify the required parameter 'worktypeId' is set
|
|
16078
|
+
if(worktypeId===undefined||worktypeId===null){throw'Missing the required parameter "worktypeId" when calling getTaskmanagementWorktypeFlowsOnattributechangeRules';}return this.apiClient.callApi('/api/v2/taskmanagement/worktypes/{worktypeId}/flows/onattributechange/rules','GET',{'worktypeId':worktypeId},{'after':opts['after'],'pageSize':opts['pageSize']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
16079
|
+
* Get an on-create rule
|
|
16080
|
+
*
|
|
16081
|
+
* @param {String} worktypeId Worktype id
|
|
16082
|
+
* @param {String} ruleId ruleId
|
|
16083
|
+
*/},{key:"getTaskmanagementWorktypeFlowsOncreateRule",value:function getTaskmanagementWorktypeFlowsOncreateRule(worktypeId,ruleId){// verify the required parameter 'worktypeId' is set
|
|
16084
|
+
if(worktypeId===undefined||worktypeId===null){throw'Missing the required parameter "worktypeId" when calling getTaskmanagementWorktypeFlowsOncreateRule';}// verify the required parameter 'ruleId' is set
|
|
16085
|
+
if(ruleId===undefined||ruleId===null){throw'Missing the required parameter "ruleId" when calling getTaskmanagementWorktypeFlowsOncreateRule';}return this.apiClient.callApi('/api/v2/taskmanagement/worktypes/{worktypeId}/flows/oncreate/rules/{ruleId}','GET',{'worktypeId':worktypeId,'ruleId':ruleId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
16086
|
+
* Get all on-create rules for a worktype
|
|
16087
|
+
*
|
|
16088
|
+
* @param {String} worktypeId Worktype id
|
|
16089
|
+
* @param {Object} opts Optional parameters
|
|
16090
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
16091
|
+
* @param {Number} opts.pageSize Limit the number of entities to return. It is not guaranteed that the requested number of entities will be filled in a single request. If an `after` key is returned as part of the response it is possible that more entities that match the filter criteria exist. Maximum of 200. (default to 25)
|
|
16092
|
+
*/},{key:"getTaskmanagementWorktypeFlowsOncreateRules",value:function getTaskmanagementWorktypeFlowsOncreateRules(worktypeId,opts){opts=opts||{};// verify the required parameter 'worktypeId' is set
|
|
16093
|
+
if(worktypeId===undefined||worktypeId===null){throw'Missing the required parameter "worktypeId" when calling getTaskmanagementWorktypeFlowsOncreateRules';}return this.apiClient.callApi('/api/v2/taskmanagement/worktypes/{worktypeId}/flows/oncreate/rules','GET',{'worktypeId':worktypeId},{'after':opts['after'],'pageSize':opts['pageSize']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
15916
16094
|
* Get a listing of a worktype's attribute change history
|
|
15917
16095
|
*
|
|
15918
16096
|
* @param {String} worktypeId Worktype id
|
|
@@ -15998,6 +16176,24 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
15998
16176
|
*/},{key:"patchTaskmanagementWorktype",value:function patchTaskmanagementWorktype(worktypeId,body){// verify the required parameter 'worktypeId' is set
|
|
15999
16177
|
if(worktypeId===undefined||worktypeId===null){throw'Missing the required parameter "worktypeId" when calling patchTaskmanagementWorktype';}// verify the required parameter 'body' is set
|
|
16000
16178
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling patchTaskmanagementWorktype';}return this.apiClient.callApi('/api/v2/taskmanagement/worktypes/{worktypeId}','PATCH',{'worktypeId':worktypeId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
16179
|
+
* Update the attributes of a rule
|
|
16180
|
+
*
|
|
16181
|
+
* @param {String} worktypeId Worktype id
|
|
16182
|
+
* @param {String} ruleId ruleId
|
|
16183
|
+
* @param {Object} body Rule
|
|
16184
|
+
*/},{key:"patchTaskmanagementWorktypeFlowsOnattributechangeRule",value:function patchTaskmanagementWorktypeFlowsOnattributechangeRule(worktypeId,ruleId,body){// verify the required parameter 'worktypeId' is set
|
|
16185
|
+
if(worktypeId===undefined||worktypeId===null){throw'Missing the required parameter "worktypeId" when calling patchTaskmanagementWorktypeFlowsOnattributechangeRule';}// verify the required parameter 'ruleId' is set
|
|
16186
|
+
if(ruleId===undefined||ruleId===null){throw'Missing the required parameter "ruleId" when calling patchTaskmanagementWorktypeFlowsOnattributechangeRule';}// verify the required parameter 'body' is set
|
|
16187
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling patchTaskmanagementWorktypeFlowsOnattributechangeRule';}return this.apiClient.callApi('/api/v2/taskmanagement/worktypes/{worktypeId}/flows/onattributechange/rules/{ruleId}','PATCH',{'worktypeId':worktypeId,'ruleId':ruleId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
16188
|
+
* Update the attributes of a rule
|
|
16189
|
+
*
|
|
16190
|
+
* @param {String} worktypeId Worktype id
|
|
16191
|
+
* @param {String} ruleId ruleId
|
|
16192
|
+
* @param {Object} body Rule
|
|
16193
|
+
*/},{key:"patchTaskmanagementWorktypeFlowsOncreateRule",value:function patchTaskmanagementWorktypeFlowsOncreateRule(worktypeId,ruleId,body){// verify the required parameter 'worktypeId' is set
|
|
16194
|
+
if(worktypeId===undefined||worktypeId===null){throw'Missing the required parameter "worktypeId" when calling patchTaskmanagementWorktypeFlowsOncreateRule';}// verify the required parameter 'ruleId' is set
|
|
16195
|
+
if(ruleId===undefined||ruleId===null){throw'Missing the required parameter "ruleId" when calling patchTaskmanagementWorktypeFlowsOncreateRule';}// verify the required parameter 'body' is set
|
|
16196
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling patchTaskmanagementWorktypeFlowsOncreateRule';}return this.apiClient.callApi('/api/v2/taskmanagement/worktypes/{worktypeId}/flows/oncreate/rules/{ruleId}','PATCH',{'worktypeId':worktypeId,'ruleId':ruleId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
16001
16197
|
* Update the attributes of a status
|
|
16002
16198
|
*
|
|
16003
16199
|
* @param {String} worktypeId Worktype id
|
|
@@ -16055,6 +16251,20 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
16055
16251
|
* @param {Object} body Schema
|
|
16056
16252
|
*/},{key:"postTaskmanagementWorkitemsSchemas",value:function postTaskmanagementWorkitemsSchemas(body){// verify the required parameter 'body' is set
|
|
16057
16253
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postTaskmanagementWorkitemsSchemas';}return this.apiClient.callApi('/api/v2/taskmanagement/workitems/schemas','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
16254
|
+
* Add an attribute-change rule to a worktype
|
|
16255
|
+
*
|
|
16256
|
+
* @param {String} worktypeId Worktype id
|
|
16257
|
+
* @param {Object} body Rule
|
|
16258
|
+
*/},{key:"postTaskmanagementWorktypeFlowsOnattributechangeRules",value:function postTaskmanagementWorktypeFlowsOnattributechangeRules(worktypeId,body){// verify the required parameter 'worktypeId' is set
|
|
16259
|
+
if(worktypeId===undefined||worktypeId===null){throw'Missing the required parameter "worktypeId" when calling postTaskmanagementWorktypeFlowsOnattributechangeRules';}// verify the required parameter 'body' is set
|
|
16260
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postTaskmanagementWorktypeFlowsOnattributechangeRules';}return this.apiClient.callApi('/api/v2/taskmanagement/worktypes/{worktypeId}/flows/onattributechange/rules','POST',{'worktypeId':worktypeId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
16261
|
+
* Add an on-create rule to a worktype
|
|
16262
|
+
*
|
|
16263
|
+
* @param {String} worktypeId Worktype id
|
|
16264
|
+
* @param {Object} body Rule
|
|
16265
|
+
*/},{key:"postTaskmanagementWorktypeFlowsOncreateRules",value:function postTaskmanagementWorktypeFlowsOncreateRules(worktypeId,body){// verify the required parameter 'worktypeId' is set
|
|
16266
|
+
if(worktypeId===undefined||worktypeId===null){throw'Missing the required parameter "worktypeId" when calling postTaskmanagementWorktypeFlowsOncreateRules';}// verify the required parameter 'body' is set
|
|
16267
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postTaskmanagementWorktypeFlowsOncreateRules';}return this.apiClient.callApi('/api/v2/taskmanagement/worktypes/{worktypeId}/flows/oncreate/rules','POST',{'worktypeId':worktypeId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
16058
16268
|
* Add a status to a worktype
|
|
16059
16269
|
*
|
|
16060
16270
|
* @param {String} worktypeId Worktype id
|
|
@@ -16081,7 +16291,7 @@ if(schemaId===undefined||schemaId===null){throw'Missing the required parameter "
|
|
|
16081
16291
|
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']);}}]);}();var TeamsApi=/*#__PURE__*/function(){/**
|
|
16082
16292
|
* Teams service.
|
|
16083
16293
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
16084
|
-
* @version
|
|
16294
|
+
* @version 207.0.0
|
|
16085
16295
|
*//**
|
|
16086
16296
|
* Constructs a new TeamsApi.
|
|
16087
16297
|
* @alias module:purecloud-platform-client-v2/api/TeamsApi
|
|
@@ -16104,8 +16314,10 @@ if(id===undefined||id===null){throw'Missing the required parameter "id" when cal
|
|
|
16104
16314
|
* Get team
|
|
16105
16315
|
*
|
|
16106
16316
|
* @param {String} teamId Team ID
|
|
16107
|
-
|
|
16108
|
-
|
|
16317
|
+
* @param {Object} opts Optional parameters
|
|
16318
|
+
* @param {Object} opts.expand Expand the division name
|
|
16319
|
+
*/},{key:"getTeam",value:function getTeam(teamId,opts){opts=opts||{};// verify the required parameter 'teamId' is set
|
|
16320
|
+
if(teamId===undefined||teamId===null){throw'Missing the required parameter "teamId" when calling getTeam';}return this.apiClient.callApi('/api/v2/teams/{teamId}','GET',{'teamId':teamId},{'expand':opts['expand']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
16109
16321
|
* Get team membership
|
|
16110
16322
|
*
|
|
16111
16323
|
* @param {String} teamId Team ID
|
|
@@ -16159,7 +16371,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
16159
16371
|
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']);}}]);}();var TelephonyApi=/*#__PURE__*/function(){/**
|
|
16160
16372
|
* Telephony service.
|
|
16161
16373
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
16162
|
-
* @version
|
|
16374
|
+
* @version 207.0.0
|
|
16163
16375
|
*//**
|
|
16164
16376
|
* Constructs a new TelephonyApi.
|
|
16165
16377
|
* @alias module:purecloud-platform-client-v2/api/TelephonyApi
|
|
@@ -16206,7 +16418,7 @@ if(downloadId===undefined||downloadId===null){throw'Missing the required paramet
|
|
|
16206
16418
|
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']);}}]);}();var TelephonyProvidersEdgeApi=/*#__PURE__*/function(){/**
|
|
16207
16419
|
* TelephonyProvidersEdge service.
|
|
16208
16420
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
16209
|
-
* @version
|
|
16421
|
+
* @version 207.0.0
|
|
16210
16422
|
*//**
|
|
16211
16423
|
* Constructs a new TelephonyProvidersEdgeApi.
|
|
16212
16424
|
* @alias module:purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
@@ -17029,7 +17241,7 @@ if(trunkBaseSettingsId===undefined||trunkBaseSettingsId===null){throw'Missing th
|
|
|
17029
17241
|
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']);}}]);}();var TextbotsApi=/*#__PURE__*/function(){/**
|
|
17030
17242
|
* Textbots service.
|
|
17031
17243
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
17032
|
-
* @version
|
|
17244
|
+
* @version 207.0.0
|
|
17033
17245
|
*//**
|
|
17034
17246
|
* Constructs a new TextbotsApi.
|
|
17035
17247
|
* @alias module:purecloud-platform-client-v2/api/TextbotsApi
|
|
@@ -17064,7 +17276,7 @@ if(launchRequest===undefined||launchRequest===null){throw'Missing the required p
|
|
|
17064
17276
|
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']);}}]);}();var TokensApi=/*#__PURE__*/function(){/**
|
|
17065
17277
|
* Tokens service.
|
|
17066
17278
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
17067
|
-
* @version
|
|
17279
|
+
* @version 207.0.0
|
|
17068
17280
|
*//**
|
|
17069
17281
|
* Constructs a new TokensApi.
|
|
17070
17282
|
* @alias module:purecloud-platform-client-v2/api/TokensApi
|
|
@@ -17098,7 +17310,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
17098
17310
|
*/},{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']);}}]);}();var UploadsApi=/*#__PURE__*/function(){/**
|
|
17099
17311
|
* Uploads service.
|
|
17100
17312
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
17101
|
-
* @version
|
|
17313
|
+
* @version 207.0.0
|
|
17102
17314
|
*//**
|
|
17103
17315
|
* Constructs a new UploadsApi.
|
|
17104
17316
|
* @alias module:purecloud-platform-client-v2/api/UploadsApi
|
|
@@ -17164,7 +17376,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
17164
17376
|
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']);}}]);}();var UsageApi=/*#__PURE__*/function(){/**
|
|
17165
17377
|
* Usage service.
|
|
17166
17378
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
17167
|
-
* @version
|
|
17379
|
+
* @version 207.0.0
|
|
17168
17380
|
*//**
|
|
17169
17381
|
* Constructs a new UsageApi.
|
|
17170
17382
|
* @alias module:purecloud-platform-client-v2/api/UsageApi
|
|
@@ -17218,7 +17430,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
17218
17430
|
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']);}}]);}();var UserRecordingsApi=/*#__PURE__*/function(){/**
|
|
17219
17431
|
* UserRecordings service.
|
|
17220
17432
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
17221
|
-
* @version
|
|
17433
|
+
* @version 207.0.0
|
|
17222
17434
|
*//**
|
|
17223
17435
|
* Constructs a new UserRecordingsApi.
|
|
17224
17436
|
* @alias module:purecloud-platform-client-v2/api/UserRecordingsApi
|
|
@@ -17275,7 +17487,7 @@ if(recordingId===undefined||recordingId===null){throw'Missing the required param
|
|
|
17275
17487
|
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']);}}]);}();var UsersApi=/*#__PURE__*/function(){/**
|
|
17276
17488
|
* Users service.
|
|
17277
17489
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
17278
|
-
* @version
|
|
17490
|
+
* @version 207.0.0
|
|
17279
17491
|
*//**
|
|
17280
17492
|
* Constructs a new UsersApi.
|
|
17281
17493
|
* @alias module:purecloud-platform-client-v2/api/UsersApi
|
|
@@ -17600,6 +17812,13 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
17600
17812
|
* @param {Object} opts.integrationPresenceSource Gets an integration presence for users instead of their defaults. This parameter will only be used when presence is provided as an expand. When using this parameter the maximum number of users that can be returned is 100.
|
|
17601
17813
|
* @param {Object} opts.state Only list users of this state (default to active)
|
|
17602
17814
|
*/},{key:"getUsers",value:function getUsers(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/users','GET',{},{'pageSize':opts['pageSize'],'pageNumber':opts['pageNumber'],'id':this.apiClient.buildCollectionParam(opts['id'],'multi'),'jabberId':this.apiClient.buildCollectionParam(opts['jabberId'],'multi'),'sortOrder':opts['sortOrder'],'expand':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'integrationPresenceSource':opts['integrationPresenceSource'],'state':opts['state']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
17815
|
+
* Get chats for a user
|
|
17816
|
+
*
|
|
17817
|
+
* @param {Object} opts Optional parameters
|
|
17818
|
+
* @param {Boolean} opts.excludeClosed Whether or not to exclude closed chats
|
|
17819
|
+
* @param {Boolean} opts.includePresence Whether or not to include user presence
|
|
17820
|
+
* @param {String} opts.after The key to start after
|
|
17821
|
+
*/},{key:"getUsersChatsMe",value:function getUsersChatsMe(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/users/chats/me','GET',{},{'excludeClosed':opts['excludeClosed'],'includePresence':opts['includePresence'],'after':opts['after']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
17603
17822
|
* Get list of Development Activities
|
|
17604
17823
|
* Either moduleId or userId is required. Results are filtered based on the applicable permissions.
|
|
17605
17824
|
* @param {Object} opts Optional parameters
|
|
@@ -17965,7 +18184,7 @@ if(verifierId===undefined||verifierId===null){throw'Missing the required paramet
|
|
|
17965
18184
|
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']);}}]);}();var UtilitiesApi=/*#__PURE__*/function(){/**
|
|
17966
18185
|
* Utilities service.
|
|
17967
18186
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
17968
|
-
* @version
|
|
18187
|
+
* @version 207.0.0
|
|
17969
18188
|
*//**
|
|
17970
18189
|
* Constructs a new UtilitiesApi.
|
|
17971
18190
|
* @alias module:purecloud-platform-client-v2/api/UtilitiesApi
|
|
@@ -17992,7 +18211,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
17992
18211
|
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']);}}]);}();var VoicemailApi=/*#__PURE__*/function(){/**
|
|
17993
18212
|
* Voicemail service.
|
|
17994
18213
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
17995
|
-
* @version
|
|
18214
|
+
* @version 207.0.0
|
|
17996
18215
|
*//**
|
|
17997
18216
|
* Constructs a new VoicemailApi.
|
|
17998
18217
|
* @alias module:purecloud-platform-client-v2/api/VoicemailApi
|
|
@@ -18079,6 +18298,19 @@ if(queueId===undefined||queueId===null){throw'Missing the required parameter "qu
|
|
|
18079
18298
|
* @param {Array.<String>} opts.expand expand
|
|
18080
18299
|
*/},{key:"getVoicemailSearch",value:function getVoicemailSearch(q64,opts){opts=opts||{};// verify the required parameter 'q64' is set
|
|
18081
18300
|
if(q64===undefined||q64===null){throw'Missing the required parameter "q64" when calling getVoicemailSearch';}return this.apiClient.callApi('/api/v2/voicemail/search','GET',{},{'q64':q64,'expand':this.apiClient.buildCollectionParam(opts['expand'],'multi')},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
18301
|
+
* Get a user's mailbox information
|
|
18302
|
+
*
|
|
18303
|
+
* @param {String} userId userId
|
|
18304
|
+
*/},{key:"getVoicemailUserMailbox",value:function getVoicemailUserMailbox(userId){// verify the required parameter 'userId' is set
|
|
18305
|
+
if(userId===undefined||userId===null){throw'Missing the required parameter "userId" when calling getVoicemailUserMailbox';}return this.apiClient.callApi('/api/v2/voicemail/users/{userId}/mailbox','GET',{'userId':userId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
18306
|
+
* List voicemail messages
|
|
18307
|
+
*
|
|
18308
|
+
* @param {String} userId User ID
|
|
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
|
+
*/},{key:"getVoicemailUserMessages",value:function getVoicemailUserMessages(userId,opts){opts=opts||{};// verify the required parameter 'userId' is set
|
|
18313
|
+
if(userId===undefined||userId===null){throw'Missing the required parameter "userId" when calling getVoicemailUserMessages';}return this.apiClient.callApi('/api/v2/voicemail/users/{userId}/messages','GET',{'userId':userId},{'pageSize':opts['pageSize'],'pageNumber':opts['pageNumber']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
18082
18314
|
* Get a user's voicemail policy
|
|
18083
18315
|
*
|
|
18084
18316
|
* @param {String} userId User ID
|
|
@@ -18141,7 +18373,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
18141
18373
|
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']);}}]);}();var WebChatApi=/*#__PURE__*/function(){/**
|
|
18142
18374
|
* WebChat service.
|
|
18143
18375
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
18144
|
-
* @version
|
|
18376
|
+
* @version 207.0.0
|
|
18145
18377
|
*//**
|
|
18146
18378
|
* Constructs a new WebChatApi.
|
|
18147
18379
|
* @alias module:purecloud-platform-client-v2/api/WebChatApi
|
|
@@ -18276,7 +18508,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
18276
18508
|
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']);}}]);}();var WebDeploymentsApi=/*#__PURE__*/function(){/**
|
|
18277
18509
|
* WebDeployments service.
|
|
18278
18510
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
18279
|
-
* @version
|
|
18511
|
+
* @version 207.0.0
|
|
18280
18512
|
*//**
|
|
18281
18513
|
* Constructs a new WebDeploymentsApi.
|
|
18282
18514
|
* @alias module:purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
@@ -18327,7 +18559,7 @@ if(configurationId===undefined||configurationId===null){throw'Missing the requir
|
|
|
18327
18559
|
* View configuration drafts
|
|
18328
18560
|
*
|
|
18329
18561
|
* @param {Object} opts Optional parameters
|
|
18330
|
-
* @param {Boolean} opts.showOnlyPublished
|
|
18562
|
+
* @param {Boolean} opts.showOnlyPublished Filter by published status.
|
|
18331
18563
|
*/},{key:"getWebdeploymentsConfigurations",value:function getWebdeploymentsConfigurations(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/webdeployments/configurations','GET',{},{'showOnlyPublished':opts['showOnlyPublished']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
18332
18564
|
* Get a deployment
|
|
18333
18565
|
*
|
|
@@ -18397,7 +18629,7 @@ if(deploymentId===undefined||deploymentId===null){throw'Missing the required par
|
|
|
18397
18629
|
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']);}}]);}();var WebMessagingApi=/*#__PURE__*/function(){/**
|
|
18398
18630
|
* WebMessaging service.
|
|
18399
18631
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
18400
|
-
* @version
|
|
18632
|
+
* @version 207.0.0
|
|
18401
18633
|
*//**
|
|
18402
18634
|
* Constructs a new WebMessagingApi.
|
|
18403
18635
|
* @alias module:purecloud-platform-client-v2/api/WebMessagingApi
|
|
@@ -18413,7 +18645,7 @@ if(deployment===undefined||deployment===null){throw'Missing the required paramet
|
|
|
18413
18645
|
*/return _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']);}}]);}();var WidgetsApi=/*#__PURE__*/function(){/**
|
|
18414
18646
|
* Widgets service.
|
|
18415
18647
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
18416
|
-
* @version
|
|
18648
|
+
* @version 207.0.0
|
|
18417
18649
|
*//**
|
|
18418
18650
|
* Constructs a new WidgetsApi.
|
|
18419
18651
|
* @alias module:purecloud-platform-client-v2/api/WidgetsApi
|
|
@@ -18448,7 +18680,7 @@ if(deploymentId===undefined||deploymentId===null){throw'Missing the required par
|
|
|
18448
18680
|
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']);}}]);}();var WorkforceManagementApi=/*#__PURE__*/function(){/**
|
|
18449
18681
|
* WorkforceManagement service.
|
|
18450
18682
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
18451
|
-
* @version
|
|
18683
|
+
* @version 207.0.0
|
|
18452
18684
|
*//**
|
|
18453
18685
|
* Constructs a new WorkforceManagementApi.
|
|
18454
18686
|
* @alias module:purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
@@ -19422,6 +19654,13 @@ if(managementUnitId===undefined||managementUnitId===null){throw'Missing the requ
|
|
|
19422
19654
|
* @param {Object} opts.body body
|
|
19423
19655
|
*/},{key:"patchWorkforcemanagementManagementunitAgents",value:function patchWorkforcemanagementManagementunitAgents(managementUnitId,opts){opts=opts||{};// verify the required parameter 'managementUnitId' is set
|
|
19424
19656
|
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']);}/**
|
|
19657
|
+
* Updates agent work plan configuration
|
|
19658
|
+
*
|
|
19659
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
19660
|
+
* @param {Object} opts Optional parameters
|
|
19661
|
+
* @param {Object} opts.body body
|
|
19662
|
+
*/},{key:"patchWorkforcemanagementManagementunitAgentsWorkplansBulk",value:function patchWorkforcemanagementManagementunitAgentsWorkplansBulk(managementUnitId,opts){opts=opts||{};// verify the required parameter 'managementUnitId' is set
|
|
19663
|
+
if(managementUnitId===undefined||managementUnitId===null){throw'Missing the required parameter "managementUnitId" when calling patchWorkforcemanagementManagementunitAgentsWorkplansBulk';}return this.apiClient.callApi('/api/v2/workforcemanagement/managementunits/{managementUnitId}/agents/workplans/bulk','PATCH',{'managementUnitId':managementUnitId},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
19425
19664
|
* Updates a time off limit object.
|
|
19426
19665
|
* Updates time off limit object properties, but not daily values.
|
|
19427
19666
|
* @param {String} managementUnitId The ID of the management unit.
|
|
@@ -19906,6 +20145,14 @@ if(businessUnitId===undefined||businessUnitId===null){throw'Missing the required
|
|
|
19906
20145
|
* @param {String} hrisIntegrationId The ID of the HRIS integration for which time off types are queried.
|
|
19907
20146
|
*/},{key:"postWorkforcemanagementIntegrationsHriTimeofftypesJobs",value:function postWorkforcemanagementIntegrationsHriTimeofftypesJobs(hrisIntegrationId){// verify the required parameter 'hrisIntegrationId' is set
|
|
19908
20147
|
if(hrisIntegrationId===undefined||hrisIntegrationId===null){throw'Missing the required parameter "hrisIntegrationId" when calling postWorkforcemanagementIntegrationsHriTimeofftypesJobs';}return this.apiClient.callApi('/api/v2/workforcemanagement/integrations/hris/{hrisIntegrationId}/timeofftypes/jobs','POST',{'hrisIntegrationId':hrisIntegrationId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
20148
|
+
* Get agents work plans configuration
|
|
20149
|
+
*
|
|
20150
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
20151
|
+
* @param {Object} opts Optional parameters
|
|
20152
|
+
* @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
|
|
20153
|
+
* @param {Object} opts.body body
|
|
20154
|
+
*/},{key:"postWorkforcemanagementManagementunitAgentsWorkplansQuery",value:function postWorkforcemanagementManagementunitAgentsWorkplansQuery(managementUnitId,opts){opts=opts||{};// verify the required parameter 'managementUnitId' is set
|
|
20155
|
+
if(managementUnitId===undefined||managementUnitId===null){throw'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitAgentsWorkplansQuery';}return this.apiClient.callApi('/api/v2/workforcemanagement/managementunits/{managementUnitId}/agents/workplans/query','POST',{'managementUnitId':managementUnitId},{'forceDownloadService':opts['forceDownloadService']},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
19909
20156
|
* Query published schedules for given given time range for set of users
|
|
19910
20157
|
*
|
|
19911
20158
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
@@ -20214,7 +20461,7 @@ if(timeOffLimitId===undefined||timeOffLimitId===null){throw'Missing the required
|
|
|
20214
20461
|
* </pre>
|
|
20215
20462
|
* </p>
|
|
20216
20463
|
* @module purecloud-platform-client-v2/index
|
|
20217
|
-
* @version
|
|
20464
|
+
* @version 207.0.0
|
|
20218
20465
|
*/var platformClient=/*#__PURE__*/_createClass(function platformClient(){_classCallCheck(this,platformClient);/**
|
|
20219
20466
|
* The ApiClient constructor.
|
|
20220
20467
|
* @property {module:purecloud-platform-client-v2/ApiClient}
|