purecloud-platform-client-v2 231.0.0 → 232.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 +22 -3
- package/dist/node/purecloud-platform-client-v2.js +362 -102
- package/dist/web-amd/purecloud-platform-client-v2.js +362 -102
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +169 -103
- package/dist/web-cjs/purecloud-platform-client-v2.js +291 -170
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +753 -261
- package/package.json +1 -1
- package/src/purecloud-platform-client-v2/ApiClient.js +31 -6
- package/src/purecloud-platform-client-v2/api/AIStudioApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AgentAssistantsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AgentCopilotApi.js +25 -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 +1 -1
- package/src/purecloud-platform-client-v2/api/ArchitectApi.js +1 -1
- 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/BusinessRulesApi.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 +1 -1
- package/src/purecloud-platform-client-v2/api/ConversationsApi.js +173 -4
- package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/DataPrivacyApi.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 +1 -1
- package/src/purecloud-platform-client-v2/api/FaxApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/FlowsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GamificationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GeolocationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GreetingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GroupsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/IdentityProviderApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/InfrastructureAsCodeApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +5 -2
- package/src/purecloud-platform-client-v2/api/JourneyApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LanguagesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LearningApi.js +7 -3
- 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 +1 -1
- package/src/purecloud-platform-client-v2/api/OutboundApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/PresenceApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ProcessAutomationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/QualityApi.js +2 -2
- package/src/purecloud-platform-client-v2/api/RecordingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RoutingApi.js +6 -4
- package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ScreenRecordingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ScriptsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SearchApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SettingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SocialMediaApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/StationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SuggestApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TaskManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TeamsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TelephonyApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TextbotsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TokensApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UploadsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsageApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsersApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/VoicemailApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebChatApi.js +7 -4
- 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 +31 -1
- package/src/purecloud-platform-client-v2/index.js +1 -1
package/dist/web-cjs/bundle.js
CHANGED
|
@@ -911,7 +911,7 @@ if(env)this.environment=env;else this.environment=this.host?this.host:'mypureclo
|
|
|
911
911
|
this.environment=this.environment.replace(/\/+$/,'');// Strip protocol and subdomain
|
|
912
912
|
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];}}}]);}();/**
|
|
913
913
|
* @module purecloud-platform-client-v2/ApiClient
|
|
914
|
-
* @version
|
|
914
|
+
* @version 232.0.0
|
|
915
915
|
*/var ApiClient=/*#__PURE__*/function(){/**
|
|
916
916
|
* Manages low level client-server communications, parameter marshalling, etc. There should not be any need for an
|
|
917
917
|
* application to use this class directly - the *Api and model classes provide the public API for the service. The
|
|
@@ -940,7 +940,7 @@ if(this.environment.startsWith('https://'))this.environment=this.environment.sub
|
|
|
940
940
|
*/PIPES:'|',/**
|
|
941
941
|
* Native array. Value: <code>multi</code>
|
|
942
942
|
* @const
|
|
943
|
-
*/MULTI:'multi'};/**
|
|
943
|
+
*/MULTI:'multi'};this.useLegacyParameterFilter=true;/**
|
|
944
944
|
* @description Value is `true` if local storage exists. Otherwise, false.
|
|
945
945
|
*/try{localStorage.setItem('purecloud_local_storage_test','purecloud_local_storage_test');localStorage.removeItem('purecloud_local_storage_test');this.hasLocalStorage=true;}catch(e){this.hasLocalStorage=false;}/**
|
|
946
946
|
* The authentication methods to be included for all API calls.
|
|
@@ -1168,10 +1168,13 @@ this.setAccessToken(this.authentications['PureCloud OAuth'].accessToken);}/**
|
|
|
1168
1168
|
* @param {string} path - The path for the URL
|
|
1169
1169
|
* @param {object} query - An object of key/value pairs to use for querystring keys/values
|
|
1170
1170
|
*/},{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,"?"));}/**
|
|
1171
|
+
* @description If set to `true`, the ApiClient will continue to use its legacy approach for filtering method parameters (mapped to an API Endpoint's query parameter). This is option is meant to facilitate transition from legacy to current and accurate parameters filtering.
|
|
1172
|
+
* @param {boolean} useLegacyParameterFilter - `false` to use modern/accurate approach (default value), `true` to use legacy approach (i.e. parameters of boolean type and equal to false are ignored/filtered, parameters of type integer/number and equal to 0 are ignored/filtered)
|
|
1173
|
+
*/},{key:"setUseLegacyParameterFilter",value:function setUseLegacyParameterFilter(useLegacyParameterFilter){this.useLegacyParameterFilter=useLegacyParameterFilter;}},{key:"getUseLegacyParameterFilter",value:function getUseLegacyParameterFilter(){return this.useLegacyParameterFilter;}/**
|
|
1171
1174
|
* Returns a string representation for an actual parameter.
|
|
1172
1175
|
* @param param The actual parameter.
|
|
1173
1176
|
* @returns {String} The string representation of <code>param</code>.
|
|
1174
|
-
*/},{key:"paramToString",value:function paramToString(param){if(!param){return'';}if(param instanceof Date){return param.toJSON();}if(param instanceof Boolean){return param.toString().toLowerCase();}return param.toString();}/**
|
|
1177
|
+
*/},{key:"paramToString",value:function paramToString(param){if(this.useLegacyParameterFilter!==true){if(param!==null&¶m!==undefined){if(typeof param==="boolean"){return param.toString().toLowerCase();}else if(param instanceof Boolean){return param.toString().toLowerCase();}else if(typeof param==="number"){return param.toString();}}}if(!param){return'';}if(param instanceof Date){return param.toJSON();}if(param instanceof Boolean){return param.toString().toLowerCase();}return param.toString();}/**
|
|
1175
1178
|
* Returns query parameters serialized in the format needed for an axios request.
|
|
1176
1179
|
* @param param The unserialized query parameters.
|
|
1177
1180
|
* @returns {Object} The serialized representation the query parameters.
|
|
@@ -1222,12 +1225,12 @@ if(typeof File==='function'&¶m instanceof File){return true;}return false;}/
|
|
|
1222
1225
|
* @param {module:purecloud-platform-client-v2/ApiClient.CollectionFormatEnum} collectionFormat The array element separator strategy.
|
|
1223
1226
|
* @returns {String|Array} A string representation of the supplied collection, using the specified delimiter. Returns
|
|
1224
1227
|
* <code>param</code> as is if <code>collectionFormat</code> is <code>multi</code>.
|
|
1225
|
-
*/},{key:"buildCollectionParam",value:function buildCollectionParam(param,collectionFormat){if(!param)return;if(!Array.isArray(param)){param=[param];}switch(collectionFormat){case'csv':return param.map(
|
|
1226
|
-
return param.map(
|
|
1228
|
+
*/},{key:"buildCollectionParam",value:function buildCollectionParam(param,collectionFormat){var _this13=this;if(!param)return;if(!Array.isArray(param)){param=[param];}switch(collectionFormat){case'csv':return param.map(function(x){return _this13.paramToString(x);}).join(',');case'ssv':return param.map(function(x){return _this13.paramToString(x);}).join(' ');case'tsv':return param.map(function(x){return _this13.paramToString(x);}).join('\t');case'pipes':return param.map(function(x){return _this13.paramToString(x);}).join('|');case'multi':// return the array directly as axios will handle it as expected
|
|
1229
|
+
return param.map(function(x){return _this13.paramToString(x);});default:throw new Error("Unknown collection format: ".concat(collectionFormat));}}/**
|
|
1227
1230
|
* Applies authentication headers to the request.
|
|
1228
1231
|
* @param {Object} request The axios request config object.
|
|
1229
1232
|
* @param {Array.<String>} authNames An array of authentication method names.
|
|
1230
|
-
*/},{key:"applyAuthToRequest",value:function applyAuthToRequest(request,authNames){var
|
|
1233
|
+
*/},{key:"applyAuthToRequest",value:function applyAuthToRequest(request,authNames){var _this14=this;authNames.forEach(function(authName){var auth=_this14.authentications[authName];switch(auth.type){case'basic':if(auth.username||auth.password){request.auth={username:auth.username||'',password:auth.password||''};}break;case'apiKey':if(auth.apiKey){var data={};if(auth.apiKeyPrefix){data[auth.name]="".concat(auth.apiKeyPrefix," ").concat(auth.apiKey);}else{data[auth.name]=auth.apiKey;}if(auth['in']==='header'){request.headers=_this14.addHeaders(request.headers,data);}else{request.setParams(_this14.serialize(data));}}break;case'oauth2':if(auth.accessToken){request.headers=_this14.addHeaders(request.headers,{'Authorization':"Bearer ".concat(auth.accessToken)});}break;default:throw new Error("Unknown authentication type: ".concat(auth.type));}});}/**
|
|
1231
1234
|
* @description Sets the proxy agent axios will use for requests
|
|
1232
1235
|
* @param {any} agent - The proxy agent
|
|
1233
1236
|
*/},{key:"setProxyAgent",value:function setProxyAgent(agent){this.proxyAgent=agent;var httpClient=this.getHttpClient();httpClient.setHttpsAgent(this.proxyAgent);}/**
|
|
@@ -1244,7 +1247,7 @@ return param.map(this.paramToString);default:throw new Error("Unknown collection
|
|
|
1244
1247
|
* @param {Array.<String>} accepts An array of acceptable response MIME types.types or the
|
|
1245
1248
|
* constructor for a complex type.
|
|
1246
1249
|
* @returns {Promise} A Promise object.
|
|
1247
|
-
*/},{key:"callApi",value:function callApi(path,httpMethod,pathParams,queryParams,headerParams,formParams,bodyParam,authNames,contentTypes,accepts){var
|
|
1250
|
+
*/},{key:"callApi",value:function callApi(path,httpMethod,pathParams,queryParams,headerParams,formParams,bodyParam,authNames,contentTypes,accepts){var _this15=this;return new Promise(function(resolve,reject){sendRequest(_this15);function sendRequest(that){var url=that.buildUrl(path,pathParams);var request=new HttpRequestOptions(url,httpMethod,null,that.serialize(queryParams),null,that.timeout);// apply authentications
|
|
1248
1251
|
that.applyAuthToRequest(request,authNames);// set header parameters
|
|
1249
1252
|
var defaultHeaders=that.defaultHeaders;var normalizedHeaderParams=that.normalizeParams(headerParams);request.headers=that.addHeaders(request.headers,defaultHeaders,normalizedHeaderParams);var contentType=that.jsonPreferredMime(contentTypes);if(contentType){request.headers['Content-Type']=contentType;}else if(!request.headers['Content-Type']){request.headers['Content-Type']='application/json';}if(contentType==='application/x-www-form-urlencoded'){request.setData(that.normalizeParams(formParams));}else if(contentType=='multipart/form-data'){var _formParams=that.normalizeParams(formParams);for(var key in _formParams){if(_formParams.hasOwnProperty(key)){// Looks like axios handles files and forms the same way
|
|
1250
1253
|
var formData=new FormData();formData.set(key,_formParams[key]);request.setData(formData);}}}else if(bodyParam){request.setData(bodyParam);}var accept=that.jsonPreferredMime(accepts);if(accept){request.headers['Accept']=accept;}var httpClient=that.getHttpClient();httpClient.request(request).then(function(response){// Build response object
|
|
@@ -1254,7 +1257,7 @@ resolve(data);})["catch"](function(error){var data=error;if(error.response&&erro
|
|
|
1254
1257
|
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 AIStudioApi=/*#__PURE__*/function(){/**
|
|
1255
1258
|
* AIStudio service.
|
|
1256
1259
|
* @module purecloud-platform-client-v2/api/AIStudioApi
|
|
1257
|
-
* @version
|
|
1260
|
+
* @version 232.0.0
|
|
1258
1261
|
*//**
|
|
1259
1262
|
* Constructs a new AIStudioApi.
|
|
1260
1263
|
* @alias module:purecloud-platform-client-v2/api/AIStudioApi
|
|
@@ -1405,7 +1408,7 @@ if(summarySettingId===undefined||summarySettingId===null||summarySettingId==='')
|
|
|
1405
1408
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putConversationsSummariesSetting';}return this.apiClient.callApi('/api/v2/conversations/summaries/settings/{summarySettingId}','PUT',{'summarySettingId':summarySettingId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var AgentAssistantsApi=/*#__PURE__*/function(){/**
|
|
1406
1409
|
* AgentAssistants service.
|
|
1407
1410
|
* @module purecloud-platform-client-v2/api/AgentAssistantsApi
|
|
1408
|
-
* @version
|
|
1411
|
+
* @version 232.0.0
|
|
1409
1412
|
*//**
|
|
1410
1413
|
* Constructs a new AgentAssistantsApi.
|
|
1411
1414
|
* @alias module:purecloud-platform-client-v2/api/AgentAssistantsApi
|
|
@@ -1536,7 +1539,7 @@ if(queueId===undefined||queueId===null||queueId===''){throw'Missing the required
|
|
|
1536
1539
|
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(){/**
|
|
1537
1540
|
* AgentCopilot service.
|
|
1538
1541
|
* @module purecloud-platform-client-v2/api/AgentCopilotApi
|
|
1539
|
-
* @version
|
|
1542
|
+
* @version 232.0.0
|
|
1540
1543
|
*//**
|
|
1541
1544
|
* Constructs a new AgentCopilotApi.
|
|
1542
1545
|
* @alias module:purecloud-platform-client-v2/api/AgentCopilotApi
|
|
@@ -1549,6 +1552,11 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
1549
1552
|
* @param {String} assistantId Assistant ID
|
|
1550
1553
|
*/return _createClass(AgentCopilotApi,[{key:"getAssistantCopilot",value:function getAssistantCopilot(assistantId){// verify the required parameter 'assistantId' is set
|
|
1551
1554
|
if(assistantId===undefined||assistantId===null||assistantId===''){throw'Missing the required parameter "assistantId" when calling getAssistantCopilot';}return this.apiClient.callApi('/api/v2/assistants/{assistantId}/copilot','GET',{'assistantId':assistantId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
1555
|
+
* Get information about the support of features for all the languages or only for a certain language.
|
|
1556
|
+
*
|
|
1557
|
+
* @param {Object} opts Optional parameters
|
|
1558
|
+
* @param {String} opts.language Which language are the features supported for
|
|
1559
|
+
*/},{key:"getAssistantsCopilotFeaturesupport",value:function getAssistantsCopilotFeaturesupport(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/assistants/copilot/featuresupport','GET',{},{'language':opts['language']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
1552
1560
|
* Update agent copilot configuration
|
|
1553
1561
|
*
|
|
1554
1562
|
* @param {String} assistantId Assistant ID
|
|
@@ -1558,7 +1566,7 @@ if(assistantId===undefined||assistantId===null||assistantId===''){throw'Missing
|
|
|
1558
1566
|
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(){/**
|
|
1559
1567
|
* AgentUI service.
|
|
1560
1568
|
* @module purecloud-platform-client-v2/api/AgentUIApi
|
|
1561
|
-
* @version
|
|
1569
|
+
* @version 232.0.0
|
|
1562
1570
|
*//**
|
|
1563
1571
|
* Constructs a new AgentUIApi.
|
|
1564
1572
|
* @alias module:purecloud-platform-client-v2/api/AgentUIApi
|
|
@@ -1592,7 +1600,7 @@ if(agentId===undefined||agentId===null||agentId===''){throw'Missing the required
|
|
|
1592
1600
|
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(){/**
|
|
1593
1601
|
* Alerting service.
|
|
1594
1602
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
1595
|
-
* @version
|
|
1603
|
+
* @version 232.0.0
|
|
1596
1604
|
*//**
|
|
1597
1605
|
* Constructs a new AlertingApi.
|
|
1598
1606
|
* @alias module:purecloud-platform-client-v2/api/AlertingApi
|
|
@@ -1681,7 +1689,7 @@ if(ruleId===undefined||ruleId===null||ruleId===''){throw'Missing the required pa
|
|
|
1681
1689
|
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(){/**
|
|
1682
1690
|
* Analytics service.
|
|
1683
1691
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
1684
|
-
* @version
|
|
1692
|
+
* @version 232.0.0
|
|
1685
1693
|
*//**
|
|
1686
1694
|
* Constructs a new AnalyticsApi.
|
|
1687
1695
|
* @alias module:purecloud-platform-client-v2/api/AnalyticsApi
|
|
@@ -2457,7 +2465,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
2457
2465
|
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(){/**
|
|
2458
2466
|
* Architect service.
|
|
2459
2467
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
2460
|
-
* @version
|
|
2468
|
+
* @version 232.0.0
|
|
2461
2469
|
*//**
|
|
2462
2470
|
* Constructs a new ArchitectApi.
|
|
2463
2471
|
* @alias module:purecloud-platform-client-v2/api/ArchitectApi
|
|
@@ -3591,7 +3599,7 @@ if(milestoneId===undefined||milestoneId===null||milestoneId===''){throw'Missing
|
|
|
3591
3599
|
if(flowOutcomeId===undefined||flowOutcomeId===null||flowOutcomeId===''){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(){/**
|
|
3592
3600
|
* Audit service.
|
|
3593
3601
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
3594
|
-
* @version
|
|
3602
|
+
* @version 232.0.0
|
|
3595
3603
|
*//**
|
|
3596
3604
|
* Constructs a new AuditApi.
|
|
3597
3605
|
* @alias module:purecloud-platform-client-v2/api/AuditApi
|
|
@@ -3641,7 +3649,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
3641
3649
|
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(){/**
|
|
3642
3650
|
* Authorization service.
|
|
3643
3651
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
3644
|
-
* @version
|
|
3652
|
+
* @version 232.0.0
|
|
3645
3653
|
*//**
|
|
3646
3654
|
* Constructs a new AuthorizationApi.
|
|
3647
3655
|
* @alias module:purecloud-platform-client-v2/api/AuthorizationApi
|
|
@@ -4076,7 +4084,7 @@ if(subjectId===undefined||subjectId===null||subjectId===''){throw'Missing the re
|
|
|
4076
4084
|
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(){/**
|
|
4077
4085
|
* Billing service.
|
|
4078
4086
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
4079
|
-
* @version
|
|
4087
|
+
* @version 232.0.0
|
|
4080
4088
|
*//**
|
|
4081
4089
|
* Constructs a new BillingApi.
|
|
4082
4090
|
* @alias module:purecloud-platform-client-v2/api/BillingApi
|
|
@@ -4153,7 +4161,7 @@ if(endDate===undefined||endDate===null){throw'Missing the required parameter "en
|
|
|
4153
4161
|
if(trustorOrgId===undefined||trustorOrgId===null||trustorOrgId===''){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 BusinessRulesApi=/*#__PURE__*/function(){/**
|
|
4154
4162
|
* BusinessRules service.
|
|
4155
4163
|
* @module purecloud-platform-client-v2/api/BusinessRulesApi
|
|
4156
|
-
* @version
|
|
4164
|
+
* @version 232.0.0
|
|
4157
4165
|
*//**
|
|
4158
4166
|
* Constructs a new BusinessRulesApi.
|
|
4159
4167
|
* @alias module:purecloud-platform-client-v2/api/BusinessRulesApi
|
|
@@ -4403,7 +4411,7 @@ if(schemaId===undefined||schemaId===null||schemaId===''){throw'Missing the requi
|
|
|
4403
4411
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putBusinessrulesSchema';}return this.apiClient.callApi('/api/v2/businessrules/schemas/{schemaId}','PUT',{'schemaId':schemaId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var CarrierServicesApi=/*#__PURE__*/function(){/**
|
|
4404
4412
|
* CarrierServices service.
|
|
4405
4413
|
* @module purecloud-platform-client-v2/api/CarrierServicesApi
|
|
4406
|
-
* @version
|
|
4414
|
+
* @version 232.0.0
|
|
4407
4415
|
*//**
|
|
4408
4416
|
* Constructs a new CarrierServicesApi.
|
|
4409
4417
|
* @alias module:purecloud-platform-client-v2/api/CarrierServicesApi
|
|
@@ -4423,7 +4431,7 @@ if(phoneNumber===undefined||phoneNumber===null){throw'Missing the required param
|
|
|
4423
4431
|
*/},{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(){/**
|
|
4424
4432
|
* Chat service.
|
|
4425
4433
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
4426
|
-
* @version
|
|
4434
|
+
* @version 232.0.0
|
|
4427
4435
|
*//**
|
|
4428
4436
|
* Constructs a new ChatApi.
|
|
4429
4437
|
* @alias module:purecloud-platform-client-v2/api/ChatApi
|
|
@@ -4654,7 +4662,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
4654
4662
|
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(){/**
|
|
4655
4663
|
* Coaching service.
|
|
4656
4664
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
4657
|
-
* @version
|
|
4665
|
+
* @version 232.0.0
|
|
4658
4666
|
*//**
|
|
4659
4667
|
* Constructs a new CoachingApi.
|
|
4660
4668
|
* @alias module:purecloud-platform-client-v2/api/CoachingApi
|
|
@@ -4807,7 +4815,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
4807
4815
|
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(){/**
|
|
4808
4816
|
* ContentManagement service.
|
|
4809
4817
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
4810
|
-
* @version
|
|
4818
|
+
* @version 232.0.0
|
|
4811
4819
|
*//**
|
|
4812
4820
|
* Constructs a new ContentManagementApi.
|
|
4813
4821
|
* @alias module:purecloud-platform-client-v2/api/ContentManagementApi
|
|
@@ -5089,7 +5097,7 @@ if(tagId===undefined||tagId===null||tagId===''){throw'Missing the required param
|
|
|
5089
5097
|
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(){/**
|
|
5090
5098
|
* Conversations service.
|
|
5091
5099
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
5092
|
-
* @version
|
|
5100
|
+
* @version 232.0.0
|
|
5093
5101
|
*//**
|
|
5094
5102
|
* Constructs a new ConversationsApi.
|
|
5095
5103
|
* @alias module:purecloud-platform-client-v2/api/ConversationsApi
|
|
@@ -5148,6 +5156,11 @@ if(attachmentId===undefined||attachmentId===null||attachmentId===''){throw'Missi
|
|
|
5148
5156
|
* @param {String} cachedMediaItemId cachedMediaItemId
|
|
5149
5157
|
*/},{key:"deleteConversationsMessagesCachedmediaCachedMediaItemId",value:function deleteConversationsMessagesCachedmediaCachedMediaItemId(cachedMediaItemId){// verify the required parameter 'cachedMediaItemId' is set
|
|
5150
5158
|
if(cachedMediaItemId===undefined||cachedMediaItemId===null||cachedMediaItemId===''){throw'Missing the required parameter "cachedMediaItemId" when calling deleteConversationsMessagesCachedmediaCachedMediaItemId';}return this.apiClient.callApi('/api/v2/conversations/messages/cachedmedia/{cachedMediaItemId}','DELETE',{'cachedMediaItemId':cachedMediaItemId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
5159
|
+
* Delete an Apple messaging integration
|
|
5160
|
+
*
|
|
5161
|
+
* @param {String} integrationId Integration ID
|
|
5162
|
+
*/},{key:"deleteConversationsMessagingIntegrationsAppleIntegrationId",value:function deleteConversationsMessagingIntegrationsAppleIntegrationId(integrationId){// verify the required parameter 'integrationId' is set
|
|
5163
|
+
if(integrationId===undefined||integrationId===null||integrationId===''){throw'Missing the required parameter "integrationId" when calling deleteConversationsMessagingIntegrationsAppleIntegrationId';}return this.apiClient.callApi('/api/v2/conversations/messaging/integrations/apple/{integrationId}','DELETE',{'integrationId':integrationId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
5151
5164
|
* Delete a Facebook messaging integration
|
|
5152
5165
|
*
|
|
5153
5166
|
* @param {String} integrationId Integration ID
|
|
@@ -5651,7 +5664,6 @@ if(cachedMediaItemId===undefined||cachedMediaItemId===null||cachedMediaItemId===
|
|
|
5651
5664
|
* Get Apple messaging integration identity resolution settings
|
|
5652
5665
|
*
|
|
5653
5666
|
* @param {String} integrationId Integration ID
|
|
5654
|
-
* getConversationsMessagingIdentityresolutionIntegrationsAppleIntegrationId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
5655
5667
|
*/},{key:"getConversationsMessagingIdentityresolutionIntegrationsAppleIntegrationId",value:function getConversationsMessagingIdentityresolutionIntegrationsAppleIntegrationId(integrationId){// verify the required parameter 'integrationId' is set
|
|
5656
5668
|
if(integrationId===undefined||integrationId===null||integrationId===''){throw'Missing the required parameter "integrationId" when calling getConversationsMessagingIdentityresolutionIntegrationsAppleIntegrationId';}return this.apiClient.callApi('/api/v2/conversations/messaging/identityresolution/integrations/apple/{integrationId}','GET',{'integrationId':integrationId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
5657
5669
|
* Get Facebook messaging integration identity resolution settings
|
|
@@ -5693,6 +5705,22 @@ if(integrationId===undefined||integrationId===null||integrationId===''){throw'Mi
|
|
|
5693
5705
|
* @param {String} opts.supportedContentId Filter integrations returned based on the supported content ID
|
|
5694
5706
|
* @param {String} opts.messagingSettingId Filter integrations returned based on the setting ID
|
|
5695
5707
|
*/},{key:"getConversationsMessagingIntegrations",value:function getConversationsMessagingIntegrations(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/conversations/messaging/integrations','GET',{},{'pageSize':opts['pageSize'],'pageNumber':opts['pageNumber'],'expand':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'supportedContent.id':opts['supportedContentId'],'messagingSetting.id':opts['messagingSettingId']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
5708
|
+
* Get a list of Apple Integrations
|
|
5709
|
+
*
|
|
5710
|
+
* @param {Object} opts Optional parameters
|
|
5711
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
5712
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
5713
|
+
* @param {Object} opts.expand Expand instructions for the return value.
|
|
5714
|
+
* @param {String} opts.supportedContentId Filter integrations returned based on the supported content ID
|
|
5715
|
+
* @param {String} opts.messagingSettingId Filter integrations returned based on the setting ID
|
|
5716
|
+
*/},{key:"getConversationsMessagingIntegrationsApple",value:function getConversationsMessagingIntegrationsApple(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/conversations/messaging/integrations/apple','GET',{},{'pageSize':opts['pageSize'],'pageNumber':opts['pageNumber'],'expand':opts['expand'],'supportedContent.id':opts['supportedContentId'],'messagingSetting.id':opts['messagingSettingId']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
5717
|
+
* Get an Apple messaging integration
|
|
5718
|
+
*
|
|
5719
|
+
* @param {String} integrationId Integration ID
|
|
5720
|
+
* @param {Object} opts Optional parameters
|
|
5721
|
+
* @param {Object} opts.expand Expand instructions for the return value.
|
|
5722
|
+
*/},{key:"getConversationsMessagingIntegrationsAppleIntegrationId",value:function getConversationsMessagingIntegrationsAppleIntegrationId(integrationId,opts){opts=opts||{};// verify the required parameter 'integrationId' is set
|
|
5723
|
+
if(integrationId===undefined||integrationId===null||integrationId===''){throw'Missing the required parameter "integrationId" when calling getConversationsMessagingIntegrationsAppleIntegrationId';}return this.apiClient.callApi('/api/v2/conversations/messaging/integrations/apple/{integrationId}','GET',{'integrationId':integrationId},{'expand':opts['expand']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
5696
5724
|
* Get a list of Facebook Integrations
|
|
5697
5725
|
*
|
|
5698
5726
|
* @param {Object} opts Optional parameters
|
|
@@ -5776,6 +5804,15 @@ if(integrationId===undefined||integrationId===null||integrationId===''){throw'Mi
|
|
|
5776
5804
|
* @param {Object} opts.expand Expand instructions for the return value.
|
|
5777
5805
|
*/},{key:"getConversationsMessagingIntegrationsWhatsappIntegrationId",value:function getConversationsMessagingIntegrationsWhatsappIntegrationId(integrationId,opts){opts=opts||{};// verify the required parameter 'integrationId' is set
|
|
5778
5806
|
if(integrationId===undefined||integrationId===null||integrationId===''){throw'Missing the required parameter "integrationId" when calling getConversationsMessagingIntegrationsWhatsappIntegrationId';}return this.apiClient.callApi('/api/v2/conversations/messaging/integrations/whatsapp/{integrationId}','GET',{'integrationId':integrationId},{'expand':opts['expand']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
5807
|
+
* Call Authentication provider callback to validate state and code
|
|
5808
|
+
*
|
|
5809
|
+
* @param {String} code The authorization code to be sent to the authentication server during the token request.
|
|
5810
|
+
* @param {String} state The state/nonce value generated by Genesys Auth-Client Service.
|
|
5811
|
+
* @param {Object} opts Optional parameters
|
|
5812
|
+
* @param {String} opts.error Error parameter from OAuth provider
|
|
5813
|
+
*/},{key:"getConversationsMessagingOauthAppleCallback",value:function getConversationsMessagingOauthAppleCallback(code,state,opts){opts=opts||{};// verify the required parameter 'code' is set
|
|
5814
|
+
if(code===undefined||code===null){throw'Missing the required parameter "code" when calling getConversationsMessagingOauthAppleCallback';}// verify the required parameter 'state' is set
|
|
5815
|
+
if(state===undefined||state===null){throw'Missing the required parameter "state" when calling getConversationsMessagingOauthAppleCallback';}return this.apiClient.callApi('/api/v2/conversations/messaging/oauth/apple/callback','GET',{},{'code':code,'state':state,'error':opts['error']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
5779
5816
|
* Get a messaging setting
|
|
5780
5817
|
*
|
|
5781
5818
|
* @param {String} messageSettingId Message Setting ID
|
|
@@ -6187,6 +6224,13 @@ if(conversationId===undefined||conversationId===null||conversationId===''){throw
|
|
|
6187
6224
|
if(participantId===undefined||participantId===null||participantId===''){throw'Missing the required parameter "participantId" when calling patchConversationsMessageParticipantCommunication';}// verify the required parameter 'communicationId' is set
|
|
6188
6225
|
if(communicationId===undefined||communicationId===null||communicationId===''){throw'Missing the required parameter "communicationId" when calling patchConversationsMessageParticipantCommunication';}// verify the required parameter 'body' is set
|
|
6189
6226
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling patchConversationsMessageParticipantCommunication';}return this.apiClient.callApi('/api/v2/conversations/messages/{conversationId}/participants/{participantId}/communications/{communicationId}','PATCH',{'conversationId':conversationId,'participantId':participantId,'communicationId':communicationId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
6227
|
+
* Update an Apple messaging integration
|
|
6228
|
+
*
|
|
6229
|
+
* @param {String} integrationId Integration ID
|
|
6230
|
+
* @param {Object} body AppleIntegrationUpdateRequest
|
|
6231
|
+
*/},{key:"patchConversationsMessagingIntegrationsAppleIntegrationId",value:function patchConversationsMessagingIntegrationsAppleIntegrationId(integrationId,body){// verify the required parameter 'integrationId' is set
|
|
6232
|
+
if(integrationId===undefined||integrationId===null||integrationId===''){throw'Missing the required parameter "integrationId" when calling patchConversationsMessagingIntegrationsAppleIntegrationId';}// verify the required parameter 'body' is set
|
|
6233
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling patchConversationsMessagingIntegrationsAppleIntegrationId';}return this.apiClient.callApi('/api/v2/conversations/messaging/integrations/apple/{integrationId}','PATCH',{'integrationId':integrationId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
6190
6234
|
* Update Facebook messaging integration
|
|
6191
6235
|
*
|
|
6192
6236
|
* @param {String} integrationId Integration ID
|
|
@@ -6546,7 +6590,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
6546
6590
|
*/},{key:"postConversationsCallParticipants",value:function postConversationsCallParticipants(conversationId,body){// verify the required parameter 'conversationId' is set
|
|
6547
6591
|
if(conversationId===undefined||conversationId===null||conversationId===''){throw'Missing the required parameter "conversationId" when calling postConversationsCallParticipants';}// verify the required parameter 'body' is set
|
|
6548
6592
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postConversationsCallParticipants';}return this.apiClient.callApi('/api/v2/conversations/calls/{conversationId}/participants','POST',{'conversationId':conversationId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
6549
|
-
* Add participants to a conversation
|
|
6593
|
+
* Add participants to a conversation on behalf of a user
|
|
6550
6594
|
*
|
|
6551
6595
|
* @param {String} conversationId conversationId
|
|
6552
6596
|
* @param {String} userId userId
|
|
@@ -6870,6 +6914,11 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
6870
6914
|
* @deprecated
|
|
6871
6915
|
*/},{key:"postConversationsMessagesInboundOpen",value:function postConversationsMessagesInboundOpen(body){// verify the required parameter 'body' is set
|
|
6872
6916
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postConversationsMessagesInboundOpen';}return this.apiClient.callApi('/api/v2/conversations/messages/inbound/open','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
6917
|
+
* Create Apple Integration
|
|
6918
|
+
*
|
|
6919
|
+
* @param {Object} body AppleIntegrationRequest
|
|
6920
|
+
*/},{key:"postConversationsMessagingIntegrationsApple",value:function postConversationsMessagingIntegrationsApple(body){// verify the required parameter 'body' is set
|
|
6921
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postConversationsMessagingIntegrationsApple';}return this.apiClient.callApi('/api/v2/conversations/messaging/integrations/apple','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
6873
6922
|
* Create a Facebook Integration
|
|
6874
6923
|
*
|
|
6875
6924
|
* @param {Object} body FacebookIntegrationRequest
|
|
@@ -7058,7 +7107,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
7058
7107
|
*
|
|
7059
7108
|
* @param {String} integrationId Integration ID
|
|
7060
7109
|
* @param {Object} body IdentityResolutionConfig
|
|
7061
|
-
* putConversationsMessagingIdentityresolutionIntegrationsAppleIntegrationId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
7062
7110
|
*/},{key:"putConversationsMessagingIdentityresolutionIntegrationsAppleIntegrationId",value:function putConversationsMessagingIdentityresolutionIntegrationsAppleIntegrationId(integrationId,body){// verify the required parameter 'integrationId' is set
|
|
7063
7111
|
if(integrationId===undefined||integrationId===null||integrationId===''){throw'Missing the required parameter "integrationId" when calling putConversationsMessagingIdentityresolutionIntegrationsAppleIntegrationId';}// verify the required parameter 'body' is set
|
|
7064
7112
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putConversationsMessagingIdentityresolutionIntegrationsAppleIntegrationId';}return this.apiClient.callApi('/api/v2/conversations/messaging/identityresolution/integrations/apple/{integrationId}','PUT',{'integrationId':integrationId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
@@ -7136,7 +7184,7 @@ if(conversationId===undefined||conversationId===null||conversationId===''){throw
|
|
|
7136
7184
|
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(){/**
|
|
7137
7185
|
* DataExtensions service.
|
|
7138
7186
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
7139
|
-
* @version
|
|
7187
|
+
* @version 232.0.0
|
|
7140
7188
|
*//**
|
|
7141
7189
|
* Constructs a new DataExtensionsApi.
|
|
7142
7190
|
* @alias module:purecloud-platform-client-v2/api/DataExtensionsApi
|
|
@@ -7157,7 +7205,7 @@ if(coretypeName===undefined||coretypeName===null||coretypeName===''){throw'Missi
|
|
|
7157
7205
|
*/},{key:"getDataextensionsLimits",value:function getDataextensionsLimits(){return this.apiClient.callApi('/api/v2/dataextensions/limits','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var DataPrivacyApi=/*#__PURE__*/function(){/**
|
|
7158
7206
|
* DataPrivacy service.
|
|
7159
7207
|
* @module purecloud-platform-client-v2/api/DataPrivacyApi
|
|
7160
|
-
* @version
|
|
7208
|
+
* @version 232.0.0
|
|
7161
7209
|
*//**
|
|
7162
7210
|
* Constructs a new DataPrivacyApi.
|
|
7163
7211
|
* @alias module:purecloud-platform-client-v2/api/DataPrivacyApi
|
|
@@ -7197,7 +7245,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
7197
7245
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postDataprivacyMaskingrulesValidate';}return this.apiClient.callApi('/api/v2/dataprivacy/maskingrules/validate','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var DownloadsApi=/*#__PURE__*/function(){/**
|
|
7198
7246
|
* Downloads service.
|
|
7199
7247
|
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
7200
|
-
* @version
|
|
7248
|
+
* @version 232.0.0
|
|
7201
7249
|
*//**
|
|
7202
7250
|
* Constructs a new DownloadsApi.
|
|
7203
7251
|
* @alias module:purecloud-platform-client-v2/api/DownloadsApi
|
|
@@ -7216,7 +7264,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
7216
7264
|
if(downloadId===undefined||downloadId===null||downloadId===''){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(){/**
|
|
7217
7265
|
* Emails service.
|
|
7218
7266
|
* @module purecloud-platform-client-v2/api/EmailsApi
|
|
7219
|
-
* @version
|
|
7267
|
+
* @version 232.0.0
|
|
7220
7268
|
*//**
|
|
7221
7269
|
* Constructs a new EmailsApi.
|
|
7222
7270
|
* @alias module:purecloud-platform-client-v2/api/EmailsApi
|
|
@@ -7245,7 +7293,7 @@ if(downloadId===undefined||downloadId===null||downloadId===''){throw'Missing the
|
|
|
7245
7293
|
*/},{key:"patchEmailsSettingsThreading",value:function patchEmailsSettingsThreading(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/emails/settings/threading','PATCH',{},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var EmployeeEngagementApi=/*#__PURE__*/function(){/**
|
|
7246
7294
|
* EmployeeEngagement service.
|
|
7247
7295
|
* @module purecloud-platform-client-v2/api/EmployeeEngagementApi
|
|
7248
|
-
* @version
|
|
7296
|
+
* @version 232.0.0
|
|
7249
7297
|
*//**
|
|
7250
7298
|
* Constructs a new EmployeeEngagementApi.
|
|
7251
7299
|
* @alias module:purecloud-platform-client-v2/api/EmployeeEngagementApi
|
|
@@ -7283,7 +7331,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
7283
7331
|
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(){/**
|
|
7284
7332
|
* Events service.
|
|
7285
7333
|
* @module purecloud-platform-client-v2/api/EventsApi
|
|
7286
|
-
* @version
|
|
7334
|
+
* @version 232.0.0
|
|
7287
7335
|
*//**
|
|
7288
7336
|
* Constructs a new EventsApi.
|
|
7289
7337
|
* @alias module:purecloud-platform-client-v2/api/EventsApi
|
|
@@ -7308,7 +7356,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
7308
7356
|
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(){/**
|
|
7309
7357
|
* ExternalContacts service.
|
|
7310
7358
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
7311
|
-
* @version
|
|
7359
|
+
* @version 232.0.0
|
|
7312
7360
|
*//**
|
|
7313
7361
|
* Constructs a new ExternalContactsApi.
|
|
7314
7362
|
* @alias module:purecloud-platform-client-v2/api/ExternalContactsApi
|
|
@@ -8058,7 +8106,7 @@ if(relationshipId===undefined||relationshipId===null||relationshipId===''){throw
|
|
|
8058
8106
|
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(){/**
|
|
8059
8107
|
* Fax service.
|
|
8060
8108
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
8061
|
-
* @version
|
|
8109
|
+
* @version 232.0.0
|
|
8062
8110
|
*//**
|
|
8063
8111
|
* Constructs a new FaxApi.
|
|
8064
8112
|
* @alias module:purecloud-platform-client-v2/api/FaxApi
|
|
@@ -8107,7 +8155,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
8107
8155
|
*/},{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(){/**
|
|
8108
8156
|
* Flows service.
|
|
8109
8157
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
8110
|
-
* @version
|
|
8158
|
+
* @version 232.0.0
|
|
8111
8159
|
*//**
|
|
8112
8160
|
* Constructs a new FlowsApi.
|
|
8113
8161
|
* @alias module:purecloud-platform-client-v2/api/FlowsApi
|
|
@@ -8161,7 +8209,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
8161
8209
|
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(){/**
|
|
8162
8210
|
* Gamification service.
|
|
8163
8211
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
8164
|
-
* @version
|
|
8212
|
+
* @version 232.0.0
|
|
8165
8213
|
*//**
|
|
8166
8214
|
* Constructs a new GamificationApi.
|
|
8167
8215
|
* @alias module:purecloud-platform-client-v2/api/GamificationApi
|
|
@@ -8814,7 +8862,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
8814
8862
|
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(){/**
|
|
8815
8863
|
* GeneralDataProtectionRegulation service.
|
|
8816
8864
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
8817
|
-
* @version
|
|
8865
|
+
* @version 232.0.0
|
|
8818
8866
|
*//**
|
|
8819
8867
|
* Constructs a new GeneralDataProtectionRegulationApi.
|
|
8820
8868
|
* @alias module:purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
@@ -8849,7 +8897,7 @@ if(searchValue===undefined||searchValue===null){throw'Missing the required param
|
|
|
8849
8897
|
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(){/**
|
|
8850
8898
|
* Geolocation service.
|
|
8851
8899
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
8852
|
-
* @version
|
|
8900
|
+
* @version 232.0.0
|
|
8853
8901
|
*//**
|
|
8854
8902
|
* Constructs a new GeolocationApi.
|
|
8855
8903
|
* @alias module:purecloud-platform-client-v2/api/GeolocationApi
|
|
@@ -8883,7 +8931,7 @@ if(clientId===undefined||clientId===null||clientId===''){throw'Missing the requi
|
|
|
8883
8931
|
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(){/**
|
|
8884
8932
|
* Greetings service.
|
|
8885
8933
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
8886
|
-
* @version
|
|
8934
|
+
* @version 232.0.0
|
|
8887
8935
|
*//**
|
|
8888
8936
|
* Constructs a new GreetingsApi.
|
|
8889
8937
|
* @alias module:purecloud-platform-client-v2/api/GreetingsApi
|
|
@@ -9011,7 +9059,7 @@ if(userId===undefined||userId===null||userId===''){throw'Missing the required pa
|
|
|
9011
9059
|
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(){/**
|
|
9012
9060
|
* Groups service.
|
|
9013
9061
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
9014
|
-
* @version
|
|
9062
|
+
* @version 232.0.0
|
|
9015
9063
|
*//**
|
|
9016
9064
|
* Constructs a new GroupsApi.
|
|
9017
9065
|
* @alias module:purecloud-platform-client-v2/api/GroupsApi
|
|
@@ -9144,7 +9192,7 @@ if(groupId===undefined||groupId===null||groupId===''){throw'Missing the required
|
|
|
9144
9192
|
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(){/**
|
|
9145
9193
|
* IdentityProvider service.
|
|
9146
9194
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
9147
|
-
* @version
|
|
9195
|
+
* @version 232.0.0
|
|
9148
9196
|
*//**
|
|
9149
9197
|
* Constructs a new IdentityProviderApi.
|
|
9150
9198
|
* @alias module:purecloud-platform-client-v2/api/IdentityProviderApi
|
|
@@ -9300,7 +9348,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
9300
9348
|
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(){/**
|
|
9301
9349
|
* InfrastructureAsCode service.
|
|
9302
9350
|
* @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
9303
|
-
* @version
|
|
9351
|
+
* @version 232.0.0
|
|
9304
9352
|
*//**
|
|
9305
9353
|
* Constructs a new InfrastructureAsCodeApi.
|
|
9306
9354
|
* @alias module:purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
@@ -9354,7 +9402,7 @@ if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required param
|
|
|
9354
9402
|
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(){/**
|
|
9355
9403
|
* Integrations service.
|
|
9356
9404
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
9357
|
-
* @version
|
|
9405
|
+
* @version 232.0.0
|
|
9358
9406
|
*//**
|
|
9359
9407
|
* Constructs a new IntegrationsApi.
|
|
9360
9408
|
* @alias module:purecloud-platform-client-v2/api/IntegrationsApi
|
|
@@ -9408,7 +9456,10 @@ if(integrationId===undefined||integrationId===null||integrationId===''){throw'Mi
|
|
|
9408
9456
|
* @param {Array.<String>} opts.expand variable name requested by expand list
|
|
9409
9457
|
* @param {String} opts.nextPage next page token
|
|
9410
9458
|
* @param {String} opts.previousPage Previous page token
|
|
9411
|
-
|
|
9459
|
+
* @param {Array.<String>} opts.ids Comma-separated list of integration IDs to filter by (max 100)
|
|
9460
|
+
* @param {String} opts.integrationType Filter integrations by integration type ID
|
|
9461
|
+
* @param {Object} opts.reportedState Filter integrations by reported state (case-insensitive)
|
|
9462
|
+
*/},{key:"getIntegrations",value:function getIntegrations(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/integrations','GET',{},{'pageSize':opts['pageSize'],'pageNumber':opts['pageNumber'],'sortBy':opts['sortBy'],'expand':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'nextPage':opts['nextPage'],'previousPage':opts['previousPage'],'ids':this.apiClient.buildCollectionParam(opts['ids'],'multi'),'integrationType':opts['integrationType'],'reportedState':opts['reportedState']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
9412
9463
|
* Retrieves a single Action matching id.
|
|
9413
9464
|
*
|
|
9414
9465
|
* @param {String} actionId actionId
|
|
@@ -10041,7 +10092,7 @@ if(ucIntegrationId===undefined||ucIntegrationId===null||ucIntegrationId===''){th
|
|
|
10041
10092
|
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(){/**
|
|
10042
10093
|
* Journey service.
|
|
10043
10094
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
10044
|
-
* @version
|
|
10095
|
+
* @version 232.0.0
|
|
10045
10096
|
*//**
|
|
10046
10097
|
* Constructs a new JourneyApi.
|
|
10047
10098
|
* @alias module:purecloud-platform-client-v2/api/JourneyApi
|
|
@@ -10550,7 +10601,7 @@ if(versionId===undefined||versionId===null||versionId===''){throw'Missing the re
|
|
|
10550
10601
|
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(){/**
|
|
10551
10602
|
* Knowledge service.
|
|
10552
10603
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
10553
|
-
* @version
|
|
10604
|
+
* @version 232.0.0
|
|
10554
10605
|
*//**
|
|
10555
10606
|
* Constructs a new KnowledgeApi.
|
|
10556
10607
|
* @alias module:purecloud-platform-client-v2/api/KnowledgeApi
|
|
@@ -11620,7 +11671,7 @@ if(sourceId===undefined||sourceId===null||sourceId===''){throw'Missing the requi
|
|
|
11620
11671
|
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(){/**
|
|
11621
11672
|
* LanguageUnderstanding service.
|
|
11622
11673
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
11623
|
-
* @version
|
|
11674
|
+
* @version 232.0.0
|
|
11624
11675
|
*//**
|
|
11625
11676
|
* Constructs a new LanguageUnderstandingApi.
|
|
11626
11677
|
* @alias module:purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
@@ -11929,7 +11980,7 @@ if(domainVersionId===undefined||domainVersionId===null||domainVersionId===''){th
|
|
|
11929
11980
|
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(){/**
|
|
11930
11981
|
* Languages service.
|
|
11931
11982
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
11932
|
-
* @version
|
|
11983
|
+
* @version 232.0.0
|
|
11933
11984
|
*//**
|
|
11934
11985
|
* Constructs a new LanguagesApi.
|
|
11935
11986
|
* @alias module:purecloud-platform-client-v2/api/LanguagesApi
|
|
@@ -11984,7 +12035,7 @@ if(userId===undefined||userId===null||userId===''){throw'Missing the required pa
|
|
|
11984
12035
|
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(){/**
|
|
11985
12036
|
* Learning service.
|
|
11986
12037
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
11987
|
-
* @version
|
|
12038
|
+
* @version 232.0.0
|
|
11988
12039
|
*//**
|
|
11989
12040
|
* Constructs a new LearningApi.
|
|
11990
12041
|
* @alias module:purecloud-platform-client-v2/api/LearningApi
|
|
@@ -12250,12 +12301,14 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
12250
12301
|
* This will update a learning module rule with the specified fields.
|
|
12251
12302
|
* @param {String} moduleId The ID of the learning module
|
|
12252
12303
|
* @param {Object} body The learning module rule to be updated
|
|
12253
|
-
|
|
12304
|
+
* @param {Object} opts Optional parameters
|
|
12305
|
+
* @param {Boolean} opts.assign Whether to assign the module to users or not (default to true)
|
|
12306
|
+
*/},{key:"putLearningModuleRule",value:function putLearningModuleRule(moduleId,body,opts){opts=opts||{};// verify the required parameter 'moduleId' is set
|
|
12254
12307
|
if(moduleId===undefined||moduleId===null||moduleId===''){throw'Missing the required parameter "moduleId" when calling putLearningModuleRule';}// verify the required parameter 'body' is set
|
|
12255
|
-
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(){/**
|
|
12308
|
+
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},{'assign':opts['assign']},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var LicenseApi=/*#__PURE__*/function(){/**
|
|
12256
12309
|
* License service.
|
|
12257
12310
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
12258
|
-
* @version
|
|
12311
|
+
* @version 232.0.0
|
|
12259
12312
|
*//**
|
|
12260
12313
|
* Constructs a new LicenseApi.
|
|
12261
12314
|
* @alias module:purecloud-platform-client-v2/api/LicenseApi
|
|
@@ -12309,7 +12362,7 @@ if(featureName===undefined||featureName===null||featureName===''){throw'Missing
|
|
|
12309
12362
|
*/},{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(){/**
|
|
12310
12363
|
* Locations service.
|
|
12311
12364
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
12312
|
-
* @version
|
|
12365
|
+
* @version 232.0.0
|
|
12313
12366
|
*//**
|
|
12314
12367
|
* Constructs a new LocationsApi.
|
|
12315
12368
|
* @alias module:purecloud-platform-client-v2/api/LocationsApi
|
|
@@ -12368,7 +12421,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
12368
12421
|
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(){/**
|
|
12369
12422
|
* LogCapture service.
|
|
12370
12423
|
* @module purecloud-platform-client-v2/api/LogCaptureApi
|
|
12371
|
-
* @version
|
|
12424
|
+
* @version 232.0.0
|
|
12372
12425
|
*//**
|
|
12373
12426
|
* Constructs a new LogCaptureApi.
|
|
12374
12427
|
* @alias module:purecloud-platform-client-v2/api/LogCaptureApi
|
|
@@ -12417,7 +12470,7 @@ if(userId===undefined||userId===null||userId===''){throw'Missing the required pa
|
|
|
12417
12470
|
if(userId===undefined||userId===null||userId===''){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(){/**
|
|
12418
12471
|
* Messaging service.
|
|
12419
12472
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
12420
|
-
* @version
|
|
12473
|
+
* @version 232.0.0
|
|
12421
12474
|
*//**
|
|
12422
12475
|
* Constructs a new MessagingApi.
|
|
12423
12476
|
* @alias module:purecloud-platform-client-v2/api/MessagingApi
|
|
@@ -12507,7 +12560,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
12507
12560
|
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(){/**
|
|
12508
12561
|
* MobileDevices service.
|
|
12509
12562
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
12510
|
-
* @version
|
|
12563
|
+
* @version 232.0.0
|
|
12511
12564
|
*//**
|
|
12512
12565
|
* Constructs a new MobileDevicesApi.
|
|
12513
12566
|
* @alias module:purecloud-platform-client-v2/api/MobileDevicesApi
|
|
@@ -12546,7 +12599,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
12546
12599
|
if(deviceId===undefined||deviceId===null||deviceId===''){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(){/**
|
|
12547
12600
|
* Notifications service.
|
|
12548
12601
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
12549
|
-
* @version
|
|
12602
|
+
* @version 232.0.0
|
|
12550
12603
|
*//**
|
|
12551
12604
|
* Constructs a new NotificationsApi.
|
|
12552
12605
|
* @alias module:purecloud-platform-client-v2/api/NotificationsApi
|
|
@@ -12603,7 +12656,7 @@ if(channelId===undefined||channelId===null||channelId===''){throw'Missing the re
|
|
|
12603
12656
|
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(){/**
|
|
12604
12657
|
* OAuth service.
|
|
12605
12658
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
12606
|
-
* @version
|
|
12659
|
+
* @version 232.0.0
|
|
12607
12660
|
*//**
|
|
12608
12661
|
* Constructs a new OAuthApi.
|
|
12609
12662
|
* @alias module:purecloud-platform-client-v2/api/OAuthApi
|
|
@@ -12688,7 +12741,7 @@ if(clientId===undefined||clientId===null||clientId===''){throw'Missing the requi
|
|
|
12688
12741
|
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(){/**
|
|
12689
12742
|
* Objects service.
|
|
12690
12743
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
12691
|
-
* @version
|
|
12744
|
+
* @version 232.0.0
|
|
12692
12745
|
*//**
|
|
12693
12746
|
* Constructs a new ObjectsApi.
|
|
12694
12747
|
* @alias module:purecloud-platform-client-v2/api/ObjectsApi
|
|
@@ -12774,7 +12827,7 @@ if(divisionId===undefined||divisionId===null||divisionId===''){throw'Missing the
|
|
|
12774
12827
|
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(){/**
|
|
12775
12828
|
* OperationalEvents service.
|
|
12776
12829
|
* @module purecloud-platform-client-v2/api/OperationalEventsApi
|
|
12777
|
-
* @version
|
|
12830
|
+
* @version 232.0.0
|
|
12778
12831
|
*//**
|
|
12779
12832
|
* Constructs a new OperationalEventsApi.
|
|
12780
12833
|
* @alias module:purecloud-platform-client-v2/api/OperationalEventsApi
|
|
@@ -12805,7 +12858,7 @@ if(eventDefinitionId===undefined||eventDefinitionId===null||eventDefinitionId===
|
|
|
12805
12858
|
*/},{key:"postUsageEventsQuery",value:function postUsageEventsQuery(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/usage/events/query','POST',{},{'before':opts['before'],'after':opts['after'],'pageSize':opts['pageSize']},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var OrganizationApi=/*#__PURE__*/function(){/**
|
|
12806
12859
|
* Organization service.
|
|
12807
12860
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
12808
|
-
* @version
|
|
12861
|
+
* @version 232.0.0
|
|
12809
12862
|
*//**
|
|
12810
12863
|
* Constructs a new OrganizationApi.
|
|
12811
12864
|
* @alias module:purecloud-platform-client-v2/api/OrganizationApi
|
|
@@ -12910,7 +12963,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
12910
12963
|
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(){/**
|
|
12911
12964
|
* OrganizationAuthorization service.
|
|
12912
12965
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
12913
|
-
* @version
|
|
12966
|
+
* @version 232.0.0
|
|
12914
12967
|
*//**
|
|
12915
12968
|
* Constructs a new OrganizationAuthorizationApi.
|
|
12916
12969
|
* @alias module:purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
@@ -13244,7 +13297,7 @@ if(trustorOrgId===undefined||trustorOrgId===null||trustorOrgId===''){throw'Missi
|
|
|
13244
13297
|
if(trusteeUserId===undefined||trusteeUserId===null||trusteeUserId===''){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(){/**
|
|
13245
13298
|
* Outbound service.
|
|
13246
13299
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
13247
|
-
* @version
|
|
13300
|
+
* @version 232.0.0
|
|
13248
13301
|
*//**
|
|
13249
13302
|
* Constructs a new OutboundApi.
|
|
13250
13303
|
* @alias module:purecloud-platform-client-v2/api/OutboundApi
|
|
@@ -14395,7 +14448,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
14395
14448
|
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(){/**
|
|
14396
14449
|
* Presence service.
|
|
14397
14450
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
14398
|
-
* @version
|
|
14451
|
+
* @version 232.0.0
|
|
14399
14452
|
*//**
|
|
14400
14453
|
* Constructs a new PresenceApi.
|
|
14401
14454
|
* @alias module:purecloud-platform-client-v2/api/PresenceApi
|
|
@@ -14568,7 +14621,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
14568
14621
|
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(){/**
|
|
14569
14622
|
* ProcessAutomation service.
|
|
14570
14623
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
14571
|
-
* @version
|
|
14624
|
+
* @version 232.0.0
|
|
14572
14625
|
*//**
|
|
14573
14626
|
* Constructs a new ProcessAutomationApi.
|
|
14574
14627
|
* @alias module:purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
@@ -14631,7 +14684,7 @@ if(triggerId===undefined||triggerId===null||triggerId===''){throw'Missing the re
|
|
|
14631
14684
|
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(){/**
|
|
14632
14685
|
* Quality service.
|
|
14633
14686
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
14634
|
-
* @version
|
|
14687
|
+
* @version 232.0.0
|
|
14635
14688
|
*//**
|
|
14636
14689
|
* Constructs a new QualityApi.
|
|
14637
14690
|
* @alias module:purecloud-platform-client-v2/api/QualityApi
|
|
@@ -14805,7 +14858,7 @@ if(transactionId===undefined||transactionId===null||transactionId===''){throw'Mi
|
|
|
14805
14858
|
* @param {String} opts.sortOrder NOTE: Does not work when conversationId is supplied.
|
|
14806
14859
|
* @param {Boolean} opts.includeDeletedUsers Allow returning an agent or evaluator user with a 'delete' status. Defaults to false. (default to false)
|
|
14807
14860
|
*/},{key:"getQualityEvaluationsQuery",value:function getQualityEvaluationsQuery(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/quality/evaluations/query','GET',{},{'pageSize':opts['pageSize'],'pageNumber':opts['pageNumber'],'expand':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'previousPage':opts['previousPage'],'conversationId':opts['conversationId'],'agentUserId':opts['agentUserId'],'agentTeamId':opts['agentTeamId'],'evaluatorUserId':opts['evaluatorUserId'],'assigneeUserId':opts['assigneeUserId'],'queueId':opts['queueId'],'startTime':opts['startTime'],'endTime':opts['endTime'],'formContextId':opts['formContextId'],'evaluationState':this.apiClient.buildCollectionParam(opts['evaluationState'],'multi'),'isReleased':opts['isReleased'],'agentHasRead':opts['agentHasRead'],'expandAnswerTotalScores':opts['expandAnswerTotalScores'],'maximum':opts['maximum'],'sortOrder':opts['sortOrder'],'includeDeletedUsers':opts['includeDeletedUsers']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
14808
|
-
* Get an evaluator activity
|
|
14861
|
+
* Get an evaluator activity. To ensure optimal performance and prevent timeouts when processing large datasets, startTime and endTime fields are highly recommended for all requests.
|
|
14809
14862
|
*
|
|
14810
14863
|
* @param {Object} opts Optional parameters
|
|
14811
14864
|
* @param {Number} opts.pageSize The total page size requested (default to 25)
|
|
@@ -15149,7 +15202,7 @@ if(customerSurveyUrl===undefined||customerSurveyUrl===null){throw'Missing the re
|
|
|
15149
15202
|
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(){/**
|
|
15150
15203
|
* Recording service.
|
|
15151
15204
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
15152
|
-
* @version
|
|
15205
|
+
* @version 232.0.0
|
|
15153
15206
|
*//**
|
|
15154
15207
|
* Constructs a new RecordingApi.
|
|
15155
15208
|
* @alias module:purecloud-platform-client-v2/api/RecordingApi
|
|
@@ -15548,7 +15601,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
15548
15601
|
*/},{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(){/**
|
|
15549
15602
|
* ResponseManagement service.
|
|
15550
15603
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
15551
|
-
* @version
|
|
15604
|
+
* @version 232.0.0
|
|
15552
15605
|
*//**
|
|
15553
15606
|
* Constructs a new ResponseManagementApi.
|
|
15554
15607
|
* @alias module:purecloud-platform-client-v2/api/ResponseManagementApi
|
|
@@ -15669,7 +15722,7 @@ if(responseAssetId===undefined||responseAssetId===null||responseAssetId===''){th
|
|
|
15669
15722
|
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(){/**
|
|
15670
15723
|
* Routing service.
|
|
15671
15724
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
15672
|
-
* @version
|
|
15725
|
+
* @version 232.0.0
|
|
15673
15726
|
*//**
|
|
15674
15727
|
* Constructs a new RoutingApi.
|
|
15675
15728
|
* @alias module:purecloud-platform-client-v2/api/RoutingApi
|
|
@@ -15958,7 +16011,9 @@ if(predictorId===undefined||predictorId===null||predictorId===''){throw'Missing
|
|
|
15958
16011
|
* @param {String} opts.limit Number of entities to return. Maximum of 200. Deprecated in favour of pageSize
|
|
15959
16012
|
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
15960
16013
|
* @param {Array.<String>} opts.queueId Comma-separated list of queue Ids to filter by.
|
|
15961
|
-
|
|
16014
|
+
* @param {String} opts.kpiId Standard or custom KPI id used to filter predictors.
|
|
16015
|
+
* @param {Object} opts.state The state used to filter predictors.
|
|
16016
|
+
*/},{key:"getRoutingPredictors",value:function getRoutingPredictors(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/routing/predictors','GET',{},{'before':opts['before'],'after':opts['after'],'limit':opts['limit'],'pageSize':opts['pageSize'],'queueId':this.apiClient.buildCollectionParam(opts['queueId'],'multi'),'kpiId':opts['kpiId'],'state':opts['state']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
15962
16017
|
* Get a list of Key Performance Indicators
|
|
15963
16018
|
*
|
|
15964
16019
|
* @param {Object} opts Optional parameters
|
|
@@ -15976,9 +16031,9 @@ if(queueId===undefined||queueId===null||queueId===''){throw'Missing the required
|
|
|
15976
16031
|
*
|
|
15977
16032
|
* @param {String} queueId Queue ID
|
|
15978
16033
|
* @param {Object} opts Optional parameters
|
|
15979
|
-
* @param {
|
|
16034
|
+
* @param {Array.<String>} opts.expand Which fields, if any, to expand.
|
|
15980
16035
|
*/},{key:"getRoutingQueueAssistant",value:function getRoutingQueueAssistant(queueId,opts){opts=opts||{};// verify the required parameter 'queueId' is set
|
|
15981
|
-
if(queueId===undefined||queueId===null||queueId===''){throw'Missing the required parameter "queueId" when calling getRoutingQueueAssistant';}return this.apiClient.callApi('/api/v2/routing/queues/{queueId}/assistant','GET',{'queueId':queueId},{'expand':opts['expand']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
16036
|
+
if(queueId===undefined||queueId===null||queueId===''){throw'Missing the required parameter "queueId" when calling getRoutingQueueAssistant';}return this.apiClient.callApi('/api/v2/routing/queues/{queueId}/assistant','GET',{'queueId':queueId},{'expand':this.apiClient.buildCollectionParam(opts['expand'],'multi')},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
15982
16037
|
* Get a Comparison Period.
|
|
15983
16038
|
*
|
|
15984
16039
|
* @param {String} queueId Queue id
|
|
@@ -16726,7 +16781,7 @@ if(userId===undefined||userId===null||userId===''){throw'Missing the required pa
|
|
|
16726
16781
|
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(){/**
|
|
16727
16782
|
* SCIM service.
|
|
16728
16783
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
16729
|
-
* @version
|
|
16784
|
+
* @version 232.0.0
|
|
16730
16785
|
*//**
|
|
16731
16786
|
* Constructs a new SCIMApi.
|
|
16732
16787
|
* @alias module:purecloud-platform-client-v2/api/SCIMApi
|
|
@@ -16951,7 +17006,7 @@ if(userId===undefined||userId===null||userId===''){throw'Missing the required pa
|
|
|
16951
17006
|
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(){/**
|
|
16952
17007
|
* ScreenRecording service.
|
|
16953
17008
|
* @module purecloud-platform-client-v2/api/ScreenRecordingApi
|
|
16954
|
-
* @version
|
|
17009
|
+
* @version 232.0.0
|
|
16955
17010
|
*//**
|
|
16956
17011
|
* Constructs a new ScreenRecordingApi.
|
|
16957
17012
|
* @alias module:purecloud-platform-client-v2/api/ScreenRecordingApi
|
|
@@ -16966,7 +17021,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
16966
17021
|
*/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(){/**
|
|
16967
17022
|
* Scripts service.
|
|
16968
17023
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
16969
|
-
* @version
|
|
17024
|
+
* @version 232.0.0
|
|
16970
17025
|
*//**
|
|
16971
17026
|
* Constructs a new ScriptsApi.
|
|
16972
17027
|
* @alias module:purecloud-platform-client-v2/api/ScriptsApi
|
|
@@ -17112,7 +17167,7 @@ if(scriptId===undefined||scriptId===null||scriptId===''){throw'Missing the requi
|
|
|
17112
17167
|
*/},{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(){/**
|
|
17113
17168
|
* Search service.
|
|
17114
17169
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
17115
|
-
* @version
|
|
17170
|
+
* @version 232.0.0
|
|
17116
17171
|
*//**
|
|
17117
17172
|
* Constructs a new SearchApi.
|
|
17118
17173
|
* @alias module:purecloud-platform-client-v2/api/SearchApi
|
|
@@ -17279,7 +17334,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
17279
17334
|
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(){/**
|
|
17280
17335
|
* Settings service.
|
|
17281
17336
|
* @module purecloud-platform-client-v2/api/SettingsApi
|
|
17282
|
-
* @version
|
|
17337
|
+
* @version 232.0.0
|
|
17283
17338
|
*//**
|
|
17284
17339
|
* Constructs a new SettingsApi.
|
|
17285
17340
|
* @alias module:purecloud-platform-client-v2/api/SettingsApi
|
|
@@ -17351,7 +17406,7 @@ if(agentId===undefined||agentId===null||agentId===''){throw'Missing the required
|
|
|
17351
17406
|
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 SocialMediaApi=/*#__PURE__*/function(){/**
|
|
17352
17407
|
* SocialMedia service.
|
|
17353
17408
|
* @module purecloud-platform-client-v2/api/SocialMediaApi
|
|
17354
|
-
* @version
|
|
17409
|
+
* @version 232.0.0
|
|
17355
17410
|
*//**
|
|
17356
17411
|
* Constructs a new SocialMediaApi.
|
|
17357
17412
|
* @alias module:purecloud-platform-client-v2/api/SocialMediaApi
|
|
@@ -17764,7 +17819,7 @@ if(topicId===undefined||topicId===null||topicId===''){throw'Missing the required
|
|
|
17764
17819
|
if(twitterIngestionRuleId===undefined||twitterIngestionRuleId===null||twitterIngestionRuleId===''){throw'Missing the required parameter "twitterIngestionRuleId" when calling putSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId';}return this.apiClient.callApi('/api/v2/socialmedia/topics/{topicId}/dataingestionrules/twitter/{twitterIngestionRuleId}','PUT',{'topicId':topicId,'twitterIngestionRuleId':twitterIngestionRuleId},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var SpeechTextAnalyticsApi=/*#__PURE__*/function(){/**
|
|
17765
17820
|
* SpeechTextAnalytics service.
|
|
17766
17821
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
17767
|
-
* @version
|
|
17822
|
+
* @version 232.0.0
|
|
17768
17823
|
*//**
|
|
17769
17824
|
* Constructs a new SpeechTextAnalyticsApi.
|
|
17770
17825
|
* @alias module:purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
@@ -18133,7 +18188,7 @@ if(topicId===undefined||topicId===null||topicId===''){throw'Missing the required
|
|
|
18133
18188
|
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(){/**
|
|
18134
18189
|
* Stations service.
|
|
18135
18190
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
18136
|
-
* @version
|
|
18191
|
+
* @version 232.0.0
|
|
18137
18192
|
*//**
|
|
18138
18193
|
* Constructs a new StationsApi.
|
|
18139
18194
|
* @alias module:purecloud-platform-client-v2/api/StationsApi
|
|
@@ -18165,7 +18220,7 @@ if(stationId===undefined||stationId===null||stationId===''){throw'Missing the re
|
|
|
18165
18220
|
*/},{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(){/**
|
|
18166
18221
|
* Suggest service.
|
|
18167
18222
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
18168
|
-
* @version
|
|
18223
|
+
* @version 232.0.0
|
|
18169
18224
|
*//**
|
|
18170
18225
|
* Constructs a new SuggestApi.
|
|
18171
18226
|
* @alias module:purecloud-platform-client-v2/api/SuggestApi
|
|
@@ -18205,7 +18260,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
18205
18260
|
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(){/**
|
|
18206
18261
|
* TaskManagement service.
|
|
18207
18262
|
* @module purecloud-platform-client-v2/api/TaskManagementApi
|
|
18208
|
-
* @version
|
|
18263
|
+
* @version 232.0.0
|
|
18209
18264
|
*//**
|
|
18210
18265
|
* Constructs a new TaskManagementApi.
|
|
18211
18266
|
* @alias module:purecloud-platform-client-v2/api/TaskManagementApi
|
|
@@ -18713,7 +18768,7 @@ if(schemaId===undefined||schemaId===null||schemaId===''){throw'Missing the requi
|
|
|
18713
18768
|
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(){/**
|
|
18714
18769
|
* Teams service.
|
|
18715
18770
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
18716
|
-
* @version
|
|
18771
|
+
* @version 232.0.0
|
|
18717
18772
|
*//**
|
|
18718
18773
|
* Constructs a new TeamsApi.
|
|
18719
18774
|
* @alias module:purecloud-platform-client-v2/api/TeamsApi
|
|
@@ -18793,7 +18848,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
18793
18848
|
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(){/**
|
|
18794
18849
|
* Telephony service.
|
|
18795
18850
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
18796
|
-
* @version
|
|
18851
|
+
* @version 232.0.0
|
|
18797
18852
|
*//**
|
|
18798
18853
|
* Constructs a new TelephonyApi.
|
|
18799
18854
|
* @alias module:purecloud-platform-client-v2/api/TelephonyApi
|
|
@@ -18864,7 +18919,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
18864
18919
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putTelephonyAgentsGreetingsMe';}return this.apiClient.callApi('/api/v2/telephony/agents/greetings/me','PUT',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var TelephonyProvidersEdgeApi=/*#__PURE__*/function(){/**
|
|
18865
18920
|
* TelephonyProvidersEdge service.
|
|
18866
18921
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
18867
|
-
* @version
|
|
18922
|
+
* @version 232.0.0
|
|
18868
18923
|
*//**
|
|
18869
18924
|
* Constructs a new TelephonyProvidersEdgeApi.
|
|
18870
18925
|
* @alias module:purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
@@ -19712,7 +19767,7 @@ if(trunkBaseSettingsId===undefined||trunkBaseSettingsId===null||trunkBaseSetting
|
|
|
19712
19767
|
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(){/**
|
|
19713
19768
|
* Textbots service.
|
|
19714
19769
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
19715
|
-
* @version
|
|
19770
|
+
* @version 232.0.0
|
|
19716
19771
|
*//**
|
|
19717
19772
|
* Constructs a new TextbotsApi.
|
|
19718
19773
|
* @alias module:purecloud-platform-client-v2/api/TextbotsApi
|
|
@@ -19748,7 +19803,7 @@ if(launchRequest===undefined||launchRequest===null){throw'Missing the required p
|
|
|
19748
19803
|
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(){/**
|
|
19749
19804
|
* Tokens service.
|
|
19750
19805
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
19751
|
-
* @version
|
|
19806
|
+
* @version 232.0.0
|
|
19752
19807
|
*//**
|
|
19753
19808
|
* Constructs a new TokensApi.
|
|
19754
19809
|
* @alias module:purecloud-platform-client-v2/api/TokensApi
|
|
@@ -19782,7 +19837,7 @@ if(userId===undefined||userId===null||userId===''){throw'Missing the required pa
|
|
|
19782
19837
|
*/},{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(){/**
|
|
19783
19838
|
* Uploads service.
|
|
19784
19839
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
19785
|
-
* @version
|
|
19840
|
+
* @version 232.0.0
|
|
19786
19841
|
*//**
|
|
19787
19842
|
* Constructs a new UploadsApi.
|
|
19788
19843
|
* @alias module:purecloud-platform-client-v2/api/UploadsApi
|
|
@@ -19850,7 +19905,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
19850
19905
|
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(){/**
|
|
19851
19906
|
* Usage service.
|
|
19852
19907
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
19853
|
-
* @version
|
|
19908
|
+
* @version 232.0.0
|
|
19854
19909
|
*//**
|
|
19855
19910
|
* Constructs a new UsageApi.
|
|
19856
19911
|
* @alias module:purecloud-platform-client-v2/api/UsageApi
|
|
@@ -19934,7 +19989,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
19934
19989
|
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(){/**
|
|
19935
19990
|
* UserRecordings service.
|
|
19936
19991
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
19937
|
-
* @version
|
|
19992
|
+
* @version 232.0.0
|
|
19938
19993
|
*//**
|
|
19939
19994
|
* Constructs a new UserRecordingsApi.
|
|
19940
19995
|
* @alias module:purecloud-platform-client-v2/api/UserRecordingsApi
|
|
@@ -19982,7 +20037,7 @@ if(recordingId===undefined||recordingId===null||recordingId===''){throw'Missing
|
|
|
19982
20037
|
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(){/**
|
|
19983
20038
|
* Users service.
|
|
19984
20039
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
19985
|
-
* @version
|
|
20040
|
+
* @version 232.0.0
|
|
19986
20041
|
*//**
|
|
19987
20042
|
* Constructs a new UsersApi.
|
|
19988
20043
|
* @alias module:purecloud-platform-client-v2/api/UsersApi
|
|
@@ -20726,7 +20781,7 @@ if(verifierId===undefined||verifierId===null||verifierId===''){throw'Missing the
|
|
|
20726
20781
|
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(){/**
|
|
20727
20782
|
* Utilities service.
|
|
20728
20783
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
20729
|
-
* @version
|
|
20784
|
+
* @version 232.0.0
|
|
20730
20785
|
*//**
|
|
20731
20786
|
* Constructs a new UtilitiesApi.
|
|
20732
20787
|
* @alias module:purecloud-platform-client-v2/api/UtilitiesApi
|
|
@@ -20753,7 +20808,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
20753
20808
|
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(){/**
|
|
20754
20809
|
* Voicemail service.
|
|
20755
20810
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
20756
|
-
* @version
|
|
20811
|
+
* @version 232.0.0
|
|
20757
20812
|
*//**
|
|
20758
20813
|
* Constructs a new VoicemailApi.
|
|
20759
20814
|
* @alias module:purecloud-platform-client-v2/api/VoicemailApi
|
|
@@ -20915,7 +20970,7 @@ if(userId===undefined||userId===null||userId===''){throw'Missing the required pa
|
|
|
20915
20970
|
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(){/**
|
|
20916
20971
|
* WebChat service.
|
|
20917
20972
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
20918
|
-
* @version
|
|
20973
|
+
* @version 232.0.0
|
|
20919
20974
|
*//**
|
|
20920
20975
|
* Constructs a new WebChatApi.
|
|
20921
20976
|
* @alias module:purecloud-platform-client-v2/api/WebChatApi
|
|
@@ -20938,7 +20993,8 @@ if(deploymentId===undefined||deploymentId===null||deploymentId===''){throw'Missi
|
|
|
20938
20993
|
if(conversationId===undefined||conversationId===null||conversationId===''){throw'Missing the required parameter "conversationId" when calling deleteWebchatGuestConversationMember';}// verify the required parameter 'memberId' is set
|
|
20939
20994
|
if(memberId===undefined||memberId===null||memberId===''){throw'Missing the required parameter "memberId" when calling deleteWebchatGuestConversationMember';}return this.apiClient.callApi('/api/v2/webchat/guest/conversations/{conversationId}/members/{memberId}','DELETE',{'conversationId':conversationId,'memberId':memberId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
20940
20995
|
* Remove WebChat deployment settings
|
|
20941
|
-
*
|
|
20996
|
+
* This endpoint is deprecated. Please see the article https://community.genesys.com/discussion/deprecation-acd-chat-v20-and-resulting-impact-to-apiv2webchatsettings.
|
|
20997
|
+
* @deprecated
|
|
20942
20998
|
*/},{key:"deleteWebchatSettings",value:function deleteWebchatSettings(){return this.apiClient.callApi('/api/v2/webchat/settings','DELETE',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
20943
20999
|
* Get a WebChat deployment
|
|
20944
21000
|
*
|
|
@@ -21002,7 +21058,8 @@ if(messageId===undefined||messageId===null||messageId===''){throw'Missing the re
|
|
|
21002
21058
|
*/},{key:"getWebchatGuestConversationMessages",value:function getWebchatGuestConversationMessages(conversationId,opts){opts=opts||{};// verify the required parameter 'conversationId' is set
|
|
21003
21059
|
if(conversationId===undefined||conversationId===null||conversationId===''){throw'Missing the required parameter "conversationId" when calling getWebchatGuestConversationMessages';}return this.apiClient.callApi('/api/v2/webchat/guest/conversations/{conversationId}/messages','GET',{'conversationId':conversationId},{'after':opts['after'],'before':opts['before'],'sortOrder':opts['sortOrder'],'maxResults':opts['maxResults']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
21004
21060
|
* Get WebChat deployment settings
|
|
21005
|
-
*
|
|
21061
|
+
* This endpoint is deprecated. Please see the article https://community.genesys.com/discussion/deprecation-acd-chat-v20-and-resulting-impact-to-apiv2webchatsettings.
|
|
21062
|
+
* @deprecated
|
|
21006
21063
|
*/},{key:"getWebchatSettings",value:function getWebchatSettings(){return this.apiClient.callApi('/api/v2/webchat/settings','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
21007
21064
|
* Update a media request in the conversation, setting the state to ACCEPTED/DECLINED/ERRORED
|
|
21008
21065
|
* This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-legacy-co-browse-and-screenshare/
|
|
@@ -21053,13 +21110,14 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
21053
21110
|
if(deploymentId===undefined||deploymentId===null||deploymentId===''){throw'Missing the required parameter "deploymentId" when calling putWebchatDeployment';}// verify the required parameter 'body' is set
|
|
21054
21111
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putWebchatDeployment';}return this.apiClient.callApi('/api/v2/webchat/deployments/{deploymentId}','PUT',{'deploymentId':deploymentId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
21055
21112
|
* Update WebChat deployment settings
|
|
21056
|
-
*
|
|
21113
|
+
* This endpoint is deprecated. Please see the article https://community.genesys.com/discussion/deprecation-acd-chat-v20-and-resulting-impact-to-apiv2webchatsettings.
|
|
21057
21114
|
* @param {Object} body webChatSettings
|
|
21115
|
+
* @deprecated
|
|
21058
21116
|
*/},{key:"putWebchatSettings",value:function putWebchatSettings(body){// verify the required parameter 'body' is set
|
|
21059
21117
|
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(){/**
|
|
21060
21118
|
* WebDeployments service.
|
|
21061
21119
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
21062
|
-
* @version
|
|
21120
|
+
* @version 232.0.0
|
|
21063
21121
|
*//**
|
|
21064
21122
|
* Constructs a new WebDeploymentsApi.
|
|
21065
21123
|
* @alias module:purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
@@ -21192,7 +21250,7 @@ if(deploymentId===undefined||deploymentId===null||deploymentId===''){throw'Missi
|
|
|
21192
21250
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putWebdeploymentsDeploymentIdentityresolution';}return this.apiClient.callApi('/api/v2/webdeployments/deployments/{deploymentId}/identityresolution','PUT',{'deploymentId':deploymentId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var WebMessagingApi=/*#__PURE__*/function(){/**
|
|
21193
21251
|
* WebMessaging service.
|
|
21194
21252
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
21195
|
-
* @version
|
|
21253
|
+
* @version 232.0.0
|
|
21196
21254
|
*//**
|
|
21197
21255
|
* Constructs a new WebMessagingApi.
|
|
21198
21256
|
* @alias module:purecloud-platform-client-v2/api/WebMessagingApi
|
|
@@ -21233,7 +21291,7 @@ if(tokenId===undefined||tokenId===null||tokenId===''){throw'Missing the required
|
|
|
21233
21291
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postWebmessagingDeploymentPushdevice';}return this.apiClient.callApi('/api/v2/webmessaging/deployments/{deploymentId}/pushdevices/{tokenId}','POST',{'deploymentId':deploymentId,'tokenId':tokenId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var WidgetsApi=/*#__PURE__*/function(){/**
|
|
21234
21292
|
* Widgets service.
|
|
21235
21293
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
21236
|
-
* @version
|
|
21294
|
+
* @version 232.0.0
|
|
21237
21295
|
*//**
|
|
21238
21296
|
* Constructs a new WidgetsApi.
|
|
21239
21297
|
* @alias module:purecloud-platform-client-v2/api/WidgetsApi
|
|
@@ -21273,7 +21331,7 @@ if(deploymentId===undefined||deploymentId===null||deploymentId===''){throw'Missi
|
|
|
21273
21331
|
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(){/**
|
|
21274
21332
|
* WorkforceManagement service.
|
|
21275
21333
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
21276
|
-
* @version
|
|
21334
|
+
* @version 232.0.0
|
|
21277
21335
|
*//**
|
|
21278
21336
|
* Constructs a new WorkforceManagementApi.
|
|
21279
21337
|
* @alias module:purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
@@ -22500,6 +22558,14 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
22500
22558
|
* @param {Object} body body
|
|
22501
22559
|
*/},{key:"postWorkforcemanagementAgentsMePossibleworkshifts",value:function postWorkforcemanagementAgentsMePossibleworkshifts(body){// verify the required parameter 'body' is set
|
|
22502
22560
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postWorkforcemanagementAgentsMePossibleworkshifts';}return this.apiClient.callApi('/api/v2/workforcemanagement/agents/me/possibleworkshifts','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
22561
|
+
* Fetch agent schedules for the logged in user's management unit
|
|
22562
|
+
*
|
|
22563
|
+
* @param {Object} body body
|
|
22564
|
+
* @param {Object} opts Optional parameters
|
|
22565
|
+
* @param {Boolean} opts.forceAsync Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes
|
|
22566
|
+
* @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
|
|
22567
|
+
*/},{key:"postWorkforcemanagementAgentschedulesManagementunitsMine",value:function postWorkforcemanagementAgentschedulesManagementunitsMine(body,opts){opts=opts||{};// verify the required parameter 'body' is set
|
|
22568
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postWorkforcemanagementAgentschedulesManagementunitsMine';}return this.apiClient.callApi('/api/v2/workforcemanagement/agentschedules/managementunits/mine','POST',{},{'forceAsync':opts['forceAsync'],'forceDownloadService':opts['forceDownloadService']},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
22503
22569
|
* Get published schedule for the current user
|
|
22504
22570
|
*
|
|
22505
22571
|
* @param {Object} body body
|
|
@@ -23225,7 +23291,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
23225
23291
|
* </pre>
|
|
23226
23292
|
* </p>
|
|
23227
23293
|
* @module purecloud-platform-client-v2/index
|
|
23228
|
-
* @version
|
|
23294
|
+
* @version 232.0.0
|
|
23229
23295
|
*/var platformClient=/*#__PURE__*/_createClass(function platformClient(){_classCallCheck(this,platformClient);/**
|
|
23230
23296
|
* The ApiClient constructor.
|
|
23231
23297
|
* @property {module:purecloud-platform-client-v2/ApiClient}
|