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
|
@@ -6157,18 +6157,30 @@ axios.Cancel=axios.CanceledError;// Expose all/spread
|
|
|
6157
6157
|
axios.all=function all(promises){return Promise.all(promises);};axios.spread=spread;// Expose isAxiosError
|
|
6158
6158
|
axios.isAxiosError=isAxiosError;// Expose mergeConfig
|
|
6159
6159
|
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
|
|
6160
|
-
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:/**
|
|
6160
|
+
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:/**
|
|
6161
6161
|
* Singleton getter
|
|
6162
6162
|
*/function get(){return Configuration.instance;}/**
|
|
6163
6163
|
* Singleton setter
|
|
6164
6164
|
*/,set:function set(value){Configuration.instance=value;}},{key:"liveLoadConfig",value:function liveLoadConfig(){// If in browser, don't read config file, use default values
|
|
6165
|
-
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
|
|
6166
|
-
this.logger.setLogger();}
|
|
6165
|
+
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
|
|
6166
|
+
this.logger.setLogger();}/**
|
|
6167
|
+
* @description Sets the gateway used by the session
|
|
6168
|
+
* @param {object} gateway - Gateway Configuration interface
|
|
6169
|
+
* @param {string} gateway.host - The address of the gateway.
|
|
6170
|
+
* @param {string} gateway.protocol - (optional) The protocol to use. It will default to "https" if the parameter is not defined or empty.
|
|
6171
|
+
* @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).
|
|
6172
|
+
* @param {string} gateway.path_params_login - (optional) An arbitrary string to be appended to the gateway url path for Login requests.
|
|
6173
|
+
* @param {string} gateway.path_params_api - (optional) An arbitrary string to be appended to the gateway url path for API requests.
|
|
6174
|
+
* @param {string} gateway.username - (optional) Not used at this stage (for a possible future use).
|
|
6175
|
+
* @param {string} gateway.password - (optional) Not used at this stage (for a possible future use).
|
|
6176
|
+
*/},{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
|
|
6177
|
+
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
|
|
6178
|
+
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
|
|
6167
6179
|
if(env)this.environment=env;else this.environment=this.host?this.host:'mypurecloud.com';// Strip trailing slash
|
|
6168
6180
|
this.environment=this.environment.replace(/\/+$/,'');// Strip protocol and subdomain
|
|
6169
|
-
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];}}}]);}();/**
|
|
6181
|
+
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];}}}]);}();/**
|
|
6170
6182
|
* @module purecloud-platform-client-v2/ApiClient
|
|
6171
|
-
* @version
|
|
6183
|
+
* @version 207.0.0
|
|
6172
6184
|
*/var ApiClient=/*#__PURE__*/function(){/**
|
|
6173
6185
|
* Manages low level client-server communications, parameter marshalling, etc. There should not be any need for an
|
|
6174
6186
|
* application to use this class directly - the *Api and model classes provide the public API for the service. The
|
|
@@ -6237,6 +6249,16 @@ var tempState=this.authData.state;this.authData=localStorage.getItem("".concat(t
|
|
|
6237
6249
|
* @description Sets the environment used by the session
|
|
6238
6250
|
* @param {string} environment - (Optional, default "mypurecloud.com") Environment the session use, e.g. mypurecloud.ie, mypurecloud.com.au, etc.
|
|
6239
6251
|
*/},{key:"setEnvironment",value:function setEnvironment(environment){this.config.setEnvironment(environment);}/**
|
|
6252
|
+
* @description Sets the gateway used by the session
|
|
6253
|
+
* @param {object} gateway - Gateway Configuration interface
|
|
6254
|
+
* @param {string} gateway.host - The address of the gateway.
|
|
6255
|
+
* @param {string} gateway.protocol - (optional) The protocol to use. It will default to "https" if the parameter is not defined or empty.
|
|
6256
|
+
* @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).
|
|
6257
|
+
* @param {string} gateway.path_params_login - (optional) An arbitrary string to be appended to the gateway url path for Login requests.
|
|
6258
|
+
* @param {string} gateway.path_params_api - (optional) An arbitrary string to be appended to the gateway url path for API requests.
|
|
6259
|
+
* @param {string} gateway.username - (optional) Not used at this stage (for a possible future use).
|
|
6260
|
+
* @param {string} gateway.password - (optional) Not used at this stage (for a possible future use).
|
|
6261
|
+
*/},{key:"setGateway",value:function setGateway(gateway){this.config.setGateway(gateway);}/**
|
|
6240
6262
|
* @description Initiates the implicit grant login flow. Will attempt to load the token from local storage, if enabled.
|
|
6241
6263
|
* @param {string} clientId - The client ID of an OAuth Implicit Grant client
|
|
6242
6264
|
* @param {string} redirectUri - The redirect URI of the OAuth Implicit Grant client
|
|
@@ -6252,35 +6274,35 @@ _this2._testTokenAccess().then(function(){if(!_this2.authData.state&&opts.state)
|
|
|
6252
6274
|
* @description Initiates the client credentials login flow. Only available in node apps.
|
|
6253
6275
|
* @param {string} clientId - The client ID of an OAuth Implicit Grant client
|
|
6254
6276
|
* @param {string} clientSecret - The client secret of an OAuth Implicit Grant client
|
|
6255
|
-
*/},{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
|
|
6256
|
-
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:"
|
|
6257
|
-
_this3.config.logger.log('trace',response.status,'POST',"
|
|
6277
|
+
*/},{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
|
|
6278
|
+
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
|
|
6279
|
+
_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
|
|
6258
6280
|
_this3.setAccessToken(response.data['access_token']);// Set expiry time
|
|
6259
6281
|
_this3.authData.tokenExpiryTime=new Date().getTime()+response.data['expires_in']*1000;_this3.authData.tokenExpiryTimeString=new Date(_this3.authData.tokenExpiryTime).toUTCString();// Return auth data
|
|
6260
6282
|
resolve(_this3.authData);})["catch"](function(error){// Log error
|
|
6261
|
-
if(error.response){_this3.config.logger.log('error',error.response.status,'POST',"
|
|
6283
|
+
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);});});}/**
|
|
6262
6284
|
* @description Initiates the Saml2Bearerflow. Only available in node apps.
|
|
6263
6285
|
* @param {string} clientId - The client ID of an OAuth Implicit Grant client
|
|
6264
6286
|
* @param {string} clientSecret - The client secret of an OAuth Implicit Grant client
|
|
6265
6287
|
* @param {string} orgName - The orgName of an OAuth Implicit Grant client
|
|
6266
6288
|
* @param {string} assertion - The saml2bearer assertion
|
|
6267
|
-
*/},{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
|
|
6289
|
+
*/},{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
|
|
6268
6290
|
request.then(function(response){// Logging
|
|
6269
|
-
_this4.config.logger.log('trace',response.status,'POST',"
|
|
6291
|
+
_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
|
|
6270
6292
|
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
|
|
6271
6293
|
resolve(_this4.authData);})["catch"](function(error){// Log error
|
|
6272
|
-
if(error.response){_this4.config.logger.log('error',error.response.status,'POST',"
|
|
6294
|
+
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);});});}/**
|
|
6273
6295
|
* @description Completes the PKCE Code Authorization.
|
|
6274
6296
|
* @param {string} clientId - The client ID of an OAuth Code Authorization Grant client
|
|
6275
6297
|
* @param {string} codeVerifier - code verifier used to generate the code challenge
|
|
6276
6298
|
* @param {string} authCode - Authorization code
|
|
6277
6299
|
* @param {string} redirectUri - Authorized redirect URI for your Code Authorization client
|
|
6278
|
-
*/},{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:"
|
|
6300
|
+
*/},{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
|
|
6279
6301
|
request.then(function(response){// Logging
|
|
6280
|
-
_this5.config.logger.log('trace',response.status,'POST',"
|
|
6302
|
+
_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
|
|
6281
6303
|
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
|
|
6282
6304
|
resolve(_this5.authData);})["catch"](function(error){// Log error
|
|
6283
|
-
if(error.response){_this5.config.logger.log('error',error.response.status,'POST',"
|
|
6305
|
+
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);});});}/**
|
|
6284
6306
|
* @description Generate a random string used as PKCE Code Verifier - length = 43 to 128.
|
|
6285
6307
|
* @param {number} nChar - code length
|
|
6286
6308
|
*/},{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
|
|
@@ -6346,15 +6368,15 @@ _this8._handleCodeAuthorizationResponse(request,bodyParam,resolve,reject);});}/*
|
|
|
6346
6368
|
* @param {object} bodyParam - Input body data for authorization request
|
|
6347
6369
|
* @param {function} resolve - Promise resolve callback
|
|
6348
6370
|
* @param {function} reject - Promise reject callback
|
|
6349
|
-
*/},{key:"_handleCodeAuthorizationResponse",value:function _handleCodeAuthorizationResponse(request,bodyParam,resolve,reject){var _this9=this;request.then(function(response){// Logging
|
|
6350
|
-
_this9.config.logger.log('trace',response.status,'POST',"
|
|
6371
|
+
*/},{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
|
|
6372
|
+
_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
|
|
6351
6373
|
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
|
|
6352
6374
|
resolve(_this9.authData);})["catch"](function(error){// Log error
|
|
6353
|
-
if(error.response){_this9.config.logger.log('error',error.response.status,'POST',"
|
|
6375
|
+
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);});}/**
|
|
6354
6376
|
* @description Utility function to create the request for auth requests
|
|
6355
6377
|
* @param {string} encodedData - Base64 encoded client and clientSecret pair
|
|
6356
6378
|
* @param {object} data - data to url form encode
|
|
6357
|
-
*/},{key:"_formAuthRequest",value:function _formAuthRequest(encodedData,data){var request=axios$1({method:"POST",url:"
|
|
6379
|
+
*/},{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;}/**
|
|
6358
6380
|
* @description Handles an expired access token. Only available in node apps.
|
|
6359
6381
|
* @param {string} statusCode - The status code of a request
|
|
6360
6382
|
*/},{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
|
|
@@ -6393,7 +6415,7 @@ this.setAccessToken(this.authentications['PureCloud OAuth'].accessToken);}/**
|
|
|
6393
6415
|
* @description Constructs a URL to the auth server
|
|
6394
6416
|
* @param {string} path - The path for the URL
|
|
6395
6417
|
* @param {object} query - An object of key/value pairs to use for querystring keys/values
|
|
6396
|
-
*/},{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(
|
|
6418
|
+
*/},{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,"?"));}/**
|
|
6397
6419
|
* Returns a string representation for an actual parameter.
|
|
6398
6420
|
* @param param The actual parameter.
|
|
6399
6421
|
* @returns {String} The string representation of <code>param</code>.
|
|
@@ -6412,7 +6434,7 @@ this.setAccessToken(this.authentications['PureCloud OAuth'].accessToken);}/**
|
|
|
6412
6434
|
* @param {String} path The path to append to the base URL.
|
|
6413
6435
|
* @param {Object} pathParams The parameter values to append.
|
|
6414
6436
|
* @returns {String} The encoded path with parameter values substituted.
|
|
6415
|
-
*/},{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;}/**
|
|
6437
|
+
*/},{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;}/**
|
|
6416
6438
|
* Checks whether the given content type represents JSON.<br>
|
|
6417
6439
|
* JSON content type examples:<br>
|
|
6418
6440
|
* <ul>
|
|
@@ -6480,7 +6502,7 @@ resolve(data);})["catch"](function(error){var data=error;if(error.response&&erro
|
|
|
6480
6502
|
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(){/**
|
|
6481
6503
|
* AgentAssistants service.
|
|
6482
6504
|
* @module purecloud-platform-client-v2/api/AgentAssistantsApi
|
|
6483
|
-
* @version
|
|
6505
|
+
* @version 207.0.0
|
|
6484
6506
|
*//**
|
|
6485
6507
|
* Constructs a new AgentAssistantsApi.
|
|
6486
6508
|
* @alias module:purecloud-platform-client-v2/api/AgentAssistantsApi
|
|
@@ -6581,7 +6603,7 @@ if(queueId===undefined||queueId===null){throw'Missing the required parameter "qu
|
|
|
6581
6603
|
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(){/**
|
|
6582
6604
|
* AgentCopilot service.
|
|
6583
6605
|
* @module purecloud-platform-client-v2/api/AgentCopilotApi
|
|
6584
|
-
* @version
|
|
6606
|
+
* @version 207.0.0
|
|
6585
6607
|
*//**
|
|
6586
6608
|
* Constructs a new AgentCopilotApi.
|
|
6587
6609
|
* @alias module:purecloud-platform-client-v2/api/AgentCopilotApi
|
|
@@ -6603,7 +6625,7 @@ if(assistantId===undefined||assistantId===null){throw'Missing the required param
|
|
|
6603
6625
|
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(){/**
|
|
6604
6626
|
* AgentUI service.
|
|
6605
6627
|
* @module purecloud-platform-client-v2/api/AgentUIApi
|
|
6606
|
-
* @version
|
|
6628
|
+
* @version 207.0.0
|
|
6607
6629
|
*//**
|
|
6608
6630
|
* Constructs a new AgentUIApi.
|
|
6609
6631
|
* @alias module:purecloud-platform-client-v2/api/AgentUIApi
|
|
@@ -6637,7 +6659,7 @@ if(agentId===undefined||agentId===null){throw'Missing the required parameter "ag
|
|
|
6637
6659
|
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(){/**
|
|
6638
6660
|
* Alerting service.
|
|
6639
6661
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
6640
|
-
* @version
|
|
6662
|
+
* @version 207.0.0
|
|
6641
6663
|
*//**
|
|
6642
6664
|
* Constructs a new AlertingApi.
|
|
6643
6665
|
* @alias module:purecloud-platform-client-v2/api/AlertingApi
|
|
@@ -6794,7 +6816,7 @@ if(ruleId===undefined||ruleId===null){throw'Missing the required parameter "rule
|
|
|
6794
6816
|
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(){/**
|
|
6795
6817
|
* Analytics service.
|
|
6796
6818
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
6797
|
-
* @version
|
|
6819
|
+
* @version 207.0.0
|
|
6798
6820
|
*//**
|
|
6799
6821
|
* Constructs a new AnalyticsApi.
|
|
6800
6822
|
* @alias module:purecloud-platform-client-v2/api/AnalyticsApi
|
|
@@ -7018,7 +7040,8 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
7018
7040
|
* @param {Number} opts.pageSize (default to 25)
|
|
7019
7041
|
* @param {Array.<String>} opts.id A list of user IDs to fetch by bulk
|
|
7020
7042
|
* @param {Object} opts.state Only list users of this state
|
|
7021
|
-
|
|
7043
|
+
* @param {Boolean} opts.deletedOnly Only list deleted dashboards that are still recoverable
|
|
7044
|
+
*/},{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']);}/**
|
|
7022
7045
|
* Get all view export requests for a user
|
|
7023
7046
|
*
|
|
7024
7047
|
* @param {Object} opts Optional parameters
|
|
@@ -7052,9 +7075,10 @@ if(dashboardAccessFilter===undefined||dashboardAccessFilter===null){throw'Missin
|
|
|
7052
7075
|
* @param {Number} opts.pageSize (default to 50)
|
|
7053
7076
|
* @param {Boolean} opts.publicOnly If true, retrieve only public dashboards
|
|
7054
7077
|
* @param {Boolean} opts.favoriteOnly If true, retrieve only favorite dashboards
|
|
7078
|
+
* @param {Boolean} opts.deletedOnly If true, retrieve only deleted dashboards that are still recoverable
|
|
7055
7079
|
* @param {String} opts.name retrieve dashboards that match with given name
|
|
7056
7080
|
*/},{key:"getAnalyticsReportingSettingsUserDashboards",value:function getAnalyticsReportingSettingsUserDashboards(userId,opts){opts=opts||{};// verify the required parameter 'userId' is set
|
|
7057
|
-
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']);}/**
|
|
7081
|
+
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']);}/**
|
|
7058
7082
|
* Get status for async query for resolution aggregates
|
|
7059
7083
|
*
|
|
7060
7084
|
* @param {String} jobId jobId
|
|
@@ -7298,7 +7322,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
7298
7322
|
* @param {Object} body query
|
|
7299
7323
|
*/},{key:"postAnalyticsRatelimitsAggregatesQuery",value:function postAnalyticsRatelimitsAggregatesQuery(body){// verify the required parameter 'body' is set
|
|
7300
7324
|
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']);}/**
|
|
7301
|
-
* Bulk delete dashboards owned by other user(s)
|
|
7325
|
+
* Bulk soft delete dashboards owned by other user(s)
|
|
7302
7326
|
*
|
|
7303
7327
|
* @param {Array.<String>} body List of userIds
|
|
7304
7328
|
*/},{key:"postAnalyticsReportingDashboardsUsersBulkRemove",value:function postAnalyticsReportingDashboardsUsersBulkRemove(body){// verify the required parameter 'body' is set
|
|
@@ -7308,7 +7332,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
7308
7332
|
* @param {Object} body ReportingExportJobRequest
|
|
7309
7333
|
*/},{key:"postAnalyticsReportingExports",value:function postAnalyticsReportingExports(body){// verify the required parameter 'body' is set
|
|
7310
7334
|
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']);}/**
|
|
7311
|
-
* Bulk
|
|
7335
|
+
* Bulk soft delete dashboard configurations
|
|
7312
7336
|
*
|
|
7313
7337
|
* @param {Object} body
|
|
7314
7338
|
*/},{key:"postAnalyticsReportingSettingsDashboardsBulkRemove",value:function postAnalyticsReportingSettingsDashboardsBulkRemove(body){// verify the required parameter 'body' is set
|
|
@@ -7352,7 +7376,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
7352
7376
|
* Query for task management aggregates
|
|
7353
7377
|
*
|
|
7354
7378
|
* @param {Object} body query
|
|
7355
|
-
* postAnalyticsTaskmanagementAggregatesQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
7356
7379
|
*/},{key:"postAnalyticsTaskmanagementAggregatesQuery",value:function postAnalyticsTaskmanagementAggregatesQuery(body){// verify the required parameter 'body' is set
|
|
7357
7380
|
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']);}/**
|
|
7358
7381
|
* Query for team activity observations
|
|
@@ -7415,7 +7438,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
7415
7438
|
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(){/**
|
|
7416
7439
|
* Architect service.
|
|
7417
7440
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
7418
|
-
* @version
|
|
7441
|
+
* @version 207.0.0
|
|
7419
7442
|
*//**
|
|
7420
7443
|
* Constructs a new ArchitectApi.
|
|
7421
7444
|
* @alias module:purecloud-platform-client-v2/api/ArchitectApi
|
|
@@ -7905,7 +7928,7 @@ if(flowId===undefined||flowId===null){throw'Missing the required parameter "flow
|
|
|
7905
7928
|
*/},{key:"getFlowVersion",value:function getFlowVersion(flowId,versionId,opts){opts=opts||{};// verify the required parameter 'flowId' is set
|
|
7906
7929
|
if(flowId===undefined||flowId===null){throw'Missing the required parameter "flowId" when calling getFlowVersion';}// verify the required parameter 'versionId' is set
|
|
7907
7930
|
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']);}/**
|
|
7908
|
-
*
|
|
7931
|
+
* Get flow version configuration
|
|
7909
7932
|
*
|
|
7910
7933
|
* @param {String} flowId Flow ID
|
|
7911
7934
|
* @param {String} versionId Version ID
|
|
@@ -8507,7 +8530,7 @@ if(milestoneId===undefined||milestoneId===null){throw'Missing the required param
|
|
|
8507
8530
|
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(){/**
|
|
8508
8531
|
* Audit service.
|
|
8509
8532
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
8510
|
-
* @version
|
|
8533
|
+
* @version 207.0.0
|
|
8511
8534
|
*//**
|
|
8512
8535
|
* Constructs a new AuditApi.
|
|
8513
8536
|
* @alias module:purecloud-platform-client-v2/api/AuditApi
|
|
@@ -8557,7 +8580,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
8557
8580
|
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(){/**
|
|
8558
8581
|
* Authorization service.
|
|
8559
8582
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
8560
|
-
* @version
|
|
8583
|
+
* @version 207.0.0
|
|
8561
8584
|
*//**
|
|
8562
8585
|
* Constructs a new AuthorizationApi.
|
|
8563
8586
|
* @alias module:purecloud-platform-client-v2/api/AuthorizationApi
|
|
@@ -8880,7 +8903,7 @@ if(subjectId===undefined||subjectId===null){throw'Missing the required parameter
|
|
|
8880
8903
|
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(){/**
|
|
8881
8904
|
* Billing service.
|
|
8882
8905
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
8883
|
-
* @version
|
|
8906
|
+
* @version 207.0.0
|
|
8884
8907
|
*//**
|
|
8885
8908
|
* Constructs a new BillingApi.
|
|
8886
8909
|
* @alias module:purecloud-platform-client-v2/api/BillingApi
|
|
@@ -8904,7 +8927,7 @@ if(endDate===undefined||endDate===null){throw'Missing the required parameter "en
|
|
|
8904
8927
|
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(){/**
|
|
8905
8928
|
* CarrierServices service.
|
|
8906
8929
|
* @module purecloud-platform-client-v2/api/CarrierServicesApi
|
|
8907
|
-
* @version
|
|
8930
|
+
* @version 207.0.0
|
|
8908
8931
|
*//**
|
|
8909
8932
|
* Constructs a new CarrierServicesApi.
|
|
8910
8933
|
* @alias module:purecloud-platform-client-v2/api/CarrierServicesApi
|
|
@@ -8924,7 +8947,7 @@ if(phoneNumber===undefined||phoneNumber===null){throw'Missing the required param
|
|
|
8924
8947
|
*/},{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(){/**
|
|
8925
8948
|
* Chat service.
|
|
8926
8949
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
8927
|
-
* @version
|
|
8950
|
+
* @version 207.0.0
|
|
8928
8951
|
*//**
|
|
8929
8952
|
* Constructs a new ChatApi.
|
|
8930
8953
|
* @alias module:purecloud-platform-client-v2/api/ChatApi
|
|
@@ -9149,7 +9172,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
9149
9172
|
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(){/**
|
|
9150
9173
|
* Coaching service.
|
|
9151
9174
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
9152
|
-
* @version
|
|
9175
|
+
* @version 207.0.0
|
|
9153
9176
|
*//**
|
|
9154
9177
|
* Constructs a new CoachingApi.
|
|
9155
9178
|
* @alias module:purecloud-platform-client-v2/api/CoachingApi
|
|
@@ -9302,7 +9325,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
9302
9325
|
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(){/**
|
|
9303
9326
|
* ContentManagement service.
|
|
9304
9327
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
9305
|
-
* @version
|
|
9328
|
+
* @version 207.0.0
|
|
9306
9329
|
*//**
|
|
9307
9330
|
* Constructs a new ContentManagementApi.
|
|
9308
9331
|
* @alias module:purecloud-platform-client-v2/api/ContentManagementApi
|
|
@@ -9406,12 +9429,11 @@ if(shareId===undefined||shareId===null){throw'Missing the required parameter "sh
|
|
|
9406
9429
|
* 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.
|
|
9407
9430
|
* @param {String} sharedId Shared ID
|
|
9408
9431
|
* @param {Object} opts Optional parameters
|
|
9409
|
-
* @param {Boolean} opts.redirect Turn on or off redirect (default to true)
|
|
9410
9432
|
* @param {Object} opts.disposition Request how the share content will be downloaded: attached as a file or inline. Default is attachment. (default to attachment)
|
|
9411
9433
|
* @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
|
|
9412
9434
|
* @param {Object} opts.expand Expand some document fields
|
|
9413
9435
|
*/},{key:"getContentmanagementSharedSharedId",value:function getContentmanagementSharedSharedId(sharedId,opts){opts=opts||{};// verify the required parameter 'sharedId' is set
|
|
9414
|
-
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},{'
|
|
9436
|
+
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']);}/**
|
|
9415
9437
|
* Gets a list of shares. You must specify at least one filter (e.g. entityId).
|
|
9416
9438
|
* Failing to specify a filter will return 400.
|
|
9417
9439
|
* @param {Object} opts Optional parameters
|
|
@@ -9585,7 +9607,7 @@ if(tagId===undefined||tagId===null){throw'Missing the required parameter "tagId"
|
|
|
9585
9607
|
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(){/**
|
|
9586
9608
|
* Conversations service.
|
|
9587
9609
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
9588
|
-
* @version
|
|
9610
|
+
* @version 207.0.0
|
|
9589
9611
|
*//**
|
|
9590
9612
|
* Constructs a new ConversationsApi.
|
|
9591
9613
|
* @alias module:purecloud-platform-client-v2/api/ConversationsApi
|
|
@@ -10499,7 +10521,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
10499
10521
|
* @param {String} conversationId conversationId
|
|
10500
10522
|
* @param {String} participantId participantId
|
|
10501
10523
|
* @param {Object} body Parking update request
|
|
10502
|
-
* patchConversationsEmailParticipantParkingstate is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
10503
10524
|
*/},{key:"patchConversationsEmailParticipantParkingstate",value:function patchConversationsEmailParticipantParkingstate(conversationId,participantId,body){// verify the required parameter 'conversationId' is set
|
|
10504
10525
|
if(conversationId===undefined||conversationId===null){throw'Missing the required parameter "conversationId" when calling patchConversationsEmailParticipantParkingstate';}// verify the required parameter 'participantId' is set
|
|
10505
10526
|
if(participantId===undefined||participantId===null){throw'Missing the required parameter "participantId" when calling patchConversationsEmailParticipantParkingstate';}// verify the required parameter 'body' is set
|
|
@@ -10725,9 +10746,10 @@ if(conversationId===undefined||conversationId===null){throw'Missing the required
|
|
|
10725
10746
|
if(suggestionId===undefined||suggestionId===null){throw'Missing the required parameter "suggestionId" when calling postConversationSuggestionEngagement';}// verify the required parameter 'body' is set
|
|
10726
10747
|
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']);}/**
|
|
10727
10748
|
* Suggestion feedback.
|
|
10728
|
-
*
|
|
10749
|
+
* Google Agent Assist offering within Genesys will no longer be supported
|
|
10729
10750
|
* @param {String} conversationId Conversation ID
|
|
10730
10751
|
* @param {Object} body SuggestionFeedback
|
|
10752
|
+
* @deprecated
|
|
10731
10753
|
*/},{key:"postConversationSuggestionsFeedback",value:function postConversationSuggestionsFeedback(conversationId,body){// verify the required parameter 'conversationId' is set
|
|
10732
10754
|
if(conversationId===undefined||conversationId===null){throw'Missing the required parameter "conversationId" when calling postConversationSuggestionsFeedback';}// verify the required parameter 'body' is set
|
|
10733
10755
|
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']);}/**
|
|
@@ -11043,9 +11065,11 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
11043
11065
|
* 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.
|
|
11044
11066
|
* @param {String} integrationId integrationId
|
|
11045
11067
|
* @param {Object} body NormalizedMessage
|
|
11046
|
-
|
|
11068
|
+
* @param {Object} opts Optional parameters
|
|
11069
|
+
* @param {Boolean} opts.prefetchConversationId Indicates whether or not to prefetch conversationId (default to false)
|
|
11070
|
+
*/},{key:"postConversationsMessageInboundOpenMessage",value:function postConversationsMessageInboundOpenMessage(integrationId,body,opts){opts=opts||{};// verify the required parameter 'integrationId' is set
|
|
11047
11071
|
if(integrationId===undefined||integrationId===null){throw'Missing the required parameter "integrationId" when calling postConversationsMessageInboundOpenMessage';}// verify the required parameter 'body' is set
|
|
11048
|
-
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']);}/**
|
|
11072
|
+
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']);}/**
|
|
11049
11073
|
* Send an inbound Open Receipt Message
|
|
11050
11074
|
* 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.
|
|
11051
11075
|
* @param {String} integrationId integrationId
|
|
@@ -11312,7 +11336,7 @@ if(conversationId===undefined||conversationId===null){throw'Missing the required
|
|
|
11312
11336
|
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(){/**
|
|
11313
11337
|
* DataExtensions service.
|
|
11314
11338
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
11315
|
-
* @version
|
|
11339
|
+
* @version 207.0.0
|
|
11316
11340
|
*//**
|
|
11317
11341
|
* Constructs a new DataExtensionsApi.
|
|
11318
11342
|
* @alias module:purecloud-platform-client-v2/api/DataExtensionsApi
|
|
@@ -11333,7 +11357,7 @@ if(coretypeName===undefined||coretypeName===null){throw'Missing the required par
|
|
|
11333
11357
|
*/},{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(){/**
|
|
11334
11358
|
* Downloads service.
|
|
11335
11359
|
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
11336
|
-
* @version
|
|
11360
|
+
* @version 207.0.0
|
|
11337
11361
|
*//**
|
|
11338
11362
|
* Constructs a new DownloadsApi.
|
|
11339
11363
|
* @alias module:purecloud-platform-client-v2/api/DownloadsApi
|
|
@@ -11352,7 +11376,7 @@ if(coretypeName===undefined||coretypeName===null){throw'Missing the required par
|
|
|
11352
11376
|
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(){/**
|
|
11353
11377
|
* Emails service.
|
|
11354
11378
|
* @module purecloud-platform-client-v2/api/EmailsApi
|
|
11355
|
-
* @version
|
|
11379
|
+
* @version 207.0.0
|
|
11356
11380
|
*//**
|
|
11357
11381
|
* Constructs a new EmailsApi.
|
|
11358
11382
|
* @alias module:purecloud-platform-client-v2/api/EmailsApi
|
|
@@ -11370,7 +11394,7 @@ if(downloadId===undefined||downloadId===null){throw'Missing the required paramet
|
|
|
11370
11394
|
*/},{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(){/**
|
|
11371
11395
|
* EmployeeEngagement service.
|
|
11372
11396
|
* @module purecloud-platform-client-v2/api/EmployeeEngagementApi
|
|
11373
|
-
* @version
|
|
11397
|
+
* @version 207.0.0
|
|
11374
11398
|
*//**
|
|
11375
11399
|
* Constructs a new EmployeeEngagementApi.
|
|
11376
11400
|
* @alias module:purecloud-platform-client-v2/api/EmployeeEngagementApi
|
|
@@ -11408,7 +11432,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
11408
11432
|
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(){/**
|
|
11409
11433
|
* Events service.
|
|
11410
11434
|
* @module purecloud-platform-client-v2/api/EventsApi
|
|
11411
|
-
* @version
|
|
11435
|
+
* @version 207.0.0
|
|
11412
11436
|
*//**
|
|
11413
11437
|
* Constructs a new EventsApi.
|
|
11414
11438
|
* @alias module:purecloud-platform-client-v2/api/EventsApi
|
|
@@ -11433,7 +11457,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
11433
11457
|
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(){/**
|
|
11434
11458
|
* ExternalContacts service.
|
|
11435
11459
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
11436
|
-
* @version
|
|
11460
|
+
* @version 207.0.0
|
|
11437
11461
|
*//**
|
|
11438
11462
|
* Constructs a new ExternalContactsApi.
|
|
11439
11463
|
* @alias module:purecloud-platform-client-v2/api/ExternalContactsApi
|
|
@@ -11464,6 +11488,11 @@ if(schemaId===undefined||schemaId===null){throw'Missing the required parameter "
|
|
|
11464
11488
|
* deleteExternalcontactsExternalsource is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
11465
11489
|
*/},{key:"deleteExternalcontactsExternalsource",value:function deleteExternalcontactsExternalsource(externalSourceId){// verify the required parameter 'externalSourceId' is set
|
|
11466
11490
|
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']);}/**
|
|
11491
|
+
* Delete settings for CSV import
|
|
11492
|
+
*
|
|
11493
|
+
* @param {String} settingsId Settings id
|
|
11494
|
+
*/},{key:"deleteExternalcontactsImportCsvSetting",value:function deleteExternalcontactsImportCsvSetting(settingsId){// verify the required parameter 'settingsId' is set
|
|
11495
|
+
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']);}/**
|
|
11467
11496
|
* Delete an external organization
|
|
11468
11497
|
*
|
|
11469
11498
|
* @param {String} externalOrganizationId External Organization ID
|
|
@@ -11577,6 +11606,28 @@ if(externalSourceId===undefined||externalSourceId===null){throw'Missing the requ
|
|
|
11577
11606
|
* @param {Boolean} opts.active Filter by active status of external source
|
|
11578
11607
|
* getExternalcontactsExternalsources is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
11579
11608
|
*/},{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']);}/**
|
|
11609
|
+
* Get settings for CSV import
|
|
11610
|
+
*
|
|
11611
|
+
* @param {String} settingsId Settings id
|
|
11612
|
+
*/},{key:"getExternalcontactsImportCsvSetting",value:function getExternalcontactsImportCsvSetting(settingsId){// verify the required parameter 'settingsId' is set
|
|
11613
|
+
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']);}/**
|
|
11614
|
+
* Retrieve all settings for organization filtered by externalSettingsId if provided
|
|
11615
|
+
*
|
|
11616
|
+
* @param {Object} opts Optional parameters
|
|
11617
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
11618
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
11619
|
+
* @param {String} opts.externalSettingsId External Settings Id to filter the list.
|
|
11620
|
+
*/},{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']);}/**
|
|
11621
|
+
* Get details for CSV upload
|
|
11622
|
+
*
|
|
11623
|
+
* @param {String} uploadId Upload id
|
|
11624
|
+
*/},{key:"getExternalcontactsImportCsvUploadDetails",value:function getExternalcontactsImportCsvUploadDetails(uploadId){// verify the required parameter 'uploadId' is set
|
|
11625
|
+
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']);}/**
|
|
11626
|
+
* Get preview for CSV upload
|
|
11627
|
+
*
|
|
11628
|
+
* @param {String} uploadId Upload id
|
|
11629
|
+
*/},{key:"getExternalcontactsImportCsvUploadPreview",value:function getExternalcontactsImportCsvUploadPreview(uploadId){// verify the required parameter 'uploadId' is set
|
|
11630
|
+
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']);}/**
|
|
11580
11631
|
* Fetch an external organization
|
|
11581
11632
|
*
|
|
11582
11633
|
* @param {String} externalOrganizationId External Organization ID
|
|
@@ -11821,6 +11872,21 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
11821
11872
|
* @param {Array.<String>} opts.expand which field, if any, to expand
|
|
11822
11873
|
*/},{key:"postExternalcontactsIdentifierlookup",value:function postExternalcontactsIdentifierlookup(identifier,opts){opts=opts||{};// verify the required parameter 'identifier' is set
|
|
11823
11874
|
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']);}/**
|
|
11875
|
+
* Create CSV import job
|
|
11876
|
+
*
|
|
11877
|
+
* @param {Object} body ImportRequest
|
|
11878
|
+
*/},{key:"postExternalcontactsImportCsvJobs",value:function postExternalcontactsImportCsvJobs(body){// verify the required parameter 'body' is set
|
|
11879
|
+
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']);}/**
|
|
11880
|
+
* Create settings for CSV import
|
|
11881
|
+
*
|
|
11882
|
+
* @param {Object} body Settings
|
|
11883
|
+
*/},{key:"postExternalcontactsImportCsvSettings",value:function postExternalcontactsImportCsvSettings(body){// verify the required parameter 'body' is set
|
|
11884
|
+
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']);}/**
|
|
11885
|
+
* Get url for CSV upload
|
|
11886
|
+
*
|
|
11887
|
+
* @param {Object} body UploadRequest
|
|
11888
|
+
*/},{key:"postExternalcontactsImportCsvUploads",value:function postExternalcontactsImportCsvUploads(body){// verify the required parameter 'body' is set
|
|
11889
|
+
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']);}/**
|
|
11824
11890
|
* Merge two contacts into a new contact record
|
|
11825
11891
|
* Two curated contacts cannot be merged. Refer to the Contact Merging article on the Developer Center for details
|
|
11826
11892
|
* @param {Object} body MergeRequest
|
|
@@ -11886,6 +11952,13 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
11886
11952
|
*/},{key:"putExternalcontactsExternalsource",value:function putExternalcontactsExternalsource(externalSourceId,body){// verify the required parameter 'externalSourceId' is set
|
|
11887
11953
|
if(externalSourceId===undefined||externalSourceId===null){throw'Missing the required parameter "externalSourceId" when calling putExternalcontactsExternalsource';}// verify the required parameter 'body' is set
|
|
11888
11954
|
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']);}/**
|
|
11955
|
+
* Update settings for CSV import
|
|
11956
|
+
*
|
|
11957
|
+
* @param {String} settingsId Settings id
|
|
11958
|
+
* @param {Object} body Settings
|
|
11959
|
+
*/},{key:"putExternalcontactsImportCsvSetting",value:function putExternalcontactsImportCsvSetting(settingsId,body){// verify the required parameter 'settingsId' is set
|
|
11960
|
+
if(settingsId===undefined||settingsId===null){throw'Missing the required parameter "settingsId" when calling putExternalcontactsImportCsvSetting';}// verify the required parameter 'body' is set
|
|
11961
|
+
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']);}/**
|
|
11889
11962
|
* Update an external organization
|
|
11890
11963
|
*
|
|
11891
11964
|
* @param {String} externalOrganizationId External Organization ID
|
|
@@ -11925,7 +11998,7 @@ if(relationshipId===undefined||relationshipId===null){throw'Missing the required
|
|
|
11925
11998
|
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(){/**
|
|
11926
11999
|
* Fax service.
|
|
11927
12000
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
11928
|
-
* @version
|
|
12001
|
+
* @version 207.0.0
|
|
11929
12002
|
*//**
|
|
11930
12003
|
* Constructs a new FaxApi.
|
|
11931
12004
|
* @alias module:purecloud-platform-client-v2/api/FaxApi
|
|
@@ -11974,7 +12047,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
11974
12047
|
*/},{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(){/**
|
|
11975
12048
|
* Flows service.
|
|
11976
12049
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
11977
|
-
* @version
|
|
12050
|
+
* @version 207.0.0
|
|
11978
12051
|
*//**
|
|
11979
12052
|
* Constructs a new FlowsApi.
|
|
11980
12053
|
* @alias module:purecloud-platform-client-v2/api/FlowsApi
|
|
@@ -12022,7 +12095,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
12022
12095
|
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(){/**
|
|
12023
12096
|
* Gamification service.
|
|
12024
12097
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
12025
|
-
* @version
|
|
12098
|
+
* @version 207.0.0
|
|
12026
12099
|
*//**
|
|
12027
12100
|
* Constructs a new GamificationApi.
|
|
12028
12101
|
* @alias module:purecloud-platform-client-v2/api/GamificationApi
|
|
@@ -12562,7 +12635,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
12562
12635
|
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(){/**
|
|
12563
12636
|
* GeneralDataProtectionRegulation service.
|
|
12564
12637
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
12565
|
-
* @version
|
|
12638
|
+
* @version 207.0.0
|
|
12566
12639
|
*//**
|
|
12567
12640
|
* Constructs a new GeneralDataProtectionRegulationApi.
|
|
12568
12641
|
* @alias module:purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
@@ -12597,7 +12670,7 @@ if(searchValue===undefined||searchValue===null){throw'Missing the required param
|
|
|
12597
12670
|
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(){/**
|
|
12598
12671
|
* Geolocation service.
|
|
12599
12672
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
12600
|
-
* @version
|
|
12673
|
+
* @version 207.0.0
|
|
12601
12674
|
*//**
|
|
12602
12675
|
* Constructs a new GeolocationApi.
|
|
12603
12676
|
* @alias module:purecloud-platform-client-v2/api/GeolocationApi
|
|
@@ -12631,7 +12704,7 @@ if(clientId===undefined||clientId===null){throw'Missing the required parameter "
|
|
|
12631
12704
|
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(){/**
|
|
12632
12705
|
* Greetings service.
|
|
12633
12706
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
12634
|
-
* @version
|
|
12707
|
+
* @version 207.0.0
|
|
12635
12708
|
*//**
|
|
12636
12709
|
* Constructs a new GreetingsApi.
|
|
12637
12710
|
* @alias module:purecloud-platform-client-v2/api/GreetingsApi
|
|
@@ -12738,7 +12811,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
12738
12811
|
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(){/**
|
|
12739
12812
|
* Groups service.
|
|
12740
12813
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
12741
|
-
* @version
|
|
12814
|
+
* @version 207.0.0
|
|
12742
12815
|
*//**
|
|
12743
12816
|
* Constructs a new GroupsApi.
|
|
12744
12817
|
* @alias module:purecloud-platform-client-v2/api/GroupsApi
|
|
@@ -12871,7 +12944,7 @@ if(groupId===undefined||groupId===null){throw'Missing the required parameter "gr
|
|
|
12871
12944
|
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(){/**
|
|
12872
12945
|
* IdentityProvider service.
|
|
12873
12946
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
12874
|
-
* @version
|
|
12947
|
+
* @version 207.0.0
|
|
12875
12948
|
*//**
|
|
12876
12949
|
* Constructs a new IdentityProviderApi.
|
|
12877
12950
|
* @alias module:purecloud-platform-client-v2/api/IdentityProviderApi
|
|
@@ -13027,7 +13100,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
13027
13100
|
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(){/**
|
|
13028
13101
|
* InfrastructureAsCode service.
|
|
13029
13102
|
* @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
13030
|
-
* @version
|
|
13103
|
+
* @version 207.0.0
|
|
13031
13104
|
*//**
|
|
13032
13105
|
* Constructs a new InfrastructureAsCodeApi.
|
|
13033
13106
|
* @alias module:purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
@@ -13081,7 +13154,7 @@ if(jobId===undefined||jobId===null){throw'Missing the required parameter "jobId"
|
|
|
13081
13154
|
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(){/**
|
|
13082
13155
|
* Integrations service.
|
|
13083
13156
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
13084
|
-
* @version
|
|
13157
|
+
* @version 207.0.0
|
|
13085
13158
|
*//**
|
|
13086
13159
|
* Constructs a new IntegrationsApi.
|
|
13087
13160
|
* @alias module:purecloud-platform-client-v2/api/IntegrationsApi
|
|
@@ -13706,7 +13779,7 @@ if(ucIntegrationId===undefined||ucIntegrationId===null){throw'Missing the requir
|
|
|
13706
13779
|
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(){/**
|
|
13707
13780
|
* Journey service.
|
|
13708
13781
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
13709
|
-
* @version
|
|
13782
|
+
* @version 207.0.0
|
|
13710
13783
|
*//**
|
|
13711
13784
|
* Constructs a new JourneyApi.
|
|
13712
13785
|
* @alias module:purecloud-platform-client-v2/api/JourneyApi
|
|
@@ -13918,6 +13991,26 @@ if(viewId===undefined||viewId===null){throw'Missing the required parameter "view
|
|
|
13918
13991
|
*/},{key:"getJourneyViewVersion",value:function getJourneyViewVersion(viewId,versionId){// verify the required parameter 'viewId' is set
|
|
13919
13992
|
if(viewId===undefined||viewId===null){throw'Missing the required parameter "viewId" when calling getJourneyViewVersion';}// verify the required parameter 'versionId' is set
|
|
13920
13993
|
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']);}/**
|
|
13994
|
+
* Get a Chart by ID
|
|
13995
|
+
* returns the latest version
|
|
13996
|
+
* @param {String} viewId viewId
|
|
13997
|
+
* @param {String} journeyViewVersion Journey View Version
|
|
13998
|
+
* @param {String} chartId chartId
|
|
13999
|
+
*/},{key:"getJourneyViewVersionChart",value:function getJourneyViewVersionChart(viewId,journeyViewVersion,chartId){// verify the required parameter 'viewId' is set
|
|
14000
|
+
if(viewId===undefined||viewId===null){throw'Missing the required parameter "viewId" when calling getJourneyViewVersionChart';}// verify the required parameter 'journeyViewVersion' is set
|
|
14001
|
+
if(journeyViewVersion===undefined||journeyViewVersion===null){throw'Missing the required parameter "journeyViewVersion" when calling getJourneyViewVersionChart';}// verify the required parameter 'chartId' is set
|
|
14002
|
+
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']);}/**
|
|
14003
|
+
* Get a Chart by ID and version
|
|
14004
|
+
*
|
|
14005
|
+
* @param {String} viewId viewId
|
|
14006
|
+
* @param {String} journeyViewVersion Journey View Version
|
|
14007
|
+
* @param {String} chartId chartId
|
|
14008
|
+
* @param {String} chartVersion chartVersion
|
|
14009
|
+
*/},{key:"getJourneyViewVersionChartVersion",value:function getJourneyViewVersionChartVersion(viewId,journeyViewVersion,chartId,chartVersion){// verify the required parameter 'viewId' is set
|
|
14010
|
+
if(viewId===undefined||viewId===null){throw'Missing the required parameter "viewId" when calling getJourneyViewVersionChartVersion';}// verify the required parameter 'journeyViewVersion' is set
|
|
14011
|
+
if(journeyViewVersion===undefined||journeyViewVersion===null){throw'Missing the required parameter "journeyViewVersion" when calling getJourneyViewVersionChartVersion';}// verify the required parameter 'chartId' is set
|
|
14012
|
+
if(chartId===undefined||chartId===null){throw'Missing the required parameter "chartId" when calling getJourneyViewVersionChartVersion';}// verify the required parameter 'chartVersion' is set
|
|
14013
|
+
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']);}/**
|
|
13921
14014
|
* Get the job for a journey view version.
|
|
13922
14015
|
* used for long descriptions
|
|
13923
14016
|
* @param {String} viewId Journey View Id
|
|
@@ -13936,6 +14029,17 @@ if(jobId===undefined||jobId===null){throw'Missing the required parameter "jobId"
|
|
|
13936
14029
|
if(viewId===undefined||viewId===null){throw'Missing the required parameter "viewId" when calling getJourneyViewVersionJobResults';}// verify the required parameter 'journeyViewVersion' is set
|
|
13937
14030
|
if(journeyViewVersion===undefined||journeyViewVersion===null){throw'Missing the required parameter "journeyViewVersion" when calling getJourneyViewVersionJobResults';}// verify the required parameter 'jobId' is set
|
|
13938
14031
|
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']);}/**
|
|
14032
|
+
* Get the chart result associated with a journey view job.
|
|
14033
|
+
*
|
|
14034
|
+
* @param {String} viewId Journey View Id
|
|
14035
|
+
* @param {String} journeyVersionId Journey View Version
|
|
14036
|
+
* @param {String} jobId JobId
|
|
14037
|
+
* @param {String} chartId ChartId
|
|
14038
|
+
*/},{key:"getJourneyViewVersionJobResultsChart",value:function getJourneyViewVersionJobResultsChart(viewId,journeyVersionId,jobId,chartId){// verify the required parameter 'viewId' is set
|
|
14039
|
+
if(viewId===undefined||viewId===null){throw'Missing the required parameter "viewId" when calling getJourneyViewVersionJobResultsChart';}// verify the required parameter 'journeyVersionId' is set
|
|
14040
|
+
if(journeyVersionId===undefined||journeyVersionId===null){throw'Missing the required parameter "journeyVersionId" when calling getJourneyViewVersionJobResultsChart';}// verify the required parameter 'jobId' is set
|
|
14041
|
+
if(jobId===undefined||jobId===null){throw'Missing the required parameter "jobId" when calling getJourneyViewVersionJobResultsChart';}// verify the required parameter 'chartId' is set
|
|
14042
|
+
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']);}/**
|
|
13939
14043
|
* Get the latest job of a journey view version.
|
|
13940
14044
|
* used for long descriptions
|
|
13941
14045
|
* @param {String} viewId Journey View Id
|
|
@@ -13955,12 +14059,10 @@ if(journeyVersionId===undefined||journeyVersionId===null){throw'Missing the requ
|
|
|
13955
14059
|
* Get an Event Definition
|
|
13956
14060
|
*
|
|
13957
14061
|
* @param {String} eventDefinitionId Event Definition ID
|
|
13958
|
-
* getJourneyViewsEventdefinition is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
13959
14062
|
*/},{key:"getJourneyViewsEventdefinition",value:function getJourneyViewsEventdefinition(eventDefinitionId){// verify the required parameter 'eventDefinitionId' is set
|
|
13960
14063
|
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']);}/**
|
|
13961
14064
|
* Get a list of Event Definitions
|
|
13962
14065
|
*
|
|
13963
|
-
* getJourneyViewsEventdefinitions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
13964
14066
|
*/},{key:"getJourneyViewsEventdefinitions",value:function getJourneyViewsEventdefinitions(){return this.apiClient.callApi('/api/v2/journey/views/eventdefinitions','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
13965
14067
|
* Get the jobs for an organization.
|
|
13966
14068
|
*
|
|
@@ -14005,6 +14107,17 @@ if(outcomeId===undefined||outcomeId===null){throw'Missing the required parameter
|
|
|
14005
14107
|
* @param {Object} opts.body
|
|
14006
14108
|
*/},{key:"patchJourneySegment",value:function patchJourneySegment(segmentId,opts){opts=opts||{};// verify the required parameter 'segmentId' is set
|
|
14007
14109
|
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']);}/**
|
|
14110
|
+
* Update the job for a journey view version. Only the status can be changed and only to Cancelled
|
|
14111
|
+
* used for long descriptions
|
|
14112
|
+
* @param {String} viewId Journey View Id
|
|
14113
|
+
* @param {String} journeyVersionId Journey View Version
|
|
14114
|
+
* @param {String} jobId JobId
|
|
14115
|
+
* @param {Object} body journeyViewJob
|
|
14116
|
+
*/},{key:"patchJourneyViewVersionJob",value:function patchJourneyViewVersionJob(viewId,journeyVersionId,jobId,body){// verify the required parameter 'viewId' is set
|
|
14117
|
+
if(viewId===undefined||viewId===null){throw'Missing the required parameter "viewId" when calling patchJourneyViewVersionJob';}// verify the required parameter 'journeyVersionId' is set
|
|
14118
|
+
if(journeyVersionId===undefined||journeyVersionId===null){throw'Missing the required parameter "journeyVersionId" when calling patchJourneyViewVersionJob';}// verify the required parameter 'jobId' is set
|
|
14119
|
+
if(jobId===undefined||jobId===null){throw'Missing the required parameter "jobId" when calling patchJourneyViewVersionJob';}// verify the required parameter 'body' is set
|
|
14120
|
+
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']);}/**
|
|
14008
14121
|
* Query for journey aggregates asynchronously
|
|
14009
14122
|
*
|
|
14010
14123
|
* @param {Object} body query
|
|
@@ -14101,11 +14214,19 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
14101
14214
|
* True indicates a valid encoding
|
|
14102
14215
|
* @param {Object} opts Optional parameters
|
|
14103
14216
|
* @param {Array.<Object>} opts.body
|
|
14104
|
-
|
|
14105
|
-
|
|
14217
|
+
*/},{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']);}/**
|
|
14218
|
+
* Update a Journey View by ID and version
|
|
14219
|
+
* does not create a new version
|
|
14220
|
+
* @param {String} viewId viewId
|
|
14221
|
+
* @param {String} versionId versionId
|
|
14222
|
+
* @param {Object} body JourneyView
|
|
14223
|
+
*/},{key:"putJourneyViewVersion",value:function putJourneyViewVersion(viewId,versionId,body){// verify the required parameter 'viewId' is set
|
|
14224
|
+
if(viewId===undefined||viewId===null){throw'Missing the required parameter "viewId" when calling putJourneyViewVersion';}// verify the required parameter 'versionId' is set
|
|
14225
|
+
if(versionId===undefined||versionId===null){throw'Missing the required parameter "versionId" when calling putJourneyViewVersion';}// verify the required parameter 'body' is set
|
|
14226
|
+
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(){/**
|
|
14106
14227
|
* Knowledge service.
|
|
14107
14228
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
14108
|
-
* @version
|
|
14229
|
+
* @version 207.0.0
|
|
14109
14230
|
*//**
|
|
14110
14231
|
* Constructs a new KnowledgeApi.
|
|
14111
14232
|
* @alias module:purecloud-platform-client-v2/api/KnowledgeApi
|
|
@@ -14196,7 +14317,6 @@ if(importId===undefined||importId===null){throw'Missing the required parameter "
|
|
|
14196
14317
|
*
|
|
14197
14318
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
14198
14319
|
* @param {String} sourceId Source ID
|
|
14199
|
-
* deleteKnowledgeKnowledgebaseSourcesSalesforceSourceId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
14200
14320
|
*/},{key:"deleteKnowledgeKnowledgebaseSourcesSalesforceSourceId",value:function deleteKnowledgeKnowledgebaseSourcesSalesforceSourceId(knowledgeBaseId,sourceId){// verify the required parameter 'knowledgeBaseId' is set
|
|
14201
14321
|
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling deleteKnowledgeKnowledgebaseSourcesSalesforceSourceId';}// verify the required parameter 'sourceId' is set
|
|
14202
14322
|
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']);}/**
|
|
@@ -14204,7 +14324,6 @@ if(sourceId===undefined||sourceId===null){throw'Missing the required parameter "
|
|
|
14204
14324
|
*
|
|
14205
14325
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
14206
14326
|
* @param {String} sourceId Source ID
|
|
14207
|
-
* deleteKnowledgeKnowledgebaseSourcesServicenowSourceId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
14208
14327
|
*/},{key:"deleteKnowledgeKnowledgebaseSourcesServicenowSourceId",value:function deleteKnowledgeKnowledgebaseSourcesServicenowSourceId(knowledgeBaseId,sourceId){// verify the required parameter 'knowledgeBaseId' is set
|
|
14209
14328
|
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling deleteKnowledgeKnowledgebaseSourcesServicenowSourceId';}// verify the required parameter 'sourceId' is set
|
|
14210
14329
|
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']);}/**
|
|
@@ -14212,7 +14331,6 @@ if(sourceId===undefined||sourceId===null){throw'Missing the required parameter "
|
|
|
14212
14331
|
*
|
|
14213
14332
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
14214
14333
|
* @param {String} syncJobId Synchronization job ID
|
|
14215
|
-
* deleteKnowledgeKnowledgebaseSynchronizeJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
14216
14334
|
*/},{key:"deleteKnowledgeKnowledgebaseSynchronizeJob",value:function deleteKnowledgeKnowledgebaseSynchronizeJob(knowledgeBaseId,syncJobId){// verify the required parameter 'knowledgeBaseId' is set
|
|
14217
14335
|
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling deleteKnowledgeKnowledgebaseSynchronizeJob';}// verify the required parameter 'syncJobId' is set
|
|
14218
14336
|
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']);}/**
|
|
@@ -14249,7 +14367,6 @@ if(sessionId===undefined||sessionId===null){throw'Missing the required parameter
|
|
|
14249
14367
|
* Get sync options available for a knowledge-connect integration
|
|
14250
14368
|
*
|
|
14251
14369
|
* @param {String} integrationId Integration ID
|
|
14252
|
-
* getKnowledgeIntegrationOptions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
14253
14370
|
*/},{key:"getKnowledgeIntegrationOptions",value:function getKnowledgeIntegrationOptions(integrationId){// verify the required parameter 'integrationId' is set
|
|
14254
14371
|
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']);}/**
|
|
14255
14372
|
* Get knowledge base
|
|
@@ -14549,13 +14666,11 @@ if(languageCode===undefined||languageCode===null){throw'Missing the required par
|
|
|
14549
14666
|
* @param {Array.<String>} opts.status If specified, retrieves operations with specified operation status, comma separated values expected.
|
|
14550
14667
|
* @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
|
|
14551
14668
|
* @param {Array.<String>} opts.sourceId If specified, retrieves operations associated with source ids, comma separated values expected.
|
|
14552
|
-
* getKnowledgeKnowledgebaseOperations is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
14553
14669
|
*/},{key:"getKnowledgeKnowledgebaseOperations",value:function getKnowledgeKnowledgebaseOperations(knowledgeBaseId,opts){opts=opts||{};// verify the required parameter 'knowledgeBaseId' is set
|
|
14554
14670
|
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']);}/**
|
|
14555
14671
|
* Get ids of operation creator users and oauth clients
|
|
14556
14672
|
*
|
|
14557
14673
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
14558
|
-
* getKnowledgeKnowledgebaseOperationsUsersQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
14559
14674
|
*/},{key:"getKnowledgeKnowledgebaseOperationsUsersQuery",value:function getKnowledgeKnowledgebaseOperationsUsersQuery(knowledgeBaseId){// verify the required parameter 'knowledgeBaseId' is set
|
|
14560
14675
|
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']);}/**
|
|
14561
14676
|
* Get parse job report
|
|
@@ -14575,7 +14690,6 @@ if(parseJobId===undefined||parseJobId===null){throw'Missing the required paramet
|
|
|
14575
14690
|
* @param {Object} opts.type If specified, retrieves integration sources with specified integration type.
|
|
14576
14691
|
* @param {Array.<String>} opts.expand The specified entity attributes will be filled. Comma separated values expected.
|
|
14577
14692
|
* @param {Array.<String>} opts.ids If specified, retrieves integration sources with specified IDs.
|
|
14578
|
-
* getKnowledgeKnowledgebaseSources is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
14579
14693
|
*/},{key:"getKnowledgeKnowledgebaseSources",value:function getKnowledgeKnowledgebaseSources(knowledgeBaseId,opts){opts=opts||{};// verify the required parameter 'knowledgeBaseId' is set
|
|
14580
14694
|
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']);}/**
|
|
14581
14695
|
* Get Salesforce Knowledge integration source
|
|
@@ -14584,7 +14698,6 @@ if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the requir
|
|
|
14584
14698
|
* @param {String} sourceId Source ID
|
|
14585
14699
|
* @param {Object} opts Optional parameters
|
|
14586
14700
|
* @param {Array.<String>} opts.expand The specified entity attributes will be filled. Comma separated values expected.
|
|
14587
|
-
* getKnowledgeKnowledgebaseSourcesSalesforceSourceId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
14588
14701
|
*/},{key:"getKnowledgeKnowledgebaseSourcesSalesforceSourceId",value:function getKnowledgeKnowledgebaseSourcesSalesforceSourceId(knowledgeBaseId,sourceId,opts){opts=opts||{};// verify the required parameter 'knowledgeBaseId' is set
|
|
14589
14702
|
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseSourcesSalesforceSourceId';}// verify the required parameter 'sourceId' is set
|
|
14590
14703
|
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']);}/**
|
|
@@ -14594,7 +14707,6 @@ if(sourceId===undefined||sourceId===null){throw'Missing the required parameter "
|
|
|
14594
14707
|
* @param {String} sourceId Source ID
|
|
14595
14708
|
* @param {Object} opts Optional parameters
|
|
14596
14709
|
* @param {Array.<String>} opts.expand The specified entity attributes will be filled. Comma separated values expected.
|
|
14597
|
-
* getKnowledgeKnowledgebaseSourcesServicenowSourceId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
14598
14710
|
*/},{key:"getKnowledgeKnowledgebaseSourcesServicenowSourceId",value:function getKnowledgeKnowledgebaseSourcesServicenowSourceId(knowledgeBaseId,sourceId,opts){opts=opts||{};// verify the required parameter 'knowledgeBaseId' is set
|
|
14599
14711
|
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseSourcesServicenowSourceId';}// verify the required parameter 'sourceId' is set
|
|
14600
14712
|
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']);}/**
|
|
@@ -14602,7 +14714,6 @@ if(sourceId===undefined||sourceId===null){throw'Missing the required parameter "
|
|
|
14602
14714
|
*
|
|
14603
14715
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
14604
14716
|
* @param {String} syncJobId Synchronization job ID
|
|
14605
|
-
* getKnowledgeKnowledgebaseSynchronizeJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
14606
14717
|
*/},{key:"getKnowledgeKnowledgebaseSynchronizeJob",value:function getKnowledgeKnowledgebaseSynchronizeJob(knowledgeBaseId,syncJobId){// verify the required parameter 'knowledgeBaseId' is set
|
|
14607
14718
|
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseSynchronizeJob';}// verify the required parameter 'syncJobId' is set
|
|
14608
14719
|
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']);}/**
|
|
@@ -14804,7 +14915,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
14804
14915
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
14805
14916
|
* @param {String} syncJobId Synchronization job ID
|
|
14806
14917
|
* @param {Object} body
|
|
14807
|
-
* patchKnowledgeKnowledgebaseSynchronizeJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
14808
14918
|
*/},{key:"patchKnowledgeKnowledgebaseSynchronizeJob",value:function patchKnowledgeKnowledgebaseSynchronizeJob(knowledgeBaseId,syncJobId,body){// verify the required parameter 'knowledgeBaseId' is set
|
|
14809
14919
|
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling patchKnowledgeKnowledgebaseSynchronizeJob';}// verify the required parameter 'syncJobId' is set
|
|
14810
14920
|
if(syncJobId===undefined||syncJobId===null){throw'Missing the required parameter "syncJobId" when calling patchKnowledgeKnowledgebaseSynchronizeJob';}// verify the required parameter 'body' is set
|
|
@@ -15118,7 +15228,6 @@ if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the requir
|
|
|
15118
15228
|
*
|
|
15119
15229
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
15120
15230
|
* @param {Object} body
|
|
15121
|
-
* postKnowledgeKnowledgebaseSourcesSalesforce is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
15122
15231
|
*/},{key:"postKnowledgeKnowledgebaseSourcesSalesforce",value:function postKnowledgeKnowledgebaseSourcesSalesforce(knowledgeBaseId,body){// verify the required parameter 'knowledgeBaseId' is set
|
|
15123
15232
|
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseSourcesSalesforce';}// verify the required parameter 'body' is set
|
|
15124
15233
|
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']);}/**
|
|
@@ -15126,7 +15235,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
15126
15235
|
*
|
|
15127
15236
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
15128
15237
|
* @param {String} sourceId Source ID
|
|
15129
|
-
* postKnowledgeKnowledgebaseSourcesSalesforceSourceIdSync is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
15130
15238
|
*/},{key:"postKnowledgeKnowledgebaseSourcesSalesforceSourceIdSync",value:function postKnowledgeKnowledgebaseSourcesSalesforceSourceIdSync(knowledgeBaseId,sourceId){// verify the required parameter 'knowledgeBaseId' is set
|
|
15131
15239
|
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseSourcesSalesforceSourceIdSync';}// verify the required parameter 'sourceId' is set
|
|
15132
15240
|
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']);}/**
|
|
@@ -15134,7 +15242,6 @@ if(sourceId===undefined||sourceId===null){throw'Missing the required parameter "
|
|
|
15134
15242
|
*
|
|
15135
15243
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
15136
15244
|
* @param {Object} body
|
|
15137
|
-
* postKnowledgeKnowledgebaseSourcesServicenow is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
15138
15245
|
*/},{key:"postKnowledgeKnowledgebaseSourcesServicenow",value:function postKnowledgeKnowledgebaseSourcesServicenow(knowledgeBaseId,body){// verify the required parameter 'knowledgeBaseId' is set
|
|
15139
15246
|
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseSourcesServicenow';}// verify the required parameter 'body' is set
|
|
15140
15247
|
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']);}/**
|
|
@@ -15142,7 +15249,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
15142
15249
|
*
|
|
15143
15250
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
15144
15251
|
* @param {String} sourceId Source ID
|
|
15145
|
-
* postKnowledgeKnowledgebaseSourcesServicenowSourceIdSync is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
15146
15252
|
*/},{key:"postKnowledgeKnowledgebaseSourcesServicenowSourceIdSync",value:function postKnowledgeKnowledgebaseSourcesServicenowSourceIdSync(knowledgeBaseId,sourceId){// verify the required parameter 'knowledgeBaseId' is set
|
|
15147
15253
|
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseSourcesServicenowSourceIdSync';}// verify the required parameter 'sourceId' is set
|
|
15148
15254
|
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']);}/**
|
|
@@ -15150,7 +15256,6 @@ if(sourceId===undefined||sourceId===null){throw'Missing the required parameter "
|
|
|
15150
15256
|
*
|
|
15151
15257
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
15152
15258
|
* @param {Object} body
|
|
15153
|
-
* postKnowledgeKnowledgebaseSynchronizeJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
15154
15259
|
*/},{key:"postKnowledgeKnowledgebaseSynchronizeJobs",value:function postKnowledgeKnowledgebaseSynchronizeJobs(knowledgeBaseId,body){// verify the required parameter 'knowledgeBaseId' is set
|
|
15155
15260
|
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseSynchronizeJobs';}// verify the required parameter 'body' is set
|
|
15156
15261
|
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']);}/**
|
|
@@ -15172,7 +15277,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
15172
15277
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
15173
15278
|
* @param {String} sourceId Source ID
|
|
15174
15279
|
* @param {Object} body
|
|
15175
|
-
* putKnowledgeKnowledgebaseSourcesSalesforceSourceId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
15176
15280
|
*/},{key:"putKnowledgeKnowledgebaseSourcesSalesforceSourceId",value:function putKnowledgeKnowledgebaseSourcesSalesforceSourceId(knowledgeBaseId,sourceId,body){// verify the required parameter 'knowledgeBaseId' is set
|
|
15177
15281
|
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling putKnowledgeKnowledgebaseSourcesSalesforceSourceId';}// verify the required parameter 'sourceId' is set
|
|
15178
15282
|
if(sourceId===undefined||sourceId===null){throw'Missing the required parameter "sourceId" when calling putKnowledgeKnowledgebaseSourcesSalesforceSourceId';}// verify the required parameter 'body' is set
|
|
@@ -15182,14 +15286,13 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
15182
15286
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
15183
15287
|
* @param {String} sourceId Source ID
|
|
15184
15288
|
* @param {Object} body
|
|
15185
|
-
* putKnowledgeKnowledgebaseSourcesServicenowSourceId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
15186
15289
|
*/},{key:"putKnowledgeKnowledgebaseSourcesServicenowSourceId",value:function putKnowledgeKnowledgebaseSourcesServicenowSourceId(knowledgeBaseId,sourceId,body){// verify the required parameter 'knowledgeBaseId' is set
|
|
15187
15290
|
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling putKnowledgeKnowledgebaseSourcesServicenowSourceId';}// verify the required parameter 'sourceId' is set
|
|
15188
15291
|
if(sourceId===undefined||sourceId===null){throw'Missing the required parameter "sourceId" when calling putKnowledgeKnowledgebaseSourcesServicenowSourceId';}// verify the required parameter 'body' is set
|
|
15189
15292
|
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(){/**
|
|
15190
15293
|
* LanguageUnderstanding service.
|
|
15191
15294
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
15192
|
-
* @version
|
|
15295
|
+
* @version 207.0.0
|
|
15193
15296
|
*//**
|
|
15194
15297
|
* Constructs a new LanguageUnderstandingApi.
|
|
15195
15298
|
* @alias module:purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
@@ -15449,7 +15552,7 @@ if(domainVersionId===undefined||domainVersionId===null){throw'Missing the requir
|
|
|
15449
15552
|
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(){/**
|
|
15450
15553
|
* Languages service.
|
|
15451
15554
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
15452
|
-
* @version
|
|
15555
|
+
* @version 207.0.0
|
|
15453
15556
|
*//**
|
|
15454
15557
|
* Constructs a new LanguagesApi.
|
|
15455
15558
|
* @alias module:purecloud-platform-client-v2/api/LanguagesApi
|
|
@@ -15504,7 +15607,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
15504
15607
|
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(){/**
|
|
15505
15608
|
* Learning service.
|
|
15506
15609
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
15507
|
-
* @version
|
|
15610
|
+
* @version 207.0.0
|
|
15508
15611
|
*//**
|
|
15509
15612
|
* Constructs a new LearningApi.
|
|
15510
15613
|
* @alias module:purecloud-platform-client-v2/api/LearningApi
|
|
@@ -15775,7 +15878,7 @@ if(moduleId===undefined||moduleId===null){throw'Missing the required parameter "
|
|
|
15775
15878
|
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(){/**
|
|
15776
15879
|
* License service.
|
|
15777
15880
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
15778
|
-
* @version
|
|
15881
|
+
* @version 207.0.0
|
|
15779
15882
|
*//**
|
|
15780
15883
|
* Constructs a new LicenseApi.
|
|
15781
15884
|
* @alias module:purecloud-platform-client-v2/api/LicenseApi
|
|
@@ -15829,7 +15932,7 @@ if(featureName===undefined||featureName===null){throw'Missing the required param
|
|
|
15829
15932
|
*/},{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(){/**
|
|
15830
15933
|
* Locations service.
|
|
15831
15934
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
15832
|
-
* @version
|
|
15935
|
+
* @version 207.0.0
|
|
15833
15936
|
*//**
|
|
15834
15937
|
* Constructs a new LocationsApi.
|
|
15835
15938
|
* @alias module:purecloud-platform-client-v2/api/LocationsApi
|
|
@@ -15888,7 +15991,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
15888
15991
|
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(){/**
|
|
15889
15992
|
* LogCapture service.
|
|
15890
15993
|
* @module purecloud-platform-client-v2/api/LogCaptureApi
|
|
15891
|
-
* @version
|
|
15994
|
+
* @version 207.0.0
|
|
15892
15995
|
*//**
|
|
15893
15996
|
* Constructs a new LogCaptureApi.
|
|
15894
15997
|
* @alias module:purecloud-platform-client-v2/api/LogCaptureApi
|
|
@@ -15938,7 +16041,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
15938
16041
|
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(){/**
|
|
15939
16042
|
* Messaging service.
|
|
15940
16043
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
15941
|
-
* @version
|
|
16044
|
+
* @version 207.0.0
|
|
15942
16045
|
*//**
|
|
15943
16046
|
* Constructs a new MessagingApi.
|
|
15944
16047
|
* @alias module:purecloud-platform-client-v2/api/MessagingApi
|
|
@@ -16028,7 +16131,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
16028
16131
|
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(){/**
|
|
16029
16132
|
* MobileDevices service.
|
|
16030
16133
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
16031
|
-
* @version
|
|
16134
|
+
* @version 207.0.0
|
|
16032
16135
|
*//**
|
|
16033
16136
|
* Constructs a new MobileDevicesApi.
|
|
16034
16137
|
* @alias module:purecloud-platform-client-v2/api/MobileDevicesApi
|
|
@@ -16067,7 +16170,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
16067
16170
|
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(){/**
|
|
16068
16171
|
* Notifications service.
|
|
16069
16172
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
16070
|
-
* @version
|
|
16173
|
+
* @version 207.0.0
|
|
16071
16174
|
*//**
|
|
16072
16175
|
* Constructs a new NotificationsApi.
|
|
16073
16176
|
* @alias module:purecloud-platform-client-v2/api/NotificationsApi
|
|
@@ -16124,7 +16227,7 @@ if(channelId===undefined||channelId===null){throw'Missing the required parameter
|
|
|
16124
16227
|
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(){/**
|
|
16125
16228
|
* OAuth service.
|
|
16126
16229
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
16127
|
-
* @version
|
|
16230
|
+
* @version 207.0.0
|
|
16128
16231
|
*//**
|
|
16129
16232
|
* Constructs a new OAuthApi.
|
|
16130
16233
|
* @alias module:purecloud-platform-client-v2/api/OAuthApi
|
|
@@ -16209,7 +16312,7 @@ if(clientId===undefined||clientId===null){throw'Missing the required parameter "
|
|
|
16209
16312
|
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(){/**
|
|
16210
16313
|
* Objects service.
|
|
16211
16314
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
16212
|
-
* @version
|
|
16315
|
+
* @version 207.0.0
|
|
16213
16316
|
*//**
|
|
16214
16317
|
* Constructs a new ObjectsApi.
|
|
16215
16318
|
* @alias module:purecloud-platform-client-v2/api/ObjectsApi
|
|
@@ -16280,7 +16383,7 @@ if(divisionId===undefined||divisionId===null){throw'Missing the required paramet
|
|
|
16280
16383
|
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(){/**
|
|
16281
16384
|
* OperationalEvents service.
|
|
16282
16385
|
* @module purecloud-platform-client-v2/api/OperationalEventsApi
|
|
16283
|
-
* @version
|
|
16386
|
+
* @version 207.0.0
|
|
16284
16387
|
*//**
|
|
16285
16388
|
* Constructs a new OperationalEventsApi.
|
|
16286
16389
|
* @alias module:purecloud-platform-client-v2/api/OperationalEventsApi
|
|
@@ -16298,7 +16401,7 @@ if(eventDefinitionId===undefined||eventDefinitionId===null){throw'Missing the re
|
|
|
16298
16401
|
*/},{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(){/**
|
|
16299
16402
|
* Organization service.
|
|
16300
16403
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
16301
|
-
* @version
|
|
16404
|
+
* @version 207.0.0
|
|
16302
16405
|
*//**
|
|
16303
16406
|
* Constructs a new OrganizationApi.
|
|
16304
16407
|
* @alias module:purecloud-platform-client-v2/api/OrganizationApi
|
|
@@ -16423,7 +16526,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
16423
16526
|
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(){/**
|
|
16424
16527
|
* OrganizationAuthorization service.
|
|
16425
16528
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
16426
|
-
* @version
|
|
16529
|
+
* @version 207.0.0
|
|
16427
16530
|
*//**
|
|
16428
16531
|
* Constructs a new OrganizationAuthorizationApi.
|
|
16429
16532
|
* @alias module:purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
@@ -16574,6 +16677,9 @@ if(trusteeOrgId===undefined||trusteeOrgId===null){throw'Missing the required par
|
|
|
16574
16677
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
16575
16678
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
16576
16679
|
*/},{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']);}/**
|
|
16680
|
+
* Get Customer Care organization ids.
|
|
16681
|
+
*
|
|
16682
|
+
*/},{key:"getOrgauthorizationTrusteesCare",value:function getOrgauthorizationTrusteesCare(){return this.apiClient.callApi('/api/v2/orgauthorization/trustees/care','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
16577
16683
|
* Get organization authorization trust with Customer Care, if one exists.
|
|
16578
16684
|
*
|
|
16579
16685
|
*/},{key:"getOrgauthorizationTrusteesDefault",value:function getOrgauthorizationTrusteesDefault(){return this.apiClient.callApi('/api/v2/orgauthorization/trustees/default','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
@@ -16664,6 +16770,14 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
16664
16770
|
* @param {String} opts.sortOrder Sort order (default to descending)
|
|
16665
16771
|
*/},{key:"postOrgauthorizationTrusteesAudits",value:function postOrgauthorizationTrusteesAudits(body,opts){opts=opts||{};// verify the required parameter 'body' is set
|
|
16666
16772
|
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']);}/**
|
|
16773
|
+
* Create a new organization authorization trust with Customer Care. This is required to grant your regional Customer Care organization access to your organization.
|
|
16774
|
+
*
|
|
16775
|
+
* @param {Object} opts Optional parameters
|
|
16776
|
+
* @param {Boolean} opts.assignDefaultRole Assign Admin role to default pairing with Customer Care
|
|
16777
|
+
* @param {Boolean} opts.autoExpire Automatically expire pairing after 30 days
|
|
16778
|
+
* @param {Boolean} opts.assignFullAccess Grant Customer Care full access to the organization
|
|
16779
|
+
* @param {Boolean} opts.allowTrustedUserAccess Make Customer Care a Trusted User
|
|
16780
|
+
*/},{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']);}/**
|
|
16667
16781
|
* Create a new organization authorization trust with Customer Care. This is required to grant your regional Customer Care organization access to your organization.
|
|
16668
16782
|
*
|
|
16669
16783
|
* @param {Object} opts Optional parameters
|
|
@@ -16746,7 +16860,7 @@ if(trustorOrgId===undefined||trustorOrgId===null){throw'Missing the required par
|
|
|
16746
16860
|
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(){/**
|
|
16747
16861
|
* Outbound service.
|
|
16748
16862
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
16749
|
-
* @version
|
|
16863
|
+
* @version 207.0.0
|
|
16750
16864
|
*//**
|
|
16751
16865
|
* Constructs a new OutboundApi.
|
|
16752
16866
|
* @alias module:purecloud-platform-client-v2/api/OutboundApi
|
|
@@ -17503,6 +17617,16 @@ if(campaignId===undefined||campaignId===null){throw'Missing the required paramet
|
|
|
17503
17617
|
*/},{key:"postOutboundCampaignCallbackSchedule",value:function postOutboundCampaignCallbackSchedule(campaignId,body){// verify the required parameter 'campaignId' is set
|
|
17504
17618
|
if(campaignId===undefined||campaignId===null){throw'Missing the required parameter "campaignId" when calling postOutboundCampaignCallbackSchedule';}// verify the required parameter 'body' is set
|
|
17505
17619
|
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']);}/**
|
|
17620
|
+
* Start the campaign
|
|
17621
|
+
*
|
|
17622
|
+
* @param {String} campaignId Campaign ID
|
|
17623
|
+
*/},{key:"postOutboundCampaignStart",value:function postOutboundCampaignStart(campaignId){// verify the required parameter 'campaignId' is set
|
|
17624
|
+
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']);}/**
|
|
17625
|
+
* Stop the campaign
|
|
17626
|
+
*
|
|
17627
|
+
* @param {String} campaignId Campaign ID
|
|
17628
|
+
*/},{key:"postOutboundCampaignStop",value:function postOutboundCampaignStop(campaignId){// verify the required parameter 'campaignId' is set
|
|
17629
|
+
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']);}/**
|
|
17506
17630
|
* Create Campaign Rule
|
|
17507
17631
|
*
|
|
17508
17632
|
* @param {Object} body CampaignRule
|
|
@@ -17655,6 +17779,16 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
17655
17779
|
* @param {Array.<Object>} body import template(s) to add
|
|
17656
17780
|
*/},{key:"postOutboundImporttemplatesBulkAdd",value:function postOutboundImporttemplatesBulkAdd(body){// verify the required parameter 'body' is set
|
|
17657
17781
|
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']);}/**
|
|
17782
|
+
* Start the campaign
|
|
17783
|
+
* Documented permissions are applicable based on campaign type.
|
|
17784
|
+
* @param {String} messagingCampaignId The Messaging Campaign ID
|
|
17785
|
+
*/},{key:"postOutboundMessagingcampaignStart",value:function postOutboundMessagingcampaignStart(messagingCampaignId){// verify the required parameter 'messagingCampaignId' is set
|
|
17786
|
+
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']);}/**
|
|
17787
|
+
* Stop the campaign
|
|
17788
|
+
* Documented permissions are applicable based on campaign type.
|
|
17789
|
+
* @param {String} messagingCampaignId The Messaging Campaign ID
|
|
17790
|
+
*/},{key:"postOutboundMessagingcampaignStop",value:function postOutboundMessagingcampaignStop(messagingCampaignId){// verify the required parameter 'messagingCampaignId' is set
|
|
17791
|
+
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']);}/**
|
|
17658
17792
|
* Create a Messaging Campaign
|
|
17659
17793
|
*
|
|
17660
17794
|
* @param {Object} body Messaging Campaign
|
|
@@ -17833,7 +17967,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
17833
17967
|
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(){/**
|
|
17834
17968
|
* Presence service.
|
|
17835
17969
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
17836
|
-
* @version
|
|
17970
|
+
* @version 207.0.0
|
|
17837
17971
|
*//**
|
|
17838
17972
|
* Constructs a new PresenceApi.
|
|
17839
17973
|
* @alias module:purecloud-platform-client-v2/api/PresenceApi
|
|
@@ -18006,7 +18140,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
18006
18140
|
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(){/**
|
|
18007
18141
|
* ProcessAutomation service.
|
|
18008
18142
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
18009
|
-
* @version
|
|
18143
|
+
* @version 207.0.0
|
|
18010
18144
|
*//**
|
|
18011
18145
|
* Constructs a new ProcessAutomationApi.
|
|
18012
18146
|
* @alias module:purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
@@ -18069,7 +18203,7 @@ if(triggerId===undefined||triggerId===null){throw'Missing the required parameter
|
|
|
18069
18203
|
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(){/**
|
|
18070
18204
|
* Quality service.
|
|
18071
18205
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
18072
|
-
* @version
|
|
18206
|
+
* @version 207.0.0
|
|
18073
18207
|
*//**
|
|
18074
18208
|
* Constructs a new QualityApi.
|
|
18075
18209
|
* @alias module:purecloud-platform-client-v2/api/QualityApi
|
|
@@ -18546,7 +18680,7 @@ if(customerSurveyUrl===undefined||customerSurveyUrl===null){throw'Missing the re
|
|
|
18546
18680
|
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(){/**
|
|
18547
18681
|
* Recording service.
|
|
18548
18682
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
18549
|
-
* @version
|
|
18683
|
+
* @version 207.0.0
|
|
18550
18684
|
*//**
|
|
18551
18685
|
* Constructs a new RecordingApi.
|
|
18552
18686
|
* @alias module:purecloud-platform-client-v2/api/RecordingApi
|
|
@@ -18958,7 +19092,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
18958
19092
|
*/},{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(){/**
|
|
18959
19093
|
* ResponseManagement service.
|
|
18960
19094
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
18961
|
-
* @version
|
|
19095
|
+
* @version 207.0.0
|
|
18962
19096
|
*//**
|
|
18963
19097
|
* Constructs a new ResponseManagementApi.
|
|
18964
19098
|
* @alias module:purecloud-platform-client-v2/api/ResponseManagementApi
|
|
@@ -19079,7 +19213,7 @@ if(responseAssetId===undefined||responseAssetId===null){throw'Missing the requir
|
|
|
19079
19213
|
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(){/**
|
|
19080
19214
|
* Routing service.
|
|
19081
19215
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
19082
|
-
* @version
|
|
19216
|
+
* @version 207.0.0
|
|
19083
19217
|
*//**
|
|
19084
19218
|
* Constructs a new RoutingApi.
|
|
19085
19219
|
* @alias module:purecloud-platform-client-v2/api/RoutingApi
|
|
@@ -20083,7 +20217,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
20083
20217
|
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(){/**
|
|
20084
20218
|
* SCIM service.
|
|
20085
20219
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
20086
|
-
* @version
|
|
20220
|
+
* @version 207.0.0
|
|
20087
20221
|
*//**
|
|
20088
20222
|
* Constructs a new SCIMApi.
|
|
20089
20223
|
* @alias module:purecloud-platform-client-v2/api/SCIMApi
|
|
@@ -20308,7 +20442,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
20308
20442
|
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(){/**
|
|
20309
20443
|
* ScreenRecording service.
|
|
20310
20444
|
* @module purecloud-platform-client-v2/api/ScreenRecordingApi
|
|
20311
|
-
* @version
|
|
20445
|
+
* @version 207.0.0
|
|
20312
20446
|
*//**
|
|
20313
20447
|
* Constructs a new ScreenRecordingApi.
|
|
20314
20448
|
* @alias module:purecloud-platform-client-v2/api/ScreenRecordingApi
|
|
@@ -20323,7 +20457,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
20323
20457
|
*/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(){/**
|
|
20324
20458
|
* Scripts service.
|
|
20325
20459
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
20326
|
-
* @version
|
|
20460
|
+
* @version 207.0.0
|
|
20327
20461
|
*//**
|
|
20328
20462
|
* Constructs a new ScriptsApi.
|
|
20329
20463
|
* @alias module:purecloud-platform-client-v2/api/ScriptsApi
|
|
@@ -20459,7 +20593,7 @@ if(scriptId===undefined||scriptId===null){throw'Missing the required parameter "
|
|
|
20459
20593
|
*/},{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(){/**
|
|
20460
20594
|
* Search service.
|
|
20461
20595
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
20462
|
-
* @version
|
|
20596
|
+
* @version 207.0.0
|
|
20463
20597
|
*//**
|
|
20464
20598
|
* Constructs a new SearchApi.
|
|
20465
20599
|
* @alias module:purecloud-platform-client-v2/api/SearchApi
|
|
@@ -20619,7 +20753,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
20619
20753
|
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(){/**
|
|
20620
20754
|
* Settings service.
|
|
20621
20755
|
* @module purecloud-platform-client-v2/api/SettingsApi
|
|
20622
|
-
* @version
|
|
20756
|
+
* @version 207.0.0
|
|
20623
20757
|
*//**
|
|
20624
20758
|
* Constructs a new SettingsApi.
|
|
20625
20759
|
* @alias module:purecloud-platform-client-v2/api/SettingsApi
|
|
@@ -20669,7 +20803,7 @@ if(agentId===undefined||agentId===null){throw'Missing the required parameter "ag
|
|
|
20669
20803
|
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(){/**
|
|
20670
20804
|
* SpeechTextAnalytics service.
|
|
20671
20805
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
20672
|
-
* @version
|
|
20806
|
+
* @version 207.0.0
|
|
20673
20807
|
*//**
|
|
20674
20808
|
* Constructs a new SpeechTextAnalyticsApi.
|
|
20675
20809
|
* @alias module:purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
@@ -20968,7 +21102,7 @@ if(topicId===undefined||topicId===null){throw'Missing the required parameter "to
|
|
|
20968
21102
|
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(){/**
|
|
20969
21103
|
* Stations service.
|
|
20970
21104
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
20971
|
-
* @version
|
|
21105
|
+
* @version 207.0.0
|
|
20972
21106
|
*//**
|
|
20973
21107
|
* Constructs a new StationsApi.
|
|
20974
21108
|
* @alias module:purecloud-platform-client-v2/api/StationsApi
|
|
@@ -21000,7 +21134,7 @@ if(stationId===undefined||stationId===null){throw'Missing the required parameter
|
|
|
21000
21134
|
*/},{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(){/**
|
|
21001
21135
|
* Suggest service.
|
|
21002
21136
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
21003
|
-
* @version
|
|
21137
|
+
* @version 207.0.0
|
|
21004
21138
|
*//**
|
|
21005
21139
|
* Constructs a new SuggestApi.
|
|
21006
21140
|
* @alias module:purecloud-platform-client-v2/api/SuggestApi
|
|
@@ -21040,7 +21174,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
21040
21174
|
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(){/**
|
|
21041
21175
|
* TaskManagement service.
|
|
21042
21176
|
* @module purecloud-platform-client-v2/api/TaskManagementApi
|
|
21043
|
-
* @version
|
|
21177
|
+
* @version 207.0.0
|
|
21044
21178
|
*//**
|
|
21045
21179
|
* Constructs a new TaskManagementApi.
|
|
21046
21180
|
* @alias module:purecloud-platform-client-v2/api/TaskManagementApi
|
|
@@ -21068,6 +21202,20 @@ if(schemaId===undefined||schemaId===null){throw'Missing the required parameter "
|
|
|
21068
21202
|
* @param {String} worktypeId Worktype id
|
|
21069
21203
|
*/},{key:"deleteTaskmanagementWorktype",value:function deleteTaskmanagementWorktype(worktypeId){// verify the required parameter 'worktypeId' is set
|
|
21070
21204
|
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']);}/**
|
|
21205
|
+
* Delete a rule
|
|
21206
|
+
*
|
|
21207
|
+
* @param {String} worktypeId Worktype id
|
|
21208
|
+
* @param {String} ruleId ruleId
|
|
21209
|
+
*/},{key:"deleteTaskmanagementWorktypeFlowsOnattributechangeRule",value:function deleteTaskmanagementWorktypeFlowsOnattributechangeRule(worktypeId,ruleId){// verify the required parameter 'worktypeId' is set
|
|
21210
|
+
if(worktypeId===undefined||worktypeId===null){throw'Missing the required parameter "worktypeId" when calling deleteTaskmanagementWorktypeFlowsOnattributechangeRule';}// verify the required parameter 'ruleId' is set
|
|
21211
|
+
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']);}/**
|
|
21212
|
+
* Delete a rule
|
|
21213
|
+
*
|
|
21214
|
+
* @param {String} worktypeId Worktype id
|
|
21215
|
+
* @param {String} ruleId ruleId
|
|
21216
|
+
*/},{key:"deleteTaskmanagementWorktypeFlowsOncreateRule",value:function deleteTaskmanagementWorktypeFlowsOncreateRule(worktypeId,ruleId){// verify the required parameter 'worktypeId' is set
|
|
21217
|
+
if(worktypeId===undefined||worktypeId===null){throw'Missing the required parameter "worktypeId" when calling deleteTaskmanagementWorktypeFlowsOncreateRule';}// verify the required parameter 'ruleId' is set
|
|
21218
|
+
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']);}/**
|
|
21071
21219
|
* Delete a status
|
|
21072
21220
|
*
|
|
21073
21221
|
* @param {String} worktypeId Worktype id
|
|
@@ -21202,6 +21350,36 @@ if(schemaId===undefined||schemaId===null){throw'Missing the required parameter "
|
|
|
21202
21350
|
* @param {Array.<String>} opts.expands Which fields, if any, to expand.
|
|
21203
21351
|
*/},{key:"getTaskmanagementWorktype",value:function getTaskmanagementWorktype(worktypeId,opts){opts=opts||{};// verify the required parameter 'worktypeId' is set
|
|
21204
21352
|
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']);}/**
|
|
21353
|
+
* Get an attribute change rule
|
|
21354
|
+
*
|
|
21355
|
+
* @param {String} worktypeId Worktype id
|
|
21356
|
+
* @param {String} ruleId ruleId
|
|
21357
|
+
*/},{key:"getTaskmanagementWorktypeFlowsOnattributechangeRule",value:function getTaskmanagementWorktypeFlowsOnattributechangeRule(worktypeId,ruleId){// verify the required parameter 'worktypeId' is set
|
|
21358
|
+
if(worktypeId===undefined||worktypeId===null){throw'Missing the required parameter "worktypeId" when calling getTaskmanagementWorktypeFlowsOnattributechangeRule';}// verify the required parameter 'ruleId' is set
|
|
21359
|
+
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']);}/**
|
|
21360
|
+
* Get all attribute-change rules for a worktype
|
|
21361
|
+
*
|
|
21362
|
+
* @param {String} worktypeId Worktype id
|
|
21363
|
+
* @param {Object} opts Optional parameters
|
|
21364
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
21365
|
+
* @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)
|
|
21366
|
+
*/},{key:"getTaskmanagementWorktypeFlowsOnattributechangeRules",value:function getTaskmanagementWorktypeFlowsOnattributechangeRules(worktypeId,opts){opts=opts||{};// verify the required parameter 'worktypeId' is set
|
|
21367
|
+
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']);}/**
|
|
21368
|
+
* Get an on-create rule
|
|
21369
|
+
*
|
|
21370
|
+
* @param {String} worktypeId Worktype id
|
|
21371
|
+
* @param {String} ruleId ruleId
|
|
21372
|
+
*/},{key:"getTaskmanagementWorktypeFlowsOncreateRule",value:function getTaskmanagementWorktypeFlowsOncreateRule(worktypeId,ruleId){// verify the required parameter 'worktypeId' is set
|
|
21373
|
+
if(worktypeId===undefined||worktypeId===null){throw'Missing the required parameter "worktypeId" when calling getTaskmanagementWorktypeFlowsOncreateRule';}// verify the required parameter 'ruleId' is set
|
|
21374
|
+
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']);}/**
|
|
21375
|
+
* Get all on-create rules for a worktype
|
|
21376
|
+
*
|
|
21377
|
+
* @param {String} worktypeId Worktype id
|
|
21378
|
+
* @param {Object} opts Optional parameters
|
|
21379
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
21380
|
+
* @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)
|
|
21381
|
+
*/},{key:"getTaskmanagementWorktypeFlowsOncreateRules",value:function getTaskmanagementWorktypeFlowsOncreateRules(worktypeId,opts){opts=opts||{};// verify the required parameter 'worktypeId' is set
|
|
21382
|
+
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']);}/**
|
|
21205
21383
|
* Get a listing of a worktype's attribute change history
|
|
21206
21384
|
*
|
|
21207
21385
|
* @param {String} worktypeId Worktype id
|
|
@@ -21287,6 +21465,24 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
21287
21465
|
*/},{key:"patchTaskmanagementWorktype",value:function patchTaskmanagementWorktype(worktypeId,body){// verify the required parameter 'worktypeId' is set
|
|
21288
21466
|
if(worktypeId===undefined||worktypeId===null){throw'Missing the required parameter "worktypeId" when calling patchTaskmanagementWorktype';}// verify the required parameter 'body' is set
|
|
21289
21467
|
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']);}/**
|
|
21468
|
+
* Update the attributes of a rule
|
|
21469
|
+
*
|
|
21470
|
+
* @param {String} worktypeId Worktype id
|
|
21471
|
+
* @param {String} ruleId ruleId
|
|
21472
|
+
* @param {Object} body Rule
|
|
21473
|
+
*/},{key:"patchTaskmanagementWorktypeFlowsOnattributechangeRule",value:function patchTaskmanagementWorktypeFlowsOnattributechangeRule(worktypeId,ruleId,body){// verify the required parameter 'worktypeId' is set
|
|
21474
|
+
if(worktypeId===undefined||worktypeId===null){throw'Missing the required parameter "worktypeId" when calling patchTaskmanagementWorktypeFlowsOnattributechangeRule';}// verify the required parameter 'ruleId' is set
|
|
21475
|
+
if(ruleId===undefined||ruleId===null){throw'Missing the required parameter "ruleId" when calling patchTaskmanagementWorktypeFlowsOnattributechangeRule';}// verify the required parameter 'body' is set
|
|
21476
|
+
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']);}/**
|
|
21477
|
+
* Update the attributes of a rule
|
|
21478
|
+
*
|
|
21479
|
+
* @param {String} worktypeId Worktype id
|
|
21480
|
+
* @param {String} ruleId ruleId
|
|
21481
|
+
* @param {Object} body Rule
|
|
21482
|
+
*/},{key:"patchTaskmanagementWorktypeFlowsOncreateRule",value:function patchTaskmanagementWorktypeFlowsOncreateRule(worktypeId,ruleId,body){// verify the required parameter 'worktypeId' is set
|
|
21483
|
+
if(worktypeId===undefined||worktypeId===null){throw'Missing the required parameter "worktypeId" when calling patchTaskmanagementWorktypeFlowsOncreateRule';}// verify the required parameter 'ruleId' is set
|
|
21484
|
+
if(ruleId===undefined||ruleId===null){throw'Missing the required parameter "ruleId" when calling patchTaskmanagementWorktypeFlowsOncreateRule';}// verify the required parameter 'body' is set
|
|
21485
|
+
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']);}/**
|
|
21290
21486
|
* Update the attributes of a status
|
|
21291
21487
|
*
|
|
21292
21488
|
* @param {String} worktypeId Worktype id
|
|
@@ -21344,6 +21540,20 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
21344
21540
|
* @param {Object} body Schema
|
|
21345
21541
|
*/},{key:"postTaskmanagementWorkitemsSchemas",value:function postTaskmanagementWorkitemsSchemas(body){// verify the required parameter 'body' is set
|
|
21346
21542
|
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']);}/**
|
|
21543
|
+
* Add an attribute-change rule to a worktype
|
|
21544
|
+
*
|
|
21545
|
+
* @param {String} worktypeId Worktype id
|
|
21546
|
+
* @param {Object} body Rule
|
|
21547
|
+
*/},{key:"postTaskmanagementWorktypeFlowsOnattributechangeRules",value:function postTaskmanagementWorktypeFlowsOnattributechangeRules(worktypeId,body){// verify the required parameter 'worktypeId' is set
|
|
21548
|
+
if(worktypeId===undefined||worktypeId===null){throw'Missing the required parameter "worktypeId" when calling postTaskmanagementWorktypeFlowsOnattributechangeRules';}// verify the required parameter 'body' is set
|
|
21549
|
+
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']);}/**
|
|
21550
|
+
* Add an on-create rule to a worktype
|
|
21551
|
+
*
|
|
21552
|
+
* @param {String} worktypeId Worktype id
|
|
21553
|
+
* @param {Object} body Rule
|
|
21554
|
+
*/},{key:"postTaskmanagementWorktypeFlowsOncreateRules",value:function postTaskmanagementWorktypeFlowsOncreateRules(worktypeId,body){// verify the required parameter 'worktypeId' is set
|
|
21555
|
+
if(worktypeId===undefined||worktypeId===null){throw'Missing the required parameter "worktypeId" when calling postTaskmanagementWorktypeFlowsOncreateRules';}// verify the required parameter 'body' is set
|
|
21556
|
+
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']);}/**
|
|
21347
21557
|
* Add a status to a worktype
|
|
21348
21558
|
*
|
|
21349
21559
|
* @param {String} worktypeId Worktype id
|
|
@@ -21370,7 +21580,7 @@ if(schemaId===undefined||schemaId===null){throw'Missing the required parameter "
|
|
|
21370
21580
|
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(){/**
|
|
21371
21581
|
* Teams service.
|
|
21372
21582
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
21373
|
-
* @version
|
|
21583
|
+
* @version 207.0.0
|
|
21374
21584
|
*//**
|
|
21375
21585
|
* Constructs a new TeamsApi.
|
|
21376
21586
|
* @alias module:purecloud-platform-client-v2/api/TeamsApi
|
|
@@ -21393,8 +21603,10 @@ if(id===undefined||id===null){throw'Missing the required parameter "id" when cal
|
|
|
21393
21603
|
* Get team
|
|
21394
21604
|
*
|
|
21395
21605
|
* @param {String} teamId Team ID
|
|
21396
|
-
|
|
21397
|
-
|
|
21606
|
+
* @param {Object} opts Optional parameters
|
|
21607
|
+
* @param {Object} opts.expand Expand the division name
|
|
21608
|
+
*/},{key:"getTeam",value:function getTeam(teamId,opts){opts=opts||{};// verify the required parameter 'teamId' is set
|
|
21609
|
+
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']);}/**
|
|
21398
21610
|
* Get team membership
|
|
21399
21611
|
*
|
|
21400
21612
|
* @param {String} teamId Team ID
|
|
@@ -21448,7 +21660,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
21448
21660
|
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(){/**
|
|
21449
21661
|
* Telephony service.
|
|
21450
21662
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
21451
|
-
* @version
|
|
21663
|
+
* @version 207.0.0
|
|
21452
21664
|
*//**
|
|
21453
21665
|
* Constructs a new TelephonyApi.
|
|
21454
21666
|
* @alias module:purecloud-platform-client-v2/api/TelephonyApi
|
|
@@ -21495,7 +21707,7 @@ if(downloadId===undefined||downloadId===null){throw'Missing the required paramet
|
|
|
21495
21707
|
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(){/**
|
|
21496
21708
|
* TelephonyProvidersEdge service.
|
|
21497
21709
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
21498
|
-
* @version
|
|
21710
|
+
* @version 207.0.0
|
|
21499
21711
|
*//**
|
|
21500
21712
|
* Constructs a new TelephonyProvidersEdgeApi.
|
|
21501
21713
|
* @alias module:purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
@@ -22318,7 +22530,7 @@ if(trunkBaseSettingsId===undefined||trunkBaseSettingsId===null){throw'Missing th
|
|
|
22318
22530
|
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(){/**
|
|
22319
22531
|
* Textbots service.
|
|
22320
22532
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
22321
|
-
* @version
|
|
22533
|
+
* @version 207.0.0
|
|
22322
22534
|
*//**
|
|
22323
22535
|
* Constructs a new TextbotsApi.
|
|
22324
22536
|
* @alias module:purecloud-platform-client-v2/api/TextbotsApi
|
|
@@ -22353,7 +22565,7 @@ if(launchRequest===undefined||launchRequest===null){throw'Missing the required p
|
|
|
22353
22565
|
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(){/**
|
|
22354
22566
|
* Tokens service.
|
|
22355
22567
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
22356
|
-
* @version
|
|
22568
|
+
* @version 207.0.0
|
|
22357
22569
|
*//**
|
|
22358
22570
|
* Constructs a new TokensApi.
|
|
22359
22571
|
* @alias module:purecloud-platform-client-v2/api/TokensApi
|
|
@@ -22387,7 +22599,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
22387
22599
|
*/},{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(){/**
|
|
22388
22600
|
* Uploads service.
|
|
22389
22601
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
22390
|
-
* @version
|
|
22602
|
+
* @version 207.0.0
|
|
22391
22603
|
*//**
|
|
22392
22604
|
* Constructs a new UploadsApi.
|
|
22393
22605
|
* @alias module:purecloud-platform-client-v2/api/UploadsApi
|
|
@@ -22453,7 +22665,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
22453
22665
|
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(){/**
|
|
22454
22666
|
* Usage service.
|
|
22455
22667
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
22456
|
-
* @version
|
|
22668
|
+
* @version 207.0.0
|
|
22457
22669
|
*//**
|
|
22458
22670
|
* Constructs a new UsageApi.
|
|
22459
22671
|
* @alias module:purecloud-platform-client-v2/api/UsageApi
|
|
@@ -22507,7 +22719,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
22507
22719
|
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(){/**
|
|
22508
22720
|
* UserRecordings service.
|
|
22509
22721
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
22510
|
-
* @version
|
|
22722
|
+
* @version 207.0.0
|
|
22511
22723
|
*//**
|
|
22512
22724
|
* Constructs a new UserRecordingsApi.
|
|
22513
22725
|
* @alias module:purecloud-platform-client-v2/api/UserRecordingsApi
|
|
@@ -22564,7 +22776,7 @@ if(recordingId===undefined||recordingId===null){throw'Missing the required param
|
|
|
22564
22776
|
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(){/**
|
|
22565
22777
|
* Users service.
|
|
22566
22778
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
22567
|
-
* @version
|
|
22779
|
+
* @version 207.0.0
|
|
22568
22780
|
*//**
|
|
22569
22781
|
* Constructs a new UsersApi.
|
|
22570
22782
|
* @alias module:purecloud-platform-client-v2/api/UsersApi
|
|
@@ -22889,6 +23101,13 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
22889
23101
|
* @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.
|
|
22890
23102
|
* @param {Object} opts.state Only list users of this state (default to active)
|
|
22891
23103
|
*/},{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']);}/**
|
|
23104
|
+
* Get chats for a user
|
|
23105
|
+
*
|
|
23106
|
+
* @param {Object} opts Optional parameters
|
|
23107
|
+
* @param {Boolean} opts.excludeClosed Whether or not to exclude closed chats
|
|
23108
|
+
* @param {Boolean} opts.includePresence Whether or not to include user presence
|
|
23109
|
+
* @param {String} opts.after The key to start after
|
|
23110
|
+
*/},{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']);}/**
|
|
22892
23111
|
* Get list of Development Activities
|
|
22893
23112
|
* Either moduleId or userId is required. Results are filtered based on the applicable permissions.
|
|
22894
23113
|
* @param {Object} opts Optional parameters
|
|
@@ -23254,7 +23473,7 @@ if(verifierId===undefined||verifierId===null){throw'Missing the required paramet
|
|
|
23254
23473
|
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(){/**
|
|
23255
23474
|
* Utilities service.
|
|
23256
23475
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
23257
|
-
* @version
|
|
23476
|
+
* @version 207.0.0
|
|
23258
23477
|
*//**
|
|
23259
23478
|
* Constructs a new UtilitiesApi.
|
|
23260
23479
|
* @alias module:purecloud-platform-client-v2/api/UtilitiesApi
|
|
@@ -23281,7 +23500,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
23281
23500
|
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(){/**
|
|
23282
23501
|
* Voicemail service.
|
|
23283
23502
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
23284
|
-
* @version
|
|
23503
|
+
* @version 207.0.0
|
|
23285
23504
|
*//**
|
|
23286
23505
|
* Constructs a new VoicemailApi.
|
|
23287
23506
|
* @alias module:purecloud-platform-client-v2/api/VoicemailApi
|
|
@@ -23368,6 +23587,19 @@ if(queueId===undefined||queueId===null){throw'Missing the required parameter "qu
|
|
|
23368
23587
|
* @param {Array.<String>} opts.expand expand
|
|
23369
23588
|
*/},{key:"getVoicemailSearch",value:function getVoicemailSearch(q64,opts){opts=opts||{};// verify the required parameter 'q64' is set
|
|
23370
23589
|
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']);}/**
|
|
23590
|
+
* Get a user's mailbox information
|
|
23591
|
+
*
|
|
23592
|
+
* @param {String} userId userId
|
|
23593
|
+
*/},{key:"getVoicemailUserMailbox",value:function getVoicemailUserMailbox(userId){// verify the required parameter 'userId' is set
|
|
23594
|
+
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']);}/**
|
|
23595
|
+
* List voicemail messages
|
|
23596
|
+
*
|
|
23597
|
+
* @param {String} userId User ID
|
|
23598
|
+
* @param {Object} opts Optional parameters
|
|
23599
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
23600
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
23601
|
+
*/},{key:"getVoicemailUserMessages",value:function getVoicemailUserMessages(userId,opts){opts=opts||{};// verify the required parameter 'userId' is set
|
|
23602
|
+
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']);}/**
|
|
23371
23603
|
* Get a user's voicemail policy
|
|
23372
23604
|
*
|
|
23373
23605
|
* @param {String} userId User ID
|
|
@@ -23430,7 +23662,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
23430
23662
|
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(){/**
|
|
23431
23663
|
* WebChat service.
|
|
23432
23664
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
23433
|
-
* @version
|
|
23665
|
+
* @version 207.0.0
|
|
23434
23666
|
*//**
|
|
23435
23667
|
* Constructs a new WebChatApi.
|
|
23436
23668
|
* @alias module:purecloud-platform-client-v2/api/WebChatApi
|
|
@@ -23565,7 +23797,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
23565
23797
|
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(){/**
|
|
23566
23798
|
* WebDeployments service.
|
|
23567
23799
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
23568
|
-
* @version
|
|
23800
|
+
* @version 207.0.0
|
|
23569
23801
|
*//**
|
|
23570
23802
|
* Constructs a new WebDeploymentsApi.
|
|
23571
23803
|
* @alias module:purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
@@ -23616,7 +23848,7 @@ if(configurationId===undefined||configurationId===null){throw'Missing the requir
|
|
|
23616
23848
|
* View configuration drafts
|
|
23617
23849
|
*
|
|
23618
23850
|
* @param {Object} opts Optional parameters
|
|
23619
|
-
* @param {Boolean} opts.showOnlyPublished
|
|
23851
|
+
* @param {Boolean} opts.showOnlyPublished Filter by published status.
|
|
23620
23852
|
*/},{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']);}/**
|
|
23621
23853
|
* Get a deployment
|
|
23622
23854
|
*
|
|
@@ -23686,7 +23918,7 @@ if(deploymentId===undefined||deploymentId===null){throw'Missing the required par
|
|
|
23686
23918
|
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(){/**
|
|
23687
23919
|
* WebMessaging service.
|
|
23688
23920
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
23689
|
-
* @version
|
|
23921
|
+
* @version 207.0.0
|
|
23690
23922
|
*//**
|
|
23691
23923
|
* Constructs a new WebMessagingApi.
|
|
23692
23924
|
* @alias module:purecloud-platform-client-v2/api/WebMessagingApi
|
|
@@ -23702,7 +23934,7 @@ if(deployment===undefined||deployment===null){throw'Missing the required paramet
|
|
|
23702
23934
|
*/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(){/**
|
|
23703
23935
|
* Widgets service.
|
|
23704
23936
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
23705
|
-
* @version
|
|
23937
|
+
* @version 207.0.0
|
|
23706
23938
|
*//**
|
|
23707
23939
|
* Constructs a new WidgetsApi.
|
|
23708
23940
|
* @alias module:purecloud-platform-client-v2/api/WidgetsApi
|
|
@@ -23737,7 +23969,7 @@ if(deploymentId===undefined||deploymentId===null){throw'Missing the required par
|
|
|
23737
23969
|
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(){/**
|
|
23738
23970
|
* WorkforceManagement service.
|
|
23739
23971
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
23740
|
-
* @version
|
|
23972
|
+
* @version 207.0.0
|
|
23741
23973
|
*//**
|
|
23742
23974
|
* Constructs a new WorkforceManagementApi.
|
|
23743
23975
|
* @alias module:purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
@@ -24711,6 +24943,13 @@ if(managementUnitId===undefined||managementUnitId===null){throw'Missing the requ
|
|
|
24711
24943
|
* @param {Object} opts.body body
|
|
24712
24944
|
*/},{key:"patchWorkforcemanagementManagementunitAgents",value:function patchWorkforcemanagementManagementunitAgents(managementUnitId,opts){opts=opts||{};// verify the required parameter 'managementUnitId' is set
|
|
24713
24945
|
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']);}/**
|
|
24946
|
+
* Updates agent work plan configuration
|
|
24947
|
+
*
|
|
24948
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
24949
|
+
* @param {Object} opts Optional parameters
|
|
24950
|
+
* @param {Object} opts.body body
|
|
24951
|
+
*/},{key:"patchWorkforcemanagementManagementunitAgentsWorkplansBulk",value:function patchWorkforcemanagementManagementunitAgentsWorkplansBulk(managementUnitId,opts){opts=opts||{};// verify the required parameter 'managementUnitId' is set
|
|
24952
|
+
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']);}/**
|
|
24714
24953
|
* Updates a time off limit object.
|
|
24715
24954
|
* Updates time off limit object properties, but not daily values.
|
|
24716
24955
|
* @param {String} managementUnitId The ID of the management unit.
|
|
@@ -25195,6 +25434,14 @@ if(businessUnitId===undefined||businessUnitId===null){throw'Missing the required
|
|
|
25195
25434
|
* @param {String} hrisIntegrationId The ID of the HRIS integration for which time off types are queried.
|
|
25196
25435
|
*/},{key:"postWorkforcemanagementIntegrationsHriTimeofftypesJobs",value:function postWorkforcemanagementIntegrationsHriTimeofftypesJobs(hrisIntegrationId){// verify the required parameter 'hrisIntegrationId' is set
|
|
25197
25436
|
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']);}/**
|
|
25437
|
+
* Get agents work plans configuration
|
|
25438
|
+
*
|
|
25439
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
25440
|
+
* @param {Object} opts Optional parameters
|
|
25441
|
+
* @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
|
|
25442
|
+
* @param {Object} opts.body body
|
|
25443
|
+
*/},{key:"postWorkforcemanagementManagementunitAgentsWorkplansQuery",value:function postWorkforcemanagementManagementunitAgentsWorkplansQuery(managementUnitId,opts){opts=opts||{};// verify the required parameter 'managementUnitId' is set
|
|
25444
|
+
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']);}/**
|
|
25198
25445
|
* Query published schedules for given given time range for set of users
|
|
25199
25446
|
*
|
|
25200
25447
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
@@ -25503,7 +25750,7 @@ if(timeOffLimitId===undefined||timeOffLimitId===null){throw'Missing the required
|
|
|
25503
25750
|
* </pre>
|
|
25504
25751
|
* </p>
|
|
25505
25752
|
* @module purecloud-platform-client-v2/index
|
|
25506
|
-
* @version
|
|
25753
|
+
* @version 207.0.0
|
|
25507
25754
|
*/var platformClient=/*#__PURE__*/_createClass(function platformClient(){_classCallCheck(this,platformClient);/**
|
|
25508
25755
|
* The ApiClient constructor.
|
|
25509
25756
|
* @property {module:purecloud-platform-client-v2/ApiClient}
|