purecloud-platform-client-v2 206.0.0 → 208.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 +100 -3
- package/dist/node/purecloud-platform-client-v2.js +979 -173
- package/dist/web-amd/purecloud-platform-client-v2.js +979 -173
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +341 -176
- package/dist/web-cjs/purecloud-platform-client-v2.js +358 -179
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +1646 -606
- 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 +3 -2
- 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 +234 -8
- 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 +31 -11
- package/src/purecloud-platform-client-v2/api/JourneyApi.js +136 -4
- package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +5 -21
- 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 +12 -12
- 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 +55 -1
- package/src/purecloud-platform-client-v2/api/SettingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +4 -4
- package/src/purecloud-platform-client-v2/api/StationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SuggestApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TaskManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TeamsApi.js +7 -3
- package/src/purecloud-platform-client-v2/api/TelephonyApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +55 -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 +38 -12
- 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 +1 -1
- package/src/purecloud-platform-client-v2/api/WebMessagingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WidgetsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/configuration.js +81 -0
- package/src/purecloud-platform-client-v2/index.js +1 -1
package/dist/web-cjs/bundle.js
CHANGED
|
@@ -868,18 +868,30 @@ axios.Cancel=axios.CanceledError;// Expose all/spread
|
|
|
868
868
|
axios.all=function all(promises){return Promise.all(promises);};axios.spread=spread;// Expose isAxiosError
|
|
869
869
|
axios.isAxiosError=isAxiosError;// Expose mergeConfig
|
|
870
870
|
axios.mergeConfig=mergeConfig;axios.AxiosHeaders=AxiosHeaders$1;axios.formToJSON=function(thing){return formDataToJSON(utils$1.isHTMLForm(thing)?new FormData(thing):thing);};axios.getAdapter=adapters.getAdapter;axios.HttpStatusCode=HttpStatusCode$1;axios["default"]=axios;// this module should only have a default export
|
|
871
|
-
var axios$1=axios;var logLevelEnum={level:{LNone:'none',LError:'error',LDebug:'debug',LTrace:'trace'}};var logFormatEnum={formats:{JSON:'json',TEXT:'text'}};var Logger=/*#__PURE__*/function(){function Logger(){_classCallCheck(this,Logger);this.log_level=logLevelEnum.level.LNone;this.log_format=logFormatEnum.formats.TEXT;this.log_to_console=true;this.log_file_path;this.log_response_body=false;this.log_request_body=false;this.setLogger();}return _createClass(Logger,[{key:"logLevelEnum",get:function get(){return logLevelEnum;}},{key:"logFormatEnum",get:function get(){return logFormatEnum;}},{key:"setLogger",value:function setLogger(){}},{key:"log",value:function log(level,statusCode,method,url,requestHeaders,responseHeaders,requestBody,responseBody){var content=this.formatLog(level,statusCode,method,url,requestHeaders,responseHeaders,requestBody,responseBody);if(typeof window!=='undefined'){var shouldLog=this.calculateLogLevel(level);if(shouldLog>0&&this.log_to_console===true){if(this.log_format===this.logFormatEnum.formats.JSON){console.log(content);}else{console.log("".concat(level.toUpperCase(),": ").concat(content));}}}else{if(this.logger.transports.length>0)this.logger.log(level,content);}}},{key:"calculateLogLevel",value:function calculateLogLevel(level){switch(this.log_level){case this.logLevelEnum.level.LError:if(level!==this.logLevelEnum.level.LError){return-1;}return 1;case this.logLevelEnum.level.LDebug:if(level===this.logLevelEnum.level.LTrace){return-1;}return 1;case this.logLevelEnum.level.LTrace:return 1;default:return-1;}}},{key:"formatLog",value:function formatLog(level,statusCode,method,url,requestHeaders,responseHeaders,requestBody,responseBody){var result;var localRequestHeaders=requestHeaders?JSON.parse(JSON.stringify(requestHeaders)):null;var localResponseHeaders=responseHeaders?JSON.parse(JSON.stringify(responseHeaders)):null;var localRequestBody=requestBody?JSON.parse(JSON.stringify(requestBody)):null;var localResponseBody=responseBody?JSON.parse(JSON.stringify(responseBody)):null;if(requestHeaders)localRequestHeaders['Authorization']='[REDACTED]';if(!this.log_request_body)localRequestBody=undefined;if(!this.log_response_body)localResponseBody=undefined;if(this.log_format&&this.log_format===logFormatEnum.formats.JSON){result={level:level,date:new Date().toISOString(),method:method,url:decodeURIComponent(url),correlationId:localResponseHeaders?localResponseHeaders['inin-correlation-id']?localResponseHeaders['inin-correlation-id']:'':'',statusCode:statusCode};if(localRequestHeaders)result.requestHeaders=localRequestHeaders;if(localResponseHeaders)result.responseHeaders=localResponseHeaders;if(localRequestBody)result.requestBody=localRequestBody;if(localResponseBody)result.responseBody=localResponseBody;}else{result="".concat(new Date().toISOString(),"\n=== REQUEST === \n").concat(this.formatValue('URL',decodeURIComponent(url))).concat(this.formatValue('Method',method)).concat(this.formatValue('Headers',this.formatHeaderString(localRequestHeaders))).concat(this.formatValue('Body',localRequestBody?JSON.stringify(localRequestBody,null,2):''),"\n=== RESPONSE ===\n").concat(this.formatValue('Status',statusCode)).concat(this.formatValue('Headers',this.formatHeaderString(localResponseHeaders))).concat(this.formatValue('CorrelationId',localResponseHeaders?localResponseHeaders['inin-correlation-id']?localResponseHeaders['inin-correlation-id']:'':'')).concat(this.formatValue('Body',localResponseBody?JSON.stringify(localResponseBody,null,2):''));}return result;}},{key:"formatHeaderString",value:function formatHeaderString(headers){var headerString='';if(!headers)return headerString;for(var _i=0,_Object$entries=Object.entries(headers);_i<_Object$entries.length;_i++){var _Object$entries$_i=_slicedToArray(_Object$entries[_i],2),key=_Object$entries$_i[0],value=_Object$entries$_i[1];headerString+="\n\t".concat(key,": ").concat(value);}return headerString;}},{key:"formatValue",value:function formatValue(key,value){if(!value||value===''||value==='{}')return'';return"".concat(key,": ").concat(value,"\n");}},{key:"getLogLevel",value:function getLogLevel(level){switch(level){case'error':return logLevelEnum.level.LError;case'debug':return logLevelEnum.level.LDebug;case'trace':return logLevelEnum.level.LTrace;default:return logLevelEnum.level.LNone;}}},{key:"getLogFormat",value:function getLogFormat(format){switch(format){case'json':return logFormatEnum.formats.JSON;default:return logFormatEnum.formats.TEXT;}}}]);}();var Configuration=/*#__PURE__*/function(){function Configuration(){_classCallCheck(this,Configuration);if(!Configuration.instance){Configuration.instance=this;}if(typeof window!=='undefined'){this.configPath='';}else{var os=require('os');var path=require('path');this.configPath=path.join(os.homedir(),'.genesyscloudjavascript','config');}this.refresh_access_token=true;this.refresh_token_wait_max=10;this.live_reload_config=true;this.host;this.environment;this.basePath;this.authUrl;this.config;this.logger=new Logger();this.setEnvironment();this.liveLoadConfig();}return _createClass(Configuration,[{key:"instance",get:/**
|
|
871
|
+
var axios$1=axios;var logLevelEnum={level:{LNone:'none',LError:'error',LDebug:'debug',LTrace:'trace'}};var logFormatEnum={formats:{JSON:'json',TEXT:'text'}};var Logger=/*#__PURE__*/function(){function Logger(){_classCallCheck(this,Logger);this.log_level=logLevelEnum.level.LNone;this.log_format=logFormatEnum.formats.TEXT;this.log_to_console=true;this.log_file_path;this.log_response_body=false;this.log_request_body=false;this.setLogger();}return _createClass(Logger,[{key:"logLevelEnum",get:function get(){return logLevelEnum;}},{key:"logFormatEnum",get:function get(){return logFormatEnum;}},{key:"setLogger",value:function setLogger(){}},{key:"log",value:function log(level,statusCode,method,url,requestHeaders,responseHeaders,requestBody,responseBody){var content=this.formatLog(level,statusCode,method,url,requestHeaders,responseHeaders,requestBody,responseBody);if(typeof window!=='undefined'){var shouldLog=this.calculateLogLevel(level);if(shouldLog>0&&this.log_to_console===true){if(this.log_format===this.logFormatEnum.formats.JSON){console.log(content);}else{console.log("".concat(level.toUpperCase(),": ").concat(content));}}}else{if(this.logger.transports.length>0)this.logger.log(level,content);}}},{key:"calculateLogLevel",value:function calculateLogLevel(level){switch(this.log_level){case this.logLevelEnum.level.LError:if(level!==this.logLevelEnum.level.LError){return-1;}return 1;case this.logLevelEnum.level.LDebug:if(level===this.logLevelEnum.level.LTrace){return-1;}return 1;case this.logLevelEnum.level.LTrace:return 1;default:return-1;}}},{key:"formatLog",value:function formatLog(level,statusCode,method,url,requestHeaders,responseHeaders,requestBody,responseBody){var result;var localRequestHeaders=requestHeaders?JSON.parse(JSON.stringify(requestHeaders)):null;var localResponseHeaders=responseHeaders?JSON.parse(JSON.stringify(responseHeaders)):null;var localRequestBody=requestBody?JSON.parse(JSON.stringify(requestBody)):null;var localResponseBody=responseBody?JSON.parse(JSON.stringify(responseBody)):null;if(requestHeaders)localRequestHeaders['Authorization']='[REDACTED]';if(!this.log_request_body)localRequestBody=undefined;if(!this.log_response_body)localResponseBody=undefined;if(this.log_format&&this.log_format===logFormatEnum.formats.JSON){result={level:level,date:new Date().toISOString(),method:method,url:decodeURIComponent(url),correlationId:localResponseHeaders?localResponseHeaders['inin-correlation-id']?localResponseHeaders['inin-correlation-id']:'':'',statusCode:statusCode};if(localRequestHeaders)result.requestHeaders=localRequestHeaders;if(localResponseHeaders)result.responseHeaders=localResponseHeaders;if(localRequestBody)result.requestBody=localRequestBody;if(localResponseBody)result.responseBody=localResponseBody;}else{result="".concat(new Date().toISOString(),"\n=== REQUEST === \n").concat(this.formatValue('URL',decodeURIComponent(url))).concat(this.formatValue('Method',method)).concat(this.formatValue('Headers',this.formatHeaderString(localRequestHeaders))).concat(this.formatValue('Body',localRequestBody?JSON.stringify(localRequestBody,null,2):''),"\n=== RESPONSE ===\n").concat(this.formatValue('Status',statusCode)).concat(this.formatValue('Headers',this.formatHeaderString(localResponseHeaders))).concat(this.formatValue('CorrelationId',localResponseHeaders?localResponseHeaders['inin-correlation-id']?localResponseHeaders['inin-correlation-id']:'':'')).concat(this.formatValue('Body',localResponseBody?JSON.stringify(localResponseBody,null,2):''));}return result;}},{key:"formatHeaderString",value:function formatHeaderString(headers){var headerString='';if(!headers)return headerString;for(var _i=0,_Object$entries=Object.entries(headers);_i<_Object$entries.length;_i++){var _Object$entries$_i=_slicedToArray(_Object$entries[_i],2),key=_Object$entries$_i[0],value=_Object$entries$_i[1];headerString+="\n\t".concat(key,": ").concat(value);}return headerString;}},{key:"formatValue",value:function formatValue(key,value){if(!value||value===''||value==='{}')return'';return"".concat(key,": ").concat(value,"\n");}},{key:"getLogLevel",value:function getLogLevel(level){switch(level){case'error':return logLevelEnum.level.LError;case'debug':return logLevelEnum.level.LDebug;case'trace':return logLevelEnum.level.LTrace;default:return logLevelEnum.level.LNone;}}},{key:"getLogFormat",value:function getLogFormat(format){switch(format){case'json':return logFormatEnum.formats.JSON;default:return logFormatEnum.formats.TEXT;}}}]);}();var Configuration=/*#__PURE__*/function(){function Configuration(){_classCallCheck(this,Configuration);if(!Configuration.instance){Configuration.instance=this;}if(typeof window!=='undefined'){this.configPath='';}else{var os=require('os');var path=require('path');this.configPath=path.join(os.homedir(),'.genesyscloudjavascript','config');}this.refresh_access_token=true;this.refresh_token_wait_max=10;this.live_reload_config=true;this.host;this.environment;this.basePath;this.authUrl;this.config;this.gateway=undefined;this.logger=new Logger();this.setEnvironment();this.liveLoadConfig();}return _createClass(Configuration,[{key:"instance",get:/**
|
|
872
872
|
* Singleton getter
|
|
873
873
|
*/function get(){return Configuration.instance;}/**
|
|
874
874
|
* Singleton setter
|
|
875
875
|
*/,set:function set(value){Configuration.instance=value;}},{key:"liveLoadConfig",value:function liveLoadConfig(){// If in browser, don't read config file, use default values
|
|
876
|
-
this.configPath='';}},{key:"setConfigPath",value:function setConfigPath(path){if(path&&path!==this.configPath){this.configPath=path;this.liveLoadConfig();}}},{key:"updateConfigFromFile",value:function updateConfigFromFile(){}},{key:"updateConfigValues",value:function updateConfigValues(){this.logger.log_level=this.logger.getLogLevel(this.getConfigString('logging','log_level'));this.logger.log_format=this.logger.getLogFormat(this.getConfigString('logging','log_format'));this.logger.log_to_console=this.getConfigBoolean('logging','log_to_console')!==undefined?this.getConfigBoolean('logging','log_to_console'):this.logger.log_to_console;this.logger.log_file_path=this.getConfigString('logging','log_file_path')!==undefined?this.getConfigString('logging','log_file_path'):this.logger.log_file_path;this.logger.log_response_body=this.getConfigBoolean('logging','log_response_body')!==undefined?this.getConfigBoolean('logging','log_response_body'):this.logger.log_response_body;this.logger.log_request_body=this.getConfigBoolean('logging','log_request_body')!==undefined?this.getConfigBoolean('logging','log_request_body'):this.logger.log_request_body;this.refresh_access_token=this.getConfigBoolean('reauthentication','refresh_access_token')!==undefined?this.getConfigBoolean('reauthentication','refresh_access_token'):this.refresh_access_token;this.refresh_token_wait_max=this.getConfigInt('reauthentication','refresh_token_wait_max')!==undefined?this.getConfigInt('reauthentication','refresh_token_wait_max'):this.refresh_token_wait_max;this.live_reload_config=this.getConfigBoolean('general','live_reload_config')!==undefined?this.getConfigBoolean('general','live_reload_config'):this.live_reload_config;this.host=this.getConfigString('general','host')!==undefined?this.getConfigString('general','host'):this.host;this.setEnvironment();// Update logging configs
|
|
877
|
-
this.logger.setLogger();}
|
|
876
|
+
this.configPath='';}},{key:"setConfigPath",value:function setConfigPath(path){if(path&&path!==this.configPath){this.configPath=path;this.liveLoadConfig();}}},{key:"updateConfigFromFile",value:function updateConfigFromFile(){}},{key:"updateConfigValues",value:function updateConfigValues(){this.logger.log_level=this.logger.getLogLevel(this.getConfigString('logging','log_level'));this.logger.log_format=this.logger.getLogFormat(this.getConfigString('logging','log_format'));this.logger.log_to_console=this.getConfigBoolean('logging','log_to_console')!==undefined?this.getConfigBoolean('logging','log_to_console'):this.logger.log_to_console;this.logger.log_file_path=this.getConfigString('logging','log_file_path')!==undefined?this.getConfigString('logging','log_file_path'):this.logger.log_file_path;this.logger.log_response_body=this.getConfigBoolean('logging','log_response_body')!==undefined?this.getConfigBoolean('logging','log_response_body'):this.logger.log_response_body;this.logger.log_request_body=this.getConfigBoolean('logging','log_request_body')!==undefined?this.getConfigBoolean('logging','log_request_body'):this.logger.log_request_body;this.refresh_access_token=this.getConfigBoolean('reauthentication','refresh_access_token')!==undefined?this.getConfigBoolean('reauthentication','refresh_access_token'):this.refresh_access_token;this.refresh_token_wait_max=this.getConfigInt('reauthentication','refresh_token_wait_max')!==undefined?this.getConfigInt('reauthentication','refresh_token_wait_max'):this.refresh_token_wait_max;this.live_reload_config=this.getConfigBoolean('general','live_reload_config')!==undefined?this.getConfigBoolean('general','live_reload_config'):this.live_reload_config;this.host=this.getConfigString('general','host')!==undefined?this.getConfigString('general','host'):this.host;if(this.getConfigString('gateway','host')!==undefined){var gateway={host:this.getConfigString('gateway','host')};if(this.getConfigString('gateway','protocol')!==undefined)gateway.protocol=this.getConfigString('gateway','protocol');if(this.getConfigInt('gateway','port')!==undefined)gateway.port=this.getConfigInt('gateway','port');if(this.getConfigString('gateway','path_params_login')!==undefined)gateway.path_params_login=this.getConfigString('gateway','path_params_login');if(this.getConfigString('gateway','path_params_api')!==undefined)gateway.path_params_api=this.getConfigString('gateway','path_params_api');if(this.getConfigString('gateway','username')!==undefined)gateway.username=this.getConfigString('gateway','username');if(this.getConfigString('gateway','password')!==undefined)gateway.password=this.getConfigString('gateway','password');this.setGateway(gateway);}else{this.setGateway();}this.setEnvironment();// Update logging configs
|
|
877
|
+
this.logger.setLogger();}/**
|
|
878
|
+
* @description Sets the gateway used by the session
|
|
879
|
+
* @param {object} gateway - Gateway Configuration interface
|
|
880
|
+
* @param {string} gateway.host - The address of the gateway.
|
|
881
|
+
* @param {string} gateway.protocol - (optional) The protocol to use. It will default to "https" if the parameter is not defined or empty.
|
|
882
|
+
* @param {number} gateway.port - (optional) The port to target. This parameter can be defined if a non default port is used and needs to be specified in the url (value must be greater or equal to 0).
|
|
883
|
+
* @param {string} gateway.path_params_login - (optional) An arbitrary string to be appended to the gateway url path for Login requests.
|
|
884
|
+
* @param {string} gateway.path_params_api - (optional) An arbitrary string to be appended to the gateway url path for API requests.
|
|
885
|
+
* @param {string} gateway.username - (optional) Not used at this stage (for a possible future use).
|
|
886
|
+
* @param {string} gateway.password - (optional) Not used at this stage (for a possible future use).
|
|
887
|
+
*/},{key:"setGateway",value:function setGateway(gateway){if(gateway){this.gateway={host:''};if(gateway.protocol)this.gateway.protocol=gateway.protocol;else this.gateway.protocol='https';if(gateway.host)this.gateway.host=gateway.host;else this.gateway.host='';if(gateway.port&&gateway.port>-1)this.gateway.port=gateway.port;else this.gateway.port=-1;if(gateway.path_params_login){this.gateway.path_params_login=gateway.path_params_login;// Strip trailing slash
|
|
888
|
+
this.gateway.path_params_login=this.gateway.path_params_login.replace(/\/+$/,'');}else this.gateway.path_params_login='';if(gateway.path_params_api){this.gateway.path_params_api=gateway.path_params_api;// Strip trailing slash
|
|
889
|
+
this.gateway.path_params_api=this.gateway.path_params_api.replace(/\/+$/,'');}else this.gateway.path_params_api='';if(gateway.username)this.gateway.username=gateway.username;if(gateway.password)this.gateway.password=gateway.password;}else{this.gateway=undefined;}}},{key:"setEnvironment",value:function setEnvironment(env){// Default value
|
|
878
890
|
if(env)this.environment=env;else this.environment=this.host?this.host:'mypurecloud.com';// Strip trailing slash
|
|
879
891
|
this.environment=this.environment.replace(/\/+$/,'');// Strip protocol and subdomain
|
|
880
|
-
if(this.environment.startsWith('https://'))this.environment=this.environment.substring(8);if(this.environment.startsWith('http://'))this.environment=this.environment.substring(7);if(this.environment.startsWith('api.'))this.environment=this.environment.substring(4);this.basePath="https://api.".concat(this.environment);this.authUrl="https://login.".concat(this.environment);}},{key:"getConfigString",value:function getConfigString(section,key){if(this.config._sections[section])return this.config._sections[section][key];}},{key:"getConfigBoolean",value:function getConfigBoolean(section,key){if(this.config._sections[section]&&this.config._sections[section][key]!==undefined){if(typeof this.config._sections[section][key]==='string'){return this.config._sections[section][key]==='true';}else return this.config._sections[section][key];}}},{key:"getConfigInt",value:function getConfigInt(section,key){if(this.config._sections[section]&&this.config._sections[section][key]){if(typeof this.config._sections[section][key]==='string'){return parseInt(this.config._sections[section][key]);}else return this.config._sections[section][key];}}}]);}();/**
|
|
892
|
+
if(this.environment.startsWith('https://'))this.environment=this.environment.substring(8);if(this.environment.startsWith('http://'))this.environment=this.environment.substring(7);if(this.environment.startsWith('api.'))this.environment=this.environment.substring(4);this.basePath="https://api.".concat(this.environment);this.authUrl="https://login.".concat(this.environment);}},{key:"getConfUrl",value:function getConfUrl(pathType,regionUrl){if(!this.gateway)return regionUrl;if(!this.gateway.host)return regionUrl;var url=this.gateway.protocol+'://'+this.gateway.host;if(this.gateway.port>-1)url=url+':'+this.gateway.port.toString();if(pathType==='login'){if(this.gateway.path_params_login){if(this.gateway.path_params_login.startsWith('/'))url=url+this.gateway.path_params_login;else url=url+'/'+this.gateway.path_params_login;}}else{if(this.gateway.path_params_api){if(this.gateway.path_params_api.startsWith('/'))url=url+this.gateway.path_params_api;else url=url+'/'+this.gateway.path_params_api;}}return url;}},{key:"getConfigString",value:function getConfigString(section,key){if(this.config._sections[section])return this.config._sections[section][key];}},{key:"getConfigBoolean",value:function getConfigBoolean(section,key){if(this.config._sections[section]&&this.config._sections[section][key]!==undefined){if(typeof this.config._sections[section][key]==='string'){return this.config._sections[section][key]==='true';}else return this.config._sections[section][key];}}},{key:"getConfigInt",value:function getConfigInt(section,key){if(this.config._sections[section]&&this.config._sections[section][key]){if(typeof this.config._sections[section][key]==='string'){return parseInt(this.config._sections[section][key]);}else return this.config._sections[section][key];}}}]);}();/**
|
|
881
893
|
* @module purecloud-platform-client-v2/ApiClient
|
|
882
|
-
* @version
|
|
894
|
+
* @version 208.0.0
|
|
883
895
|
*/var ApiClient=/*#__PURE__*/function(){/**
|
|
884
896
|
* Manages low level client-server communications, parameter marshalling, etc. There should not be any need for an
|
|
885
897
|
* application to use this class directly - the *Api and model classes provide the public API for the service. The
|
|
@@ -948,6 +960,16 @@ var tempState=this.authData.state;this.authData=localStorage.getItem("".concat(t
|
|
|
948
960
|
* @description Sets the environment used by the session
|
|
949
961
|
* @param {string} environment - (Optional, default "mypurecloud.com") Environment the session use, e.g. mypurecloud.ie, mypurecloud.com.au, etc.
|
|
950
962
|
*/},{key:"setEnvironment",value:function setEnvironment(environment){this.config.setEnvironment(environment);}/**
|
|
963
|
+
* @description Sets the gateway used by the session
|
|
964
|
+
* @param {object} gateway - Gateway Configuration interface
|
|
965
|
+
* @param {string} gateway.host - The address of the gateway.
|
|
966
|
+
* @param {string} gateway.protocol - (optional) The protocol to use. It will default to "https" if the parameter is not defined or empty.
|
|
967
|
+
* @param {string} gateway.port - (optional) The port to target. This parameter can be defined if a non default port is used and needs to be specified in the url (value must be greater than 0).
|
|
968
|
+
* @param {string} gateway.path_params_login - (optional) An arbitrary string to be appended to the gateway url path for Login requests.
|
|
969
|
+
* @param {string} gateway.path_params_api - (optional) An arbitrary string to be appended to the gateway url path for API requests.
|
|
970
|
+
* @param {string} gateway.username - (optional) Not used at this stage (for a possible future use).
|
|
971
|
+
* @param {string} gateway.password - (optional) Not used at this stage (for a possible future use).
|
|
972
|
+
*/},{key:"setGateway",value:function setGateway(gateway){this.config.setGateway(gateway);}/**
|
|
951
973
|
* @description Initiates the implicit grant login flow. Will attempt to load the token from local storage, if enabled.
|
|
952
974
|
* @param {string} clientId - The client ID of an OAuth Implicit Grant client
|
|
953
975
|
* @param {string} redirectUri - The redirect URI of the OAuth Implicit Grant client
|
|
@@ -963,35 +985,35 @@ _this2._testTokenAccess().then(function(){if(!_this2.authData.state&&opts.state)
|
|
|
963
985
|
* @description Initiates the client credentials login flow. Only available in node apps.
|
|
964
986
|
* @param {string} clientId - The client ID of an OAuth Implicit Grant client
|
|
965
987
|
* @param {string} clientSecret - The client secret of an OAuth Implicit Grant client
|
|
966
|
-
*/},{key:"loginClientCredentialsGrant",value:function loginClientCredentialsGrant(clientId,clientSecret){var _this3=this;this.clientId=clientId;var authHeader=Buffer.from("".concat(clientId,":").concat(clientSecret)).toString('base64');return new Promise(function(resolve,reject){// Block browsers from using client credentials
|
|
967
|
-
if(typeof window!=='undefined'){reject(new Error('The client credentials grant is not supported in a browser.'));return;}var headers={'Authorization':"Basic ".concat(authHeader)};axios$1({method:"POST",url:"
|
|
968
|
-
_this3.config.logger.log('trace',response.status,'POST',"
|
|
988
|
+
*/},{key:"loginClientCredentialsGrant",value:function loginClientCredentialsGrant(clientId,clientSecret){var _this3=this;this.clientId=clientId;var authHeader=Buffer.from("".concat(clientId,":").concat(clientSecret)).toString('base64');var loginBasePath=this.config.getConfUrl('login',"https://login.".concat(this.config.environment));return new Promise(function(resolve,reject){// Block browsers from using client credentials
|
|
989
|
+
if(typeof window!=='undefined'){reject(new Error('The client credentials grant is not supported in a browser.'));return;}var headers={'Authorization':"Basic ".concat(authHeader)};axios$1({method:"POST",url:"".concat(loginBasePath,"/oauth/token"),headers:headers,data:'grant_type=client_credentials',httpsAgent:_this3.proxyAgent}).then(function(response){// Logging
|
|
990
|
+
_this3.config.logger.log('trace',response.status,'POST',"".concat(loginBasePath,"/oauth/token"),headers,response.headers,{grant_type:'client_credentials'},undefined);_this3.config.logger.log('debug',response.status,'POST',"".concat(loginBasePath,"/oauth/token"),headers,undefined,{grant_type:'client_credentials'},undefined);// Save access token
|
|
969
991
|
_this3.setAccessToken(response.data['access_token']);// Set expiry time
|
|
970
992
|
_this3.authData.tokenExpiryTime=new Date().getTime()+response.data['expires_in']*1000;_this3.authData.tokenExpiryTimeString=new Date(_this3.authData.tokenExpiryTime).toUTCString();// Return auth data
|
|
971
993
|
resolve(_this3.authData);})["catch"](function(error){// Log error
|
|
972
|
-
if(error.response){_this3.config.logger.log('error',error.response.status,'POST',"
|
|
994
|
+
if(error.response){_this3.config.logger.log('error',error.response.status,'POST',"".concat(loginBasePath,"/oauth/token"),headers,error.response.headers,{grant_type:'client_credentials'},error.response.data);}reject(error);});});}/**
|
|
973
995
|
* @description Initiates the Saml2Bearerflow. Only available in node apps.
|
|
974
996
|
* @param {string} clientId - The client ID of an OAuth Implicit Grant client
|
|
975
997
|
* @param {string} clientSecret - The client secret of an OAuth Implicit Grant client
|
|
976
998
|
* @param {string} orgName - The orgName of an OAuth Implicit Grant client
|
|
977
999
|
* @param {string} assertion - The saml2bearer assertion
|
|
978
|
-
*/},{key:"loginSaml2BearerGrant",value:function loginSaml2BearerGrant(clientId,clientSecret,orgName,assertion){var _this4=this;this.clientId=clientId;return new Promise(function(resolve,reject){if(typeof window!=='undefined'){reject(new Error('The saml2bearer grant is not supported in a browser.'));return;}var encodedData=Buffer.from(clientId+':'+clientSecret).toString('base64');var request=_this4._formAuthRequest(encodedData,{grant_type:'urn:ietf:params:oauth:grant-type:saml2-bearer',orgName:orgName,assertion:assertion});request.proxy=_this4.proxy;var bodyParam={grant_type:'urn:ietf:params:oauth:grant-type:saml2-bearer',orgName:orgName,assertion:assertion};// Handle response
|
|
1000
|
+
*/},{key:"loginSaml2BearerGrant",value:function loginSaml2BearerGrant(clientId,clientSecret,orgName,assertion){var _this4=this;this.clientId=clientId;var loginBasePath=this.config.getConfUrl('login',"https://login.".concat(this.config.environment));return new Promise(function(resolve,reject){if(typeof window!=='undefined'){reject(new Error('The saml2bearer grant is not supported in a browser.'));return;}var encodedData=Buffer.from(clientId+':'+clientSecret).toString('base64');var request=_this4._formAuthRequest(encodedData,{grant_type:'urn:ietf:params:oauth:grant-type:saml2-bearer',orgName:orgName,assertion:assertion});request.proxy=_this4.proxy;var bodyParam={grant_type:'urn:ietf:params:oauth:grant-type:saml2-bearer',orgName:orgName,assertion:assertion};// Handle response
|
|
979
1001
|
request.then(function(response){// Logging
|
|
980
|
-
_this4.config.logger.log('trace',response.status,'POST',"
|
|
1002
|
+
_this4.config.logger.log('trace',response.status,'POST',"".concat(loginBasePath,"/oauth/token"),request.headers,response.headers,bodyParam,undefined);_this4.config.logger.log('debug',response.status,'POST',"".concat(loginBasePath,"/oauth/token"),request.headers,undefined,bodyParam,undefined);// Get access token from response
|
|
981
1003
|
var access_token=response.data.access_token;_this4.setAccessToken(access_token);_this4.authData.tokenExpiryTime=new Date().getTime()+response.data['expires_in']*1000;_this4.authData.tokenExpiryTimeString=new Date(_this4.authData.tokenExpiryTime).toUTCString();// Return auth data
|
|
982
1004
|
resolve(_this4.authData);})["catch"](function(error){// Log error
|
|
983
|
-
if(error.response){_this4.config.logger.log('error',error.response.status,'POST',"
|
|
1005
|
+
if(error.response){_this4.config.logger.log('error',error.response.status,'POST',"".concat(loginBasePath,"/oauth/token"),request.headers,error.response.headers,bodyParam,error.response.data);}reject(error);});});}/**
|
|
984
1006
|
* @description Completes the PKCE Code Authorization.
|
|
985
1007
|
* @param {string} clientId - The client ID of an OAuth Code Authorization Grant client
|
|
986
1008
|
* @param {string} codeVerifier - code verifier used to generate the code challenge
|
|
987
1009
|
* @param {string} authCode - Authorization code
|
|
988
1010
|
* @param {string} redirectUri - Authorized redirect URI for your Code Authorization client
|
|
989
|
-
*/},{key:"authorizePKCEGrant",value:function authorizePKCEGrant(clientId,codeVerifier,authCode,redirectUri){var _this5=this;this.clientId=clientId;return new Promise(function(resolve,reject){var request=axios$1({method:"POST",url:"
|
|
1011
|
+
*/},{key:"authorizePKCEGrant",value:function authorizePKCEGrant(clientId,codeVerifier,authCode,redirectUri){var _this5=this;this.clientId=clientId;var loginBasePath=this.config.getConfUrl('login',"https://login.".concat(this.config.environment));return new Promise(function(resolve,reject){var request=axios$1({method:"POST",url:"".concat(loginBasePath,"/oauth/token"),headers:{'Content-Type':'application/x-www-form-urlencoded'},data:qs__default["default"].stringify({grant_type:'authorization_code',code:authCode,code_verifier:codeVerifier,client_id:clientId,redirect_uri:redirectUri})});request.proxy=_this5.proxy;var bodyParam={grant_type:'authorization_code',code:authCode,code_verifier:codeVerifier,client_id:clientId,redirect_uri:redirectUri};// Handle response
|
|
990
1012
|
request.then(function(response){// Logging
|
|
991
|
-
_this5.config.logger.log('trace',response.status,'POST',"
|
|
1013
|
+
_this5.config.logger.log('trace',response.status,'POST',"".concat(loginBasePath,"/oauth/token"),request.headers,response.headers,bodyParam,undefined);_this5.config.logger.log('debug',response.status,'POST',"".concat(loginBasePath,"/oauth/token"),request.headers,undefined,bodyParam,undefined);// Get access token from response
|
|
992
1014
|
var access_token=response.data.access_token;_this5.setAccessToken(access_token);_this5.authData.tokenExpiryTime=new Date().getTime()+response.data['expires_in']*1000;_this5.authData.tokenExpiryTimeString=new Date(_this5.authData.tokenExpiryTime).toUTCString();// Return auth data
|
|
993
1015
|
resolve(_this5.authData);})["catch"](function(error){// Log error
|
|
994
|
-
if(error.response){_this5.config.logger.log('error',error.response.status,'POST',"
|
|
1016
|
+
if(error.response){_this5.config.logger.log('error',error.response.status,'POST',"".concat(loginBasePath,"/oauth/token"),request.headers,error.response.headers,bodyParam,error.response.data);}reject(error);});});}/**
|
|
995
1017
|
* @description Generate a random string used as PKCE Code Verifier - length = 43 to 128.
|
|
996
1018
|
* @param {number} nChar - code length
|
|
997
1019
|
*/},{key:"generatePKCECodeVerifier",value:function generatePKCECodeVerifier(nChar){if(nChar<43||nChar>128){throw new Error("PKCE Code Verifier (length) must be between 43 and 128 characters");}// Check for window
|
|
@@ -1057,15 +1079,15 @@ _this8._handleCodeAuthorizationResponse(request,bodyParam,resolve,reject);});}/*
|
|
|
1057
1079
|
* @param {object} bodyParam - Input body data for authorization request
|
|
1058
1080
|
* @param {function} resolve - Promise resolve callback
|
|
1059
1081
|
* @param {function} reject - Promise reject callback
|
|
1060
|
-
*/},{key:"_handleCodeAuthorizationResponse",value:function _handleCodeAuthorizationResponse(request,bodyParam,resolve,reject){var _this9=this;request.then(function(response){// Logging
|
|
1061
|
-
_this9.config.logger.log('trace',response.status,'POST',"
|
|
1082
|
+
*/},{key:"_handleCodeAuthorizationResponse",value:function _handleCodeAuthorizationResponse(request,bodyParam,resolve,reject){var _this9=this;var loginBasePath=this.config.getConfUrl('login',"https://login.".concat(this.config.environment));request.then(function(response){// Logging
|
|
1083
|
+
_this9.config.logger.log('trace',response.status,'POST',"".concat(loginBasePath,"/oauth/token"),request.headers,response.headers,bodyParam,undefined);_this9.config.logger.log('debug',response.status,'POST',"".concat(loginBasePath,"/oauth/token"),request.headers,undefined,bodyParam,undefined);// Get access token from response
|
|
1062
1084
|
var access_token=response.data.access_token;var refresh_token=response.data.refresh_token;_this9.setAccessToken(access_token);_this9.authData.refreshToken=refresh_token;_this9.authData.tokenExpiryTime=new Date().getTime()+response.data['expires_in']*1000;_this9.authData.tokenExpiryTimeString=new Date(_this9.authData.tokenExpiryTime).toUTCString();// Return auth data
|
|
1063
1085
|
resolve(_this9.authData);})["catch"](function(error){// Log error
|
|
1064
|
-
if(error.response){_this9.config.logger.log('error',error.response.status,'POST',"
|
|
1086
|
+
if(error.response){_this9.config.logger.log('error',error.response.status,'POST',"".concat(loginBasePath,"/oauth/token"),request.headers,error.response.headers,bodyParam,error.response.data);}reject(error);});}/**
|
|
1065
1087
|
* @description Utility function to create the request for auth requests
|
|
1066
1088
|
* @param {string} encodedData - Base64 encoded client and clientSecret pair
|
|
1067
1089
|
* @param {object} data - data to url form encode
|
|
1068
|
-
*/},{key:"_formAuthRequest",value:function _formAuthRequest(encodedData,data){var request=axios$1({method:"POST",url:"
|
|
1090
|
+
*/},{key:"_formAuthRequest",value:function _formAuthRequest(encodedData,data){var loginBasePath=this.config.getConfUrl('login',"https://login.".concat(this.config.environment));var request=axios$1({method:"POST",url:"".concat(loginBasePath,"/oauth/token"),headers:{'Authorization':'Basic '+encodedData,'Content-Type':'application/x-www-form-urlencoded'},data:qs__default["default"].stringify(data)});return request;}/**
|
|
1069
1091
|
* @description Handles an expired access token. Only available in node apps.
|
|
1070
1092
|
* @param {string} statusCode - The status code of a request
|
|
1071
1093
|
*/},{key:"_handleExpiredAccessToken",value:function _handleExpiredAccessToken(){var _this10=this;return new Promise(function(resolve,reject){if(typeof window!=='undefined'){reject(new Error('This method is not supported in a browser.'));return;}if(!_this10.refreshInProgress){_this10.refreshInProgress=true;_this10.refreshCodeAuthorizationGrant(_this10.clientId,_this10.clientSecret,_this10.authData.refreshToken).then(function(){_this10.refreshInProgress=false;resolve();})["catch"](function(err){// Handle failure response
|
|
@@ -1104,7 +1126,7 @@ this.setAccessToken(this.authentications['PureCloud OAuth'].accessToken);}/**
|
|
|
1104
1126
|
* @description Constructs a URL to the auth server
|
|
1105
1127
|
* @param {string} path - The path for the URL
|
|
1106
1128
|
* @param {object} query - An object of key/value pairs to use for querystring keys/values
|
|
1107
|
-
*/},{key:"_buildAuthUrl",value:function _buildAuthUrl(path,query){if(!query)query={};return Object.keys(query).reduce(function(url,key){return!query[key]?url:"".concat(url,"&").concat(key,"=").concat(query[key]);},"".concat(
|
|
1129
|
+
*/},{key:"_buildAuthUrl",value:function _buildAuthUrl(path,query){if(!query)query={};var loginBasePath=this.config.getConfUrl('login',this.config.authUrl);return Object.keys(query).reduce(function(url,key){return!query[key]?url:"".concat(url,"&").concat(key,"=").concat(query[key]);},"".concat(loginBasePath,"/").concat(path,"?"));}/**
|
|
1108
1130
|
* Returns a string representation for an actual parameter.
|
|
1109
1131
|
* @param param The actual parameter.
|
|
1110
1132
|
* @returns {String} The string representation of <code>param</code>.
|
|
@@ -1123,7 +1145,7 @@ this.setAccessToken(this.authentications['PureCloud OAuth'].accessToken);}/**
|
|
|
1123
1145
|
* @param {String} path The path to append to the base URL.
|
|
1124
1146
|
* @param {Object} pathParams The parameter values to append.
|
|
1125
1147
|
* @returns {String} The encoded path with parameter values substituted.
|
|
1126
|
-
*/},{key:"buildUrl",value:function buildUrl(path,pathParams){var _this12=this;if(!path.match(/^\//)){path="/".concat(path);}var url=this.config.basePath+path;url=url.replace(/\{([\w-]+)\}/g,function(fullMatch,key){var value;if(pathParams.hasOwnProperty(key)){value=_this12.paramToString(pathParams[key]);}else{value=fullMatch;}return encodeURIComponent(value);});return url;}/**
|
|
1148
|
+
*/},{key:"buildUrl",value:function buildUrl(path,pathParams){var _this12=this;if(!path.match(/^\//)){path="/".concat(path);}var url=this.config.getConfUrl('api',this.config.basePath)+path;url=url.replace(/\{([\w-]+)\}/g,function(fullMatch,key){var value;if(pathParams.hasOwnProperty(key)){value=_this12.paramToString(pathParams[key]);}else{value=fullMatch;}return encodeURIComponent(value);});return url;}/**
|
|
1127
1149
|
* Checks whether the given content type represents JSON.<br>
|
|
1128
1150
|
* JSON content type examples:<br>
|
|
1129
1151
|
* <ul>
|
|
@@ -1191,7 +1213,7 @@ resolve(data);})["catch"](function(error){var data=error;if(error.response&&erro
|
|
|
1191
1213
|
that.config.logger.log('error',error.response.status,httpMethod,url,request.headers,error.response.headers,bodyParam,error.response.data);data=that.returnExtended===true?{status:error.response.status,statusText:error.response.statusText,headers:error.response.headers,body:error.response.data,text:error.response.text,error:error}:error.response.data?error.response.data:error.response.text;}reject(data);});}});}}]);}();var AgentAssistantsApi=/*#__PURE__*/function(){/**
|
|
1192
1214
|
* AgentAssistants service.
|
|
1193
1215
|
* @module purecloud-platform-client-v2/api/AgentAssistantsApi
|
|
1194
|
-
* @version
|
|
1216
|
+
* @version 208.0.0
|
|
1195
1217
|
*//**
|
|
1196
1218
|
* Constructs a new AgentAssistantsApi.
|
|
1197
1219
|
* @alias module:purecloud-platform-client-v2/api/AgentAssistantsApi
|
|
@@ -1292,7 +1314,7 @@ if(queueId===undefined||queueId===null){throw'Missing the required parameter "qu
|
|
|
1292
1314
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putAssistantQueue';}return this.apiClient.callApi('/api/v2/assistants/{assistantId}/queues/{queueId}','PUT',{'assistantId':assistantId,'queueId':queueId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var AgentCopilotApi=/*#__PURE__*/function(){/**
|
|
1293
1315
|
* AgentCopilot service.
|
|
1294
1316
|
* @module purecloud-platform-client-v2/api/AgentCopilotApi
|
|
1295
|
-
* @version
|
|
1317
|
+
* @version 208.0.0
|
|
1296
1318
|
*//**
|
|
1297
1319
|
* Constructs a new AgentCopilotApi.
|
|
1298
1320
|
* @alias module:purecloud-platform-client-v2/api/AgentCopilotApi
|
|
@@ -1314,7 +1336,7 @@ if(assistantId===undefined||assistantId===null){throw'Missing the required param
|
|
|
1314
1336
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putAssistantCopilot';}return this.apiClient.callApi('/api/v2/assistants/{assistantId}/copilot','PUT',{'assistantId':assistantId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var AgentUIApi=/*#__PURE__*/function(){/**
|
|
1315
1337
|
* AgentUI service.
|
|
1316
1338
|
* @module purecloud-platform-client-v2/api/AgentUIApi
|
|
1317
|
-
* @version
|
|
1339
|
+
* @version 208.0.0
|
|
1318
1340
|
*//**
|
|
1319
1341
|
* Constructs a new AgentUIApi.
|
|
1320
1342
|
* @alias module:purecloud-platform-client-v2/api/AgentUIApi
|
|
@@ -1348,7 +1370,7 @@ if(agentId===undefined||agentId===null){throw'Missing the required parameter "ag
|
|
|
1348
1370
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putUsersAgentuiAgentsAutoanswerAgentIdSettings';}return this.apiClient.callApi('/api/v2/users/agentui/agents/autoanswer/{agentId}/settings','PUT',{'agentId':agentId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var AlertingApi=/*#__PURE__*/function(){/**
|
|
1349
1371
|
* Alerting service.
|
|
1350
1372
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
1351
|
-
* @version
|
|
1373
|
+
* @version 208.0.0
|
|
1352
1374
|
*//**
|
|
1353
1375
|
* Constructs a new AlertingApi.
|
|
1354
1376
|
* @alias module:purecloud-platform-client-v2/api/AlertingApi
|
|
@@ -1505,7 +1527,7 @@ if(ruleId===undefined||ruleId===null){throw'Missing the required parameter "rule
|
|
|
1505
1527
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putAlertingRule';}return this.apiClient.callApi('/api/v2/alerting/rules/{ruleId}','PUT',{'ruleId':ruleId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var AnalyticsApi=/*#__PURE__*/function(){/**
|
|
1506
1528
|
* Analytics service.
|
|
1507
1529
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
1508
|
-
* @version
|
|
1530
|
+
* @version 208.0.0
|
|
1509
1531
|
*//**
|
|
1510
1532
|
* Constructs a new AnalyticsApi.
|
|
1511
1533
|
* @alias module:purecloud-platform-client-v2/api/AnalyticsApi
|
|
@@ -1729,7 +1751,8 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
1729
1751
|
* @param {Number} opts.pageSize (default to 25)
|
|
1730
1752
|
* @param {Array.<String>} opts.id A list of user IDs to fetch by bulk
|
|
1731
1753
|
* @param {Object} opts.state Only list users of this state
|
|
1732
|
-
|
|
1754
|
+
* @param {Boolean} opts.deletedOnly Only list deleted dashboards that are still recoverable
|
|
1755
|
+
*/},{key:"getAnalyticsReportingDashboardsUsers",value:function getAnalyticsReportingDashboardsUsers(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/analytics/reporting/dashboards/users','GET',{},{'sortBy':opts['sortBy'],'pageNumber':opts['pageNumber'],'pageSize':opts['pageSize'],'id':this.apiClient.buildCollectionParam(opts['id'],'multi'),'state':opts['state'],'deletedOnly':opts['deletedOnly']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
1733
1756
|
* Get all view export requests for a user
|
|
1734
1757
|
*
|
|
1735
1758
|
* @param {Object} opts Optional parameters
|
|
@@ -1763,9 +1786,10 @@ if(dashboardAccessFilter===undefined||dashboardAccessFilter===null){throw'Missin
|
|
|
1763
1786
|
* @param {Number} opts.pageSize (default to 50)
|
|
1764
1787
|
* @param {Boolean} opts.publicOnly If true, retrieve only public dashboards
|
|
1765
1788
|
* @param {Boolean} opts.favoriteOnly If true, retrieve only favorite dashboards
|
|
1789
|
+
* @param {Boolean} opts.deletedOnly If true, retrieve only deleted dashboards that are still recoverable
|
|
1766
1790
|
* @param {String} opts.name retrieve dashboards that match with given name
|
|
1767
1791
|
*/},{key:"getAnalyticsReportingSettingsUserDashboards",value:function getAnalyticsReportingSettingsUserDashboards(userId,opts){opts=opts||{};// verify the required parameter 'userId' is set
|
|
1768
|
-
if(userId===undefined||userId===null){throw'Missing the required parameter "userId" when calling getAnalyticsReportingSettingsUserDashboards';}return this.apiClient.callApi('/api/v2/analytics/reporting/settings/users/{userId}/dashboards','GET',{'userId':userId},{'sortBy':opts['sortBy'],'pageNumber':opts['pageNumber'],'pageSize':opts['pageSize'],'publicOnly':opts['publicOnly'],'favoriteOnly':opts['favoriteOnly'],'name':opts['name']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
1792
|
+
if(userId===undefined||userId===null){throw'Missing the required parameter "userId" when calling getAnalyticsReportingSettingsUserDashboards';}return this.apiClient.callApi('/api/v2/analytics/reporting/settings/users/{userId}/dashboards','GET',{'userId':userId},{'sortBy':opts['sortBy'],'pageNumber':opts['pageNumber'],'pageSize':opts['pageSize'],'publicOnly':opts['publicOnly'],'favoriteOnly':opts['favoriteOnly'],'deletedOnly':opts['deletedOnly'],'name':opts['name']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
1769
1793
|
* Get status for async query for resolution aggregates
|
|
1770
1794
|
*
|
|
1771
1795
|
* @param {String} jobId jobId
|
|
@@ -2009,7 +2033,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
2009
2033
|
* @param {Object} body query
|
|
2010
2034
|
*/},{key:"postAnalyticsRatelimitsAggregatesQuery",value:function postAnalyticsRatelimitsAggregatesQuery(body){// verify the required parameter 'body' is set
|
|
2011
2035
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postAnalyticsRatelimitsAggregatesQuery';}return this.apiClient.callApi('/api/v2/analytics/ratelimits/aggregates/query','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
2012
|
-
* Bulk delete dashboards owned by other user(s)
|
|
2036
|
+
* Bulk soft delete dashboards owned by other user(s)
|
|
2013
2037
|
*
|
|
2014
2038
|
* @param {Array.<String>} body List of userIds
|
|
2015
2039
|
*/},{key:"postAnalyticsReportingDashboardsUsersBulkRemove",value:function postAnalyticsReportingDashboardsUsersBulkRemove(body){// verify the required parameter 'body' is set
|
|
@@ -2019,7 +2043,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
2019
2043
|
* @param {Object} body ReportingExportJobRequest
|
|
2020
2044
|
*/},{key:"postAnalyticsReportingExports",value:function postAnalyticsReportingExports(body){// verify the required parameter 'body' is set
|
|
2021
2045
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postAnalyticsReportingExports';}return this.apiClient.callApi('/api/v2/analytics/reporting/exports','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
2022
|
-
* Bulk
|
|
2046
|
+
* Bulk soft delete dashboard configurations
|
|
2023
2047
|
*
|
|
2024
2048
|
* @param {Object} body
|
|
2025
2049
|
*/},{key:"postAnalyticsReportingSettingsDashboardsBulkRemove",value:function postAnalyticsReportingSettingsDashboardsBulkRemove(body){// verify the required parameter 'body' is set
|
|
@@ -2063,7 +2087,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
2063
2087
|
* Query for task management aggregates
|
|
2064
2088
|
*
|
|
2065
2089
|
* @param {Object} body query
|
|
2066
|
-
* postAnalyticsTaskmanagementAggregatesQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2067
2090
|
*/},{key:"postAnalyticsTaskmanagementAggregatesQuery",value:function postAnalyticsTaskmanagementAggregatesQuery(body){// verify the required parameter 'body' is set
|
|
2068
2091
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postAnalyticsTaskmanagementAggregatesQuery';}return this.apiClient.callApi('/api/v2/analytics/taskmanagement/aggregates/query','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
2069
2092
|
* Query for team activity observations
|
|
@@ -2126,7 +2149,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
2126
2149
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putAnalyticsDataretentionSettings';}return this.apiClient.callApi('/api/v2/analytics/dataretention/settings','PUT',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var ArchitectApi=/*#__PURE__*/function(){/**
|
|
2127
2150
|
* Architect service.
|
|
2128
2151
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
2129
|
-
* @version
|
|
2152
|
+
* @version 208.0.0
|
|
2130
2153
|
*//**
|
|
2131
2154
|
* Constructs a new ArchitectApi.
|
|
2132
2155
|
* @alias module:purecloud-platform-client-v2/api/ArchitectApi
|
|
@@ -2616,7 +2639,7 @@ if(flowId===undefined||flowId===null){throw'Missing the required parameter "flow
|
|
|
2616
2639
|
*/},{key:"getFlowVersion",value:function getFlowVersion(flowId,versionId,opts){opts=opts||{};// verify the required parameter 'flowId' is set
|
|
2617
2640
|
if(flowId===undefined||flowId===null){throw'Missing the required parameter "flowId" when calling getFlowVersion';}// verify the required parameter 'versionId' is set
|
|
2618
2641
|
if(versionId===undefined||versionId===null){throw'Missing the required parameter "versionId" when calling getFlowVersion';}return this.apiClient.callApi('/api/v2/flows/{flowId}/versions/{versionId}','GET',{'flowId':flowId,'versionId':versionId},{'deleted':opts['deleted']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
2619
|
-
*
|
|
2642
|
+
* Get flow version configuration
|
|
2620
2643
|
*
|
|
2621
2644
|
* @param {String} flowId Flow ID
|
|
2622
2645
|
* @param {String} versionId Version ID
|
|
@@ -3218,7 +3241,7 @@ if(milestoneId===undefined||milestoneId===null){throw'Missing the required param
|
|
|
3218
3241
|
if(flowOutcomeId===undefined||flowOutcomeId===null){throw'Missing the required parameter "flowOutcomeId" when calling putFlowsOutcome';}return this.apiClient.callApi('/api/v2/flows/outcomes/{flowOutcomeId}','PUT',{'flowOutcomeId':flowOutcomeId},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var AuditApi=/*#__PURE__*/function(){/**
|
|
3219
3242
|
* Audit service.
|
|
3220
3243
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
3221
|
-
* @version
|
|
3244
|
+
* @version 208.0.0
|
|
3222
3245
|
*//**
|
|
3223
3246
|
* Constructs a new AuditApi.
|
|
3224
3247
|
* @alias module:purecloud-platform-client-v2/api/AuditApi
|
|
@@ -3268,7 +3291,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
3268
3291
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postAuditsQueryRealtimeRelated';}return this.apiClient.callApi('/api/v2/audits/query/realtime/related','POST',{},{'expand':this.apiClient.buildCollectionParam(opts['expand'],'multi')},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var AuthorizationApi=/*#__PURE__*/function(){/**
|
|
3269
3292
|
* Authorization service.
|
|
3270
3293
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
3271
|
-
* @version
|
|
3294
|
+
* @version 208.0.0
|
|
3272
3295
|
*//**
|
|
3273
3296
|
* Constructs a new AuthorizationApi.
|
|
3274
3297
|
* @alias module:purecloud-platform-client-v2/api/AuthorizationApi
|
|
@@ -3591,7 +3614,7 @@ if(subjectId===undefined||subjectId===null){throw'Missing the required parameter
|
|
|
3591
3614
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putUserRoles';}return this.apiClient.callApi('/api/v2/users/{subjectId}/roles','PUT',{'subjectId':subjectId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var BillingApi=/*#__PURE__*/function(){/**
|
|
3592
3615
|
* Billing service.
|
|
3593
3616
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
3594
|
-
* @version
|
|
3617
|
+
* @version 208.0.0
|
|
3595
3618
|
*//**
|
|
3596
3619
|
* Constructs a new BillingApi.
|
|
3597
3620
|
* @alias module:purecloud-platform-client-v2/api/BillingApi
|
|
@@ -3615,7 +3638,7 @@ if(endDate===undefined||endDate===null){throw'Missing the required parameter "en
|
|
|
3615
3638
|
if(trustorOrgId===undefined||trustorOrgId===null){throw'Missing the required parameter "trustorOrgId" when calling getBillingTrusteebillingoverviewTrustorOrgId';}return this.apiClient.callApi('/api/v2/billing/trusteebillingoverview/{trustorOrgId}','GET',{'trustorOrgId':trustorOrgId},{'billingPeriodIndex':opts['billingPeriodIndex']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var CarrierServicesApi=/*#__PURE__*/function(){/**
|
|
3616
3639
|
* CarrierServices service.
|
|
3617
3640
|
* @module purecloud-platform-client-v2/api/CarrierServicesApi
|
|
3618
|
-
* @version
|
|
3641
|
+
* @version 208.0.0
|
|
3619
3642
|
*//**
|
|
3620
3643
|
* Constructs a new CarrierServicesApi.
|
|
3621
3644
|
* @alias module:purecloud-platform-client-v2/api/CarrierServicesApi
|
|
@@ -3635,7 +3658,7 @@ if(phoneNumber===undefined||phoneNumber===null){throw'Missing the required param
|
|
|
3635
3658
|
*/},{key:"postCarrierservicesIntegrationsEmergencylocationsMe",value:function postCarrierservicesIntegrationsEmergencylocationsMe(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/carrierservices/integrations/emergencylocations/me','POST',{},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var ChatApi=/*#__PURE__*/function(){/**
|
|
3636
3659
|
* Chat service.
|
|
3637
3660
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
3638
|
-
* @version
|
|
3661
|
+
* @version 208.0.0
|
|
3639
3662
|
*//**
|
|
3640
3663
|
* Constructs a new ChatApi.
|
|
3641
3664
|
* @alias module:purecloud-platform-client-v2/api/ChatApi
|
|
@@ -3860,7 +3883,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
3860
3883
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putChatsSettings';}return this.apiClient.callApi('/api/v2/chats/settings','PUT',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var CoachingApi=/*#__PURE__*/function(){/**
|
|
3861
3884
|
* Coaching service.
|
|
3862
3885
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
3863
|
-
* @version
|
|
3886
|
+
* @version 208.0.0
|
|
3864
3887
|
*//**
|
|
3865
3888
|
* Constructs a new CoachingApi.
|
|
3866
3889
|
* @alias module:purecloud-platform-client-v2/api/CoachingApi
|
|
@@ -4013,7 +4036,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
4013
4036
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postCoachingScheduleslotsQuery';}return this.apiClient.callApi('/api/v2/coaching/scheduleslots/query','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var ContentManagementApi=/*#__PURE__*/function(){/**
|
|
4014
4037
|
* ContentManagement service.
|
|
4015
4038
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
4016
|
-
* @version
|
|
4039
|
+
* @version 208.0.0
|
|
4017
4040
|
*//**
|
|
4018
4041
|
* Constructs a new ContentManagementApi.
|
|
4019
4042
|
* @alias module:purecloud-platform-client-v2/api/ContentManagementApi
|
|
@@ -4117,12 +4140,11 @@ if(shareId===undefined||shareId===null){throw'Missing the required parameter "sh
|
|
|
4117
4140
|
* This method requires the download sharing URI obtained in the get document response (downloadSharingUri). Documents may be shared between users in the same workspace. Documents may also be shared between any user by creating a content management share.
|
|
4118
4141
|
* @param {String} sharedId Shared ID
|
|
4119
4142
|
* @param {Object} opts Optional parameters
|
|
4120
|
-
* @param {Boolean} opts.redirect Turn on or off redirect (default to true)
|
|
4121
4143
|
* @param {Object} opts.disposition Request how the share content will be downloaded: attached as a file or inline. Default is attachment. (default to attachment)
|
|
4122
4144
|
* @param {String} opts.contentType The requested format for the specified document. If supported, the document will be returned in that format. Example contentType=audio/wav
|
|
4123
4145
|
* @param {Object} opts.expand Expand some document fields
|
|
4124
4146
|
*/},{key:"getContentmanagementSharedSharedId",value:function getContentmanagementSharedSharedId(sharedId,opts){opts=opts||{};// verify the required parameter 'sharedId' is set
|
|
4125
|
-
if(sharedId===undefined||sharedId===null){throw'Missing the required parameter "sharedId" when calling getContentmanagementSharedSharedId';}return this.apiClient.callApi('/api/v2/contentmanagement/shared/{sharedId}','GET',{'sharedId':sharedId},{'
|
|
4147
|
+
if(sharedId===undefined||sharedId===null){throw'Missing the required parameter "sharedId" when calling getContentmanagementSharedSharedId';}return this.apiClient.callApi('/api/v2/contentmanagement/shared/{sharedId}','GET',{'sharedId':sharedId},{'disposition':opts['disposition'],'contentType':opts['contentType'],'expand':opts['expand']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
4126
4148
|
* Gets a list of shares. You must specify at least one filter (e.g. entityId).
|
|
4127
4149
|
* Failing to specify a filter will return 400.
|
|
4128
4150
|
* @param {Object} opts Optional parameters
|
|
@@ -4296,7 +4318,7 @@ if(tagId===undefined||tagId===null){throw'Missing the required parameter "tagId"
|
|
|
4296
4318
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putContentmanagementWorkspaceTagvalue';}return this.apiClient.callApi('/api/v2/contentmanagement/workspaces/{workspaceId}/tagvalues/{tagId}','PUT',{'workspaceId':workspaceId,'tagId':tagId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var ConversationsApi=/*#__PURE__*/function(){/**
|
|
4297
4319
|
* Conversations service.
|
|
4298
4320
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
4299
|
-
* @version
|
|
4321
|
+
* @version 208.0.0
|
|
4300
4322
|
*//**
|
|
4301
4323
|
* Constructs a new ConversationsApi.
|
|
4302
4324
|
* @alias module:purecloud-platform-client-v2/api/ConversationsApi
|
|
@@ -5435,9 +5457,10 @@ if(conversationId===undefined||conversationId===null){throw'Missing the required
|
|
|
5435
5457
|
if(suggestionId===undefined||suggestionId===null){throw'Missing the required parameter "suggestionId" when calling postConversationSuggestionEngagement';}// verify the required parameter 'body' is set
|
|
5436
5458
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postConversationSuggestionEngagement';}return this.apiClient.callApi('/api/v2/conversations/{conversationId}/suggestions/{suggestionId}/engagement','POST',{'conversationId':conversationId,'suggestionId':suggestionId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
5437
5459
|
* Suggestion feedback.
|
|
5438
|
-
*
|
|
5460
|
+
* Google Agent Assist offering within Genesys will no longer be supported
|
|
5439
5461
|
* @param {String} conversationId Conversation ID
|
|
5440
5462
|
* @param {Object} body SuggestionFeedback
|
|
5463
|
+
* @deprecated
|
|
5441
5464
|
*/},{key:"postConversationSuggestionsFeedback",value:function postConversationSuggestionsFeedback(conversationId,body){// verify the required parameter 'conversationId' is set
|
|
5442
5465
|
if(conversationId===undefined||conversationId===null){throw'Missing the required parameter "conversationId" when calling postConversationSuggestionsFeedback';}// verify the required parameter 'body' is set
|
|
5443
5466
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postConversationSuggestionsFeedback';}return this.apiClient.callApi('/api/v2/conversations/{conversationId}/suggestions/feedback','POST',{'conversationId':conversationId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
@@ -6024,7 +6047,7 @@ if(conversationId===undefined||conversationId===null){throw'Missing the required
|
|
|
6024
6047
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putConversationsVideoRecordingstate';}return this.apiClient.callApi('/api/v2/conversations/videos/{conversationId}/recordingstate','PUT',{'conversationId':conversationId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var DataExtensionsApi=/*#__PURE__*/function(){/**
|
|
6025
6048
|
* DataExtensions service.
|
|
6026
6049
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
6027
|
-
* @version
|
|
6050
|
+
* @version 208.0.0
|
|
6028
6051
|
*//**
|
|
6029
6052
|
* Constructs a new DataExtensionsApi.
|
|
6030
6053
|
* @alias module:purecloud-platform-client-v2/api/DataExtensionsApi
|
|
@@ -6045,7 +6068,7 @@ if(coretypeName===undefined||coretypeName===null){throw'Missing the required par
|
|
|
6045
6068
|
*/},{key:"getDataextensionsLimits",value:function getDataextensionsLimits(){return this.apiClient.callApi('/api/v2/dataextensions/limits','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var DownloadsApi=/*#__PURE__*/function(){/**
|
|
6046
6069
|
* Downloads service.
|
|
6047
6070
|
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
6048
|
-
* @version
|
|
6071
|
+
* @version 208.0.0
|
|
6049
6072
|
*//**
|
|
6050
6073
|
* Constructs a new DownloadsApi.
|
|
6051
6074
|
* @alias module:purecloud-platform-client-v2/api/DownloadsApi
|
|
@@ -6064,7 +6087,7 @@ if(coretypeName===undefined||coretypeName===null){throw'Missing the required par
|
|
|
6064
6087
|
if(downloadId===undefined||downloadId===null){throw'Missing the required parameter "downloadId" when calling getDownload';}return this.apiClient.callApi('/api/v2/downloads/{downloadId}','GET',{'downloadId':downloadId},{'contentDisposition':opts['contentDisposition'],'issueRedirect':opts['issueRedirect'],'redirectToAuth':opts['redirectToAuth']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var EmailsApi=/*#__PURE__*/function(){/**
|
|
6065
6088
|
* Emails service.
|
|
6066
6089
|
* @module purecloud-platform-client-v2/api/EmailsApi
|
|
6067
|
-
* @version
|
|
6090
|
+
* @version 208.0.0
|
|
6068
6091
|
*//**
|
|
6069
6092
|
* Constructs a new EmailsApi.
|
|
6070
6093
|
* @alias module:purecloud-platform-client-v2/api/EmailsApi
|
|
@@ -6082,7 +6105,7 @@ if(downloadId===undefined||downloadId===null){throw'Missing the required paramet
|
|
|
6082
6105
|
*/},{key:"patchEmailsSettings",value:function patchEmailsSettings(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/emails/settings','PATCH',{},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var EmployeeEngagementApi=/*#__PURE__*/function(){/**
|
|
6083
6106
|
* EmployeeEngagement service.
|
|
6084
6107
|
* @module purecloud-platform-client-v2/api/EmployeeEngagementApi
|
|
6085
|
-
* @version
|
|
6108
|
+
* @version 208.0.0
|
|
6086
6109
|
*//**
|
|
6087
6110
|
* Constructs a new EmployeeEngagementApi.
|
|
6088
6111
|
* @alias module:purecloud-platform-client-v2/api/EmployeeEngagementApi
|
|
@@ -6120,7 +6143,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
6120
6143
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postEmployeeengagementRecognitions';}return this.apiClient.callApi('/api/v2/employeeengagement/recognitions','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var EventsApi=/*#__PURE__*/function(){/**
|
|
6121
6144
|
* Events service.
|
|
6122
6145
|
* @module purecloud-platform-client-v2/api/EventsApi
|
|
6123
|
-
* @version
|
|
6146
|
+
* @version 208.0.0
|
|
6124
6147
|
*//**
|
|
6125
6148
|
* Constructs a new EventsApi.
|
|
6126
6149
|
* @alias module:purecloud-platform-client-v2/api/EventsApi
|
|
@@ -6145,7 +6168,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
6145
6168
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postEventsUsersRoutingstatus';}return this.apiClient.callApi('/api/v2/events/users/routingstatus','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var ExternalContactsApi=/*#__PURE__*/function(){/**
|
|
6146
6169
|
* ExternalContacts service.
|
|
6147
6170
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
6148
|
-
* @version
|
|
6171
|
+
* @version 208.0.0
|
|
6149
6172
|
*//**
|
|
6150
6173
|
* Constructs a new ExternalContactsApi.
|
|
6151
6174
|
* @alias module:purecloud-platform-client-v2/api/ExternalContactsApi
|
|
@@ -6173,9 +6196,13 @@ if(schemaId===undefined||schemaId===null){throw'Missing the required parameter "
|
|
|
6173
6196
|
* Delete an External Source. WARNING: Any records that reference this External Source will not be automatically cleaned up. Those records will still be editable, but their External IDs may not be fully viewable.
|
|
6174
6197
|
*
|
|
6175
6198
|
* @param {String} externalSourceId External Source ID
|
|
6176
|
-
* deleteExternalcontactsExternalsource is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
6177
6199
|
*/},{key:"deleteExternalcontactsExternalsource",value:function deleteExternalcontactsExternalsource(externalSourceId){// verify the required parameter 'externalSourceId' is set
|
|
6178
6200
|
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']);}/**
|
|
6201
|
+
* Delete settings for CSV import
|
|
6202
|
+
*
|
|
6203
|
+
* @param {String} settingsId Settings id
|
|
6204
|
+
*/},{key:"deleteExternalcontactsImportCsvSetting",value:function deleteExternalcontactsImportCsvSetting(settingsId){// verify the required parameter 'settingsId' is set
|
|
6205
|
+
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']);}/**
|
|
6179
6206
|
* Delete an external organization
|
|
6180
6207
|
*
|
|
6181
6208
|
* @param {String} externalOrganizationId External Organization ID
|
|
@@ -6242,7 +6269,7 @@ if(contactId===undefined||contactId===null){throw'Missing the required parameter
|
|
|
6242
6269
|
*
|
|
6243
6270
|
* @param {String} contactId ExternalContact ID
|
|
6244
6271
|
* @param {Object} opts Optional parameters
|
|
6245
|
-
* @param {Array.<String>} opts.expand which fields, if any, to expand
|
|
6272
|
+
* @param {Array.<String>} opts.expand which fields, if any, to expand
|
|
6246
6273
|
*/},{key:"getExternalcontactsContactUnresolved",value:function getExternalcontactsContactUnresolved(contactId,opts){opts=opts||{};// verify the required parameter 'contactId' is set
|
|
6247
6274
|
if(contactId===undefined||contactId===null){throw'Missing the required parameter "contactId" when calling getExternalcontactsContactUnresolved';}return this.apiClient.callApi('/api/v2/externalcontacts/contacts/{contactId}/unresolved','GET',{'contactId':contactId},{'expand':this.apiClient.buildCollectionParam(opts['expand'],'multi')},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
6248
6275
|
* Search for external contacts
|
|
@@ -6277,7 +6304,6 @@ if(schemaId===undefined||schemaId===null){throw'Missing the required parameter "
|
|
|
6277
6304
|
* Fetch an External Source
|
|
6278
6305
|
*
|
|
6279
6306
|
* @param {String} externalSourceId External Source ID
|
|
6280
|
-
* getExternalcontactsExternalsource is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
6281
6307
|
*/},{key:"getExternalcontactsExternalsource",value:function getExternalcontactsExternalsource(externalSourceId){// verify the required parameter 'externalSourceId' is set
|
|
6282
6308
|
if(externalSourceId===undefined||externalSourceId===null){throw'Missing the required parameter "externalSourceId" when calling getExternalcontactsExternalsource';}return this.apiClient.callApi('/api/v2/externalcontacts/externalsources/{externalSourceId}','GET',{'externalSourceId':externalSourceId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
6283
6309
|
* Fetch a list of External Sources
|
|
@@ -6287,13 +6313,34 @@ if(externalSourceId===undefined||externalSourceId===null){throw'Missing the requ
|
|
|
6287
6313
|
* @param {Number} opts.limit The number of ExternalSources per page; must be between 10 and 200, default is 100
|
|
6288
6314
|
* @param {String} opts.name Filter by external source name. Filtering is prefix filtering and not an exact match
|
|
6289
6315
|
* @param {Boolean} opts.active Filter by active status of external source
|
|
6290
|
-
* getExternalcontactsExternalsources is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
6291
6316
|
*/},{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']);}/**
|
|
6317
|
+
* Get settings for CSV import
|
|
6318
|
+
*
|
|
6319
|
+
* @param {String} settingsId Settings id
|
|
6320
|
+
*/},{key:"getExternalcontactsImportCsvSetting",value:function getExternalcontactsImportCsvSetting(settingsId){// verify the required parameter 'settingsId' is set
|
|
6321
|
+
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']);}/**
|
|
6322
|
+
* Retrieve all settings for organization filtered by externalSettingsId if provided
|
|
6323
|
+
*
|
|
6324
|
+
* @param {Object} opts Optional parameters
|
|
6325
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
6326
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
6327
|
+
* @param {String} opts.externalSettingsId External Settings Id to filter the list.
|
|
6328
|
+
*/},{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']);}/**
|
|
6329
|
+
* Get details for CSV upload
|
|
6330
|
+
*
|
|
6331
|
+
* @param {String} uploadId Upload id
|
|
6332
|
+
*/},{key:"getExternalcontactsImportCsvUploadDetails",value:function getExternalcontactsImportCsvUploadDetails(uploadId){// verify the required parameter 'uploadId' is set
|
|
6333
|
+
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']);}/**
|
|
6334
|
+
* Get preview for CSV upload
|
|
6335
|
+
*
|
|
6336
|
+
* @param {String} uploadId Upload id
|
|
6337
|
+
*/},{key:"getExternalcontactsImportCsvUploadPreview",value:function getExternalcontactsImportCsvUploadPreview(uploadId){// verify the required parameter 'uploadId' is set
|
|
6338
|
+
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']);}/**
|
|
6292
6339
|
* Fetch an external organization
|
|
6293
6340
|
*
|
|
6294
6341
|
* @param {String} externalOrganizationId External Organization ID
|
|
6295
6342
|
* @param {Object} opts Optional parameters
|
|
6296
|
-
* @param {Array.<String>} opts.expand which fields, if any, to expand
|
|
6343
|
+
* @param {Array.<String>} opts.expand which fields, if any, to expand
|
|
6297
6344
|
* @param {Boolean} opts.includeTrustors (true or false) whether or not to include trustor information embedded in the externalOrganization
|
|
6298
6345
|
*/},{key:"getExternalcontactsOrganization",value:function getExternalcontactsOrganization(externalOrganizationId,opts){opts=opts||{};// verify the required parameter 'externalOrganizationId' is set
|
|
6299
6346
|
if(externalOrganizationId===undefined||externalOrganizationId===null){throw'Missing the required parameter "externalOrganizationId" when calling getExternalcontactsOrganization';}return this.apiClient.callApi('/api/v2/externalcontacts/organizations/{externalOrganizationId}','GET',{'externalOrganizationId':externalOrganizationId},{'expand':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'includeTrustors':opts['includeTrustors']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
@@ -6523,7 +6570,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
6523
6570
|
* Create an External Source
|
|
6524
6571
|
*
|
|
6525
6572
|
* @param {Object} body External Source
|
|
6526
|
-
* postExternalcontactsExternalsources is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
6527
6573
|
*/},{key:"postExternalcontactsExternalsources",value:function postExternalcontactsExternalsources(body){// verify the required parameter 'body' is set
|
|
6528
6574
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postExternalcontactsExternalsources';}return this.apiClient.callApi('/api/v2/externalcontacts/externalsources','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
6529
6575
|
* Fetch a contact using an identifier type and value.
|
|
@@ -6533,6 +6579,21 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
6533
6579
|
* @param {Array.<String>} opts.expand which field, if any, to expand
|
|
6534
6580
|
*/},{key:"postExternalcontactsIdentifierlookup",value:function postExternalcontactsIdentifierlookup(identifier,opts){opts=opts||{};// verify the required parameter 'identifier' is set
|
|
6535
6581
|
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']);}/**
|
|
6582
|
+
* Create CSV import job
|
|
6583
|
+
*
|
|
6584
|
+
* @param {Object} body ImportRequest
|
|
6585
|
+
*/},{key:"postExternalcontactsImportCsvJobs",value:function postExternalcontactsImportCsvJobs(body){// verify the required parameter 'body' is set
|
|
6586
|
+
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']);}/**
|
|
6587
|
+
* Create settings for CSV import
|
|
6588
|
+
*
|
|
6589
|
+
* @param {Object} body Settings
|
|
6590
|
+
*/},{key:"postExternalcontactsImportCsvSettings",value:function postExternalcontactsImportCsvSettings(body){// verify the required parameter 'body' is set
|
|
6591
|
+
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']);}/**
|
|
6592
|
+
* Get url for CSV upload
|
|
6593
|
+
*
|
|
6594
|
+
* @param {Object} body UploadRequest
|
|
6595
|
+
*/},{key:"postExternalcontactsImportCsvUploads",value:function postExternalcontactsImportCsvUploads(body){// verify the required parameter 'body' is set
|
|
6596
|
+
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']);}/**
|
|
6536
6597
|
* Merge two contacts into a new contact record
|
|
6537
6598
|
* Two curated contacts cannot be merged. Refer to the Contact Merging article on the Developer Center for details
|
|
6538
6599
|
* @param {Object} body MergeRequest
|
|
@@ -6594,10 +6655,16 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
6594
6655
|
*
|
|
6595
6656
|
* @param {String} externalSourceId External Source ID
|
|
6596
6657
|
* @param {Object} body External Source
|
|
6597
|
-
* putExternalcontactsExternalsource is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
6598
6658
|
*/},{key:"putExternalcontactsExternalsource",value:function putExternalcontactsExternalsource(externalSourceId,body){// verify the required parameter 'externalSourceId' is set
|
|
6599
6659
|
if(externalSourceId===undefined||externalSourceId===null){throw'Missing the required parameter "externalSourceId" when calling putExternalcontactsExternalsource';}// verify the required parameter 'body' is set
|
|
6600
6660
|
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']);}/**
|
|
6661
|
+
* Update settings for CSV import
|
|
6662
|
+
*
|
|
6663
|
+
* @param {String} settingsId Settings id
|
|
6664
|
+
* @param {Object} body Settings
|
|
6665
|
+
*/},{key:"putExternalcontactsImportCsvSetting",value:function putExternalcontactsImportCsvSetting(settingsId,body){// verify the required parameter 'settingsId' is set
|
|
6666
|
+
if(settingsId===undefined||settingsId===null){throw'Missing the required parameter "settingsId" when calling putExternalcontactsImportCsvSetting';}// verify the required parameter 'body' is set
|
|
6667
|
+
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']);}/**
|
|
6601
6668
|
* Update an external organization
|
|
6602
6669
|
*
|
|
6603
6670
|
* @param {String} externalOrganizationId External Organization ID
|
|
@@ -6637,7 +6704,7 @@ if(relationshipId===undefined||relationshipId===null){throw'Missing the required
|
|
|
6637
6704
|
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(){/**
|
|
6638
6705
|
* Fax service.
|
|
6639
6706
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
6640
|
-
* @version
|
|
6707
|
+
* @version 208.0.0
|
|
6641
6708
|
*//**
|
|
6642
6709
|
* Constructs a new FaxApi.
|
|
6643
6710
|
* @alias module:purecloud-platform-client-v2/api/FaxApi
|
|
@@ -6686,7 +6753,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
6686
6753
|
*/},{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(){/**
|
|
6687
6754
|
* Flows service.
|
|
6688
6755
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
6689
|
-
* @version
|
|
6756
|
+
* @version 208.0.0
|
|
6690
6757
|
*//**
|
|
6691
6758
|
* Constructs a new FlowsApi.
|
|
6692
6759
|
* @alias module:purecloud-platform-client-v2/api/FlowsApi
|
|
@@ -6734,7 +6801,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
6734
6801
|
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(){/**
|
|
6735
6802
|
* Gamification service.
|
|
6736
6803
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
6737
|
-
* @version
|
|
6804
|
+
* @version 208.0.0
|
|
6738
6805
|
*//**
|
|
6739
6806
|
* Constructs a new GamificationApi.
|
|
6740
6807
|
* @alias module:purecloud-platform-client-v2/api/GamificationApi
|
|
@@ -7274,7 +7341,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
7274
7341
|
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(){/**
|
|
7275
7342
|
* GeneralDataProtectionRegulation service.
|
|
7276
7343
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
7277
|
-
* @version
|
|
7344
|
+
* @version 208.0.0
|
|
7278
7345
|
*//**
|
|
7279
7346
|
* Constructs a new GeneralDataProtectionRegulationApi.
|
|
7280
7347
|
* @alias module:purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
@@ -7309,7 +7376,7 @@ if(searchValue===undefined||searchValue===null){throw'Missing the required param
|
|
|
7309
7376
|
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(){/**
|
|
7310
7377
|
* Geolocation service.
|
|
7311
7378
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
7312
|
-
* @version
|
|
7379
|
+
* @version 208.0.0
|
|
7313
7380
|
*//**
|
|
7314
7381
|
* Constructs a new GeolocationApi.
|
|
7315
7382
|
* @alias module:purecloud-platform-client-v2/api/GeolocationApi
|
|
@@ -7343,7 +7410,7 @@ if(clientId===undefined||clientId===null){throw'Missing the required parameter "
|
|
|
7343
7410
|
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(){/**
|
|
7344
7411
|
* Greetings service.
|
|
7345
7412
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
7346
|
-
* @version
|
|
7413
|
+
* @version 208.0.0
|
|
7347
7414
|
*//**
|
|
7348
7415
|
* Constructs a new GreetingsApi.
|
|
7349
7416
|
* @alias module:purecloud-platform-client-v2/api/GreetingsApi
|
|
@@ -7450,7 +7517,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
7450
7517
|
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(){/**
|
|
7451
7518
|
* Groups service.
|
|
7452
7519
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
7453
|
-
* @version
|
|
7520
|
+
* @version 208.0.0
|
|
7454
7521
|
*//**
|
|
7455
7522
|
* Constructs a new GroupsApi.
|
|
7456
7523
|
* @alias module:purecloud-platform-client-v2/api/GroupsApi
|
|
@@ -7583,7 +7650,7 @@ if(groupId===undefined||groupId===null){throw'Missing the required parameter "gr
|
|
|
7583
7650
|
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(){/**
|
|
7584
7651
|
* IdentityProvider service.
|
|
7585
7652
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
7586
|
-
* @version
|
|
7653
|
+
* @version 208.0.0
|
|
7587
7654
|
*//**
|
|
7588
7655
|
* Constructs a new IdentityProviderApi.
|
|
7589
7656
|
* @alias module:purecloud-platform-client-v2/api/IdentityProviderApi
|
|
@@ -7739,7 +7806,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
7739
7806
|
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(){/**
|
|
7740
7807
|
* InfrastructureAsCode service.
|
|
7741
7808
|
* @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
7742
|
-
* @version
|
|
7809
|
+
* @version 208.0.0
|
|
7743
7810
|
*//**
|
|
7744
7811
|
* Constructs a new InfrastructureAsCodeApi.
|
|
7745
7812
|
* @alias module:purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
@@ -7793,7 +7860,7 @@ if(jobId===undefined||jobId===null){throw'Missing the required parameter "jobId"
|
|
|
7793
7860
|
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(){/**
|
|
7794
7861
|
* Integrations service.
|
|
7795
7862
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
7796
|
-
* @version
|
|
7863
|
+
* @version 208.0.0
|
|
7797
7864
|
*//**
|
|
7798
7865
|
* Constructs a new IntegrationsApi.
|
|
7799
7866
|
* @alias module:purecloud-platform-client-v2/api/IntegrationsApi
|
|
@@ -7874,9 +7941,11 @@ if(actionId===undefined||actionId===null){throw'Missing the required parameter "
|
|
|
7874
7941
|
*
|
|
7875
7942
|
* @param {String} actionId actionId
|
|
7876
7943
|
* @param {String} fileName Name of schema file to be retrieved for this draft.
|
|
7877
|
-
|
|
7944
|
+
* @param {Object} opts Optional parameters
|
|
7945
|
+
* @param {Boolean} opts.flatten Indicates the response should be reformatted, based on Architect's flattening format. (default to false)
|
|
7946
|
+
*/},{key:"getIntegrationsActionDraftSchema",value:function getIntegrationsActionDraftSchema(actionId,fileName,opts){opts=opts||{};// verify the required parameter 'actionId' is set
|
|
7878
7947
|
if(actionId===undefined||actionId===null){throw'Missing the required parameter "actionId" when calling getIntegrationsActionDraftSchema';}// verify the required parameter 'fileName' is set
|
|
7879
|
-
if(fileName===undefined||fileName===null){throw'Missing the required parameter "fileName" when calling getIntegrationsActionDraftSchema';}return this.apiClient.callApi('/api/v2/integrations/actions/{actionId}/draft/schemas/{fileName}','GET',{'actionId':actionId,'fileName':fileName},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
7948
|
+
if(fileName===undefined||fileName===null){throw'Missing the required parameter "fileName" when calling getIntegrationsActionDraftSchema';}return this.apiClient.callApi('/api/v2/integrations/actions/{actionId}/draft/schemas/{fileName}','GET',{'actionId':actionId,'fileName':fileName},{'flatten':opts['flatten']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
7880
7949
|
* Retrieve templates for a Draft based on filename.
|
|
7881
7950
|
*
|
|
7882
7951
|
* @param {String} actionId actionId
|
|
@@ -7899,9 +7968,11 @@ if(actionId===undefined||actionId===null){throw'Missing the required parameter "
|
|
|
7899
7968
|
*
|
|
7900
7969
|
* @param {String} actionId actionId
|
|
7901
7970
|
* @param {String} fileName Name of schema file to be retrieved for this action.
|
|
7902
|
-
|
|
7971
|
+
* @param {Object} opts Optional parameters
|
|
7972
|
+
* @param {Boolean} opts.flatten Indicates the response should be reformatted, based on Architect's flattening format. (default to false)
|
|
7973
|
+
*/},{key:"getIntegrationsActionSchema",value:function getIntegrationsActionSchema(actionId,fileName,opts){opts=opts||{};// verify the required parameter 'actionId' is set
|
|
7903
7974
|
if(actionId===undefined||actionId===null){throw'Missing the required parameter "actionId" when calling getIntegrationsActionSchema';}// verify the required parameter 'fileName' is set
|
|
7904
|
-
if(fileName===undefined||fileName===null){throw'Missing the required parameter "fileName" when calling getIntegrationsActionSchema';}return this.apiClient.callApi('/api/v2/integrations/actions/{actionId}/schemas/{fileName}','GET',{'actionId':actionId,'fileName':fileName},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
7975
|
+
if(fileName===undefined||fileName===null){throw'Missing the required parameter "fileName" when calling getIntegrationsActionSchema';}return this.apiClient.callApi('/api/v2/integrations/actions/{actionId}/schemas/{fileName}','GET',{'actionId':actionId,'fileName':fileName},{'flatten':opts['flatten']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
7905
7976
|
* Retrieve text of templates for an action based on filename.
|
|
7906
7977
|
*
|
|
7907
7978
|
* @param {String} actionId actionId
|
|
@@ -8310,23 +8381,29 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
8310
8381
|
*
|
|
8311
8382
|
* @param {String} actionId actionId
|
|
8312
8383
|
* @param {Object.<String, {String: Object}>} body Map of parameters used for variable substitution.
|
|
8313
|
-
|
|
8384
|
+
* @param {Object} opts Optional parameters
|
|
8385
|
+
* @param {Boolean} opts.flatten Indicates the response should be reformatted, based on Architect's flattening format. (default to false)
|
|
8386
|
+
*/},{key:"postIntegrationsActionDraftTest",value:function postIntegrationsActionDraftTest(actionId,body,opts){opts=opts||{};// verify the required parameter 'actionId' is set
|
|
8314
8387
|
if(actionId===undefined||actionId===null){throw'Missing the required parameter "actionId" when calling postIntegrationsActionDraftTest';}// verify the required parameter 'body' is set
|
|
8315
|
-
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postIntegrationsActionDraftTest';}return this.apiClient.callApi('/api/v2/integrations/actions/{actionId}/draft/test','POST',{'actionId':actionId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
8388
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postIntegrationsActionDraftTest';}return this.apiClient.callApi('/api/v2/integrations/actions/{actionId}/draft/test','POST',{'actionId':actionId},{'flatten':opts['flatten']},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
8316
8389
|
* Execute Action and return response from 3rd party. Responses will follow the schemas defined on the Action for success and error.
|
|
8317
8390
|
*
|
|
8318
8391
|
* @param {String} actionId actionId
|
|
8319
8392
|
* @param {Object.<String, {String: Object}>} body Map of parameters used for variable substitution.
|
|
8320
|
-
|
|
8393
|
+
* @param {Object} opts Optional parameters
|
|
8394
|
+
* @param {Boolean} opts.flatten Indicates the response should be reformatted, based on Architect's flattening format. (default to false)
|
|
8395
|
+
*/},{key:"postIntegrationsActionExecute",value:function postIntegrationsActionExecute(actionId,body,opts){opts=opts||{};// verify the required parameter 'actionId' is set
|
|
8321
8396
|
if(actionId===undefined||actionId===null){throw'Missing the required parameter "actionId" when calling postIntegrationsActionExecute';}// verify the required parameter 'body' is set
|
|
8322
|
-
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postIntegrationsActionExecute';}return this.apiClient.callApi('/api/v2/integrations/actions/{actionId}/execute','POST',{'actionId':actionId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
8397
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postIntegrationsActionExecute';}return this.apiClient.callApi('/api/v2/integrations/actions/{actionId}/execute','POST',{'actionId':actionId},{'flatten':opts['flatten']},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
8323
8398
|
* Test the execution of an action. Responses will show execution steps broken out with intermediate results to help in debugging.
|
|
8324
8399
|
*
|
|
8325
8400
|
* @param {String} actionId actionId
|
|
8326
8401
|
* @param {Object.<String, {String: Object}>} body Map of parameters used for variable substitution.
|
|
8327
|
-
|
|
8402
|
+
* @param {Object} opts Optional parameters
|
|
8403
|
+
* @param {Boolean} opts.flatten Indicates the response should be reformatted, based on Architect's flattening format. (default to false)
|
|
8404
|
+
*/},{key:"postIntegrationsActionTest",value:function postIntegrationsActionTest(actionId,body,opts){opts=opts||{};// verify the required parameter 'actionId' is set
|
|
8328
8405
|
if(actionId===undefined||actionId===null){throw'Missing the required parameter "actionId" when calling postIntegrationsActionTest';}// verify the required parameter 'body' is set
|
|
8329
|
-
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postIntegrationsActionTest';}return this.apiClient.callApi('/api/v2/integrations/actions/{actionId}/test','POST',{'actionId':actionId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
8406
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postIntegrationsActionTest';}return this.apiClient.callApi('/api/v2/integrations/actions/{actionId}/test','POST',{'actionId':actionId},{'flatten':opts['flatten']},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
8330
8407
|
* Create a new Action. Not supported for 'Function Integration' actions. Function integrations must be created as drafts to allow managing of uploading required ZIP function package before they may be used as a published action.
|
|
8331
8408
|
*
|
|
8332
8409
|
* @param {Object} body Input used to create Action.
|
|
@@ -8418,7 +8495,7 @@ if(ucIntegrationId===undefined||ucIntegrationId===null){throw'Missing the requir
|
|
|
8418
8495
|
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(){/**
|
|
8419
8496
|
* Journey service.
|
|
8420
8497
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
8421
|
-
* @version
|
|
8498
|
+
* @version 208.0.0
|
|
8422
8499
|
*//**
|
|
8423
8500
|
* Constructs a new JourneyApi.
|
|
8424
8501
|
* @alias module:purecloud-platform-client-v2/api/JourneyApi
|
|
@@ -8458,6 +8535,11 @@ if(segmentId===undefined||segmentId===null){throw'Missing the required parameter
|
|
|
8458
8535
|
* @param {String} viewId viewId
|
|
8459
8536
|
*/},{key:"deleteJourneyView",value:function deleteJourneyView(viewId){// verify the required parameter 'viewId' is set
|
|
8460
8537
|
if(viewId===undefined||viewId===null){throw'Missing the required parameter "viewId" when calling deleteJourneyView';}return this.apiClient.callApi('/api/v2/journey/views/{viewId}','DELETE',{'viewId':viewId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
8538
|
+
* Delete the Schedule of a JourneyView
|
|
8539
|
+
* used for long descriptions
|
|
8540
|
+
* @param {String} viewId Journey View Id
|
|
8541
|
+
*/},{key:"deleteJourneyViewSchedules",value:function deleteJourneyViewSchedules(viewId){// verify the required parameter 'viewId' is set
|
|
8542
|
+
if(viewId===undefined||viewId===null){throw'Missing the required parameter "viewId" when calling deleteJourneyViewSchedules';}return this.apiClient.callApi('/api/v2/journey/views/{viewId}/schedules','DELETE',{'viewId':viewId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
8461
8543
|
* Get status for async query for journey aggregates
|
|
8462
8544
|
*
|
|
8463
8545
|
* @param {String} jobId jobId
|
|
@@ -8623,6 +8705,11 @@ if(sessionId===undefined||sessionId===null){throw'Missing the required parameter
|
|
|
8623
8705
|
* @param {String} viewId viewId
|
|
8624
8706
|
*/},{key:"getJourneyView",value:function getJourneyView(viewId){// verify the required parameter 'viewId' is set
|
|
8625
8707
|
if(viewId===undefined||viewId===null){throw'Missing the required parameter "viewId" when calling getJourneyView';}return this.apiClient.callApi('/api/v2/journey/views/{viewId}','GET',{'viewId':viewId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
8708
|
+
* Get the Schedule for a JourneyView
|
|
8709
|
+
* used for long descriptions
|
|
8710
|
+
* @param {String} viewId Journey View Id
|
|
8711
|
+
*/},{key:"getJourneyViewSchedules",value:function getJourneyViewSchedules(viewId){// verify the required parameter 'viewId' is set
|
|
8712
|
+
if(viewId===undefined||viewId===null){throw'Missing the required parameter "viewId" when calling getJourneyViewSchedules';}return this.apiClient.callApi('/api/v2/journey/views/{viewId}/schedules','GET',{'viewId':viewId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
8626
8713
|
* Get a Journey View by ID and version
|
|
8627
8714
|
*
|
|
8628
8715
|
* @param {String} viewId viewId
|
|
@@ -8698,12 +8785,10 @@ if(journeyVersionId===undefined||journeyVersionId===null){throw'Missing the requ
|
|
|
8698
8785
|
* Get an Event Definition
|
|
8699
8786
|
*
|
|
8700
8787
|
* @param {String} eventDefinitionId Event Definition ID
|
|
8701
|
-
* getJourneyViewsEventdefinition is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
8702
8788
|
*/},{key:"getJourneyViewsEventdefinition",value:function getJourneyViewsEventdefinition(eventDefinitionId){// verify the required parameter 'eventDefinitionId' is set
|
|
8703
8789
|
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']);}/**
|
|
8704
8790
|
* Get a list of Event Definitions
|
|
8705
8791
|
*
|
|
8706
|
-
* getJourneyViewsEventdefinitions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
8707
8792
|
*/},{key:"getJourneyViewsEventdefinitions",value:function getJourneyViewsEventdefinitions(){return this.apiClient.callApi('/api/v2/journey/views/eventdefinitions','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
8708
8793
|
* Get the jobs for an organization.
|
|
8709
8794
|
*
|
|
@@ -8713,6 +8798,12 @@ if(eventDefinitionId===undefined||eventDefinitionId===null){throw'Missing the re
|
|
|
8713
8798
|
* @param {String} opts.interval An absolute timeframe for filtering the jobs, expressed as an ISO 8601 interval.
|
|
8714
8799
|
* @param {String} opts.statuses Job statuses to filter for
|
|
8715
8800
|
*/},{key:"getJourneyViewsJobs",value:function getJourneyViewsJobs(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/journey/views/jobs','GET',{},{'pageNumber':opts['pageNumber'],'pageSize':opts['pageSize'],'interval':opts['interval'],'statuses':opts['statuses']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
8801
|
+
* Get the journey schedules for an organization.
|
|
8802
|
+
*
|
|
8803
|
+
* @param {Object} opts Optional parameters
|
|
8804
|
+
* @param {Number} opts.pageNumber The number of the page to return (default to 1)
|
|
8805
|
+
* @param {Number} opts.pageSize Max number of entities to return (default to 25)
|
|
8806
|
+
*/},{key:"getJourneyViewsSchedules",value:function getJourneyViewsSchedules(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/journey/views/schedules','GET',{},{'pageNumber':opts['pageNumber'],'pageSize':opts['pageSize']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
8716
8807
|
* Update single action map.
|
|
8717
8808
|
*
|
|
8718
8809
|
* @param {String} actionMapId ID of the action map.
|
|
@@ -8832,6 +8923,13 @@ if(deploymentId===undefined||deploymentId===null){throw'Missing the required par
|
|
|
8832
8923
|
* @param {Object} opts Optional parameters
|
|
8833
8924
|
* @param {Object} opts.body
|
|
8834
8925
|
*/},{key:"postJourneySegments",value:function postJourneySegments(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/journey/segments','POST',{},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
8926
|
+
* Add a new Schedule to a JourneyView
|
|
8927
|
+
*
|
|
8928
|
+
* @param {String} viewId Journey View Id
|
|
8929
|
+
* @param {Object} body journeyViewSchedule
|
|
8930
|
+
*/},{key:"postJourneyViewSchedules",value:function postJourneyViewSchedules(viewId,body){// verify the required parameter 'viewId' is set
|
|
8931
|
+
if(viewId===undefined||viewId===null){throw'Missing the required parameter "viewId" when calling postJourneyViewSchedules';}// verify the required parameter 'body' is set
|
|
8932
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postJourneyViewSchedules';}return this.apiClient.callApi('/api/v2/journey/views/{viewId}/schedules','POST',{'viewId':viewId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
8835
8933
|
* Submit a job request for a journey view version.
|
|
8836
8934
|
* used for long descriptions
|
|
8837
8935
|
* @param {String} viewId Journey View Id
|
|
@@ -8855,8 +8953,14 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
8855
8953
|
* True indicates a valid encoding
|
|
8856
8954
|
* @param {Object} opts Optional parameters
|
|
8857
8955
|
* @param {Array.<Object>} opts.body
|
|
8858
|
-
* postJourneyViewsEncodingsValidate is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
8859
8956
|
*/},{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']);}/**
|
|
8957
|
+
* Update the Schedule for a JourneyView
|
|
8958
|
+
* used for long descriptions
|
|
8959
|
+
* @param {String} viewId Journey View Id
|
|
8960
|
+
* @param {Object} body journeyViewSchedule
|
|
8961
|
+
*/},{key:"putJourneyViewSchedules",value:function putJourneyViewSchedules(viewId,body){// verify the required parameter 'viewId' is set
|
|
8962
|
+
if(viewId===undefined||viewId===null){throw'Missing the required parameter "viewId" when calling putJourneyViewSchedules';}// verify the required parameter 'body' is set
|
|
8963
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putJourneyViewSchedules';}return this.apiClient.callApi('/api/v2/journey/views/{viewId}/schedules','PUT',{'viewId':viewId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
8860
8964
|
* Update a Journey View by ID and version
|
|
8861
8965
|
* does not create a new version
|
|
8862
8966
|
* @param {String} viewId viewId
|
|
@@ -8868,7 +8972,7 @@ if(versionId===undefined||versionId===null){throw'Missing the required parameter
|
|
|
8868
8972
|
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(){/**
|
|
8869
8973
|
* Knowledge service.
|
|
8870
8974
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
8871
|
-
* @version
|
|
8975
|
+
* @version 208.0.0
|
|
8872
8976
|
*//**
|
|
8873
8977
|
* Constructs a new KnowledgeApi.
|
|
8874
8978
|
* @alias module:purecloud-platform-client-v2/api/KnowledgeApi
|
|
@@ -8959,7 +9063,6 @@ if(importId===undefined||importId===null){throw'Missing the required parameter "
|
|
|
8959
9063
|
*
|
|
8960
9064
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
8961
9065
|
* @param {String} sourceId Source ID
|
|
8962
|
-
* deleteKnowledgeKnowledgebaseSourcesSalesforceSourceId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
8963
9066
|
*/},{key:"deleteKnowledgeKnowledgebaseSourcesSalesforceSourceId",value:function deleteKnowledgeKnowledgebaseSourcesSalesforceSourceId(knowledgeBaseId,sourceId){// verify the required parameter 'knowledgeBaseId' is set
|
|
8964
9067
|
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling deleteKnowledgeKnowledgebaseSourcesSalesforceSourceId';}// verify the required parameter 'sourceId' is set
|
|
8965
9068
|
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']);}/**
|
|
@@ -8967,7 +9070,6 @@ if(sourceId===undefined||sourceId===null){throw'Missing the required parameter "
|
|
|
8967
9070
|
*
|
|
8968
9071
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
8969
9072
|
* @param {String} sourceId Source ID
|
|
8970
|
-
* deleteKnowledgeKnowledgebaseSourcesServicenowSourceId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
8971
9073
|
*/},{key:"deleteKnowledgeKnowledgebaseSourcesServicenowSourceId",value:function deleteKnowledgeKnowledgebaseSourcesServicenowSourceId(knowledgeBaseId,sourceId){// verify the required parameter 'knowledgeBaseId' is set
|
|
8972
9074
|
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling deleteKnowledgeKnowledgebaseSourcesServicenowSourceId';}// verify the required parameter 'sourceId' is set
|
|
8973
9075
|
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']);}/**
|
|
@@ -8975,7 +9077,6 @@ if(sourceId===undefined||sourceId===null){throw'Missing the required parameter "
|
|
|
8975
9077
|
*
|
|
8976
9078
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
8977
9079
|
* @param {String} syncJobId Synchronization job ID
|
|
8978
|
-
* deleteKnowledgeKnowledgebaseSynchronizeJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
8979
9080
|
*/},{key:"deleteKnowledgeKnowledgebaseSynchronizeJob",value:function deleteKnowledgeKnowledgebaseSynchronizeJob(knowledgeBaseId,syncJobId){// verify the required parameter 'knowledgeBaseId' is set
|
|
8980
9081
|
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling deleteKnowledgeKnowledgebaseSynchronizeJob';}// verify the required parameter 'syncJobId' is set
|
|
8981
9082
|
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']);}/**
|
|
@@ -9012,7 +9113,6 @@ if(sessionId===undefined||sessionId===null){throw'Missing the required parameter
|
|
|
9012
9113
|
* Get sync options available for a knowledge-connect integration
|
|
9013
9114
|
*
|
|
9014
9115
|
* @param {String} integrationId Integration ID
|
|
9015
|
-
* getKnowledgeIntegrationOptions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
9016
9116
|
*/},{key:"getKnowledgeIntegrationOptions",value:function getKnowledgeIntegrationOptions(integrationId){// verify the required parameter 'integrationId' is set
|
|
9017
9117
|
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']);}/**
|
|
9018
9118
|
* Get knowledge base
|
|
@@ -9087,10 +9187,11 @@ if(feedbackId===undefined||feedbackId===null){throw'Missing the required paramet
|
|
|
9087
9187
|
* @param {String} knowledgeBaseId Globally unique identifier for a knowledge base.
|
|
9088
9188
|
* @param {Object} opts Optional parameters
|
|
9089
9189
|
* @param {Object} opts.documentState The state of the document.
|
|
9190
|
+
* @param {Array.<String>} opts.expand The specified entity attributes will be filled. Comma separated values expected.
|
|
9090
9191
|
*/},{key:"getKnowledgeKnowledgebaseDocumentVariation",value:function getKnowledgeKnowledgebaseDocumentVariation(documentVariationId,documentId,knowledgeBaseId,opts){opts=opts||{};// verify the required parameter 'documentVariationId' is set
|
|
9091
9192
|
if(documentVariationId===undefined||documentVariationId===null){throw'Missing the required parameter "documentVariationId" when calling getKnowledgeKnowledgebaseDocumentVariation';}// verify the required parameter 'documentId' is set
|
|
9092
9193
|
if(documentId===undefined||documentId===null){throw'Missing the required parameter "documentId" when calling getKnowledgeKnowledgebaseDocumentVariation';}// verify the required parameter 'knowledgeBaseId' is set
|
|
9093
|
-
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseDocumentVariation';}return this.apiClient.callApi('/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/variations/{documentVariationId}','GET',{'documentVariationId':documentVariationId,'documentId':documentId,'knowledgeBaseId':knowledgeBaseId},{'documentState':opts['documentState']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
9194
|
+
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseDocumentVariation';}return this.apiClient.callApi('/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/variations/{documentVariationId}','GET',{'documentVariationId':documentVariationId,'documentId':documentId,'knowledgeBaseId':knowledgeBaseId},{'documentState':opts['documentState'],'expand':this.apiClient.buildCollectionParam(opts['expand'],'multi')},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
9094
9195
|
* Get variations for a document.
|
|
9095
9196
|
*
|
|
9096
9197
|
* @param {String} knowledgeBaseId Globally unique identifier for the knowledge base.
|
|
@@ -9100,9 +9201,10 @@ if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the requir
|
|
|
9100
9201
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
9101
9202
|
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
9102
9203
|
* @param {Object} opts.documentState The state of the document.
|
|
9204
|
+
* @param {Array.<String>} opts.expand The specified entity attributes will be filled. Comma separated values expected.
|
|
9103
9205
|
*/},{key:"getKnowledgeKnowledgebaseDocumentVariations",value:function getKnowledgeKnowledgebaseDocumentVariations(knowledgeBaseId,documentId,opts){opts=opts||{};// verify the required parameter 'knowledgeBaseId' is set
|
|
9104
9206
|
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseDocumentVariations';}// verify the required parameter 'documentId' is set
|
|
9105
|
-
if(documentId===undefined||documentId===null){throw'Missing the required parameter "documentId" when calling getKnowledgeKnowledgebaseDocumentVariations';}return this.apiClient.callApi('/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/variations','GET',{'knowledgeBaseId':knowledgeBaseId,'documentId':documentId},{'before':opts['before'],'after':opts['after'],'pageSize':opts['pageSize'],'documentState':opts['documentState']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
9207
|
+
if(documentId===undefined||documentId===null){throw'Missing the required parameter "documentId" when calling getKnowledgeKnowledgebaseDocumentVariations';}return this.apiClient.callApi('/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/variations','GET',{'knowledgeBaseId':knowledgeBaseId,'documentId':documentId},{'before':opts['before'],'after':opts['after'],'pageSize':opts['pageSize'],'documentState':opts['documentState'],'expand':this.apiClient.buildCollectionParam(opts['expand'],'multi')},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
9106
9208
|
* Get document version.
|
|
9107
9209
|
*
|
|
9108
9210
|
* @param {String} knowledgeBaseId Globally unique identifier for the knowledge base.
|
|
@@ -9312,13 +9414,11 @@ if(languageCode===undefined||languageCode===null){throw'Missing the required par
|
|
|
9312
9414
|
* @param {Array.<String>} opts.status If specified, retrieves operations with specified operation status, comma separated values expected.
|
|
9313
9415
|
* @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
|
|
9314
9416
|
* @param {Array.<String>} opts.sourceId If specified, retrieves operations associated with source ids, comma separated values expected.
|
|
9315
|
-
* getKnowledgeKnowledgebaseOperations is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
9316
9417
|
*/},{key:"getKnowledgeKnowledgebaseOperations",value:function getKnowledgeKnowledgebaseOperations(knowledgeBaseId,opts){opts=opts||{};// verify the required parameter 'knowledgeBaseId' is set
|
|
9317
9418
|
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']);}/**
|
|
9318
9419
|
* Get ids of operation creator users and oauth clients
|
|
9319
9420
|
*
|
|
9320
9421
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
9321
|
-
* getKnowledgeKnowledgebaseOperationsUsersQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
9322
9422
|
*/},{key:"getKnowledgeKnowledgebaseOperationsUsersQuery",value:function getKnowledgeKnowledgebaseOperationsUsersQuery(knowledgeBaseId){// verify the required parameter 'knowledgeBaseId' is set
|
|
9323
9423
|
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']);}/**
|
|
9324
9424
|
* Get parse job report
|
|
@@ -9338,7 +9438,6 @@ if(parseJobId===undefined||parseJobId===null){throw'Missing the required paramet
|
|
|
9338
9438
|
* @param {Object} opts.type If specified, retrieves integration sources with specified integration type.
|
|
9339
9439
|
* @param {Array.<String>} opts.expand The specified entity attributes will be filled. Comma separated values expected.
|
|
9340
9440
|
* @param {Array.<String>} opts.ids If specified, retrieves integration sources with specified IDs.
|
|
9341
|
-
* getKnowledgeKnowledgebaseSources is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
9342
9441
|
*/},{key:"getKnowledgeKnowledgebaseSources",value:function getKnowledgeKnowledgebaseSources(knowledgeBaseId,opts){opts=opts||{};// verify the required parameter 'knowledgeBaseId' is set
|
|
9343
9442
|
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']);}/**
|
|
9344
9443
|
* Get Salesforce Knowledge integration source
|
|
@@ -9347,7 +9446,6 @@ if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the requir
|
|
|
9347
9446
|
* @param {String} sourceId Source ID
|
|
9348
9447
|
* @param {Object} opts Optional parameters
|
|
9349
9448
|
* @param {Array.<String>} opts.expand The specified entity attributes will be filled. Comma separated values expected.
|
|
9350
|
-
* getKnowledgeKnowledgebaseSourcesSalesforceSourceId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
9351
9449
|
*/},{key:"getKnowledgeKnowledgebaseSourcesSalesforceSourceId",value:function getKnowledgeKnowledgebaseSourcesSalesforceSourceId(knowledgeBaseId,sourceId,opts){opts=opts||{};// verify the required parameter 'knowledgeBaseId' is set
|
|
9352
9450
|
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseSourcesSalesforceSourceId';}// verify the required parameter 'sourceId' is set
|
|
9353
9451
|
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']);}/**
|
|
@@ -9357,7 +9455,6 @@ if(sourceId===undefined||sourceId===null){throw'Missing the required parameter "
|
|
|
9357
9455
|
* @param {String} sourceId Source ID
|
|
9358
9456
|
* @param {Object} opts Optional parameters
|
|
9359
9457
|
* @param {Array.<String>} opts.expand The specified entity attributes will be filled. Comma separated values expected.
|
|
9360
|
-
* getKnowledgeKnowledgebaseSourcesServicenowSourceId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
9361
9458
|
*/},{key:"getKnowledgeKnowledgebaseSourcesServicenowSourceId",value:function getKnowledgeKnowledgebaseSourcesServicenowSourceId(knowledgeBaseId,sourceId,opts){opts=opts||{};// verify the required parameter 'knowledgeBaseId' is set
|
|
9362
9459
|
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseSourcesServicenowSourceId';}// verify the required parameter 'sourceId' is set
|
|
9363
9460
|
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']);}/**
|
|
@@ -9365,7 +9462,6 @@ if(sourceId===undefined||sourceId===null){throw'Missing the required parameter "
|
|
|
9365
9462
|
*
|
|
9366
9463
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
9367
9464
|
* @param {String} syncJobId Synchronization job ID
|
|
9368
|
-
* getKnowledgeKnowledgebaseSynchronizeJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
9369
9465
|
*/},{key:"getKnowledgeKnowledgebaseSynchronizeJob",value:function getKnowledgeKnowledgebaseSynchronizeJob(knowledgeBaseId,syncJobId){// verify the required parameter 'knowledgeBaseId' is set
|
|
9370
9466
|
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseSynchronizeJob';}// verify the required parameter 'syncJobId' is set
|
|
9371
9467
|
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']);}/**
|
|
@@ -9567,7 +9663,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
9567
9663
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
9568
9664
|
* @param {String} syncJobId Synchronization job ID
|
|
9569
9665
|
* @param {Object} body
|
|
9570
|
-
* patchKnowledgeKnowledgebaseSynchronizeJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
9571
9666
|
*/},{key:"patchKnowledgeKnowledgebaseSynchronizeJob",value:function patchKnowledgeKnowledgebaseSynchronizeJob(knowledgeBaseId,syncJobId,body){// verify the required parameter 'knowledgeBaseId' is set
|
|
9572
9667
|
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling patchKnowledgeKnowledgebaseSynchronizeJob';}// verify the required parameter 'syncJobId' is set
|
|
9573
9668
|
if(syncJobId===undefined||syncJobId===null){throw'Missing the required parameter "syncJobId" when calling patchKnowledgeKnowledgebaseSynchronizeJob';}// verify the required parameter 'body' is set
|
|
@@ -9881,7 +9976,6 @@ if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the requir
|
|
|
9881
9976
|
*
|
|
9882
9977
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
9883
9978
|
* @param {Object} body
|
|
9884
|
-
* postKnowledgeKnowledgebaseSourcesSalesforce is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
9885
9979
|
*/},{key:"postKnowledgeKnowledgebaseSourcesSalesforce",value:function postKnowledgeKnowledgebaseSourcesSalesforce(knowledgeBaseId,body){// verify the required parameter 'knowledgeBaseId' is set
|
|
9886
9980
|
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseSourcesSalesforce';}// verify the required parameter 'body' is set
|
|
9887
9981
|
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']);}/**
|
|
@@ -9889,7 +9983,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
9889
9983
|
*
|
|
9890
9984
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
9891
9985
|
* @param {String} sourceId Source ID
|
|
9892
|
-
* postKnowledgeKnowledgebaseSourcesSalesforceSourceIdSync is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
9893
9986
|
*/},{key:"postKnowledgeKnowledgebaseSourcesSalesforceSourceIdSync",value:function postKnowledgeKnowledgebaseSourcesSalesforceSourceIdSync(knowledgeBaseId,sourceId){// verify the required parameter 'knowledgeBaseId' is set
|
|
9894
9987
|
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseSourcesSalesforceSourceIdSync';}// verify the required parameter 'sourceId' is set
|
|
9895
9988
|
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']);}/**
|
|
@@ -9897,7 +9990,6 @@ if(sourceId===undefined||sourceId===null){throw'Missing the required parameter "
|
|
|
9897
9990
|
*
|
|
9898
9991
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
9899
9992
|
* @param {Object} body
|
|
9900
|
-
* postKnowledgeKnowledgebaseSourcesServicenow is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
9901
9993
|
*/},{key:"postKnowledgeKnowledgebaseSourcesServicenow",value:function postKnowledgeKnowledgebaseSourcesServicenow(knowledgeBaseId,body){// verify the required parameter 'knowledgeBaseId' is set
|
|
9902
9994
|
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseSourcesServicenow';}// verify the required parameter 'body' is set
|
|
9903
9995
|
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']);}/**
|
|
@@ -9905,7 +9997,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
9905
9997
|
*
|
|
9906
9998
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
9907
9999
|
* @param {String} sourceId Source ID
|
|
9908
|
-
* postKnowledgeKnowledgebaseSourcesServicenowSourceIdSync is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
9909
10000
|
*/},{key:"postKnowledgeKnowledgebaseSourcesServicenowSourceIdSync",value:function postKnowledgeKnowledgebaseSourcesServicenowSourceIdSync(knowledgeBaseId,sourceId){// verify the required parameter 'knowledgeBaseId' is set
|
|
9910
10001
|
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseSourcesServicenowSourceIdSync';}// verify the required parameter 'sourceId' is set
|
|
9911
10002
|
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']);}/**
|
|
@@ -9913,7 +10004,6 @@ if(sourceId===undefined||sourceId===null){throw'Missing the required parameter "
|
|
|
9913
10004
|
*
|
|
9914
10005
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
9915
10006
|
* @param {Object} body
|
|
9916
|
-
* postKnowledgeKnowledgebaseSynchronizeJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
9917
10007
|
*/},{key:"postKnowledgeKnowledgebaseSynchronizeJobs",value:function postKnowledgeKnowledgebaseSynchronizeJobs(knowledgeBaseId,body){// verify the required parameter 'knowledgeBaseId' is set
|
|
9918
10008
|
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseSynchronizeJobs';}// verify the required parameter 'body' is set
|
|
9919
10009
|
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']);}/**
|
|
@@ -9935,7 +10025,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
9935
10025
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
9936
10026
|
* @param {String} sourceId Source ID
|
|
9937
10027
|
* @param {Object} body
|
|
9938
|
-
* putKnowledgeKnowledgebaseSourcesSalesforceSourceId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
9939
10028
|
*/},{key:"putKnowledgeKnowledgebaseSourcesSalesforceSourceId",value:function putKnowledgeKnowledgebaseSourcesSalesforceSourceId(knowledgeBaseId,sourceId,body){// verify the required parameter 'knowledgeBaseId' is set
|
|
9940
10029
|
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling putKnowledgeKnowledgebaseSourcesSalesforceSourceId';}// verify the required parameter 'sourceId' is set
|
|
9941
10030
|
if(sourceId===undefined||sourceId===null){throw'Missing the required parameter "sourceId" when calling putKnowledgeKnowledgebaseSourcesSalesforceSourceId';}// verify the required parameter 'body' is set
|
|
@@ -9945,14 +10034,13 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
9945
10034
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
9946
10035
|
* @param {String} sourceId Source ID
|
|
9947
10036
|
* @param {Object} body
|
|
9948
|
-
* putKnowledgeKnowledgebaseSourcesServicenowSourceId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
9949
10037
|
*/},{key:"putKnowledgeKnowledgebaseSourcesServicenowSourceId",value:function putKnowledgeKnowledgebaseSourcesServicenowSourceId(knowledgeBaseId,sourceId,body){// verify the required parameter 'knowledgeBaseId' is set
|
|
9950
10038
|
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling putKnowledgeKnowledgebaseSourcesServicenowSourceId';}// verify the required parameter 'sourceId' is set
|
|
9951
10039
|
if(sourceId===undefined||sourceId===null){throw'Missing the required parameter "sourceId" when calling putKnowledgeKnowledgebaseSourcesServicenowSourceId';}// verify the required parameter 'body' is set
|
|
9952
10040
|
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(){/**
|
|
9953
10041
|
* LanguageUnderstanding service.
|
|
9954
10042
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
9955
|
-
* @version
|
|
10043
|
+
* @version 208.0.0
|
|
9956
10044
|
*//**
|
|
9957
10045
|
* Constructs a new LanguageUnderstandingApi.
|
|
9958
10046
|
* @alias module:purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
@@ -10212,7 +10300,7 @@ if(domainVersionId===undefined||domainVersionId===null){throw'Missing the requir
|
|
|
10212
10300
|
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(){/**
|
|
10213
10301
|
* Languages service.
|
|
10214
10302
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
10215
|
-
* @version
|
|
10303
|
+
* @version 208.0.0
|
|
10216
10304
|
*//**
|
|
10217
10305
|
* Constructs a new LanguagesApi.
|
|
10218
10306
|
* @alias module:purecloud-platform-client-v2/api/LanguagesApi
|
|
@@ -10267,7 +10355,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
10267
10355
|
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(){/**
|
|
10268
10356
|
* Learning service.
|
|
10269
10357
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
10270
|
-
* @version
|
|
10358
|
+
* @version 208.0.0
|
|
10271
10359
|
*//**
|
|
10272
10360
|
* Constructs a new LearningApi.
|
|
10273
10361
|
* @alias module:purecloud-platform-client-v2/api/LearningApi
|
|
@@ -10538,7 +10626,7 @@ if(moduleId===undefined||moduleId===null){throw'Missing the required parameter "
|
|
|
10538
10626
|
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(){/**
|
|
10539
10627
|
* License service.
|
|
10540
10628
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
10541
|
-
* @version
|
|
10629
|
+
* @version 208.0.0
|
|
10542
10630
|
*//**
|
|
10543
10631
|
* Constructs a new LicenseApi.
|
|
10544
10632
|
* @alias module:purecloud-platform-client-v2/api/LicenseApi
|
|
@@ -10592,7 +10680,7 @@ if(featureName===undefined||featureName===null){throw'Missing the required param
|
|
|
10592
10680
|
*/},{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(){/**
|
|
10593
10681
|
* Locations service.
|
|
10594
10682
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
10595
|
-
* @version
|
|
10683
|
+
* @version 208.0.0
|
|
10596
10684
|
*//**
|
|
10597
10685
|
* Constructs a new LocationsApi.
|
|
10598
10686
|
* @alias module:purecloud-platform-client-v2/api/LocationsApi
|
|
@@ -10651,7 +10739,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
10651
10739
|
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(){/**
|
|
10652
10740
|
* LogCapture service.
|
|
10653
10741
|
* @module purecloud-platform-client-v2/api/LogCaptureApi
|
|
10654
|
-
* @version
|
|
10742
|
+
* @version 208.0.0
|
|
10655
10743
|
*//**
|
|
10656
10744
|
* Constructs a new LogCaptureApi.
|
|
10657
10745
|
* @alias module:purecloud-platform-client-v2/api/LogCaptureApi
|
|
@@ -10701,7 +10789,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
10701
10789
|
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(){/**
|
|
10702
10790
|
* Messaging service.
|
|
10703
10791
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
10704
|
-
* @version
|
|
10792
|
+
* @version 208.0.0
|
|
10705
10793
|
*//**
|
|
10706
10794
|
* Constructs a new MessagingApi.
|
|
10707
10795
|
* @alias module:purecloud-platform-client-v2/api/MessagingApi
|
|
@@ -10791,7 +10879,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
10791
10879
|
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(){/**
|
|
10792
10880
|
* MobileDevices service.
|
|
10793
10881
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
10794
|
-
* @version
|
|
10882
|
+
* @version 208.0.0
|
|
10795
10883
|
*//**
|
|
10796
10884
|
* Constructs a new MobileDevicesApi.
|
|
10797
10885
|
* @alias module:purecloud-platform-client-v2/api/MobileDevicesApi
|
|
@@ -10830,7 +10918,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
10830
10918
|
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(){/**
|
|
10831
10919
|
* Notifications service.
|
|
10832
10920
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
10833
|
-
* @version
|
|
10921
|
+
* @version 208.0.0
|
|
10834
10922
|
*//**
|
|
10835
10923
|
* Constructs a new NotificationsApi.
|
|
10836
10924
|
* @alias module:purecloud-platform-client-v2/api/NotificationsApi
|
|
@@ -10887,7 +10975,7 @@ if(channelId===undefined||channelId===null){throw'Missing the required parameter
|
|
|
10887
10975
|
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(){/**
|
|
10888
10976
|
* OAuth service.
|
|
10889
10977
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
10890
|
-
* @version
|
|
10978
|
+
* @version 208.0.0
|
|
10891
10979
|
*//**
|
|
10892
10980
|
* Constructs a new OAuthApi.
|
|
10893
10981
|
* @alias module:purecloud-platform-client-v2/api/OAuthApi
|
|
@@ -10972,7 +11060,7 @@ if(clientId===undefined||clientId===null){throw'Missing the required parameter "
|
|
|
10972
11060
|
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(){/**
|
|
10973
11061
|
* Objects service.
|
|
10974
11062
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
10975
|
-
* @version
|
|
11063
|
+
* @version 208.0.0
|
|
10976
11064
|
*//**
|
|
10977
11065
|
* Constructs a new ObjectsApi.
|
|
10978
11066
|
* @alias module:purecloud-platform-client-v2/api/ObjectsApi
|
|
@@ -11043,7 +11131,7 @@ if(divisionId===undefined||divisionId===null){throw'Missing the required paramet
|
|
|
11043
11131
|
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(){/**
|
|
11044
11132
|
* OperationalEvents service.
|
|
11045
11133
|
* @module purecloud-platform-client-v2/api/OperationalEventsApi
|
|
11046
|
-
* @version
|
|
11134
|
+
* @version 208.0.0
|
|
11047
11135
|
*//**
|
|
11048
11136
|
* Constructs a new OperationalEventsApi.
|
|
11049
11137
|
* @alias module:purecloud-platform-client-v2/api/OperationalEventsApi
|
|
@@ -11061,7 +11149,7 @@ if(eventDefinitionId===undefined||eventDefinitionId===null){throw'Missing the re
|
|
|
11061
11149
|
*/},{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(){/**
|
|
11062
11150
|
* Organization service.
|
|
11063
11151
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
11064
|
-
* @version
|
|
11152
|
+
* @version 208.0.0
|
|
11065
11153
|
*//**
|
|
11066
11154
|
* Constructs a new OrganizationApi.
|
|
11067
11155
|
* @alias module:purecloud-platform-client-v2/api/OrganizationApi
|
|
@@ -11186,7 +11274,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
11186
11274
|
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(){/**
|
|
11187
11275
|
* OrganizationAuthorization service.
|
|
11188
11276
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
11189
|
-
* @version
|
|
11277
|
+
* @version 208.0.0
|
|
11190
11278
|
*//**
|
|
11191
11279
|
* Constructs a new OrganizationAuthorizationApi.
|
|
11192
11280
|
* @alias module:purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
@@ -11337,6 +11425,9 @@ if(trusteeOrgId===undefined||trusteeOrgId===null){throw'Missing the required par
|
|
|
11337
11425
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
11338
11426
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
11339
11427
|
*/},{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']);}/**
|
|
11428
|
+
* Get Customer Care organization ids.
|
|
11429
|
+
*
|
|
11430
|
+
*/},{key:"getOrgauthorizationTrusteesCare",value:function getOrgauthorizationTrusteesCare(){return this.apiClient.callApi('/api/v2/orgauthorization/trustees/care','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
11340
11431
|
* Get organization authorization trust with Customer Care, if one exists.
|
|
11341
11432
|
*
|
|
11342
11433
|
*/},{key:"getOrgauthorizationTrusteesDefault",value:function getOrgauthorizationTrusteesDefault(){return this.apiClient.callApi('/api/v2/orgauthorization/trustees/default','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
@@ -11427,6 +11518,14 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
11427
11518
|
* @param {String} opts.sortOrder Sort order (default to descending)
|
|
11428
11519
|
*/},{key:"postOrgauthorizationTrusteesAudits",value:function postOrgauthorizationTrusteesAudits(body,opts){opts=opts||{};// verify the required parameter 'body' is set
|
|
11429
11520
|
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']);}/**
|
|
11521
|
+
* Create a new organization authorization trust with Customer Care. This is required to grant your regional Customer Care organization access to your organization.
|
|
11522
|
+
*
|
|
11523
|
+
* @param {Object} opts Optional parameters
|
|
11524
|
+
* @param {Boolean} opts.assignDefaultRole Assign Admin role to default pairing with Customer Care
|
|
11525
|
+
* @param {Boolean} opts.autoExpire Automatically expire pairing after 30 days
|
|
11526
|
+
* @param {Boolean} opts.assignFullAccess Grant Customer Care full access to the organization
|
|
11527
|
+
* @param {Boolean} opts.allowTrustedUserAccess Make Customer Care a Trusted User
|
|
11528
|
+
*/},{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']);}/**
|
|
11430
11529
|
* Create a new organization authorization trust with Customer Care. This is required to grant your regional Customer Care organization access to your organization.
|
|
11431
11530
|
*
|
|
11432
11531
|
* @param {Object} opts Optional parameters
|
|
@@ -11509,7 +11608,7 @@ if(trustorOrgId===undefined||trustorOrgId===null){throw'Missing the required par
|
|
|
11509
11608
|
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(){/**
|
|
11510
11609
|
* Outbound service.
|
|
11511
11610
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
11512
|
-
* @version
|
|
11611
|
+
* @version 208.0.0
|
|
11513
11612
|
*//**
|
|
11514
11613
|
* Constructs a new OutboundApi.
|
|
11515
11614
|
* @alias module:purecloud-platform-client-v2/api/OutboundApi
|
|
@@ -12266,6 +12365,16 @@ if(campaignId===undefined||campaignId===null){throw'Missing the required paramet
|
|
|
12266
12365
|
*/},{key:"postOutboundCampaignCallbackSchedule",value:function postOutboundCampaignCallbackSchedule(campaignId,body){// verify the required parameter 'campaignId' is set
|
|
12267
12366
|
if(campaignId===undefined||campaignId===null){throw'Missing the required parameter "campaignId" when calling postOutboundCampaignCallbackSchedule';}// verify the required parameter 'body' is set
|
|
12268
12367
|
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']);}/**
|
|
12368
|
+
* Start the campaign
|
|
12369
|
+
*
|
|
12370
|
+
* @param {String} campaignId Campaign ID
|
|
12371
|
+
*/},{key:"postOutboundCampaignStart",value:function postOutboundCampaignStart(campaignId){// verify the required parameter 'campaignId' is set
|
|
12372
|
+
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']);}/**
|
|
12373
|
+
* Stop the campaign
|
|
12374
|
+
*
|
|
12375
|
+
* @param {String} campaignId Campaign ID
|
|
12376
|
+
*/},{key:"postOutboundCampaignStop",value:function postOutboundCampaignStop(campaignId){// verify the required parameter 'campaignId' is set
|
|
12377
|
+
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']);}/**
|
|
12269
12378
|
* Create Campaign Rule
|
|
12270
12379
|
*
|
|
12271
12380
|
* @param {Object} body CampaignRule
|
|
@@ -12418,6 +12527,16 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
12418
12527
|
* @param {Array.<Object>} body import template(s) to add
|
|
12419
12528
|
*/},{key:"postOutboundImporttemplatesBulkAdd",value:function postOutboundImporttemplatesBulkAdd(body){// verify the required parameter 'body' is set
|
|
12420
12529
|
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']);}/**
|
|
12530
|
+
* Start the campaign
|
|
12531
|
+
* Documented permissions are applicable based on campaign type.
|
|
12532
|
+
* @param {String} messagingCampaignId The Messaging Campaign ID
|
|
12533
|
+
*/},{key:"postOutboundMessagingcampaignStart",value:function postOutboundMessagingcampaignStart(messagingCampaignId){// verify the required parameter 'messagingCampaignId' is set
|
|
12534
|
+
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']);}/**
|
|
12535
|
+
* Stop the campaign
|
|
12536
|
+
* Documented permissions are applicable based on campaign type.
|
|
12537
|
+
* @param {String} messagingCampaignId The Messaging Campaign ID
|
|
12538
|
+
*/},{key:"postOutboundMessagingcampaignStop",value:function postOutboundMessagingcampaignStop(messagingCampaignId){// verify the required parameter 'messagingCampaignId' is set
|
|
12539
|
+
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']);}/**
|
|
12421
12540
|
* Create a Messaging Campaign
|
|
12422
12541
|
*
|
|
12423
12542
|
* @param {Object} body Messaging Campaign
|
|
@@ -12596,7 +12715,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
12596
12715
|
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(){/**
|
|
12597
12716
|
* Presence service.
|
|
12598
12717
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
12599
|
-
* @version
|
|
12718
|
+
* @version 208.0.0
|
|
12600
12719
|
*//**
|
|
12601
12720
|
* Constructs a new PresenceApi.
|
|
12602
12721
|
* @alias module:purecloud-platform-client-v2/api/PresenceApi
|
|
@@ -12769,7 +12888,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
12769
12888
|
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(){/**
|
|
12770
12889
|
* ProcessAutomation service.
|
|
12771
12890
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
12772
|
-
* @version
|
|
12891
|
+
* @version 208.0.0
|
|
12773
12892
|
*//**
|
|
12774
12893
|
* Constructs a new ProcessAutomationApi.
|
|
12775
12894
|
* @alias module:purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
@@ -12832,7 +12951,7 @@ if(triggerId===undefined||triggerId===null){throw'Missing the required parameter
|
|
|
12832
12951
|
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(){/**
|
|
12833
12952
|
* Quality service.
|
|
12834
12953
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
12835
|
-
* @version
|
|
12954
|
+
* @version 208.0.0
|
|
12836
12955
|
*//**
|
|
12837
12956
|
* Constructs a new QualityApi.
|
|
12838
12957
|
* @alias module:purecloud-platform-client-v2/api/QualityApi
|
|
@@ -13309,7 +13428,7 @@ if(customerSurveyUrl===undefined||customerSurveyUrl===null){throw'Missing the re
|
|
|
13309
13428
|
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(){/**
|
|
13310
13429
|
* Recording service.
|
|
13311
13430
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
13312
|
-
* @version
|
|
13431
|
+
* @version 208.0.0
|
|
13313
13432
|
*//**
|
|
13314
13433
|
* Constructs a new RecordingApi.
|
|
13315
13434
|
* @alias module:purecloud-platform-client-v2/api/RecordingApi
|
|
@@ -13721,7 +13840,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
13721
13840
|
*/},{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(){/**
|
|
13722
13841
|
* ResponseManagement service.
|
|
13723
13842
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
13724
|
-
* @version
|
|
13843
|
+
* @version 208.0.0
|
|
13725
13844
|
*//**
|
|
13726
13845
|
* Constructs a new ResponseManagementApi.
|
|
13727
13846
|
* @alias module:purecloud-platform-client-v2/api/ResponseManagementApi
|
|
@@ -13842,7 +13961,7 @@ if(responseAssetId===undefined||responseAssetId===null){throw'Missing the requir
|
|
|
13842
13961
|
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(){/**
|
|
13843
13962
|
* Routing service.
|
|
13844
13963
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
13845
|
-
* @version
|
|
13964
|
+
* @version 208.0.0
|
|
13846
13965
|
*//**
|
|
13847
13966
|
* Constructs a new RoutingApi.
|
|
13848
13967
|
* @alias module:purecloud-platform-client-v2/api/RoutingApi
|
|
@@ -13970,14 +14089,14 @@ if(tagId===undefined||tagId===null){throw'Missing the required parameter "tagId"
|
|
|
13970
14089
|
* @param {String} codeId Wrapup Code ID
|
|
13971
14090
|
*/},{key:"deleteRoutingWrapupcode",value:function deleteRoutingWrapupcode(codeId){// verify the required parameter 'codeId' is set
|
|
13972
14091
|
if(codeId===undefined||codeId===null){throw'Missing the required parameter "codeId" when calling deleteRoutingWrapupcode';}return this.apiClient.callApi('/api/v2/routing/wrapupcodes/{codeId}','DELETE',{'codeId':codeId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
13973
|
-
* Remove routing language from user
|
|
14092
|
+
* Remove a routing language from a user
|
|
13974
14093
|
*
|
|
13975
14094
|
* @param {String} userId User ID
|
|
13976
14095
|
* @param {String} languageId languageId
|
|
13977
14096
|
*/},{key:"deleteUserRoutinglanguage",value:function deleteUserRoutinglanguage(userId,languageId){// verify the required parameter 'userId' is set
|
|
13978
14097
|
if(userId===undefined||userId===null){throw'Missing the required parameter "userId" when calling deleteUserRoutinglanguage';}// verify the required parameter 'languageId' is set
|
|
13979
14098
|
if(languageId===undefined||languageId===null){throw'Missing the required parameter "languageId" when calling deleteUserRoutinglanguage';}return this.apiClient.callApi('/api/v2/users/{userId}/routinglanguages/{languageId}','DELETE',{'userId':userId,'languageId':languageId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
13980
|
-
* Remove routing skill from user
|
|
14099
|
+
* Remove a routing skill from a user
|
|
13981
14100
|
*
|
|
13982
14101
|
* @param {String} userId User ID
|
|
13983
14102
|
* @param {String} skillId skillId
|
|
@@ -14437,7 +14556,7 @@ if(codeId===undefined||codeId===null){throw'Missing the required parameter "code
|
|
|
14437
14556
|
* @param {Array.<String>} opts.divisionId Division ID(s)
|
|
14438
14557
|
*/},{key:"getUserQueues",value:function getUserQueues(userId,opts){opts=opts||{};// verify the required parameter 'userId' is set
|
|
14439
14558
|
if(userId===undefined||userId===null){throw'Missing the required parameter "userId" when calling getUserQueues';}return this.apiClient.callApi('/api/v2/users/{userId}/queues','GET',{'userId':userId},{'pageSize':opts['pageSize'],'pageNumber':opts['pageNumber'],'joined':opts['joined'],'divisionId':this.apiClient.buildCollectionParam(opts['divisionId'],'multi')},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
14440
|
-
* List routing
|
|
14559
|
+
* List routing languages assigned to a user
|
|
14441
14560
|
*
|
|
14442
14561
|
* @param {String} userId User ID
|
|
14443
14562
|
* @param {Object} opts Optional parameters
|
|
@@ -14446,7 +14565,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
14446
14565
|
* @param {Object} opts.sortOrder Ascending or descending sort order (default to ASC)
|
|
14447
14566
|
*/},{key:"getUserRoutinglanguages",value:function getUserRoutinglanguages(userId,opts){opts=opts||{};// verify the required parameter 'userId' is set
|
|
14448
14567
|
if(userId===undefined||userId===null){throw'Missing the required parameter "userId" when calling getUserRoutinglanguages';}return this.apiClient.callApi('/api/v2/users/{userId}/routinglanguages','GET',{'userId':userId},{'pageSize':opts['pageSize'],'pageNumber':opts['pageNumber'],'sortOrder':opts['sortOrder']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
14449
|
-
* List routing skills
|
|
14568
|
+
* List routing skills assigned to a user
|
|
14450
14569
|
*
|
|
14451
14570
|
* @param {String} userId User ID
|
|
14452
14571
|
* @param {Object} opts Optional parameters
|
|
@@ -14561,7 +14680,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
14561
14680
|
*/},{key:"patchUserQueues",value:function patchUserQueues(userId,body,opts){opts=opts||{};// verify the required parameter 'userId' is set
|
|
14562
14681
|
if(userId===undefined||userId===null){throw'Missing the required parameter "userId" when calling patchUserQueues';}// verify the required parameter 'body' is set
|
|
14563
14682
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling patchUserQueues';}return this.apiClient.callApi('/api/v2/users/{userId}/queues','PATCH',{'userId':userId},{'divisionId':this.apiClient.buildCollectionParam(opts['divisionId'],'multi')},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
14564
|
-
* Update routing language proficiency
|
|
14683
|
+
* Update an assigned routing language's proficiency
|
|
14565
14684
|
*
|
|
14566
14685
|
* @param {String} userId User ID
|
|
14567
14686
|
* @param {String} languageId languageId
|
|
@@ -14570,14 +14689,14 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
14570
14689
|
if(userId===undefined||userId===null){throw'Missing the required parameter "userId" when calling patchUserRoutinglanguage';}// verify the required parameter 'languageId' is set
|
|
14571
14690
|
if(languageId===undefined||languageId===null){throw'Missing the required parameter "languageId" when calling patchUserRoutinglanguage';}// verify the required parameter 'body' is set
|
|
14572
14691
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling patchUserRoutinglanguage';}return this.apiClient.callApi('/api/v2/users/{userId}/routinglanguages/{languageId}','PATCH',{'userId':userId,'languageId':languageId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
14573
|
-
*
|
|
14692
|
+
* Assign multiple routing languages to a user. Max 50 routing languages in request body
|
|
14574
14693
|
*
|
|
14575
14694
|
* @param {String} userId User ID
|
|
14576
14695
|
* @param {Array.<Object>} body Language
|
|
14577
14696
|
*/},{key:"patchUserRoutinglanguagesBulk",value:function patchUserRoutinglanguagesBulk(userId,body){// verify the required parameter 'userId' is set
|
|
14578
14697
|
if(userId===undefined||userId===null){throw'Missing the required parameter "userId" when calling patchUserRoutinglanguagesBulk';}// verify the required parameter 'body' is set
|
|
14579
14698
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling patchUserRoutinglanguagesBulk';}return this.apiClient.callApi('/api/v2/users/{userId}/routinglanguages/bulk','PATCH',{'userId':userId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
14580
|
-
*
|
|
14699
|
+
* Assign multiple routing skills to a user
|
|
14581
14700
|
*
|
|
14582
14701
|
* @param {String} userId User ID
|
|
14583
14702
|
* @param {Array.<Object>} body Skill
|
|
@@ -14731,14 +14850,14 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
14731
14850
|
* @param {Object} body WrapupCode
|
|
14732
14851
|
*/},{key:"postRoutingWrapupcodes",value:function postRoutingWrapupcodes(body){// verify the required parameter 'body' is set
|
|
14733
14852
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postRoutingWrapupcodes';}return this.apiClient.callApi('/api/v2/routing/wrapupcodes','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
14734
|
-
*
|
|
14853
|
+
* Assign a routing language to a user
|
|
14735
14854
|
*
|
|
14736
14855
|
* @param {String} userId User ID
|
|
14737
14856
|
* @param {Object} body Language
|
|
14738
14857
|
*/},{key:"postUserRoutinglanguages",value:function postUserRoutinglanguages(userId,body){// verify the required parameter 'userId' is set
|
|
14739
14858
|
if(userId===undefined||userId===null){throw'Missing the required parameter "userId" when calling postUserRoutinglanguages';}// verify the required parameter 'body' is set
|
|
14740
14859
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postUserRoutinglanguages';}return this.apiClient.callApi('/api/v2/users/{userId}/routinglanguages','POST',{'userId':userId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
14741
|
-
*
|
|
14860
|
+
* Assign a routing skill to a user
|
|
14742
14861
|
*
|
|
14743
14862
|
* @param {String} userId User ID
|
|
14744
14863
|
* @param {Object} body Skill
|
|
@@ -14828,7 +14947,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
14828
14947
|
*/},{key:"putRoutingWrapupcode",value:function putRoutingWrapupcode(codeId,body){// verify the required parameter 'codeId' is set
|
|
14829
14948
|
if(codeId===undefined||codeId===null){throw'Missing the required parameter "codeId" when calling putRoutingWrapupcode';}// verify the required parameter 'body' is set
|
|
14830
14949
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putRoutingWrapupcode';}return this.apiClient.callApi('/api/v2/routing/wrapupcodes/{codeId}','PUT',{'codeId':codeId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
14831
|
-
* Update routing skill proficiency
|
|
14950
|
+
* Update an assigned routing skill's proficiency
|
|
14832
14951
|
*
|
|
14833
14952
|
* @param {String} userId User ID
|
|
14834
14953
|
* @param {String} skillId skillId
|
|
@@ -14837,7 +14956,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
14837
14956
|
if(userId===undefined||userId===null){throw'Missing the required parameter "userId" when calling putUserRoutingskill';}// verify the required parameter 'skillId' is set
|
|
14838
14957
|
if(skillId===undefined||skillId===null){throw'Missing the required parameter "skillId" when calling putUserRoutingskill';}// verify the required parameter 'body' is set
|
|
14839
14958
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putUserRoutingskill';}return this.apiClient.callApi('/api/v2/users/{userId}/routingskills/{skillId}','PUT',{'userId':userId,'skillId':skillId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
14840
|
-
*
|
|
14959
|
+
* Assign multiple routing skills to a user, replacing any current assignments
|
|
14841
14960
|
*
|
|
14842
14961
|
* @param {String} userId User ID
|
|
14843
14962
|
* @param {Array.<Object>} body Skill
|
|
@@ -14846,7 +14965,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
14846
14965
|
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(){/**
|
|
14847
14966
|
* SCIM service.
|
|
14848
14967
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
14849
|
-
* @version
|
|
14968
|
+
* @version 208.0.0
|
|
14850
14969
|
*//**
|
|
14851
14970
|
* Constructs a new SCIMApi.
|
|
14852
14971
|
* @alias module:purecloud-platform-client-v2/api/SCIMApi
|
|
@@ -15071,7 +15190,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
15071
15190
|
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(){/**
|
|
15072
15191
|
* ScreenRecording service.
|
|
15073
15192
|
* @module purecloud-platform-client-v2/api/ScreenRecordingApi
|
|
15074
|
-
* @version
|
|
15193
|
+
* @version 208.0.0
|
|
15075
15194
|
*//**
|
|
15076
15195
|
* Constructs a new ScreenRecordingApi.
|
|
15077
15196
|
* @alias module:purecloud-platform-client-v2/api/ScreenRecordingApi
|
|
@@ -15086,7 +15205,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
15086
15205
|
*/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(){/**
|
|
15087
15206
|
* Scripts service.
|
|
15088
15207
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
15089
|
-
* @version
|
|
15208
|
+
* @version 208.0.0
|
|
15090
15209
|
*//**
|
|
15091
15210
|
* Constructs a new ScriptsApi.
|
|
15092
15211
|
* @alias module:purecloud-platform-client-v2/api/ScriptsApi
|
|
@@ -15222,7 +15341,7 @@ if(scriptId===undefined||scriptId===null){throw'Missing the required parameter "
|
|
|
15222
15341
|
*/},{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(){/**
|
|
15223
15342
|
* Search service.
|
|
15224
15343
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
15225
|
-
* @version
|
|
15344
|
+
* @version 208.0.0
|
|
15226
15345
|
*//**
|
|
15227
15346
|
* Constructs a new SearchApi.
|
|
15228
15347
|
* @alias module:purecloud-platform-client-v2/api/SearchApi
|
|
@@ -15270,6 +15389,13 @@ if(q64===undefined||q64===null){throw'Missing the required parameter "q64" when
|
|
|
15270
15389
|
* @param {Boolean} opts.profile profile (default to true)
|
|
15271
15390
|
*/},{key:"getSearchSuggest",value:function getSearchSuggest(q64,opts){opts=opts||{};// verify the required parameter 'q64' is set
|
|
15272
15391
|
if(q64===undefined||q64===null){throw'Missing the required parameter "q64" when calling getSearchSuggest';}return this.apiClient.callApi('/api/v2/search/suggest','GET',{},{'q64':q64,'expand':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'profile':opts['profile']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
15392
|
+
* Search sites using the q64 value returned from a previous search
|
|
15393
|
+
*
|
|
15394
|
+
* @param {String} q64 q64
|
|
15395
|
+
* @param {Object} opts Optional parameters
|
|
15396
|
+
* @param {Array.<String>} opts.expand expand
|
|
15397
|
+
*/},{key:"getTelephonyProvidersEdgesSitesSearch",value:function getTelephonyProvidersEdgesSitesSearch(q64,opts){opts=opts||{};// verify the required parameter 'q64' is set
|
|
15398
|
+
if(q64===undefined||q64===null){throw'Missing the required parameter "q64" when calling getTelephonyProvidersEdgesSitesSearch';}return this.apiClient.callApi('/api/v2/telephony/providers/edges/sites/search','GET',{},{'q64':q64,'expand':this.apiClient.buildCollectionParam(opts['expand'],'multi')},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
15273
15399
|
* Search users using the q64 value returned from a previous search
|
|
15274
15400
|
*
|
|
15275
15401
|
* @param {String} q64 q64
|
|
@@ -15353,6 +15479,11 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
15353
15479
|
* @param {Object} body Search request options
|
|
15354
15480
|
*/},{key:"postTeamsSearch",value:function postTeamsSearch(body){// verify the required parameter 'body' is set
|
|
15355
15481
|
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']);}/**
|
|
15482
|
+
* Search sites
|
|
15483
|
+
*
|
|
15484
|
+
* @param {Object} body Search request options
|
|
15485
|
+
*/},{key:"postTelephonyProvidersEdgesSitesSearch",value:function postTelephonyProvidersEdgesSitesSearch(body){// verify the required parameter 'body' is set
|
|
15486
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postTelephonyProvidersEdgesSitesSearch';}return this.apiClient.callApi('/api/v2/telephony/providers/edges/sites/search','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
15356
15487
|
* Search users
|
|
15357
15488
|
*
|
|
15358
15489
|
* @param {Object} body Search request options
|
|
@@ -15382,7 +15513,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
15382
15513
|
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(){/**
|
|
15383
15514
|
* Settings service.
|
|
15384
15515
|
* @module purecloud-platform-client-v2/api/SettingsApi
|
|
15385
|
-
* @version
|
|
15516
|
+
* @version 208.0.0
|
|
15386
15517
|
*//**
|
|
15387
15518
|
* Constructs a new SettingsApi.
|
|
15388
15519
|
* @alias module:purecloud-platform-client-v2/api/SettingsApi
|
|
@@ -15432,7 +15563,7 @@ if(agentId===undefined||agentId===null){throw'Missing the required parameter "ag
|
|
|
15432
15563
|
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(){/**
|
|
15433
15564
|
* SpeechTextAnalytics service.
|
|
15434
15565
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
15435
|
-
* @version
|
|
15566
|
+
* @version 208.0.0
|
|
15436
15567
|
*//**
|
|
15437
15568
|
* Constructs a new SpeechTextAnalyticsApi.
|
|
15438
15569
|
* @alias module:purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
@@ -15617,13 +15748,13 @@ if(topicId===undefined||topicId===null){throw'Missing the required parameter "to
|
|
|
15617
15748
|
* @param {String} jobId The id of the publish topics job
|
|
15618
15749
|
*/},{key:"getSpeechandtextanalyticsTopicsPublishjob",value:function getSpeechandtextanalyticsTopicsPublishjob(jobId){// verify the required parameter 'jobId' is set
|
|
15619
15750
|
if(jobId===undefined||jobId===null){throw'Missing the required parameter "jobId" when calling getSpeechandtextanalyticsTopicsPublishjob';}return this.apiClient.callApi('/api/v2/speechandtextanalytics/topics/publishjobs/{jobId}','GET',{'jobId':jobId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
15620
|
-
* Translate
|
|
15751
|
+
* Translate a single interaction recording (or an email conversation)
|
|
15621
15752
|
*
|
|
15622
15753
|
* @param {String} languageId Target translation language
|
|
15623
15754
|
* @param {String} conversationId Conversation id
|
|
15624
15755
|
* @param {Object} opts Optional parameters
|
|
15625
|
-
* @param {String} opts.communicationId Communication id associated with the conversation
|
|
15626
|
-
* @param {String} opts.recordingId Recording id associated with the communication
|
|
15756
|
+
* @param {String} opts.communicationId Communication id associated with the conversation. Please provide a valid communicationId when requesting non-email interactions.
|
|
15757
|
+
* @param {String} opts.recordingId Recording id associated with the communication. Please provide a valid recordingId when requesting voice interactions.
|
|
15627
15758
|
* getSpeechandtextanalyticsTranslationsLanguageConversation is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
15628
15759
|
*/},{key:"getSpeechandtextanalyticsTranslationsLanguageConversation",value:function getSpeechandtextanalyticsTranslationsLanguageConversation(languageId,conversationId,opts){opts=opts||{};// verify the required parameter 'languageId' is set
|
|
15629
15760
|
if(languageId===undefined||languageId===null){throw'Missing the required parameter "languageId" when calling getSpeechandtextanalyticsTranslationsLanguageConversation';}// verify the required parameter 'conversationId' is set
|
|
@@ -15731,7 +15862,7 @@ if(topicId===undefined||topicId===null){throw'Missing the required parameter "to
|
|
|
15731
15862
|
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(){/**
|
|
15732
15863
|
* Stations service.
|
|
15733
15864
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
15734
|
-
* @version
|
|
15865
|
+
* @version 208.0.0
|
|
15735
15866
|
*//**
|
|
15736
15867
|
* Constructs a new StationsApi.
|
|
15737
15868
|
* @alias module:purecloud-platform-client-v2/api/StationsApi
|
|
@@ -15763,7 +15894,7 @@ if(stationId===undefined||stationId===null){throw'Missing the required parameter
|
|
|
15763
15894
|
*/},{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(){/**
|
|
15764
15895
|
* Suggest service.
|
|
15765
15896
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
15766
|
-
* @version
|
|
15897
|
+
* @version 208.0.0
|
|
15767
15898
|
*//**
|
|
15768
15899
|
* Constructs a new SuggestApi.
|
|
15769
15900
|
* @alias module:purecloud-platform-client-v2/api/SuggestApi
|
|
@@ -15803,7 +15934,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
15803
15934
|
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(){/**
|
|
15804
15935
|
* TaskManagement service.
|
|
15805
15936
|
* @module purecloud-platform-client-v2/api/TaskManagementApi
|
|
15806
|
-
* @version
|
|
15937
|
+
* @version 208.0.0
|
|
15807
15938
|
*//**
|
|
15808
15939
|
* Constructs a new TaskManagementApi.
|
|
15809
15940
|
* @alias module:purecloud-platform-client-v2/api/TaskManagementApi
|
|
@@ -16209,7 +16340,7 @@ if(schemaId===undefined||schemaId===null){throw'Missing the required parameter "
|
|
|
16209
16340
|
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(){/**
|
|
16210
16341
|
* Teams service.
|
|
16211
16342
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
16212
|
-
* @version
|
|
16343
|
+
* @version 208.0.0
|
|
16213
16344
|
*//**
|
|
16214
16345
|
* Constructs a new TeamsApi.
|
|
16215
16346
|
* @alias module:purecloud-platform-client-v2/api/TeamsApi
|
|
@@ -16232,8 +16363,10 @@ if(id===undefined||id===null){throw'Missing the required parameter "id" when cal
|
|
|
16232
16363
|
* Get team
|
|
16233
16364
|
*
|
|
16234
16365
|
* @param {String} teamId Team ID
|
|
16235
|
-
|
|
16236
|
-
|
|
16366
|
+
* @param {Object} opts Optional parameters
|
|
16367
|
+
* @param {Object} opts.expand Expand the division name
|
|
16368
|
+
*/},{key:"getTeam",value:function getTeam(teamId,opts){opts=opts||{};// verify the required parameter 'teamId' is set
|
|
16369
|
+
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']);}/**
|
|
16237
16370
|
* Get team membership
|
|
16238
16371
|
*
|
|
16239
16372
|
* @param {String} teamId Team ID
|
|
@@ -16287,7 +16420,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
16287
16420
|
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(){/**
|
|
16288
16421
|
* Telephony service.
|
|
16289
16422
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
16290
|
-
* @version
|
|
16423
|
+
* @version 208.0.0
|
|
16291
16424
|
*//**
|
|
16292
16425
|
* Constructs a new TelephonyApi.
|
|
16293
16426
|
* @alias module:purecloud-platform-client-v2/api/TelephonyApi
|
|
@@ -16334,7 +16467,7 @@ if(downloadId===undefined||downloadId===null){throw'Missing the required paramet
|
|
|
16334
16467
|
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(){/**
|
|
16335
16468
|
* TelephonyProvidersEdge service.
|
|
16336
16469
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
16337
|
-
* @version
|
|
16470
|
+
* @version 208.0.0
|
|
16338
16471
|
*//**
|
|
16339
16472
|
* Constructs a new TelephonyProvidersEdgeApi.
|
|
16340
16473
|
* @alias module:purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
@@ -16826,6 +16959,13 @@ if(siteId===undefined||siteId===null){throw'Missing the required parameter "site
|
|
|
16826
16959
|
* @param {Boolean} opts.managed Filter by managed
|
|
16827
16960
|
* @param {Array.<String>} opts.expand Fields to expand in the response, comma-separated
|
|
16828
16961
|
*/},{key:"getTelephonyProvidersEdgesSites",value:function getTelephonyProvidersEdgesSites(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/telephony/providers/edges/sites','GET',{},{'pageSize':opts['pageSize'],'pageNumber':opts['pageNumber'],'sortBy':opts['sortBy'],'sortOrder':opts['sortOrder'],'name':opts['name'],'location.id':opts['locationId'],'managed':opts['managed'],'expand':this.apiClient.buildCollectionParam(opts['expand'],'multi')},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
16962
|
+
* Search sites using the q64 value returned from a previous search
|
|
16963
|
+
*
|
|
16964
|
+
* @param {String} q64 q64
|
|
16965
|
+
* @param {Object} opts Optional parameters
|
|
16966
|
+
* @param {Array.<String>} opts.expand expand
|
|
16967
|
+
*/},{key:"getTelephonyProvidersEdgesSitesSearch",value:function getTelephonyProvidersEdgesSitesSearch(q64,opts){opts=opts||{};// verify the required parameter 'q64' is set
|
|
16968
|
+
if(q64===undefined||q64===null){throw'Missing the required parameter "q64" when calling getTelephonyProvidersEdgesSitesSearch';}return this.apiClient.callApi('/api/v2/telephony/providers/edges/sites/search','GET',{},{'q64':q64,'expand':this.apiClient.buildCollectionParam(opts['expand'],'multi')},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
16829
16969
|
* Get a list of Edge-compatible time zones
|
|
16830
16970
|
*
|
|
16831
16971
|
* @param {Object} opts Optional parameters
|
|
@@ -17041,6 +17181,11 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
17041
17181
|
* @param {Object} body Site
|
|
17042
17182
|
*/},{key:"postTelephonyProvidersEdgesSites",value:function postTelephonyProvidersEdgesSites(body){// verify the required parameter 'body' is set
|
|
17043
17183
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postTelephonyProvidersEdgesSites';}return this.apiClient.callApi('/api/v2/telephony/providers/edges/sites','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
17184
|
+
* Search sites
|
|
17185
|
+
*
|
|
17186
|
+
* @param {Object} body Search request options
|
|
17187
|
+
*/},{key:"postTelephonyProvidersEdgesSitesSearch",value:function postTelephonyProvidersEdgesSitesSearch(body){// verify the required parameter 'body' is set
|
|
17188
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postTelephonyProvidersEdgesSitesSearch';}return this.apiClient.callApi('/api/v2/telephony/providers/edges/sites/search','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
17044
17189
|
* Create a Trunk Base Settings object
|
|
17045
17190
|
*
|
|
17046
17191
|
* @param {Object} body Trunk base settings
|
|
@@ -17157,7 +17302,7 @@ if(trunkBaseSettingsId===undefined||trunkBaseSettingsId===null){throw'Missing th
|
|
|
17157
17302
|
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(){/**
|
|
17158
17303
|
* Textbots service.
|
|
17159
17304
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
17160
|
-
* @version
|
|
17305
|
+
* @version 208.0.0
|
|
17161
17306
|
*//**
|
|
17162
17307
|
* Constructs a new TextbotsApi.
|
|
17163
17308
|
* @alias module:purecloud-platform-client-v2/api/TextbotsApi
|
|
@@ -17192,7 +17337,7 @@ if(launchRequest===undefined||launchRequest===null){throw'Missing the required p
|
|
|
17192
17337
|
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(){/**
|
|
17193
17338
|
* Tokens service.
|
|
17194
17339
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
17195
|
-
* @version
|
|
17340
|
+
* @version 208.0.0
|
|
17196
17341
|
*//**
|
|
17197
17342
|
* Constructs a new TokensApi.
|
|
17198
17343
|
* @alias module:purecloud-platform-client-v2/api/TokensApi
|
|
@@ -17226,7 +17371,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
17226
17371
|
*/},{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(){/**
|
|
17227
17372
|
* Uploads service.
|
|
17228
17373
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
17229
|
-
* @version
|
|
17374
|
+
* @version 208.0.0
|
|
17230
17375
|
*//**
|
|
17231
17376
|
* Constructs a new UploadsApi.
|
|
17232
17377
|
* @alias module:purecloud-platform-client-v2/api/UploadsApi
|
|
@@ -17292,7 +17437,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
17292
17437
|
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(){/**
|
|
17293
17438
|
* Usage service.
|
|
17294
17439
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
17295
|
-
* @version
|
|
17440
|
+
* @version 208.0.0
|
|
17296
17441
|
*//**
|
|
17297
17442
|
* Constructs a new UsageApi.
|
|
17298
17443
|
* @alias module:purecloud-platform-client-v2/api/UsageApi
|
|
@@ -17346,7 +17491,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
17346
17491
|
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(){/**
|
|
17347
17492
|
* UserRecordings service.
|
|
17348
17493
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
17349
|
-
* @version
|
|
17494
|
+
* @version 208.0.0
|
|
17350
17495
|
*//**
|
|
17351
17496
|
* Constructs a new UserRecordingsApi.
|
|
17352
17497
|
* @alias module:purecloud-platform-client-v2/api/UserRecordingsApi
|
|
@@ -17403,7 +17548,7 @@ if(recordingId===undefined||recordingId===null){throw'Missing the required param
|
|
|
17403
17548
|
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(){/**
|
|
17404
17549
|
* Users service.
|
|
17405
17550
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
17406
|
-
* @version
|
|
17551
|
+
* @version 208.0.0
|
|
17407
17552
|
*//**
|
|
17408
17553
|
* Constructs a new UsersApi.
|
|
17409
17554
|
* @alias module:purecloud-platform-client-v2/api/UsersApi
|
|
@@ -17443,14 +17588,14 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
17443
17588
|
* @param {String} userId User ID
|
|
17444
17589
|
*/},{key:"deleteUser",value:function deleteUser(userId){// verify the required parameter 'userId' is set
|
|
17445
17590
|
if(userId===undefined||userId===null){throw'Missing the required parameter "userId" when calling deleteUser';}return this.apiClient.callApi('/api/v2/users/{userId}','DELETE',{'userId':userId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
17446
|
-
* Remove routing language from user
|
|
17591
|
+
* Remove a routing language from a user
|
|
17447
17592
|
*
|
|
17448
17593
|
* @param {String} userId User ID
|
|
17449
17594
|
* @param {String} languageId languageId
|
|
17450
17595
|
*/},{key:"deleteUserRoutinglanguage",value:function deleteUserRoutinglanguage(userId,languageId){// verify the required parameter 'userId' is set
|
|
17451
17596
|
if(userId===undefined||userId===null){throw'Missing the required parameter "userId" when calling deleteUserRoutinglanguage';}// verify the required parameter 'languageId' is set
|
|
17452
17597
|
if(languageId===undefined||languageId===null){throw'Missing the required parameter "languageId" when calling deleteUserRoutinglanguage';}return this.apiClient.callApi('/api/v2/users/{userId}/routinglanguages/{languageId}','DELETE',{'userId':userId,'languageId':languageId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
17453
|
-
* Remove routing skill from user
|
|
17598
|
+
* Remove a routing skill from a user
|
|
17454
17599
|
*
|
|
17455
17600
|
* @param {String} userId User ID
|
|
17456
17601
|
* @param {String} skillId skillId
|
|
@@ -17654,7 +17799,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
17654
17799
|
* @param {String} subjectId User ID
|
|
17655
17800
|
*/},{key:"getUserRoles",value:function getUserRoles(subjectId){// verify the required parameter 'subjectId' is set
|
|
17656
17801
|
if(subjectId===undefined||subjectId===null){throw'Missing the required parameter "subjectId" when calling getUserRoles';}return this.apiClient.callApi('/api/v2/users/{subjectId}/roles','GET',{'subjectId':subjectId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
17657
|
-
* List routing
|
|
17802
|
+
* List routing languages assigned to a user
|
|
17658
17803
|
*
|
|
17659
17804
|
* @param {String} userId User ID
|
|
17660
17805
|
* @param {Object} opts Optional parameters
|
|
@@ -17663,7 +17808,7 @@ if(subjectId===undefined||subjectId===null){throw'Missing the required parameter
|
|
|
17663
17808
|
* @param {Object} opts.sortOrder Ascending or descending sort order (default to ASC)
|
|
17664
17809
|
*/},{key:"getUserRoutinglanguages",value:function getUserRoutinglanguages(userId,opts){opts=opts||{};// verify the required parameter 'userId' is set
|
|
17665
17810
|
if(userId===undefined||userId===null){throw'Missing the required parameter "userId" when calling getUserRoutinglanguages';}return this.apiClient.callApi('/api/v2/users/{userId}/routinglanguages','GET',{'userId':userId},{'pageSize':opts['pageSize'],'pageNumber':opts['pageNumber'],'sortOrder':opts['sortOrder']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
17666
|
-
* List routing skills
|
|
17811
|
+
* List routing skills assigned to a user
|
|
17667
17812
|
*
|
|
17668
17813
|
* @param {String} userId User ID
|
|
17669
17814
|
* @param {Object} opts Optional parameters
|
|
@@ -17728,6 +17873,13 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
17728
17873
|
* @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.
|
|
17729
17874
|
* @param {Object} opts.state Only list users of this state (default to active)
|
|
17730
17875
|
*/},{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']);}/**
|
|
17876
|
+
* Get chats for a user
|
|
17877
|
+
*
|
|
17878
|
+
* @param {Object} opts Optional parameters
|
|
17879
|
+
* @param {Boolean} opts.excludeClosed Whether or not to exclude closed chats
|
|
17880
|
+
* @param {Boolean} opts.includePresence Whether or not to include user presence
|
|
17881
|
+
* @param {String} opts.after The key to start after
|
|
17882
|
+
*/},{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']);}/**
|
|
17731
17883
|
* Get list of Development Activities
|
|
17732
17884
|
* Either moduleId or userId is required. Results are filtered based on the applicable permissions.
|
|
17733
17885
|
* @param {Object} opts Optional parameters
|
|
@@ -17821,7 +17973,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
17821
17973
|
*/},{key:"patchUserQueues",value:function patchUserQueues(userId,body,opts){opts=opts||{};// verify the required parameter 'userId' is set
|
|
17822
17974
|
if(userId===undefined||userId===null){throw'Missing the required parameter "userId" when calling patchUserQueues';}// verify the required parameter 'body' is set
|
|
17823
17975
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling patchUserQueues';}return this.apiClient.callApi('/api/v2/users/{userId}/queues','PATCH',{'userId':userId},{'divisionId':this.apiClient.buildCollectionParam(opts['divisionId'],'multi')},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
17824
|
-
* Update routing language proficiency
|
|
17976
|
+
* Update an assigned routing language's proficiency
|
|
17825
17977
|
*
|
|
17826
17978
|
* @param {String} userId User ID
|
|
17827
17979
|
* @param {String} languageId languageId
|
|
@@ -17830,14 +17982,14 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
17830
17982
|
if(userId===undefined||userId===null){throw'Missing the required parameter "userId" when calling patchUserRoutinglanguage';}// verify the required parameter 'languageId' is set
|
|
17831
17983
|
if(languageId===undefined||languageId===null){throw'Missing the required parameter "languageId" when calling patchUserRoutinglanguage';}// verify the required parameter 'body' is set
|
|
17832
17984
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling patchUserRoutinglanguage';}return this.apiClient.callApi('/api/v2/users/{userId}/routinglanguages/{languageId}','PATCH',{'userId':userId,'languageId':languageId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
17833
|
-
*
|
|
17985
|
+
* Assign multiple routing languages to a user. Max 50 routing languages in request body
|
|
17834
17986
|
*
|
|
17835
17987
|
* @param {String} userId User ID
|
|
17836
17988
|
* @param {Array.<Object>} body Language
|
|
17837
17989
|
*/},{key:"patchUserRoutinglanguagesBulk",value:function patchUserRoutinglanguagesBulk(userId,body){// verify the required parameter 'userId' is set
|
|
17838
17990
|
if(userId===undefined||userId===null){throw'Missing the required parameter "userId" when calling patchUserRoutinglanguagesBulk';}// verify the required parameter 'body' is set
|
|
17839
17991
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling patchUserRoutinglanguagesBulk';}return this.apiClient.callApi('/api/v2/users/{userId}/routinglanguages/bulk','PATCH',{'userId':userId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
17840
|
-
*
|
|
17992
|
+
* Assign multiple routing skills to a user
|
|
17841
17993
|
*
|
|
17842
17994
|
* @param {String} userId User ID
|
|
17843
17995
|
* @param {Array.<Object>} body Skill
|
|
@@ -17940,14 +18092,14 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
17940
18092
|
*/},{key:"postUserPassword",value:function postUserPassword(userId,body){// verify the required parameter 'userId' is set
|
|
17941
18093
|
if(userId===undefined||userId===null){throw'Missing the required parameter "userId" when calling postUserPassword';}// verify the required parameter 'body' is set
|
|
17942
18094
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postUserPassword';}return this.apiClient.callApi('/api/v2/users/{userId}/password','POST',{'userId':userId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
17943
|
-
*
|
|
18095
|
+
* Assign a routing language to a user
|
|
17944
18096
|
*
|
|
17945
18097
|
* @param {String} userId User ID
|
|
17946
18098
|
* @param {Object} body Language
|
|
17947
18099
|
*/},{key:"postUserRoutinglanguages",value:function postUserRoutinglanguages(userId,body){// verify the required parameter 'userId' is set
|
|
17948
18100
|
if(userId===undefined||userId===null){throw'Missing the required parameter "userId" when calling postUserRoutinglanguages';}// verify the required parameter 'body' is set
|
|
17949
18101
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postUserRoutinglanguages';}return this.apiClient.callApi('/api/v2/users/{userId}/routinglanguages','POST',{'userId':userId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
17950
|
-
*
|
|
18102
|
+
* Assign a routing skill to a user
|
|
17951
18103
|
*
|
|
17952
18104
|
* @param {String} userId User ID
|
|
17953
18105
|
* @param {Object} body Skill
|
|
@@ -18038,7 +18190,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
18038
18190
|
*/},{key:"putUserRoles",value:function putUserRoles(subjectId,body){// verify the required parameter 'subjectId' is set
|
|
18039
18191
|
if(subjectId===undefined||subjectId===null){throw'Missing the required parameter "subjectId" when calling putUserRoles';}// verify the required parameter 'body' is set
|
|
18040
18192
|
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']);}/**
|
|
18041
|
-
* Update routing skill proficiency
|
|
18193
|
+
* Update an assigned routing skill's proficiency
|
|
18042
18194
|
*
|
|
18043
18195
|
* @param {String} userId User ID
|
|
18044
18196
|
* @param {String} skillId skillId
|
|
@@ -18047,7 +18199,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
18047
18199
|
if(userId===undefined||userId===null){throw'Missing the required parameter "userId" when calling putUserRoutingskill';}// verify the required parameter 'skillId' is set
|
|
18048
18200
|
if(skillId===undefined||skillId===null){throw'Missing the required parameter "skillId" when calling putUserRoutingskill';}// verify the required parameter 'body' is set
|
|
18049
18201
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putUserRoutingskill';}return this.apiClient.callApi('/api/v2/users/{userId}/routingskills/{skillId}','PUT',{'userId':userId,'skillId':skillId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
18050
|
-
*
|
|
18202
|
+
* Assign multiple routing skills to a user, replacing any current assignments
|
|
18051
18203
|
*
|
|
18052
18204
|
* @param {String} userId User ID
|
|
18053
18205
|
* @param {Array.<Object>} body Skill
|
|
@@ -18093,7 +18245,7 @@ if(verifierId===undefined||verifierId===null){throw'Missing the required paramet
|
|
|
18093
18245
|
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(){/**
|
|
18094
18246
|
* Utilities service.
|
|
18095
18247
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
18096
|
-
* @version
|
|
18248
|
+
* @version 208.0.0
|
|
18097
18249
|
*//**
|
|
18098
18250
|
* Constructs a new UtilitiesApi.
|
|
18099
18251
|
* @alias module:purecloud-platform-client-v2/api/UtilitiesApi
|
|
@@ -18120,7 +18272,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
18120
18272
|
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(){/**
|
|
18121
18273
|
* Voicemail service.
|
|
18122
18274
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
18123
|
-
* @version
|
|
18275
|
+
* @version 208.0.0
|
|
18124
18276
|
*//**
|
|
18125
18277
|
* Constructs a new VoicemailApi.
|
|
18126
18278
|
* @alias module:purecloud-platform-client-v2/api/VoicemailApi
|
|
@@ -18207,6 +18359,19 @@ if(queueId===undefined||queueId===null){throw'Missing the required parameter "qu
|
|
|
18207
18359
|
* @param {Array.<String>} opts.expand expand
|
|
18208
18360
|
*/},{key:"getVoicemailSearch",value:function getVoicemailSearch(q64,opts){opts=opts||{};// verify the required parameter 'q64' is set
|
|
18209
18361
|
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']);}/**
|
|
18362
|
+
* Get a user's mailbox information
|
|
18363
|
+
*
|
|
18364
|
+
* @param {String} userId userId
|
|
18365
|
+
*/},{key:"getVoicemailUserMailbox",value:function getVoicemailUserMailbox(userId){// verify the required parameter 'userId' is set
|
|
18366
|
+
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']);}/**
|
|
18367
|
+
* List voicemail messages
|
|
18368
|
+
*
|
|
18369
|
+
* @param {String} userId User ID
|
|
18370
|
+
* @param {Object} opts Optional parameters
|
|
18371
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
18372
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
18373
|
+
*/},{key:"getVoicemailUserMessages",value:function getVoicemailUserMessages(userId,opts){opts=opts||{};// verify the required parameter 'userId' is set
|
|
18374
|
+
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']);}/**
|
|
18210
18375
|
* Get a user's voicemail policy
|
|
18211
18376
|
*
|
|
18212
18377
|
* @param {String} userId User ID
|
|
@@ -18269,7 +18434,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
18269
18434
|
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(){/**
|
|
18270
18435
|
* WebChat service.
|
|
18271
18436
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
18272
|
-
* @version
|
|
18437
|
+
* @version 208.0.0
|
|
18273
18438
|
*//**
|
|
18274
18439
|
* Constructs a new WebChatApi.
|
|
18275
18440
|
* @alias module:purecloud-platform-client-v2/api/WebChatApi
|
|
@@ -18404,7 +18569,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
18404
18569
|
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(){/**
|
|
18405
18570
|
* WebDeployments service.
|
|
18406
18571
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
18407
|
-
* @version
|
|
18572
|
+
* @version 208.0.0
|
|
18408
18573
|
*//**
|
|
18409
18574
|
* Constructs a new WebDeploymentsApi.
|
|
18410
18575
|
* @alias module:purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
@@ -18525,7 +18690,7 @@ if(deploymentId===undefined||deploymentId===null){throw'Missing the required par
|
|
|
18525
18690
|
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(){/**
|
|
18526
18691
|
* WebMessaging service.
|
|
18527
18692
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
18528
|
-
* @version
|
|
18693
|
+
* @version 208.0.0
|
|
18529
18694
|
*//**
|
|
18530
18695
|
* Constructs a new WebMessagingApi.
|
|
18531
18696
|
* @alias module:purecloud-platform-client-v2/api/WebMessagingApi
|
|
@@ -18541,7 +18706,7 @@ if(deployment===undefined||deployment===null){throw'Missing the required paramet
|
|
|
18541
18706
|
*/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(){/**
|
|
18542
18707
|
* Widgets service.
|
|
18543
18708
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
18544
|
-
* @version
|
|
18709
|
+
* @version 208.0.0
|
|
18545
18710
|
*//**
|
|
18546
18711
|
* Constructs a new WidgetsApi.
|
|
18547
18712
|
* @alias module:purecloud-platform-client-v2/api/WidgetsApi
|
|
@@ -18576,7 +18741,7 @@ if(deploymentId===undefined||deploymentId===null){throw'Missing the required par
|
|
|
18576
18741
|
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(){/**
|
|
18577
18742
|
* WorkforceManagement service.
|
|
18578
18743
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
18579
|
-
* @version
|
|
18744
|
+
* @version 208.0.0
|
|
18580
18745
|
*//**
|
|
18581
18746
|
* Constructs a new WorkforceManagementApi.
|
|
18582
18747
|
* @alias module:purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
@@ -20357,7 +20522,7 @@ if(timeOffLimitId===undefined||timeOffLimitId===null){throw'Missing the required
|
|
|
20357
20522
|
* </pre>
|
|
20358
20523
|
* </p>
|
|
20359
20524
|
* @module purecloud-platform-client-v2/index
|
|
20360
|
-
* @version
|
|
20525
|
+
* @version 208.0.0
|
|
20361
20526
|
*/var platformClient=/*#__PURE__*/_createClass(function platformClient(){_classCallCheck(this,platformClient);/**
|
|
20362
20527
|
* The ApiClient constructor.
|
|
20363
20528
|
* @property {module:purecloud-platform-client-v2/ApiClient}
|