purecloud-platform-client-v2 238.0.0 → 241.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 +3 -3
- package/dist/node/purecloud-platform-client-v2.js +855 -116
- package/dist/web-amd/purecloud-platform-client-v2.js +855 -116
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +298 -119
- package/dist/web-cjs/purecloud-platform-client-v2.js +298 -119
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +563 -8
- package/package.json +1 -1
- package/src/purecloud-platform-client-v2/ApiClient.js +5 -1
- package/src/purecloud-platform-client-v2/api/AIStudioApi.js +36 -1
- package/src/purecloud-platform-client-v2/api/AgentAssistantsApi.js +156 -1
- package/src/purecloud-platform-client-v2/api/AgentCopilotApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AgentUIApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AlertingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +135 -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 -14
- 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 +273 -13
- 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 +30 -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 +1 -1
- package/src/purecloud-platform-client-v2/api/JourneyApi.js +5 -5
- package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LanguagesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LearningApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LicenseApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LocationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LogCaptureApi.js +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 +3 -2
- package/src/purecloud-platform-client-v2/api/PresenceApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ProcessAutomationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/QualityApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RecordingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RoutingApi.js +134 -1
- package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ScreenRecordingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ScriptsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SearchApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SettingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SocialMediaApi.js +3 -2
- 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/UsersRulesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/VoicemailApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebChatApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebMessagingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WidgetsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/index.js +1 -1
package/dist/web-cjs/bundle.js
CHANGED
|
@@ -953,7 +953,7 @@ if(env)this.environment=env;else this.environment=this.host?this.host:'mypureclo
|
|
|
953
953
|
this.environment=this.environment.replace(/\/+$/,'');// Strip protocol and subdomain
|
|
954
954
|
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];}}}]);}();/**
|
|
955
955
|
* @module purecloud-platform-client-v2/ApiClient
|
|
956
|
-
* @version
|
|
956
|
+
* @version 241.0.0
|
|
957
957
|
*/var ApiClient=/*#__PURE__*/function(){/**
|
|
958
958
|
* Manages low level client-server communications, parameter marshalling, etc. There should not be any need for an
|
|
959
959
|
* application to use this class directly - the *Api and model classes provide the public API for the service. The
|
|
@@ -1070,11 +1070,12 @@ var tempState=this.authData.state;this.authData=localStorage.getItem("".concat(t
|
|
|
1070
1070
|
* @param {string} opts.state - (optional) An arbitrary string to be passed back with the login response. Used for client apps to associate login responses with a request.
|
|
1071
1071
|
* @param {string} opts.org - (optional) The organization name that would normally used when specifying an organization name when logging in. This is only used when a provider is also specified.
|
|
1072
1072
|
* @param {string} opts.provider - (optional) Authentication provider to log in with e.g. okta, adfs, salesforce, onelogin. This is only used when an org is also specified.
|
|
1073
|
+
* @param {string} opts.prompt - (optional) Use the prompt=login parameter to require that the user be prompted to enter credentials at the Gensys Cloud login screen and ignore any remembered sessions (auth cookies).
|
|
1073
1074
|
*/},{key:"loginImplicitGrant",value:function loginImplicitGrant(clientId,redirectUri,opts){var _this4=this;// Check for auth token in hash
|
|
1074
1075
|
var hash=this._setValuesFromUrlHash();this.clientId=clientId;this.redirectUri=redirectUri;if(!opts)opts={};return new Promise(function(resolve,reject){// Abort if org and provider are not set together
|
|
1075
1076
|
if(opts.org&&!opts.provider){reject(new Error('opts.provider must be set if opts.org is set'));}else if(opts.provider&&!opts.org){reject(new Error('opts.org must be set if opts.provider is set'));}// Abort on auth error
|
|
1076
1077
|
if(hash&&hash.error){hash.accessToken=undefined;_this4._saveSettings(hash);return reject(new Error("[".concat(hash.error,"] ").concat(hash.error_description)));}// Test token and proceed with login
|
|
1077
|
-
_this4._testTokenAccess().then(function(){if(!_this4.authData.state&&opts.state)_this4.authData.state=opts.state;resolve(_this4.authData);})["catch"](function(error){var query={client_id:encodeURIComponent(_this4.clientId),redirect_uri:encodeURIComponent(_this4.redirectUri),response_type:'token'};if(opts.state)query.state=encodeURIComponent(opts.state);if(opts.org)query.org=encodeURIComponent(opts.org);if(opts.provider)query.provider=encodeURIComponent(opts.provider);var url=_this4._buildAuthUrl('oauth/authorize',query);window.location.replace(url);});});}/**
|
|
1078
|
+
_this4._testTokenAccess().then(function(){if(!_this4.authData.state&&opts.state)_this4.authData.state=opts.state;resolve(_this4.authData);})["catch"](function(error){var query={client_id:encodeURIComponent(_this4.clientId),redirect_uri:encodeURIComponent(_this4.redirectUri),response_type:'token'};if(opts.state)query.state=encodeURIComponent(opts.state);if(opts.org)query.org=encodeURIComponent(opts.org);if(opts.provider)query.provider=encodeURIComponent(opts.provider);if(opts.prompt&&opts.prompt=='login')query.prompt=encodeURIComponent(opts.prompt);var url=_this4._buildAuthUrl('oauth/authorize',query);window.location.replace(url);});});}/**
|
|
1078
1079
|
* @description Initiates the client credentials login flow. Only available in node apps.
|
|
1079
1080
|
* @param {string} clientId - The client ID of an OAuth Implicit Grant client
|
|
1080
1081
|
* @param {string} clientSecret - The client secret of an OAuth Implicit Grant client
|
|
@@ -1124,6 +1125,7 @@ return reject(new Error("Code Challenge Error ".concat(error)));});});}}/**
|
|
|
1124
1125
|
* @param {string} opts.state - (optional) An arbitrary string to be passed back with the login response. Used for client apps to associate login responses with a request.
|
|
1125
1126
|
* @param {string} opts.org - (optional) The organization name that would normally used when specifying an organization name when logging in. This is only used when a provider is also specified.
|
|
1126
1127
|
* @param {string} opts.provider - (optional) Authentication provider to log in with e.g. okta, adfs, salesforce, onelogin. This is only used when an org is also specified.
|
|
1128
|
+
* @param {string} opts.prompt - (optional) Use the prompt=login parameter to require that the user be prompted to enter credentials at the Gensys Cloud login screen and ignore any remembered sessions (auth cookies).
|
|
1127
1129
|
* @param {string} codeVerifier - (optional) code verifier used to generate the code challenge
|
|
1128
1130
|
*/},{key:"loginPKCEGrant",value:function loginPKCEGrant(clientId,redirectUri,opts,codeVerifier){var _this8=this;// Need Local Storage or non null codeVerifier as parameter
|
|
1129
1131
|
if(!this.hasLocalStorage&&!codeVerifier){throw new Error("loginPKCEGrant requires Local Storage or codeVerifier as input parameter");}// Check for auth code in query
|
|
@@ -1141,7 +1143,7 @@ if(_this8.hasLocalStorage){sessionStorage.removeItem("genesys_cloud_sdk_pkce_cod
|
|
|
1141
1143
|
_this8._saveSettings({accessToken:undefined});// remove codeVerifier from session storage
|
|
1142
1144
|
if(_this8.hasLocalStorage){sessionStorage.removeItem("genesys_cloud_sdk_pkce_code_verifier");}return reject(new Error("[".concat(error.name,"] ").concat(error.msg)));});}else{// Test token (if previously stored) and proceed with login
|
|
1143
1145
|
_this8._testTokenAccess().then(function(){if(!_this8.authData.state&&opts.state)_this8.authData.state=opts.state;resolve(_this8.authData);})["catch"](function(error){if(!_this8.codeVerifier){_this8.codeVerifier=_this8.generatePKCECodeVerifier(128);// save codeVerifier in session storage
|
|
1144
|
-
if(_this8.hasLocalStorage){sessionStorage.setItem("genesys_cloud_sdk_pkce_code_verifier",_this8.codeVerifier);}}_this8.computePKCECodeChallenge(_this8.codeVerifier).then(function(codeChallenge){var tokenQuery={client_id:encodeURIComponent(_this8.clientId),redirect_uri:encodeURIComponent(_this8.redirectUri),code_challenge:encodeURIComponent(codeChallenge),response_type:'code',code_challenge_method:'S256'};if(opts.state)tokenQuery.state=encodeURIComponent(opts.state);if(opts.org)tokenQuery.org=encodeURIComponent(opts.org);if(opts.provider)tokenQuery.provider=encodeURIComponent(opts.provider);var url=_this8._buildAuthUrl('oauth/authorize',tokenQuery);window.location.replace(url);})["catch"](function(err){return reject(new Error("[".concat(err.name,"]")));});});}});}/**
|
|
1146
|
+
if(_this8.hasLocalStorage){sessionStorage.setItem("genesys_cloud_sdk_pkce_code_verifier",_this8.codeVerifier);}}_this8.computePKCECodeChallenge(_this8.codeVerifier).then(function(codeChallenge){var tokenQuery={client_id:encodeURIComponent(_this8.clientId),redirect_uri:encodeURIComponent(_this8.redirectUri),code_challenge:encodeURIComponent(codeChallenge),response_type:'code',code_challenge_method:'S256'};if(opts.state)tokenQuery.state=encodeURIComponent(opts.state);if(opts.org)tokenQuery.org=encodeURIComponent(opts.org);if(opts.provider)tokenQuery.provider=encodeURIComponent(opts.provider);if(opts.prompt&&opts.prompt=='login')tokenQuery.prompt=encodeURIComponent(opts.prompt);var url=_this8._buildAuthUrl('oauth/authorize',tokenQuery);window.location.replace(url);})["catch"](function(err){return reject(new Error("[".concat(err.name,"]")));});});}});}/**
|
|
1145
1147
|
* @description Parses the URL Query, grabs the code, and clears the query param. If no code is found, no action is taken.
|
|
1146
1148
|
*/},{key:"_setValuesFromUrlQuery",value:function _setValuesFromUrlQuery(){// Check for window
|
|
1147
1149
|
if(!(typeof window!=='undefined'&&window.location.search))return;// Process query string
|
|
@@ -1309,7 +1311,7 @@ resolve(data);})["catch"](function(error){var data=error;if(error.response&&erro
|
|
|
1309
1311
|
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(){/**
|
|
1310
1312
|
* AIStudio service.
|
|
1311
1313
|
* @module purecloud-platform-client-v2/api/AIStudioApi
|
|
1312
|
-
* @version
|
|
1314
|
+
* @version 241.0.0
|
|
1313
1315
|
*//**
|
|
1314
1316
|
* Constructs a new AIStudioApi.
|
|
1315
1317
|
* @alias module:purecloud-platform-client-v2/api/AIStudioApi
|
|
@@ -1421,6 +1423,15 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
1421
1423
|
* @param {Object} body
|
|
1422
1424
|
*/},{key:"postConversationsSummariesSettings",value:function postConversationsSummariesSettings(body){// verify the required parameter 'body' is set
|
|
1423
1425
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postConversationsSummariesSettings';}return this.apiClient.callApi('/api/v2/conversations/summaries/settings','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
1426
|
+
* Add a turn to a guide session.
|
|
1427
|
+
* Creates a new turn in the specified guide session with the provided request data. If the session ID doesnt exist, a new session will be created automatically.
|
|
1428
|
+
* @param {String} guideId Guide ID
|
|
1429
|
+
* @param {String} guideSessionId Guide Session ID
|
|
1430
|
+
* @param {Object} body
|
|
1431
|
+
*/},{key:"postGuideSessionTurns",value:function postGuideSessionTurns(guideId,guideSessionId,body){// verify the required parameter 'guideId' is set
|
|
1432
|
+
if(guideId===undefined||guideId===null||guideId===''){throw'Missing the required parameter "guideId" when calling postGuideSessionTurns';}// verify the required parameter 'guideSessionId' is set
|
|
1433
|
+
if(guideSessionId===undefined||guideSessionId===null||guideSessionId===''){throw'Missing the required parameter "guideSessionId" when calling postGuideSessionTurns';}// verify the required parameter 'body' is set
|
|
1434
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postGuideSessionTurns';}return this.apiClient.callApi('/api/v2/guides/{guideId}/sessions/{guideSessionId}/turns','POST',{'guideId':guideId,'guideSessionId':guideSessionId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
1424
1435
|
* Start the publishing of a guide version.
|
|
1425
1436
|
*
|
|
1426
1437
|
* @param {String} guideId Guide ID
|
|
@@ -1460,7 +1471,7 @@ if(summarySettingId===undefined||summarySettingId===null||summarySettingId==='')
|
|
|
1460
1471
|
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(){/**
|
|
1461
1472
|
* AgentAssistants service.
|
|
1462
1473
|
* @module purecloud-platform-client-v2/api/AgentAssistantsApi
|
|
1463
|
-
* @version
|
|
1474
|
+
* @version 241.0.0
|
|
1464
1475
|
*//**
|
|
1465
1476
|
* Constructs a new AgentAssistantsApi.
|
|
1466
1477
|
* @alias module:purecloud-platform-client-v2/api/AgentAssistantsApi
|
|
@@ -1487,6 +1498,11 @@ if(queueId===undefined||queueId===null||queueId===''){throw'Missing the required
|
|
|
1487
1498
|
* @param {String} opts.queueIds Comma-separated identifiers of the queues that need to be deleted.
|
|
1488
1499
|
*/},{key:"deleteAssistantQueues",value:function deleteAssistantQueues(assistantId,opts){opts=opts||{};// verify the required parameter 'assistantId' is set
|
|
1489
1500
|
if(assistantId===undefined||assistantId===null||assistantId===''){throw'Missing the required parameter "assistantId" when calling deleteAssistantQueues';}return this.apiClient.callApi('/api/v2/assistants/{assistantId}/queues','DELETE',{'assistantId':assistantId},{'queueIds':opts['queueIds']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
1501
|
+
* Delete an agent checklist
|
|
1502
|
+
*
|
|
1503
|
+
* @param {String} agentChecklistId Agent Checklist ID
|
|
1504
|
+
*/},{key:"deleteAssistantsAgentchecklist",value:function deleteAssistantsAgentchecklist(agentChecklistId){// verify the required parameter 'agentChecklistId' is set
|
|
1505
|
+
if(agentChecklistId===undefined||agentChecklistId===null||agentChecklistId===''){throw'Missing the required parameter "agentChecklistId" when calling deleteAssistantsAgentchecklist';}return this.apiClient.callApi('/api/v2/assistants/agentchecklists/{agentChecklistId}','DELETE',{'agentChecklistId':agentChecklistId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
1490
1506
|
* Get an assistant.
|
|
1491
1507
|
*
|
|
1492
1508
|
* @param {String} assistantId Assistant ID
|
|
@@ -1523,6 +1539,25 @@ if(assistantId===undefined||assistantId===null||assistantId===''){throw'Missing
|
|
|
1523
1539
|
* @param {String} opts.name Return the assistant by the given name.
|
|
1524
1540
|
* @param {Object} opts.expand Which fields, if any, to expand
|
|
1525
1541
|
*/},{key:"getAssistants",value:function getAssistants(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/assistants','GET',{},{'before':opts['before'],'after':opts['after'],'limit':opts['limit'],'pageSize':opts['pageSize'],'name':opts['name'],'expand':opts['expand']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
1542
|
+
* Get an agent checklist
|
|
1543
|
+
*
|
|
1544
|
+
* @param {String} agentChecklistId Agent Checklist ID
|
|
1545
|
+
*/},{key:"getAssistantsAgentchecklist",value:function getAssistantsAgentchecklist(agentChecklistId){// verify the required parameter 'agentChecklistId' is set
|
|
1546
|
+
if(agentChecklistId===undefined||agentChecklistId===null||agentChecklistId===''){throw'Missing the required parameter "agentChecklistId" when calling getAssistantsAgentchecklist';}return this.apiClient.callApi('/api/v2/assistants/agentchecklists/{agentChecklistId}','GET',{'agentChecklistId':agentChecklistId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
1547
|
+
* Get the list of agent checklists
|
|
1548
|
+
*
|
|
1549
|
+
* @param {Object} opts Optional parameters
|
|
1550
|
+
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
1551
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
1552
|
+
* @param {String} opts.pageSize The page size for the listing. The max that will be returned is 100. (default to 25)
|
|
1553
|
+
* @param {String} opts.namePrefix The agent checklist name prefix filter applied to the listing.
|
|
1554
|
+
* @param {String} opts.language The agent checklist language filter applied to the listing.
|
|
1555
|
+
* @param {Object} opts.sortOrder The sort order for the listing
|
|
1556
|
+
* @param {Object} opts.sortBy The field to sort by for the listing.
|
|
1557
|
+
*/},{key:"getAssistantsAgentchecklists",value:function getAssistantsAgentchecklists(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/assistants/agentchecklists','GET',{},{'before':opts['before'],'after':opts['after'],'pageSize':opts['pageSize'],'namePrefix':opts['namePrefix'],'language':opts['language'],'sortOrder':opts['sortOrder'],'sortBy':opts['sortBy']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
1558
|
+
* Get the list of supported languages
|
|
1559
|
+
*
|
|
1560
|
+
*/},{key:"getAssistantsAgentchecklistsLanguages",value:function getAssistantsAgentchecklistsLanguages(){return this.apiClient.callApi('/api/v2/assistants/agentchecklists/languages','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
1526
1561
|
* Get all queues assigned to any assistant.
|
|
1527
1562
|
*
|
|
1528
1563
|
* @param {Object} opts Optional parameters
|
|
@@ -1580,6 +1615,11 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
1580
1615
|
* @param {Object} body
|
|
1581
1616
|
*/},{key:"postAssistants",value:function postAssistants(body){// verify the required parameter 'body' is set
|
|
1582
1617
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postAssistants';}return this.apiClient.callApi('/api/v2/assistants','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
1618
|
+
* Create an agent checklist
|
|
1619
|
+
*
|
|
1620
|
+
* @param {Object} body Request body containing details of checklist to be added
|
|
1621
|
+
*/},{key:"postAssistantsAgentchecklists",value:function postAssistantsAgentchecklists(body){// verify the required parameter 'body' is set
|
|
1622
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postAssistantsAgentchecklists';}return this.apiClient.callApi('/api/v2/assistants/agentchecklists','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
1583
1623
|
* Create a queue assistant association.
|
|
1584
1624
|
*
|
|
1585
1625
|
* @param {String} assistantId Assistant ID
|
|
@@ -1588,10 +1628,17 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
1588
1628
|
*/},{key:"putAssistantQueue",value:function putAssistantQueue(assistantId,queueId,body){// verify the required parameter 'assistantId' is set
|
|
1589
1629
|
if(assistantId===undefined||assistantId===null||assistantId===''){throw'Missing the required parameter "assistantId" when calling putAssistantQueue';}// verify the required parameter 'queueId' is set
|
|
1590
1630
|
if(queueId===undefined||queueId===null||queueId===''){throw'Missing the required parameter "queueId" when calling putAssistantQueue';}// verify the required parameter 'body' is set
|
|
1591
|
-
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']);}
|
|
1631
|
+
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']);}/**
|
|
1632
|
+
* Update an agent checklist
|
|
1633
|
+
*
|
|
1634
|
+
* @param {String} agentChecklistId Agent Checklist ID
|
|
1635
|
+
* @param {Object} body Request body containing details of checklist to be updated
|
|
1636
|
+
*/},{key:"putAssistantsAgentchecklist",value:function putAssistantsAgentchecklist(agentChecklistId,body){// verify the required parameter 'agentChecklistId' is set
|
|
1637
|
+
if(agentChecklistId===undefined||agentChecklistId===null||agentChecklistId===''){throw'Missing the required parameter "agentChecklistId" when calling putAssistantsAgentchecklist';}// verify the required parameter 'body' is set
|
|
1638
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putAssistantsAgentchecklist';}return this.apiClient.callApi('/api/v2/assistants/agentchecklists/{agentChecklistId}','PUT',{'agentChecklistId':agentChecklistId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var AgentCopilotApi=/*#__PURE__*/function(){/**
|
|
1592
1639
|
* AgentCopilot service.
|
|
1593
1640
|
* @module purecloud-platform-client-v2/api/AgentCopilotApi
|
|
1594
|
-
* @version
|
|
1641
|
+
* @version 241.0.0
|
|
1595
1642
|
*//**
|
|
1596
1643
|
* Constructs a new AgentCopilotApi.
|
|
1597
1644
|
* @alias module:purecloud-platform-client-v2/api/AgentCopilotApi
|
|
@@ -1618,7 +1665,7 @@ if(assistantId===undefined||assistantId===null||assistantId===''){throw'Missing
|
|
|
1618
1665
|
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(){/**
|
|
1619
1666
|
* AgentUI service.
|
|
1620
1667
|
* @module purecloud-platform-client-v2/api/AgentUIApi
|
|
1621
|
-
* @version
|
|
1668
|
+
* @version 241.0.0
|
|
1622
1669
|
*//**
|
|
1623
1670
|
* Constructs a new AgentUIApi.
|
|
1624
1671
|
* @alias module:purecloud-platform-client-v2/api/AgentUIApi
|
|
@@ -1652,7 +1699,7 @@ if(agentId===undefined||agentId===null||agentId===''){throw'Missing the required
|
|
|
1652
1699
|
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(){/**
|
|
1653
1700
|
* Alerting service.
|
|
1654
1701
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
1655
|
-
* @version
|
|
1702
|
+
* @version 241.0.0
|
|
1656
1703
|
*//**
|
|
1657
1704
|
* Constructs a new AlertingApi.
|
|
1658
1705
|
* @alias module:purecloud-platform-client-v2/api/AlertingApi
|
|
@@ -1741,7 +1788,7 @@ if(ruleId===undefined||ruleId===null||ruleId===''){throw'Missing the required pa
|
|
|
1741
1788
|
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(){/**
|
|
1742
1789
|
* Analytics service.
|
|
1743
1790
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
1744
|
-
* @version
|
|
1791
|
+
* @version 241.0.0
|
|
1745
1792
|
*//**
|
|
1746
1793
|
* Constructs a new AnalyticsApi.
|
|
1747
1794
|
* @alias module:purecloud-platform-client-v2/api/AnalyticsApi
|
|
@@ -1767,6 +1814,12 @@ if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required param
|
|
|
1767
1814
|
* deleteAnalyticsBotsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
1768
1815
|
*/},{key:"deleteAnalyticsBotsAggregatesJob",value:function deleteAnalyticsBotsAggregatesJob(jobId){// verify the required parameter 'jobId' is set
|
|
1769
1816
|
if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required parameter "jobId" when calling deleteAnalyticsBotsAggregatesJob';}return this.apiClient.callApi('/api/v2/analytics/bots/aggregates/jobs/{jobId}','DELETE',{'jobId':jobId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
1817
|
+
* Delete/cancel an async request for case management aggregates
|
|
1818
|
+
*
|
|
1819
|
+
* @param {String} jobId jobId
|
|
1820
|
+
* deleteAnalyticsCasemanagementAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
1821
|
+
*/},{key:"deleteAnalyticsCasemanagementAggregatesJob",value:function deleteAnalyticsCasemanagementAggregatesJob(jobId){// verify the required parameter 'jobId' is set
|
|
1822
|
+
if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required parameter "jobId" when calling deleteAnalyticsCasemanagementAggregatesJob';}return this.apiClient.callApi('/api/v2/analytics/casemanagement/aggregates/jobs/{jobId}','DELETE',{'jobId':jobId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
1770
1823
|
* Delete/cancel an async request for conversation aggregates
|
|
1771
1824
|
*
|
|
1772
1825
|
* @param {String} jobId jobId
|
|
@@ -1934,6 +1987,20 @@ if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required param
|
|
|
1934
1987
|
* getAnalyticsBotsAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
1935
1988
|
*/},{key:"getAnalyticsBotsAggregatesJobResults",value:function getAnalyticsBotsAggregatesJobResults(jobId,opts){opts=opts||{};// verify the required parameter 'jobId' is set
|
|
1936
1989
|
if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required parameter "jobId" when calling getAnalyticsBotsAggregatesJobResults';}return this.apiClient.callApi('/api/v2/analytics/bots/aggregates/jobs/{jobId}/results','GET',{'jobId':jobId},{'cursor':opts['cursor']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
1990
|
+
* Get status for async query for case management aggregates
|
|
1991
|
+
*
|
|
1992
|
+
* @param {String} jobId jobId
|
|
1993
|
+
* getAnalyticsCasemanagementAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
1994
|
+
*/},{key:"getAnalyticsCasemanagementAggregatesJob",value:function getAnalyticsCasemanagementAggregatesJob(jobId){// verify the required parameter 'jobId' is set
|
|
1995
|
+
if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required parameter "jobId" when calling getAnalyticsCasemanagementAggregatesJob';}return this.apiClient.callApi('/api/v2/analytics/casemanagement/aggregates/jobs/{jobId}','GET',{'jobId':jobId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
1996
|
+
* Fetch a page of results for an async case management query
|
|
1997
|
+
*
|
|
1998
|
+
* @param {String} jobId jobId
|
|
1999
|
+
* @param {Object} opts Optional parameters
|
|
2000
|
+
* @param {String} opts.cursor Cursor token to retrieve next page
|
|
2001
|
+
* getAnalyticsCasemanagementAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2002
|
+
*/},{key:"getAnalyticsCasemanagementAggregatesJobResults",value:function getAnalyticsCasemanagementAggregatesJobResults(jobId,opts){opts=opts||{};// verify the required parameter 'jobId' is set
|
|
2003
|
+
if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required parameter "jobId" when calling getAnalyticsCasemanagementAggregatesJobResults';}return this.apiClient.callApi('/api/v2/analytics/casemanagement/aggregates/jobs/{jobId}/results','GET',{'jobId':jobId},{'cursor':opts['cursor']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
1937
2004
|
* Get a conversation by id
|
|
1938
2005
|
*
|
|
1939
2006
|
* @param {String} conversationId conversationId
|
|
@@ -2265,6 +2332,18 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
2265
2332
|
* @param {Object} body query
|
|
2266
2333
|
*/},{key:"postAnalyticsBotsAggregatesQuery",value:function postAnalyticsBotsAggregatesQuery(body){// verify the required parameter 'body' is set
|
|
2267
2334
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postAnalyticsBotsAggregatesQuery';}return this.apiClient.callApi('/api/v2/analytics/bots/aggregates/query','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
2335
|
+
* Query for case management aggregates asynchronously
|
|
2336
|
+
*
|
|
2337
|
+
* @param {Object} body query
|
|
2338
|
+
* postAnalyticsCasemanagementAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2339
|
+
*/},{key:"postAnalyticsCasemanagementAggregatesJobs",value:function postAnalyticsCasemanagementAggregatesJobs(body){// verify the required parameter 'body' is set
|
|
2340
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postAnalyticsCasemanagementAggregatesJobs';}return this.apiClient.callApi('/api/v2/analytics/casemanagement/aggregates/jobs','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
2341
|
+
* Query for case management aggregates
|
|
2342
|
+
*
|
|
2343
|
+
* @param {Object} body query
|
|
2344
|
+
* postAnalyticsCasemanagementAggregatesQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2345
|
+
*/},{key:"postAnalyticsCasemanagementAggregatesQuery",value:function postAnalyticsCasemanagementAggregatesQuery(body){// verify the required parameter 'body' is set
|
|
2346
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postAnalyticsCasemanagementAggregatesQuery';}return this.apiClient.callApi('/api/v2/analytics/casemanagement/aggregates/query','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
2268
2347
|
* Index conversation properties
|
|
2269
2348
|
*
|
|
2270
2349
|
* @param {String} conversationId conversationId
|
|
@@ -2517,7 +2596,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
2517
2596
|
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(){/**
|
|
2518
2597
|
* Architect service.
|
|
2519
2598
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
2520
|
-
* @version
|
|
2599
|
+
* @version 241.0.0
|
|
2521
2600
|
*//**
|
|
2522
2601
|
* Constructs a new ArchitectApi.
|
|
2523
2602
|
* @alias module:purecloud-platform-client-v2/api/ArchitectApi
|
|
@@ -3651,7 +3730,7 @@ if(milestoneId===undefined||milestoneId===null||milestoneId===''){throw'Missing
|
|
|
3651
3730
|
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(){/**
|
|
3652
3731
|
* Audit service.
|
|
3653
3732
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
3654
|
-
* @version
|
|
3733
|
+
* @version 241.0.0
|
|
3655
3734
|
*//**
|
|
3656
3735
|
* Constructs a new AuditApi.
|
|
3657
3736
|
* @alias module:purecloud-platform-client-v2/api/AuditApi
|
|
@@ -3701,7 +3780,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
3701
3780
|
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(){/**
|
|
3702
3781
|
* Authorization service.
|
|
3703
3782
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
3704
|
-
* @version
|
|
3783
|
+
* @version 241.0.0
|
|
3705
3784
|
*//**
|
|
3706
3785
|
* Constructs a new AuthorizationApi.
|
|
3707
3786
|
* @alias module:purecloud-platform-client-v2/api/AuthorizationApi
|
|
@@ -3720,7 +3799,6 @@ if(divisionId===undefined||divisionId===null||divisionId===''){throw'Missing the
|
|
|
3720
3799
|
*
|
|
3721
3800
|
* @param {String} targetName The domain:entity:action target to which the policy is applied
|
|
3722
3801
|
* @param {String} subjectId The ID of the subject to which the policy is applied
|
|
3723
|
-
* deleteAuthorizationPoliciesTargetSubjectSubjectId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
3724
3802
|
*/},{key:"deleteAuthorizationPoliciesTargetSubjectSubjectId",value:function deleteAuthorizationPoliciesTargetSubjectSubjectId(targetName,subjectId){// verify the required parameter 'targetName' is set
|
|
3725
3803
|
if(targetName===undefined||targetName===null||targetName===''){throw'Missing the required parameter "targetName" when calling deleteAuthorizationPoliciesTargetSubjectSubjectId';}// verify the required parameter 'subjectId' is set
|
|
3726
3804
|
if(subjectId===undefined||subjectId===null||subjectId===''){throw'Missing the required parameter "subjectId" when calling deleteAuthorizationPoliciesTargetSubjectSubjectId';}return this.apiClient.callApi('/api/v2/authorization/policies/targets/{targetName}/subject/{subjectId}','DELETE',{'targetName':targetName,'subjectId':subjectId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
@@ -3827,7 +3905,6 @@ if(permission===undefined||permission===null){throw'Missing the required paramet
|
|
|
3827
3905
|
* @param {Object} opts Optional parameters
|
|
3828
3906
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
3829
3907
|
* @param {Number} opts.pageSize Number of entities to return. Maximum of 200. (default to 25)
|
|
3830
|
-
* getAuthorizationPolicies is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
3831
3908
|
*/},{key:"getAuthorizationPolicies",value:function getAuthorizationPolicies(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/authorization/policies','GET',{},{'after':opts['after'],'pageSize':opts['pageSize']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
3832
3909
|
* Get a page of access policies for a given subject
|
|
3833
3910
|
*
|
|
@@ -3835,7 +3912,6 @@ if(permission===undefined||permission===null){throw'Missing the required paramet
|
|
|
3835
3912
|
* @param {Object} opts Optional parameters
|
|
3836
3913
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
3837
3914
|
* @param {Number} opts.pageSize Number of entities to return. Maximum of 200. (default to 25)
|
|
3838
|
-
* getAuthorizationPoliciesSubjectSubjectId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
3839
3915
|
*/},{key:"getAuthorizationPoliciesSubjectSubjectId",value:function getAuthorizationPoliciesSubjectSubjectId(subjectId,opts){opts=opts||{};// verify the required parameter 'subjectId' is set
|
|
3840
3916
|
if(subjectId===undefined||subjectId===null||subjectId===''){throw'Missing the required parameter "subjectId" when calling getAuthorizationPoliciesSubjectSubjectId';}return this.apiClient.callApi('/api/v2/authorization/policies/subject/{subjectId}','GET',{'subjectId':subjectId},{'after':opts['after'],'pageSize':opts['pageSize']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
3841
3917
|
* Get a page of access policies for a given policy target
|
|
@@ -3844,31 +3920,26 @@ if(subjectId===undefined||subjectId===null||subjectId===''){throw'Missing the re
|
|
|
3844
3920
|
* @param {Object} opts Optional parameters
|
|
3845
3921
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
3846
3922
|
* @param {Number} opts.pageSize Number of entities to return. Maximum of 200. (default to 25)
|
|
3847
|
-
* getAuthorizationPoliciesTarget is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
3848
3923
|
*/},{key:"getAuthorizationPoliciesTarget",value:function getAuthorizationPoliciesTarget(targetName,opts){opts=opts||{};// verify the required parameter 'targetName' is set
|
|
3849
3924
|
if(targetName===undefined||targetName===null||targetName===''){throw'Missing the required parameter "targetName" when calling getAuthorizationPoliciesTarget';}return this.apiClient.callApi('/api/v2/authorization/policies/targets/{targetName}','GET',{'targetName':targetName},{'after':opts['after'],'pageSize':opts['pageSize']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
3850
3925
|
* Get an access control policy for a specified resource target and subject
|
|
3851
3926
|
*
|
|
3852
3927
|
* @param {String} targetName The domain:entity:action resource target to which the policy is applied
|
|
3853
3928
|
* @param {String} subjectId The ID of the subject to which the policy is applied
|
|
3854
|
-
* getAuthorizationPoliciesTargetSubjectSubjectId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
3855
3929
|
*/},{key:"getAuthorizationPoliciesTargetSubjectSubjectId",value:function getAuthorizationPoliciesTargetSubjectSubjectId(targetName,subjectId){// verify the required parameter 'targetName' is set
|
|
3856
3930
|
if(targetName===undefined||targetName===null||targetName===''){throw'Missing the required parameter "targetName" when calling getAuthorizationPoliciesTargetSubjectSubjectId';}// verify the required parameter 'subjectId' is set
|
|
3857
3931
|
if(subjectId===undefined||subjectId===null||subjectId===''){throw'Missing the required parameter "subjectId" when calling getAuthorizationPoliciesTargetSubjectSubjectId';}return this.apiClient.callApi('/api/v2/authorization/policies/targets/{targetName}/subject/{subjectId}','GET',{'targetName':targetName,'subjectId':subjectId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
3858
3932
|
* Get a map of policy targets to valid attributes for those targets
|
|
3859
3933
|
*
|
|
3860
|
-
* getAuthorizationPoliciesTargets is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
3861
3934
|
*/},{key:"getAuthorizationPoliciesTargets",value:function getAuthorizationPoliciesTargets(){return this.apiClient.callApi('/api/v2/authorization/policies/targets','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
3862
3935
|
* Get an access control policy with the specified policy ID
|
|
3863
3936
|
*
|
|
3864
3937
|
* @param {String} policyId The ID of the policy to retrieve
|
|
3865
|
-
* getAuthorizationPolicy is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
3866
3938
|
*/},{key:"getAuthorizationPolicy",value:function getAuthorizationPolicy(policyId){// verify the required parameter 'policyId' is set
|
|
3867
3939
|
if(policyId===undefined||policyId===null||policyId===''){throw'Missing the required parameter "policyId" when calling getAuthorizationPolicy';}return this.apiClient.callApi('/api/v2/authorization/policies/{policyId}','GET',{'policyId':policyId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
3868
3940
|
* Get the list of attributes used to evaluate an access control policy with the specified policy ID
|
|
3869
3941
|
*
|
|
3870
3942
|
* @param {String} policyId The ID of the policy to retrieve attributes
|
|
3871
|
-
* getAuthorizationPolicyAttributes is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
3872
3943
|
*/},{key:"getAuthorizationPolicyAttributes",value:function getAuthorizationPolicyAttributes(policyId){// verify the required parameter 'policyId' is set
|
|
3873
3944
|
if(policyId===undefined||policyId===null||policyId===''){throw'Missing the required parameter "policyId" when calling getAuthorizationPolicyAttributes';}return this.apiClient.callApi('/api/v2/authorization/policies/{policyId}/attributes','GET',{'policyId':policyId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
3874
3945
|
* Get the list of enabled products
|
|
@@ -3989,7 +4060,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
3989
4060
|
*
|
|
3990
4061
|
* @param {String} targetName The domain:entity:action target to which the policy will be applied
|
|
3991
4062
|
* @param {Object} body Access control policy
|
|
3992
|
-
* postAuthorizationPoliciesTarget is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
3993
4063
|
*/},{key:"postAuthorizationPoliciesTarget",value:function postAuthorizationPoliciesTarget(targetName,body){// verify the required parameter 'targetName' is set
|
|
3994
4064
|
if(targetName===undefined||targetName===null||targetName===''){throw'Missing the required parameter "targetName" when calling postAuthorizationPoliciesTarget';}// verify the required parameter 'body' is set
|
|
3995
4065
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postAuthorizationPoliciesTarget';}return this.apiClient.callApi('/api/v2/authorization/policies/targets/{targetName}','POST',{'targetName':targetName},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
@@ -3997,7 +4067,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
3997
4067
|
*
|
|
3998
4068
|
* @param {String} targetName The domain:entity:action target to which the policy will be applied
|
|
3999
4069
|
* @param {Object} body Access control policy
|
|
4000
|
-
* postAuthorizationPoliciesTargetValidate is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
4001
4070
|
*/},{key:"postAuthorizationPoliciesTargetValidate",value:function postAuthorizationPoliciesTargetValidate(targetName,body){// verify the required parameter 'targetName' is set
|
|
4002
4071
|
if(targetName===undefined||targetName===null||targetName===''){throw'Missing the required parameter "targetName" when calling postAuthorizationPoliciesTargetValidate';}// verify the required parameter 'body' is set
|
|
4003
4072
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postAuthorizationPoliciesTargetValidate';}return this.apiClient.callApi('/api/v2/authorization/policies/targets/{targetName}/validate','POST',{'targetName':targetName},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
@@ -4005,7 +4074,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
4005
4074
|
*
|
|
4006
4075
|
* @param {String} policyId The ID of the policy to test the simulated data against
|
|
4007
4076
|
* @param {Object} body A map of attribute names to type and simulated data value
|
|
4008
|
-
* postAuthorizationPolicySimulate is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
4009
4077
|
*/},{key:"postAuthorizationPolicySimulate",value:function postAuthorizationPolicySimulate(policyId,body){// verify the required parameter 'policyId' is set
|
|
4010
4078
|
if(policyId===undefined||policyId===null||policyId===''){throw'Missing the required parameter "policyId" when calling postAuthorizationPolicySimulate';}// verify the required parameter 'body' is set
|
|
4011
4079
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postAuthorizationPolicySimulate';}return this.apiClient.callApi('/api/v2/authorization/policies/{policyId}/simulate','POST',{'policyId':policyId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
@@ -4084,7 +4152,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
4084
4152
|
*
|
|
4085
4153
|
* @param {String} targetName The domain:entity:action target to which the policy will be applied
|
|
4086
4154
|
* @param {Object} body Access control policy
|
|
4087
|
-
* putAuthorizationPoliciesTarget is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
4088
4155
|
*/},{key:"putAuthorizationPoliciesTarget",value:function putAuthorizationPoliciesTarget(targetName,body){// verify the required parameter 'targetName' is set
|
|
4089
4156
|
if(targetName===undefined||targetName===null||targetName===''){throw'Missing the required parameter "targetName" when calling putAuthorizationPoliciesTarget';}// verify the required parameter 'body' is set
|
|
4090
4157
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putAuthorizationPoliciesTarget';}return this.apiClient.callApi('/api/v2/authorization/policies/targets/{targetName}','PUT',{'targetName':targetName},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
@@ -4092,7 +4159,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
4092
4159
|
*
|
|
4093
4160
|
* @param {String} policyId The ID of the policy to update
|
|
4094
4161
|
* @param {Object} body Access control policy
|
|
4095
|
-
* putAuthorizationPolicy is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
4096
4162
|
*/},{key:"putAuthorizationPolicy",value:function putAuthorizationPolicy(policyId,body){// verify the required parameter 'policyId' is set
|
|
4097
4163
|
if(policyId===undefined||policyId===null||policyId===''){throw'Missing the required parameter "policyId" when calling putAuthorizationPolicy';}// verify the required parameter 'body' is set
|
|
4098
4164
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putAuthorizationPolicy';}return this.apiClient.callApi('/api/v2/authorization/policies/{policyId}','PUT',{'policyId':policyId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
@@ -4136,7 +4202,7 @@ if(subjectId===undefined||subjectId===null||subjectId===''){throw'Missing the re
|
|
|
4136
4202
|
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(){/**
|
|
4137
4203
|
* Billing service.
|
|
4138
4204
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
4139
|
-
* @version
|
|
4205
|
+
* @version 241.0.0
|
|
4140
4206
|
*//**
|
|
4141
4207
|
* Constructs a new BillingApi.
|
|
4142
4208
|
* @alias module:purecloud-platform-client-v2/api/BillingApi
|
|
@@ -4213,7 +4279,7 @@ if(endDate===undefined||endDate===null){throw'Missing the required parameter "en
|
|
|
4213
4279
|
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(){/**
|
|
4214
4280
|
* BusinessRules service.
|
|
4215
4281
|
* @module purecloud-platform-client-v2/api/BusinessRulesApi
|
|
4216
|
-
* @version
|
|
4282
|
+
* @version 241.0.0
|
|
4217
4283
|
*//**
|
|
4218
4284
|
* Constructs a new BusinessRulesApi.
|
|
4219
4285
|
* @alias module:purecloud-platform-client-v2/api/BusinessRulesApi
|
|
@@ -4434,7 +4500,7 @@ if(schemaId===undefined||schemaId===null||schemaId===''){throw'Missing the requi
|
|
|
4434
4500
|
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(){/**
|
|
4435
4501
|
* CarrierServices service.
|
|
4436
4502
|
* @module purecloud-platform-client-v2/api/CarrierServicesApi
|
|
4437
|
-
* @version
|
|
4503
|
+
* @version 241.0.0
|
|
4438
4504
|
*//**
|
|
4439
4505
|
* Constructs a new CarrierServicesApi.
|
|
4440
4506
|
* @alias module:purecloud-platform-client-v2/api/CarrierServicesApi
|
|
@@ -4454,7 +4520,7 @@ if(phoneNumber===undefined||phoneNumber===null){throw'Missing the required param
|
|
|
4454
4520
|
*/},{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(){/**
|
|
4455
4521
|
* Chat service.
|
|
4456
4522
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
4457
|
-
* @version
|
|
4523
|
+
* @version 241.0.0
|
|
4458
4524
|
*//**
|
|
4459
4525
|
* Constructs a new ChatApi.
|
|
4460
4526
|
* @alias module:purecloud-platform-client-v2/api/ChatApi
|
|
@@ -4685,7 +4751,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
4685
4751
|
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(){/**
|
|
4686
4752
|
* Coaching service.
|
|
4687
4753
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
4688
|
-
* @version
|
|
4754
|
+
* @version 241.0.0
|
|
4689
4755
|
*//**
|
|
4690
4756
|
* Constructs a new CoachingApi.
|
|
4691
4757
|
* @alias module:purecloud-platform-client-v2/api/CoachingApi
|
|
@@ -4848,7 +4914,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
4848
4914
|
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(){/**
|
|
4849
4915
|
* ContentManagement service.
|
|
4850
4916
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
4851
|
-
* @version
|
|
4917
|
+
* @version 241.0.0
|
|
4852
4918
|
*//**
|
|
4853
4919
|
* Constructs a new ContentManagementApi.
|
|
4854
4920
|
* @alias module:purecloud-platform-client-v2/api/ContentManagementApi
|
|
@@ -5130,7 +5196,7 @@ if(tagId===undefined||tagId===null||tagId===''){throw'Missing the required param
|
|
|
5130
5196
|
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(){/**
|
|
5131
5197
|
* Conversations service.
|
|
5132
5198
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
5133
|
-
* @version
|
|
5199
|
+
* @version 241.0.0
|
|
5134
5200
|
*//**
|
|
5135
5201
|
* Constructs a new ConversationsApi.
|
|
5136
5202
|
* @alias module:purecloud-platform-client-v2/api/ConversationsApi
|
|
@@ -5277,6 +5343,33 @@ if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required param
|
|
|
5277
5343
|
* @param {String} conversationId conversation ID
|
|
5278
5344
|
*/},{key:"getConversation",value:function getConversation(conversationId){// verify the required parameter 'conversationId' is set
|
|
5279
5345
|
if(conversationId===undefined||conversationId===null||conversationId===''){throw'Missing the required parameter "conversationId" when calling getConversation';}return this.apiClient.callApi('/api/v2/conversations/{conversationId}','GET',{'conversationId':conversationId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
5346
|
+
* Get checklist info for a single checklist.
|
|
5347
|
+
*
|
|
5348
|
+
* @param {String} conversationId Conversation ID
|
|
5349
|
+
* @param {String} communicationId Communication ID
|
|
5350
|
+
* @param {String} agentChecklistId Agent Checklist ID
|
|
5351
|
+
*/},{key:"getConversationCommunicationAgentchecklist",value:function getConversationCommunicationAgentchecklist(conversationId,communicationId,agentChecklistId){// verify the required parameter 'conversationId' is set
|
|
5352
|
+
if(conversationId===undefined||conversationId===null||conversationId===''){throw'Missing the required parameter "conversationId" when calling getConversationCommunicationAgentchecklist';}// verify the required parameter 'communicationId' is set
|
|
5353
|
+
if(communicationId===undefined||communicationId===null||communicationId===''){throw'Missing the required parameter "communicationId" when calling getConversationCommunicationAgentchecklist';}// verify the required parameter 'agentChecklistId' is set
|
|
5354
|
+
if(agentChecklistId===undefined||agentChecklistId===null||agentChecklistId===''){throw'Missing the required parameter "agentChecklistId" when calling getConversationCommunicationAgentchecklist';}return this.apiClient.callApi('/api/v2/conversations/{conversationId}/communications/{communicationId}/agentchecklists/{agentChecklistId}','GET',{'conversationId':conversationId,'communicationId':communicationId,'agentChecklistId':agentChecklistId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
5355
|
+
* Get inference job status
|
|
5356
|
+
*
|
|
5357
|
+
* @param {String} conversationId Conversation ID
|
|
5358
|
+
* @param {String} communicationId Communication ID
|
|
5359
|
+
* @param {String} agentChecklistId Agent Checklist ID
|
|
5360
|
+
* @param {String} jobId Inference Job ID
|
|
5361
|
+
*/},{key:"getConversationCommunicationAgentchecklistJob",value:function getConversationCommunicationAgentchecklistJob(conversationId,communicationId,agentChecklistId,jobId){// verify the required parameter 'conversationId' is set
|
|
5362
|
+
if(conversationId===undefined||conversationId===null||conversationId===''){throw'Missing the required parameter "conversationId" when calling getConversationCommunicationAgentchecklistJob';}// verify the required parameter 'communicationId' is set
|
|
5363
|
+
if(communicationId===undefined||communicationId===null||communicationId===''){throw'Missing the required parameter "communicationId" when calling getConversationCommunicationAgentchecklistJob';}// verify the required parameter 'agentChecklistId' is set
|
|
5364
|
+
if(agentChecklistId===undefined||agentChecklistId===null||agentChecklistId===''){throw'Missing the required parameter "agentChecklistId" when calling getConversationCommunicationAgentchecklistJob';}// verify the required parameter 'jobId' is set
|
|
5365
|
+
if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required parameter "jobId" when calling getConversationCommunicationAgentchecklistJob';}return this.apiClient.callApi('/api/v2/conversations/{conversationId}/communications/{communicationId}/agentchecklists/{agentChecklistId}/jobs/{jobId}','GET',{'conversationId':conversationId,'communicationId':communicationId,'agentChecklistId':agentChecklistId,'jobId':jobId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
5366
|
+
* Get information of all checklists associated with a conversation.
|
|
5367
|
+
*
|
|
5368
|
+
* @param {String} conversationId Conversation ID
|
|
5369
|
+
* @param {String} communicationId Communication ID
|
|
5370
|
+
*/},{key:"getConversationCommunicationAgentchecklists",value:function getConversationCommunicationAgentchecklists(conversationId,communicationId){// verify the required parameter 'conversationId' is set
|
|
5371
|
+
if(conversationId===undefined||conversationId===null||conversationId===''){throw'Missing the required parameter "conversationId" when calling getConversationCommunicationAgentchecklists';}// verify the required parameter 'communicationId' is set
|
|
5372
|
+
if(communicationId===undefined||communicationId===null||communicationId===''){throw'Missing the required parameter "communicationId" when calling getConversationCommunicationAgentchecklists';}return this.apiClient.callApi('/api/v2/conversations/{conversationId}/communications/{communicationId}/agentchecklists','GET',{'conversationId':conversationId,'communicationId':communicationId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
5280
5373
|
* Get message
|
|
5281
5374
|
*
|
|
5282
5375
|
* @param {String} conversationId conversationId
|
|
@@ -6395,6 +6488,48 @@ if(conversationId===undefined||conversationId===null||conversationId===''){throw
|
|
|
6395
6488
|
* @param {String} conversationId Conversation ID
|
|
6396
6489
|
*/},{key:"postConversationCobrowse",value:function postConversationCobrowse(conversationId){// verify the required parameter 'conversationId' is set
|
|
6397
6490
|
if(conversationId===undefined||conversationId===null||conversationId===''){throw'Missing the required parameter "conversationId" when calling postConversationCobrowse';}return this.apiClient.callApi('/api/v2/conversations/{conversationId}/cobrowse','POST',{'conversationId':conversationId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
6491
|
+
* Agent Checklist activation API
|
|
6492
|
+
*
|
|
6493
|
+
* @param {String} conversationId Conversation ID
|
|
6494
|
+
* @param {String} communicationId Communication ID
|
|
6495
|
+
* @param {String} agentChecklistId Agent Checklist ID
|
|
6496
|
+
* @param {Object} body Agent checklist activation payload
|
|
6497
|
+
*/},{key:"postConversationCommunicationAgentchecklist",value:function postConversationCommunicationAgentchecklist(conversationId,communicationId,agentChecklistId,body){// verify the required parameter 'conversationId' is set
|
|
6498
|
+
if(conversationId===undefined||conversationId===null||conversationId===''){throw'Missing the required parameter "conversationId" when calling postConversationCommunicationAgentchecklist';}// verify the required parameter 'communicationId' is set
|
|
6499
|
+
if(communicationId===undefined||communicationId===null||communicationId===''){throw'Missing the required parameter "communicationId" when calling postConversationCommunicationAgentchecklist';}// verify the required parameter 'agentChecklistId' is set
|
|
6500
|
+
if(agentChecklistId===undefined||agentChecklistId===null||agentChecklistId===''){throw'Missing the required parameter "agentChecklistId" when calling postConversationCommunicationAgentchecklist';}// verify the required parameter 'body' is set
|
|
6501
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postConversationCommunicationAgentchecklist';}return this.apiClient.callApi('/api/v2/conversations/{conversationId}/communications/{communicationId}/agentchecklists/{agentChecklistId}','POST',{'conversationId':conversationId,'communicationId':communicationId,'agentChecklistId':agentChecklistId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
6502
|
+
* API invoked to capture an agent action.
|
|
6503
|
+
*
|
|
6504
|
+
* @param {String} conversationId Conversation ID
|
|
6505
|
+
* @param {String} communicationId Communication ID
|
|
6506
|
+
* @param {String} agentChecklistId Agent Checklist ID
|
|
6507
|
+
* @param {Object} body Agent action payload
|
|
6508
|
+
*/},{key:"postConversationCommunicationAgentchecklistAgentaction",value:function postConversationCommunicationAgentchecklistAgentaction(conversationId,communicationId,agentChecklistId,body){// verify the required parameter 'conversationId' is set
|
|
6509
|
+
if(conversationId===undefined||conversationId===null||conversationId===''){throw'Missing the required parameter "conversationId" when calling postConversationCommunicationAgentchecklistAgentaction';}// verify the required parameter 'communicationId' is set
|
|
6510
|
+
if(communicationId===undefined||communicationId===null||communicationId===''){throw'Missing the required parameter "communicationId" when calling postConversationCommunicationAgentchecklistAgentaction';}// verify the required parameter 'agentChecklistId' is set
|
|
6511
|
+
if(agentChecklistId===undefined||agentChecklistId===null||agentChecklistId===''){throw'Missing the required parameter "agentChecklistId" when calling postConversationCommunicationAgentchecklistAgentaction';}// verify the required parameter 'body' is set
|
|
6512
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postConversationCommunicationAgentchecklistAgentaction';}return this.apiClient.callApi('/api/v2/conversations/{conversationId}/communications/{communicationId}/agentchecklists/{agentChecklistId}/agentaction','POST',{'conversationId':conversationId,'communicationId':communicationId,'agentChecklistId':agentChecklistId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
6513
|
+
* Create inference job
|
|
6514
|
+
*
|
|
6515
|
+
* @param {String} conversationId Conversation ID
|
|
6516
|
+
* @param {String} communicationId Communication ID
|
|
6517
|
+
* @param {String} agentChecklistId Agent Checklist ID
|
|
6518
|
+
* @param {Object} body Agent checklist inference job payload
|
|
6519
|
+
*/},{key:"postConversationCommunicationAgentchecklistJobs",value:function postConversationCommunicationAgentchecklistJobs(conversationId,communicationId,agentChecklistId,body){// verify the required parameter 'conversationId' is set
|
|
6520
|
+
if(conversationId===undefined||conversationId===null||conversationId===''){throw'Missing the required parameter "conversationId" when calling postConversationCommunicationAgentchecklistJobs';}// verify the required parameter 'communicationId' is set
|
|
6521
|
+
if(communicationId===undefined||communicationId===null||communicationId===''){throw'Missing the required parameter "communicationId" when calling postConversationCommunicationAgentchecklistJobs';}// verify the required parameter 'agentChecklistId' is set
|
|
6522
|
+
if(agentChecklistId===undefined||agentChecklistId===null||agentChecklistId===''){throw'Missing the required parameter "agentChecklistId" when calling postConversationCommunicationAgentchecklistJobs';}// verify the required parameter 'body' is set
|
|
6523
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postConversationCommunicationAgentchecklistJobs';}return this.apiClient.callApi('/api/v2/conversations/{conversationId}/communications/{communicationId}/agentchecklists/{agentChecklistId}/jobs','POST',{'conversationId':conversationId,'communicationId':communicationId,'agentChecklistId':agentChecklistId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
6524
|
+
* API invoked to finalize agent checklist evaluation.
|
|
6525
|
+
*
|
|
6526
|
+
* @param {String} conversationId Conversation ID
|
|
6527
|
+
* @param {String} communicationId Communication ID
|
|
6528
|
+
* @param {Object} body Agent checklist finalize payload
|
|
6529
|
+
*/},{key:"postConversationCommunicationAgentchecklistsFinalize",value:function postConversationCommunicationAgentchecklistsFinalize(conversationId,communicationId,body){// verify the required parameter 'conversationId' is set
|
|
6530
|
+
if(conversationId===undefined||conversationId===null||conversationId===''){throw'Missing the required parameter "conversationId" when calling postConversationCommunicationAgentchecklistsFinalize';}// verify the required parameter 'communicationId' is set
|
|
6531
|
+
if(communicationId===undefined||communicationId===null||communicationId===''){throw'Missing the required parameter "communicationId" when calling postConversationCommunicationAgentchecklistsFinalize';}// verify the required parameter 'body' is set
|
|
6532
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postConversationCommunicationAgentchecklistsFinalize';}return this.apiClient.callApi('/api/v2/conversations/{conversationId}/communications/{communicationId}/agentchecklists/finalize','POST',{'conversationId':conversationId,'communicationId':communicationId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
6398
6533
|
* Send internal message
|
|
6399
6534
|
* Send a new internal message for an existing communication.
|
|
6400
6535
|
* @param {String} conversationId conversationId
|
|
@@ -6436,11 +6571,12 @@ if(participantId===undefined||participantId===null||participantId===''){throw'Mi
|
|
|
6436
6571
|
if(conversationId===undefined||conversationId===null||conversationId===''){throw'Missing the required parameter "conversationId" when calling postConversationParticipantInternalmessagesUsersCommunications';}// verify the required parameter 'participantId' is set
|
|
6437
6572
|
if(participantId===undefined||participantId===null||participantId===''){throw'Missing the required parameter "participantId" when calling postConversationParticipantInternalmessagesUsersCommunications';}// verify the required parameter 'body' is set
|
|
6438
6573
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postConversationParticipantInternalmessagesUsersCommunications';}return this.apiClient.callApi('/api/v2/conversations/{conversationId}/participants/{participantId}/internalmessages/users/communications','POST',{'conversationId':conversationId,'participantId':participantId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
6439
|
-
* Replace this participant
|
|
6440
|
-
*
|
|
6574
|
+
* Replace this participant (Deprecated)
|
|
6575
|
+
* This endpoint is deprecated. Use one of the following endpoints instead: /transfer, /replace/agent, /replace/queue, or /replace/contact/external.
|
|
6441
6576
|
* @param {String} conversationId conversation ID
|
|
6442
6577
|
* @param {String} participantId participant ID
|
|
6443
6578
|
* @param {Object} body Transfer request
|
|
6579
|
+
* @deprecated
|
|
6444
6580
|
*/},{key:"postConversationParticipantReplace",value:function postConversationParticipantReplace(conversationId,participantId,body){// verify the required parameter 'conversationId' is set
|
|
6445
6581
|
if(conversationId===undefined||conversationId===null||conversationId===''){throw'Missing the required parameter "conversationId" when calling postConversationParticipantReplace';}// verify the required parameter 'participantId' is set
|
|
6446
6582
|
if(participantId===undefined||participantId===null||participantId===''){throw'Missing the required parameter "participantId" when calling postConversationParticipantReplace';}// verify the required parameter 'body' is set
|
|
@@ -6459,16 +6595,16 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
6459
6595
|
* @param {String} conversationId conversation ID
|
|
6460
6596
|
* @param {String} participantId participant ID
|
|
6461
6597
|
* @param {Object} body Transfer request
|
|
6462
|
-
* postConversationParticipantReplaceContactExternal is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
6463
6598
|
*/},{key:"postConversationParticipantReplaceContactExternal",value:function postConversationParticipantReplaceContactExternal(conversationId,participantId,body){// verify the required parameter 'conversationId' is set
|
|
6464
6599
|
if(conversationId===undefined||conversationId===null||conversationId===''){throw'Missing the required parameter "conversationId" when calling postConversationParticipantReplaceContactExternal';}// verify the required parameter 'participantId' is set
|
|
6465
6600
|
if(participantId===undefined||participantId===null||participantId===''){throw'Missing the required parameter "participantId" when calling postConversationParticipantReplaceContactExternal';}// verify the required parameter 'body' is set
|
|
6466
6601
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postConversationParticipantReplaceContactExternal';}return this.apiClient.callApi('/api/v2/conversations/{conversationId}/participants/{participantId}/replace/contact/external','POST',{'conversationId':conversationId,'participantId':participantId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
6467
|
-
* Replace this participant with the an external contact
|
|
6468
|
-
*
|
|
6602
|
+
* Replace this participant with the an external contact (Deprecated)
|
|
6603
|
+
* This endpoint is deprecated. Use /replace/contact/external endpoint instead.
|
|
6469
6604
|
* @param {String} conversationId conversation ID
|
|
6470
6605
|
* @param {String} participantId participant ID
|
|
6471
6606
|
* @param {Object} body Transfer request
|
|
6607
|
+
* @deprecated
|
|
6472
6608
|
*/},{key:"postConversationParticipantReplaceExternal",value:function postConversationParticipantReplaceExternal(conversationId,participantId,body){// verify the required parameter 'conversationId' is set
|
|
6473
6609
|
if(conversationId===undefined||conversationId===null||conversationId===''){throw'Missing the required parameter "conversationId" when calling postConversationParticipantReplaceExternal';}// verify the required parameter 'participantId' is set
|
|
6474
6610
|
if(participantId===undefined||participantId===null||participantId===''){throw'Missing the required parameter "participantId" when calling postConversationParticipantReplaceExternal';}// verify the required parameter 'body' is set
|
|
@@ -6496,7 +6632,6 @@ if(participantId===undefined||participantId===null||participantId===''){throw'Mi
|
|
|
6496
6632
|
* @param {String} conversationId conversation ID
|
|
6497
6633
|
* @param {String} participantId participant ID
|
|
6498
6634
|
* @param {Object} body Transfer request
|
|
6499
|
-
* postConversationParticipantTransfer is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
6500
6635
|
*/},{key:"postConversationParticipantTransfer",value:function postConversationParticipantTransfer(conversationId,participantId,body){// verify the required parameter 'conversationId' is set
|
|
6501
6636
|
if(conversationId===undefined||conversationId===null||conversationId===''){throw'Missing the required parameter "conversationId" when calling postConversationParticipantTransfer';}// verify the required parameter 'participantId' is set
|
|
6502
6637
|
if(participantId===undefined||participantId===null||participantId===''){throw'Missing the required parameter "participantId" when calling postConversationParticipantTransfer';}// verify the required parameter 'body' is set
|
|
@@ -6559,11 +6694,12 @@ if(participantId===undefined||participantId===null||participantId===''){throw'Mi
|
|
|
6559
6694
|
if(conversationId===undefined||conversationId===null||conversationId===''){throw'Missing the required parameter "conversationId" when calling postConversationsCallParticipantCommunicationWrapup';}// verify the required parameter 'participantId' is set
|
|
6560
6695
|
if(participantId===undefined||participantId===null||participantId===''){throw'Missing the required parameter "participantId" when calling postConversationsCallParticipantCommunicationWrapup';}// verify the required parameter 'communicationId' is set
|
|
6561
6696
|
if(communicationId===undefined||communicationId===null||communicationId===''){throw'Missing the required parameter "communicationId" when calling postConversationsCallParticipantCommunicationWrapup';}return this.apiClient.callApi('/api/v2/conversations/calls/{conversationId}/participants/{participantId}/communications/{communicationId}/wrapup','POST',{'conversationId':conversationId,'participantId':participantId,'communicationId':communicationId},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
6562
|
-
* Initiate and update consult transfer
|
|
6563
|
-
*
|
|
6697
|
+
* Initiate and update consult transfer (Deprecated)
|
|
6698
|
+
* This endpoint is deprecated. Use one of the following endpoints instead: /voice/consult, /consult/agent, /consult/queue, or /consult/contact/external.
|
|
6564
6699
|
* @param {String} conversationId conversationId
|
|
6565
6700
|
* @param {String} participantId participantId
|
|
6566
6701
|
* @param {Object} body Destination address and initial speak to
|
|
6702
|
+
* @deprecated
|
|
6567
6703
|
*/},{key:"postConversationsCallParticipantConsult",value:function postConversationsCallParticipantConsult(conversationId,participantId,body){// verify the required parameter 'conversationId' is set
|
|
6568
6704
|
if(conversationId===undefined||conversationId===null||conversationId===''){throw'Missing the required parameter "conversationId" when calling postConversationsCallParticipantConsult';}// verify the required parameter 'participantId' is set
|
|
6569
6705
|
if(participantId===undefined||participantId===null||participantId===''){throw'Missing the required parameter "participantId" when calling postConversationsCallParticipantConsult';}// verify the required parameter 'body' is set
|
|
@@ -6582,16 +6718,16 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
6582
6718
|
* @param {String} conversationId conversationId
|
|
6583
6719
|
* @param {String} participantId participantId
|
|
6584
6720
|
* @param {Object} body Destination address and initial speak to
|
|
6585
|
-
* postConversationsCallParticipantConsultContactExternal is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
6586
6721
|
*/},{key:"postConversationsCallParticipantConsultContactExternal",value:function postConversationsCallParticipantConsultContactExternal(conversationId,participantId,body){// verify the required parameter 'conversationId' is set
|
|
6587
6722
|
if(conversationId===undefined||conversationId===null||conversationId===''){throw'Missing the required parameter "conversationId" when calling postConversationsCallParticipantConsultContactExternal';}// verify the required parameter 'participantId' is set
|
|
6588
6723
|
if(participantId===undefined||participantId===null||participantId===''){throw'Missing the required parameter "participantId" when calling postConversationsCallParticipantConsultContactExternal';}// verify the required parameter 'body' is set
|
|
6589
6724
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postConversationsCallParticipantConsultContactExternal';}return this.apiClient.callApi('/api/v2/conversations/calls/{conversationId}/participants/{participantId}/consult/contact/external','POST',{'conversationId':conversationId,'participantId':participantId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
6590
|
-
* Initiate a consult transfer to an external contact
|
|
6591
|
-
*
|
|
6725
|
+
* Initiate a consult transfer to an external contact (Deprecated)
|
|
6726
|
+
* This endpoint is deprecated. Use /consult/contact/external endpoints instead.
|
|
6592
6727
|
* @param {String} conversationId conversationId
|
|
6593
6728
|
* @param {String} participantId participantId
|
|
6594
6729
|
* @param {Object} body Destination address and initial speak to
|
|
6730
|
+
* @deprecated
|
|
6595
6731
|
*/},{key:"postConversationsCallParticipantConsultExternal",value:function postConversationsCallParticipantConsultExternal(conversationId,participantId,body){// verify the required parameter 'conversationId' is set
|
|
6596
6732
|
if(conversationId===undefined||conversationId===null||conversationId===''){throw'Missing the required parameter "conversationId" when calling postConversationsCallParticipantConsultExternal';}// verify the required parameter 'participantId' is set
|
|
6597
6733
|
if(participantId===undefined||participantId===null||participantId===''){throw'Missing the required parameter "participantId" when calling postConversationsCallParticipantConsultExternal';}// verify the required parameter 'body' is set
|
|
@@ -6626,7 +6762,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
6626
6762
|
* @param {String} conversationId conversationId
|
|
6627
6763
|
* @param {String} participantId participantId
|
|
6628
6764
|
* @param {Object} body Destination address and initial speak to
|
|
6629
|
-
* postConversationsCallParticipantVoiceConsult is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
6630
6765
|
*/},{key:"postConversationsCallParticipantVoiceConsult",value:function postConversationsCallParticipantVoiceConsult(conversationId,participantId,body){// verify the required parameter 'conversationId' is set
|
|
6631
6766
|
if(conversationId===undefined||conversationId===null||conversationId===''){throw'Missing the required parameter "conversationId" when calling postConversationsCallParticipantVoiceConsult';}// verify the required parameter 'participantId' is set
|
|
6632
6767
|
if(participantId===undefined||participantId===null||participantId===''){throw'Missing the required parameter "participantId" when calling postConversationsCallParticipantVoiceConsult';}// verify the required parameter 'body' is set
|
|
@@ -7231,7 +7366,7 @@ if(conversationId===undefined||conversationId===null||conversationId===''){throw
|
|
|
7231
7366
|
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(){/**
|
|
7232
7367
|
* DataExtensions service.
|
|
7233
7368
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
7234
|
-
* @version
|
|
7369
|
+
* @version 241.0.0
|
|
7235
7370
|
*//**
|
|
7236
7371
|
* Constructs a new DataExtensionsApi.
|
|
7237
7372
|
* @alias module:purecloud-platform-client-v2/api/DataExtensionsApi
|
|
@@ -7252,7 +7387,7 @@ if(coretypeName===undefined||coretypeName===null||coretypeName===''){throw'Missi
|
|
|
7252
7387
|
*/},{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(){/**
|
|
7253
7388
|
* DataPrivacy service.
|
|
7254
7389
|
* @module purecloud-platform-client-v2/api/DataPrivacyApi
|
|
7255
|
-
* @version
|
|
7390
|
+
* @version 241.0.0
|
|
7256
7391
|
*//**
|
|
7257
7392
|
* Constructs a new DataPrivacyApi.
|
|
7258
7393
|
* @alias module:purecloud-platform-client-v2/api/DataPrivacyApi
|
|
@@ -7292,7 +7427,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
7292
7427
|
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(){/**
|
|
7293
7428
|
* Downloads service.
|
|
7294
7429
|
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
7295
|
-
* @version
|
|
7430
|
+
* @version 241.0.0
|
|
7296
7431
|
*//**
|
|
7297
7432
|
* Constructs a new DownloadsApi.
|
|
7298
7433
|
* @alias module:purecloud-platform-client-v2/api/DownloadsApi
|
|
@@ -7311,7 +7446,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
7311
7446
|
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(){/**
|
|
7312
7447
|
* Emails service.
|
|
7313
7448
|
* @module purecloud-platform-client-v2/api/EmailsApi
|
|
7314
|
-
* @version
|
|
7449
|
+
* @version 241.0.0
|
|
7315
7450
|
*//**
|
|
7316
7451
|
* Constructs a new EmailsApi.
|
|
7317
7452
|
* @alias module:purecloud-platform-client-v2/api/EmailsApi
|
|
@@ -7340,7 +7475,7 @@ if(downloadId===undefined||downloadId===null||downloadId===''){throw'Missing the
|
|
|
7340
7475
|
*/},{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(){/**
|
|
7341
7476
|
* EmployeeEngagement service.
|
|
7342
7477
|
* @module purecloud-platform-client-v2/api/EmployeeEngagementApi
|
|
7343
|
-
* @version
|
|
7478
|
+
* @version 241.0.0
|
|
7344
7479
|
*//**
|
|
7345
7480
|
* Constructs a new EmployeeEngagementApi.
|
|
7346
7481
|
* @alias module:purecloud-platform-client-v2/api/EmployeeEngagementApi
|
|
@@ -7364,6 +7499,16 @@ if(celebrationId===undefined||celebrationId===null||celebrationId===''){throw'Mi
|
|
|
7364
7499
|
* @param {String} recognitionId The Recognition ID
|
|
7365
7500
|
*/},{key:"getEmployeeengagementRecognition",value:function getEmployeeengagementRecognition(recognitionId){// verify the required parameter 'recognitionId' is set
|
|
7366
7501
|
if(recognitionId===undefined||recognitionId===null||recognitionId===''){throw'Missing the required parameter "recognitionId" when calling getEmployeeengagementRecognition';}return this.apiClient.callApi('/api/v2/employeeengagement/recognitions/{recognitionId}','GET',{'recognitionId':recognitionId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
7502
|
+
* Gets sent recognitions
|
|
7503
|
+
*
|
|
7504
|
+
* @param {Object} opts Optional parameters
|
|
7505
|
+
* @param {Object} opts.direction The direction of the recognitions. (default to received)
|
|
7506
|
+
* @param {String} opts.recipient The ID of the recipient (when direction is sent).
|
|
7507
|
+
* @param {Date} opts.dateStart The start date of the search range. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
|
|
7508
|
+
* @param {Date} opts.dateEnd The end date of the search range. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
|
|
7509
|
+
* @param {Number} opts.pageSize Page size (default to 100)
|
|
7510
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
7511
|
+
*/},{key:"getEmployeeengagementRecognitions",value:function getEmployeeengagementRecognitions(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/employeeengagement/recognitions','GET',{},{'direction':opts['direction'],'recipient':opts['recipient'],'dateStart':opts['dateStart'],'dateEnd':opts['dateEnd'],'pageSize':opts['pageSize'],'pageNumber':opts['pageNumber']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
7367
7512
|
* Set a state for a celebration
|
|
7368
7513
|
*
|
|
7369
7514
|
* @param {String} celebrationId The ID of the celebration
|
|
@@ -7378,7 +7523,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
7378
7523
|
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(){/**
|
|
7379
7524
|
* Events service.
|
|
7380
7525
|
* @module purecloud-platform-client-v2/api/EventsApi
|
|
7381
|
-
* @version
|
|
7526
|
+
* @version 241.0.0
|
|
7382
7527
|
*//**
|
|
7383
7528
|
* Constructs a new EventsApi.
|
|
7384
7529
|
* @alias module:purecloud-platform-client-v2/api/EventsApi
|
|
@@ -7403,7 +7548,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
7403
7548
|
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(){/**
|
|
7404
7549
|
* ExternalContacts service.
|
|
7405
7550
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
7406
|
-
* @version
|
|
7551
|
+
* @version 241.0.0
|
|
7407
7552
|
*//**
|
|
7408
7553
|
* Constructs a new ExternalContactsApi.
|
|
7409
7554
|
* @alias module:purecloud-platform-client-v2/api/ExternalContactsApi
|
|
@@ -8153,7 +8298,7 @@ if(relationshipId===undefined||relationshipId===null||relationshipId===''){throw
|
|
|
8153
8298
|
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(){/**
|
|
8154
8299
|
* Fax service.
|
|
8155
8300
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
8156
|
-
* @version
|
|
8301
|
+
* @version 241.0.0
|
|
8157
8302
|
*//**
|
|
8158
8303
|
* Constructs a new FaxApi.
|
|
8159
8304
|
* @alias module:purecloud-platform-client-v2/api/FaxApi
|
|
@@ -8202,7 +8347,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
8202
8347
|
*/},{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(){/**
|
|
8203
8348
|
* Flows service.
|
|
8204
8349
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
8205
|
-
* @version
|
|
8350
|
+
* @version 241.0.0
|
|
8206
8351
|
*//**
|
|
8207
8352
|
* Constructs a new FlowsApi.
|
|
8208
8353
|
* @alias module:purecloud-platform-client-v2/api/FlowsApi
|
|
@@ -8256,7 +8401,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
8256
8401
|
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(){/**
|
|
8257
8402
|
* Gamification service.
|
|
8258
8403
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
8259
|
-
* @version
|
|
8404
|
+
* @version 241.0.0
|
|
8260
8405
|
*//**
|
|
8261
8406
|
* Constructs a new GamificationApi.
|
|
8262
8407
|
* @alias module:purecloud-platform-client-v2/api/GamificationApi
|
|
@@ -8927,7 +9072,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
8927
9072
|
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(){/**
|
|
8928
9073
|
* GeneralDataProtectionRegulation service.
|
|
8929
9074
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
8930
|
-
* @version
|
|
9075
|
+
* @version 241.0.0
|
|
8931
9076
|
*//**
|
|
8932
9077
|
* Constructs a new GeneralDataProtectionRegulationApi.
|
|
8933
9078
|
* @alias module:purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
@@ -8962,7 +9107,7 @@ if(searchValue===undefined||searchValue===null){throw'Missing the required param
|
|
|
8962
9107
|
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(){/**
|
|
8963
9108
|
* Geolocation service.
|
|
8964
9109
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
8965
|
-
* @version
|
|
9110
|
+
* @version 241.0.0
|
|
8966
9111
|
*//**
|
|
8967
9112
|
* Constructs a new GeolocationApi.
|
|
8968
9113
|
* @alias module:purecloud-platform-client-v2/api/GeolocationApi
|
|
@@ -8996,7 +9141,7 @@ if(clientId===undefined||clientId===null||clientId===''){throw'Missing the requi
|
|
|
8996
9141
|
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(){/**
|
|
8997
9142
|
* Greetings service.
|
|
8998
9143
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
8999
|
-
* @version
|
|
9144
|
+
* @version 241.0.0
|
|
9000
9145
|
*//**
|
|
9001
9146
|
* Constructs a new GreetingsApi.
|
|
9002
9147
|
* @alias module:purecloud-platform-client-v2/api/GreetingsApi
|
|
@@ -9124,7 +9269,7 @@ if(userId===undefined||userId===null||userId===''){throw'Missing the required pa
|
|
|
9124
9269
|
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(){/**
|
|
9125
9270
|
* Groups service.
|
|
9126
9271
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
9127
|
-
* @version
|
|
9272
|
+
* @version 241.0.0
|
|
9128
9273
|
*//**
|
|
9129
9274
|
* Constructs a new GroupsApi.
|
|
9130
9275
|
* @alias module:purecloud-platform-client-v2/api/GroupsApi
|
|
@@ -9257,7 +9402,7 @@ if(groupId===undefined||groupId===null||groupId===''){throw'Missing the required
|
|
|
9257
9402
|
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(){/**
|
|
9258
9403
|
* IdentityProvider service.
|
|
9259
9404
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
9260
|
-
* @version
|
|
9405
|
+
* @version 241.0.0
|
|
9261
9406
|
*//**
|
|
9262
9407
|
* Constructs a new IdentityProviderApi.
|
|
9263
9408
|
* @alias module:purecloud-platform-client-v2/api/IdentityProviderApi
|
|
@@ -9413,7 +9558,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
9413
9558
|
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(){/**
|
|
9414
9559
|
* InfrastructureAsCode service.
|
|
9415
9560
|
* @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
9416
|
-
* @version
|
|
9561
|
+
* @version 241.0.0
|
|
9417
9562
|
*//**
|
|
9418
9563
|
* Constructs a new InfrastructureAsCodeApi.
|
|
9419
9564
|
* @alias module:purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
@@ -9467,7 +9612,7 @@ if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required param
|
|
|
9467
9612
|
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(){/**
|
|
9468
9613
|
* Integrations service.
|
|
9469
9614
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
9470
|
-
* @version
|
|
9615
|
+
* @version 241.0.0
|
|
9471
9616
|
*//**
|
|
9472
9617
|
* Constructs a new IntegrationsApi.
|
|
9473
9618
|
* @alias module:purecloud-platform-client-v2/api/IntegrationsApi
|
|
@@ -10157,7 +10302,7 @@ if(ucIntegrationId===undefined||ucIntegrationId===null||ucIntegrationId===''){th
|
|
|
10157
10302
|
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(){/**
|
|
10158
10303
|
* Journey service.
|
|
10159
10304
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
10160
|
-
* @version
|
|
10305
|
+
* @version 241.0.0
|
|
10161
10306
|
*//**
|
|
10162
10307
|
* Constructs a new JourneyApi.
|
|
10163
10308
|
* @alias module:purecloud-platform-client-v2/api/JourneyApi
|
|
@@ -10254,7 +10399,7 @@ if(actionMapId===undefined||actionMapId===null||actionMapId===''){throw'Missing
|
|
|
10254
10399
|
* @param {String} opts.filterValue Value to filter by. Requires 'filterValue' to also be set.
|
|
10255
10400
|
* @param {Array.<String>} opts.actionMapIds IDs of action maps to return. Use of this parameter is not compatible with pagination, filtering, sorting or querying. A maximum of 100 action maps are allowed per request.
|
|
10256
10401
|
* @param {Array.<String>} opts.queryFields Action Map field(s) to query on. Requires 'queryValue' to also be set.
|
|
10257
|
-
* @param {String} opts.queryValue Value to query on. Requires 'queryFields' to also be set.
|
|
10402
|
+
* @param {String} opts.queryValue Value to query on using fuzzy matching. Requires 'queryFields' to also be set.
|
|
10258
10403
|
*/},{key:"getJourneyActionmaps",value:function getJourneyActionmaps(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/journey/actionmaps','GET',{},{'pageNumber':opts['pageNumber'],'pageSize':opts['pageSize'],'sortBy':opts['sortBy'],'filterField':opts['filterField'],'filterValue':opts['filterValue'],'actionMapIds':this.apiClient.buildCollectionParam(opts['actionMapIds'],'multi'),'queryFields':this.apiClient.buildCollectionParam(opts['queryFields'],'multi'),'queryValue':opts['queryValue']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
10259
10404
|
* Get status of job.
|
|
10260
10405
|
*
|
|
@@ -10291,7 +10436,7 @@ if(actionTemplateId===undefined||actionTemplateId===null||actionTemplateId==='')
|
|
|
10291
10436
|
* @param {Object} opts.mediaType Media type
|
|
10292
10437
|
* @param {Object} opts.state Action template state.
|
|
10293
10438
|
* @param {Array.<String>} opts.queryFields ActionTemplate field(s) to query on. Requires 'queryValue' to also be set.
|
|
10294
|
-
* @param {String} opts.queryValue Value to query on. Requires 'queryFields' to also be set.
|
|
10439
|
+
* @param {String} opts.queryValue Value to query on using fuzzy matching. Requires 'queryFields' to also be set.
|
|
10295
10440
|
*/},{key:"getJourneyActiontemplates",value:function getJourneyActiontemplates(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/journey/actiontemplates','GET',{},{'pageNumber':opts['pageNumber'],'pageSize':opts['pageSize'],'sortBy':opts['sortBy'],'mediaType':opts['mediaType'],'state':opts['state'],'queryFields':this.apiClient.buildCollectionParam(opts['queryFields'],'multi'),'queryValue':opts['queryValue']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
10296
10441
|
* Send a ping.
|
|
10297
10442
|
*
|
|
@@ -10319,7 +10464,7 @@ if(outcomeId===undefined||outcomeId===null||outcomeId===''){throw'Missing the re
|
|
|
10319
10464
|
* @param {String} opts.sortBy Field(s) to sort by. The response can be sorted by any first level property on the Outcome response. Prefix with '-' for descending (e.g. sortBy=displayName,-createdDate).
|
|
10320
10465
|
* @param {Array.<String>} opts.outcomeIds IDs of outcomes to return. Use of this parameter is not compatible with pagination, sorting or querying. A maximum of 20 outcomes are allowed per request.
|
|
10321
10466
|
* @param {Array.<String>} opts.queryFields Outcome field(s) to query on. Requires 'queryValue' to also be set.
|
|
10322
|
-
* @param {String} opts.queryValue Value to query on. Requires 'queryFields' to also be set.
|
|
10467
|
+
* @param {String} opts.queryValue Value to query on using fuzzy matching. Requires 'queryFields' to also be set.
|
|
10323
10468
|
*/},{key:"getJourneyOutcomes",value:function getJourneyOutcomes(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/journey/outcomes','GET',{},{'pageNumber':opts['pageNumber'],'pageSize':opts['pageSize'],'sortBy':opts['sortBy'],'outcomeIds':this.apiClient.buildCollectionParam(opts['outcomeIds'],'multi'),'queryFields':this.apiClient.buildCollectionParam(opts['queryFields'],'multi'),'queryValue':opts['queryValue']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
10324
10469
|
* Get job status.
|
|
10325
10470
|
*
|
|
@@ -10355,7 +10500,7 @@ if(segmentId===undefined||segmentId===null||segmentId===''){throw'Missing the re
|
|
|
10355
10500
|
* @param {Boolean} opts.isActive Determines whether or not to show only active segments.
|
|
10356
10501
|
* @param {Array.<String>} opts.segmentIds IDs of segments to return. Use of this parameter is not compatible with pagination, sorting or querying. A maximum of 100 segments are allowed per request.
|
|
10357
10502
|
* @param {Array.<String>} opts.queryFields Segment field(s) to query on. Requires 'queryValue' to also be set.
|
|
10358
|
-
* @param {String} opts.queryValue Value to query on. Requires 'queryFields' to also be set.
|
|
10503
|
+
* @param {String} opts.queryValue Value to query on using fuzzy matching. Requires 'queryFields' to also be set.
|
|
10359
10504
|
*/},{key:"getJourneySegments",value:function getJourneySegments(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/journey/segments','GET',{},{'sortBy':opts['sortBy'],'pageSize':opts['pageSize'],'pageNumber':opts['pageNumber'],'isActive':opts['isActive'],'segmentIds':this.apiClient.buildCollectionParam(opts['segmentIds'],'multi'),'queryFields':this.apiClient.buildCollectionParam(opts['queryFields'],'multi'),'queryValue':opts['queryValue']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
10360
10505
|
* Retrieve a single session.
|
|
10361
10506
|
*
|
|
@@ -10666,7 +10811,7 @@ if(versionId===undefined||versionId===null||versionId===''){throw'Missing the re
|
|
|
10666
10811
|
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(){/**
|
|
10667
10812
|
* Knowledge service.
|
|
10668
10813
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
10669
|
-
* @version
|
|
10814
|
+
* @version 241.0.0
|
|
10670
10815
|
*//**
|
|
10671
10816
|
* Constructs a new KnowledgeApi.
|
|
10672
10817
|
* @alias module:purecloud-platform-client-v2/api/KnowledgeApi
|
|
@@ -11494,7 +11639,7 @@ if(sourceId===undefined||sourceId===null||sourceId===''){throw'Missing the requi
|
|
|
11494
11639
|
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(){/**
|
|
11495
11640
|
* LanguageUnderstanding service.
|
|
11496
11641
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
11497
|
-
* @version
|
|
11642
|
+
* @version 241.0.0
|
|
11498
11643
|
*//**
|
|
11499
11644
|
* Constructs a new LanguageUnderstandingApi.
|
|
11500
11645
|
* @alias module:purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
@@ -11803,7 +11948,7 @@ if(domainVersionId===undefined||domainVersionId===null||domainVersionId===''){th
|
|
|
11803
11948
|
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(){/**
|
|
11804
11949
|
* Languages service.
|
|
11805
11950
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
11806
|
-
* @version
|
|
11951
|
+
* @version 241.0.0
|
|
11807
11952
|
*//**
|
|
11808
11953
|
* Constructs a new LanguagesApi.
|
|
11809
11954
|
* @alias module:purecloud-platform-client-v2/api/LanguagesApi
|
|
@@ -11858,7 +12003,7 @@ if(userId===undefined||userId===null||userId===''){throw'Missing the required pa
|
|
|
11858
12003
|
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(){/**
|
|
11859
12004
|
* Learning service.
|
|
11860
12005
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
11861
|
-
* @version
|
|
12006
|
+
* @version 241.0.0
|
|
11862
12007
|
*//**
|
|
11863
12008
|
* Constructs a new LearningApi.
|
|
11864
12009
|
* @alias module:purecloud-platform-client-v2/api/LearningApi
|
|
@@ -12147,7 +12292,7 @@ if(moduleId===undefined||moduleId===null||moduleId===''){throw'Missing the requi
|
|
|
12147
12292
|
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(){/**
|
|
12148
12293
|
* License service.
|
|
12149
12294
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
12150
|
-
* @version
|
|
12295
|
+
* @version 241.0.0
|
|
12151
12296
|
*//**
|
|
12152
12297
|
* Constructs a new LicenseApi.
|
|
12153
12298
|
* @alias module:purecloud-platform-client-v2/api/LicenseApi
|
|
@@ -12201,7 +12346,7 @@ if(featureName===undefined||featureName===null||featureName===''){throw'Missing
|
|
|
12201
12346
|
*/},{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(){/**
|
|
12202
12347
|
* Locations service.
|
|
12203
12348
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
12204
|
-
* @version
|
|
12349
|
+
* @version 241.0.0
|
|
12205
12350
|
*//**
|
|
12206
12351
|
* Constructs a new LocationsApi.
|
|
12207
12352
|
* @alias module:purecloud-platform-client-v2/api/LocationsApi
|
|
@@ -12260,7 +12405,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
12260
12405
|
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(){/**
|
|
12261
12406
|
* LogCapture service.
|
|
12262
12407
|
* @module purecloud-platform-client-v2/api/LogCaptureApi
|
|
12263
|
-
* @version
|
|
12408
|
+
* @version 241.0.0
|
|
12264
12409
|
*//**
|
|
12265
12410
|
* Constructs a new LogCaptureApi.
|
|
12266
12411
|
* @alias module:purecloud-platform-client-v2/api/LogCaptureApi
|
|
@@ -12309,7 +12454,7 @@ if(userId===undefined||userId===null||userId===''){throw'Missing the required pa
|
|
|
12309
12454
|
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(){/**
|
|
12310
12455
|
* Messaging service.
|
|
12311
12456
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
12312
|
-
* @version
|
|
12457
|
+
* @version 241.0.0
|
|
12313
12458
|
*//**
|
|
12314
12459
|
* Constructs a new MessagingApi.
|
|
12315
12460
|
* @alias module:purecloud-platform-client-v2/api/MessagingApi
|
|
@@ -12399,7 +12544,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
12399
12544
|
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(){/**
|
|
12400
12545
|
* MobileDevices service.
|
|
12401
12546
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
12402
|
-
* @version
|
|
12547
|
+
* @version 241.0.0
|
|
12403
12548
|
*//**
|
|
12404
12549
|
* Constructs a new MobileDevicesApi.
|
|
12405
12550
|
* @alias module:purecloud-platform-client-v2/api/MobileDevicesApi
|
|
@@ -12438,7 +12583,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
12438
12583
|
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(){/**
|
|
12439
12584
|
* Notifications service.
|
|
12440
12585
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
12441
|
-
* @version
|
|
12586
|
+
* @version 241.0.0
|
|
12442
12587
|
*//**
|
|
12443
12588
|
* Constructs a new NotificationsApi.
|
|
12444
12589
|
* @alias module:purecloud-platform-client-v2/api/NotificationsApi
|
|
@@ -12495,7 +12640,7 @@ if(channelId===undefined||channelId===null||channelId===''){throw'Missing the re
|
|
|
12495
12640
|
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(){/**
|
|
12496
12641
|
* OAuth service.
|
|
12497
12642
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
12498
|
-
* @version
|
|
12643
|
+
* @version 241.0.0
|
|
12499
12644
|
*//**
|
|
12500
12645
|
* Constructs a new OAuthApi.
|
|
12501
12646
|
* @alias module:purecloud-platform-client-v2/api/OAuthApi
|
|
@@ -12580,7 +12725,7 @@ if(clientId===undefined||clientId===null||clientId===''){throw'Missing the requi
|
|
|
12580
12725
|
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(){/**
|
|
12581
12726
|
* Objects service.
|
|
12582
12727
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
12583
|
-
* @version
|
|
12728
|
+
* @version 241.0.0
|
|
12584
12729
|
*//**
|
|
12585
12730
|
* Constructs a new ObjectsApi.
|
|
12586
12731
|
* @alias module:purecloud-platform-client-v2/api/ObjectsApi
|
|
@@ -12666,7 +12811,7 @@ if(divisionId===undefined||divisionId===null||divisionId===''){throw'Missing the
|
|
|
12666
12811
|
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(){/**
|
|
12667
12812
|
* OperationalEvents service.
|
|
12668
12813
|
* @module purecloud-platform-client-v2/api/OperationalEventsApi
|
|
12669
|
-
* @version
|
|
12814
|
+
* @version 241.0.0
|
|
12670
12815
|
*//**
|
|
12671
12816
|
* Constructs a new OperationalEventsApi.
|
|
12672
12817
|
* @alias module:purecloud-platform-client-v2/api/OperationalEventsApi
|
|
@@ -12697,7 +12842,7 @@ if(eventDefinitionId===undefined||eventDefinitionId===null||eventDefinitionId===
|
|
|
12697
12842
|
*/},{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(){/**
|
|
12698
12843
|
* Organization service.
|
|
12699
12844
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
12700
|
-
* @version
|
|
12845
|
+
* @version 241.0.0
|
|
12701
12846
|
*//**
|
|
12702
12847
|
* Constructs a new OrganizationApi.
|
|
12703
12848
|
* @alias module:purecloud-platform-client-v2/api/OrganizationApi
|
|
@@ -12802,7 +12947,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
12802
12947
|
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(){/**
|
|
12803
12948
|
* OrganizationAuthorization service.
|
|
12804
12949
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
12805
|
-
* @version
|
|
12950
|
+
* @version 241.0.0
|
|
12806
12951
|
*//**
|
|
12807
12952
|
* Constructs a new OrganizationAuthorizationApi.
|
|
12808
12953
|
* @alias module:purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
@@ -13136,7 +13281,7 @@ if(trustorOrgId===undefined||trustorOrgId===null||trustorOrgId===''){throw'Missi
|
|
|
13136
13281
|
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(){/**
|
|
13137
13282
|
* Outbound service.
|
|
13138
13283
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
13139
|
-
* @version
|
|
13284
|
+
* @version 241.0.0
|
|
13140
13285
|
*//**
|
|
13141
13286
|
* Constructs a new OutboundApi.
|
|
13142
13287
|
* @alias module:purecloud-platform-client-v2/api/OutboundApi
|
|
@@ -13759,7 +13904,8 @@ if(messagingCampaignId===undefined||messagingCampaignId===null||messagingCampaig
|
|
|
13759
13904
|
* @param {Array.<String>} opts.id A list of messaging campaign ids to bulk fetch
|
|
13760
13905
|
* @param {String} opts.contentTemplateId Content template ID
|
|
13761
13906
|
* @param {Object} opts.campaignStatus Campaign Status
|
|
13762
|
-
|
|
13907
|
+
* @param {Array.<String>} opts.ruleSetIds Ruleset ID(s)
|
|
13908
|
+
*/},{key:"getOutboundMessagingcampaigns",value:function getOutboundMessagingcampaigns(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/outbound/messagingcampaigns','GET',{},{'pageSize':opts['pageSize'],'pageNumber':opts['pageNumber'],'sortBy':opts['sortBy'],'sortOrder':opts['sortOrder'],'name':opts['name'],'contactListId':opts['contactListId'],'divisionId':this.apiClient.buildCollectionParam(opts['divisionId'],'multi'),'type':opts['type'],'senderSmsPhoneNumber':opts['senderSmsPhoneNumber'],'id':this.apiClient.buildCollectionParam(opts['id'],'multi'),'contentTemplateId':opts['contentTemplateId'],'campaignStatus':opts['campaignStatus'],'ruleSetIds':this.apiClient.buildCollectionParam(opts['ruleSetIds'],'multi')},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
13763
13909
|
* Get a basic Messaging Campaign information object
|
|
13764
13910
|
* This returns a simplified version of a Messaging Campaign, consisting of id, name, and division.
|
|
13765
13911
|
* @param {String} messagingCampaignId The Messaging Campaign ID
|
|
@@ -14292,7 +14438,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
14292
14438
|
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(){/**
|
|
14293
14439
|
* Presence service.
|
|
14294
14440
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
14295
|
-
* @version
|
|
14441
|
+
* @version 241.0.0
|
|
14296
14442
|
*//**
|
|
14297
14443
|
* Constructs a new PresenceApi.
|
|
14298
14444
|
* @alias module:purecloud-platform-client-v2/api/PresenceApi
|
|
@@ -14465,7 +14611,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
14465
14611
|
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(){/**
|
|
14466
14612
|
* ProcessAutomation service.
|
|
14467
14613
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
14468
|
-
* @version
|
|
14614
|
+
* @version 241.0.0
|
|
14469
14615
|
*//**
|
|
14470
14616
|
* Constructs a new ProcessAutomationApi.
|
|
14471
14617
|
* @alias module:purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
@@ -14528,7 +14674,7 @@ if(triggerId===undefined||triggerId===null||triggerId===''){throw'Missing the re
|
|
|
14528
14674
|
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(){/**
|
|
14529
14675
|
* Quality service.
|
|
14530
14676
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
14531
|
-
* @version
|
|
14677
|
+
* @version 241.0.0
|
|
14532
14678
|
*//**
|
|
14533
14679
|
* Constructs a new QualityApi.
|
|
14534
14680
|
* @alias module:purecloud-platform-client-v2/api/QualityApi
|
|
@@ -15018,7 +15164,7 @@ if(customerSurveyUrl===undefined||customerSurveyUrl===null){throw'Missing the re
|
|
|
15018
15164
|
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(){/**
|
|
15019
15165
|
* Recording service.
|
|
15020
15166
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
15021
|
-
* @version
|
|
15167
|
+
* @version 241.0.0
|
|
15022
15168
|
*//**
|
|
15023
15169
|
* Constructs a new RecordingApi.
|
|
15024
15170
|
* @alias module:purecloud-platform-client-v2/api/RecordingApi
|
|
@@ -15417,7 +15563,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
15417
15563
|
*/},{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(){/**
|
|
15418
15564
|
* ResponseManagement service.
|
|
15419
15565
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
15420
|
-
* @version
|
|
15566
|
+
* @version 241.0.0
|
|
15421
15567
|
*//**
|
|
15422
15568
|
* Constructs a new ResponseManagementApi.
|
|
15423
15569
|
* @alias module:purecloud-platform-client-v2/api/ResponseManagementApi
|
|
@@ -15538,7 +15684,7 @@ if(responseAssetId===undefined||responseAssetId===null||responseAssetId===''){th
|
|
|
15538
15684
|
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(){/**
|
|
15539
15685
|
* Routing service.
|
|
15540
15686
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
15541
|
-
* @version
|
|
15687
|
+
* @version 241.0.0
|
|
15542
15688
|
*//**
|
|
15543
15689
|
* Constructs a new RoutingApi.
|
|
15544
15690
|
* @alias module:purecloud-platform-client-v2/api/RoutingApi
|
|
@@ -15581,6 +15727,12 @@ if(languageId===undefined||languageId===null||languageId===''){throw'Missing the
|
|
|
15581
15727
|
* @param {String} predictorId Predictor ID
|
|
15582
15728
|
*/},{key:"deleteRoutingPredictor",value:function deleteRoutingPredictor(predictorId){// verify the required parameter 'predictorId' is set
|
|
15583
15729
|
if(predictorId===undefined||predictorId===null||predictorId===''){throw'Missing the required parameter "predictorId" when calling deleteRoutingPredictor';}return this.apiClient.callApi('/api/v2/routing/predictors/{predictorId}','DELETE',{'predictorId':predictorId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
15730
|
+
* Delete a custom Key Performance Indicator.
|
|
15731
|
+
*
|
|
15732
|
+
* @param {String} kpiId Key Performance Indicator ID
|
|
15733
|
+
* deleteRoutingPredictorsKeyperformanceindicator is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
15734
|
+
*/},{key:"deleteRoutingPredictorsKeyperformanceindicator",value:function deleteRoutingPredictorsKeyperformanceindicator(kpiId){// verify the required parameter 'kpiId' is set
|
|
15735
|
+
if(kpiId===undefined||kpiId===null||kpiId===''){throw'Missing the required parameter "kpiId" when calling deleteRoutingPredictorsKeyperformanceindicator';}return this.apiClient.callApi('/api/v2/routing/predictors/keyperformanceindicators/{kpiId}','DELETE',{'kpiId':kpiId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
15584
15736
|
* Delete a queue
|
|
15585
15737
|
*
|
|
15586
15738
|
* @param {String} queueId Queue ID
|
|
@@ -15845,12 +15997,24 @@ if(predictorId===undefined||predictorId===null||predictorId===''){throw'Missing
|
|
|
15845
15997
|
* @param {String} opts.kpiId Standard or custom KPI id used to filter predictors.
|
|
15846
15998
|
* @param {Object} opts.state The state used to filter predictors.
|
|
15847
15999
|
*/},{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']);}/**
|
|
16000
|
+
* Retrieve a single Key Performance Indicator.
|
|
16001
|
+
*
|
|
16002
|
+
* @param {String} kpiId Key Performance Indicator ID
|
|
16003
|
+
* @param {Object} opts Optional parameters
|
|
16004
|
+
* @param {Array.<String>} opts.expand Parameter to request additional data to return in KPI payload
|
|
16005
|
+
* getRoutingPredictorsKeyperformanceindicator is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
16006
|
+
*/},{key:"getRoutingPredictorsKeyperformanceindicator",value:function getRoutingPredictorsKeyperformanceindicator(kpiId,opts){opts=opts||{};// verify the required parameter 'kpiId' is set
|
|
16007
|
+
if(kpiId===undefined||kpiId===null||kpiId===''){throw'Missing the required parameter "kpiId" when calling getRoutingPredictorsKeyperformanceindicator';}return this.apiClient.callApi('/api/v2/routing/predictors/keyperformanceindicators/{kpiId}','GET',{'kpiId':kpiId},{'expand':this.apiClient.buildCollectionParam(opts['expand'],'multi')},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
15848
16008
|
* Get a list of Key Performance Indicators
|
|
15849
16009
|
*
|
|
15850
16010
|
* @param {Object} opts Optional parameters
|
|
15851
16011
|
* @param {Object} opts.kpiGroup The Group of Key Performance Indicators to return
|
|
15852
16012
|
* @param {Array.<String>} opts.expand Parameter to request additional data to return in KPI payload
|
|
15853
16013
|
*/},{key:"getRoutingPredictorsKeyperformanceindicators",value:function getRoutingPredictorsKeyperformanceindicators(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/routing/predictors/keyperformanceindicators','GET',{},{'kpiGroup':opts['kpiGroup'],'expand':this.apiClient.buildCollectionParam(opts['expand'],'multi')},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
16014
|
+
* Get a list of Key Performance Indicators Types available.
|
|
16015
|
+
*
|
|
16016
|
+
* getRoutingPredictorsKeyperformanceindicatortypes is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
16017
|
+
*/},{key:"getRoutingPredictorsKeyperformanceindicatortypes",value:function getRoutingPredictorsKeyperformanceindicatortypes(){return this.apiClient.callApi('/api/v2/routing/predictors/keyperformanceindicatortypes','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
15854
16018
|
* Get details about this queue.
|
|
15855
16019
|
*
|
|
15856
16020
|
* @param {String} queueId Queue ID
|
|
@@ -16235,6 +16399,14 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
16235
16399
|
* @param {Object} opts.body
|
|
16236
16400
|
*/},{key:"patchRoutingPredictor",value:function patchRoutingPredictor(predictorId,opts){opts=opts||{};// verify the required parameter 'predictorId' is set
|
|
16237
16401
|
if(predictorId===undefined||predictorId===null||predictorId===''){throw'Missing the required parameter "predictorId" when calling patchRoutingPredictor';}return this.apiClient.callApi('/api/v2/routing/predictors/{predictorId}','PATCH',{'predictorId':predictorId},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
16402
|
+
* Update a custom Key Performance Indicator.
|
|
16403
|
+
*
|
|
16404
|
+
* @param {String} kpiId Key Performance Indicator ID
|
|
16405
|
+
* @param {Object} opts Optional parameters
|
|
16406
|
+
* @param {Object} opts.body
|
|
16407
|
+
* patchRoutingPredictorsKeyperformanceindicator is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
16408
|
+
*/},{key:"patchRoutingPredictorsKeyperformanceindicator",value:function patchRoutingPredictorsKeyperformanceindicator(kpiId,opts){opts=opts||{};// verify the required parameter 'kpiId' is set
|
|
16409
|
+
if(kpiId===undefined||kpiId===null||kpiId===''){throw'Missing the required parameter "kpiId" when calling patchRoutingPredictorsKeyperformanceindicator';}return this.apiClient.callApi('/api/v2/routing/predictors/keyperformanceindicators/{kpiId}','PATCH',{'kpiId':kpiId},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
16238
16410
|
* Update the ring number OR joined status for a queue member.
|
|
16239
16411
|
*
|
|
16240
16412
|
* @param {String} queueId Queue ID
|
|
@@ -16413,6 +16585,12 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
16413
16585
|
* @param {Object} opts Optional parameters
|
|
16414
16586
|
* @param {Object} opts.body
|
|
16415
16587
|
*/},{key:"postRoutingPredictors",value:function postRoutingPredictors(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/routing/predictors','POST',{},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
16588
|
+
* Create a custom Key Performance Indicator.
|
|
16589
|
+
*
|
|
16590
|
+
* @param {Object} body request
|
|
16591
|
+
* postRoutingPredictorsKeyperformanceindicators is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
16592
|
+
*/},{key:"postRoutingPredictorsKeyperformanceindicators",value:function postRoutingPredictorsKeyperformanceindicators(body){// verify the required parameter 'body' is set
|
|
16593
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postRoutingPredictorsKeyperformanceindicators';}return this.apiClient.callApi('/api/v2/routing/predictors/keyperformanceindicators','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
16416
16594
|
* Bulk add or delete up to 100 queue members
|
|
16417
16595
|
*
|
|
16418
16596
|
* @param {String} queueId Queue ID
|
|
@@ -16629,7 +16807,7 @@ if(userId===undefined||userId===null||userId===''){throw'Missing the required pa
|
|
|
16629
16807
|
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(){/**
|
|
16630
16808
|
* SCIM service.
|
|
16631
16809
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
16632
|
-
* @version
|
|
16810
|
+
* @version 241.0.0
|
|
16633
16811
|
*//**
|
|
16634
16812
|
* Constructs a new SCIMApi.
|
|
16635
16813
|
* @alias module:purecloud-platform-client-v2/api/SCIMApi
|
|
@@ -16854,7 +17032,7 @@ if(userId===undefined||userId===null||userId===''){throw'Missing the required pa
|
|
|
16854
17032
|
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(){/**
|
|
16855
17033
|
* ScreenRecording service.
|
|
16856
17034
|
* @module purecloud-platform-client-v2/api/ScreenRecordingApi
|
|
16857
|
-
* @version
|
|
17035
|
+
* @version 241.0.0
|
|
16858
17036
|
*//**
|
|
16859
17037
|
* Constructs a new ScreenRecordingApi.
|
|
16860
17038
|
* @alias module:purecloud-platform-client-v2/api/ScreenRecordingApi
|
|
@@ -16869,7 +17047,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
16869
17047
|
*/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(){/**
|
|
16870
17048
|
* Scripts service.
|
|
16871
17049
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
16872
|
-
* @version
|
|
17050
|
+
* @version 241.0.0
|
|
16873
17051
|
*//**
|
|
16874
17052
|
* Constructs a new ScriptsApi.
|
|
16875
17053
|
* @alias module:purecloud-platform-client-v2/api/ScriptsApi
|
|
@@ -17015,7 +17193,7 @@ if(scriptId===undefined||scriptId===null||scriptId===''){throw'Missing the requi
|
|
|
17015
17193
|
*/},{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(){/**
|
|
17016
17194
|
* Search service.
|
|
17017
17195
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
17018
|
-
* @version
|
|
17196
|
+
* @version 241.0.0
|
|
17019
17197
|
*//**
|
|
17020
17198
|
* Constructs a new SearchApi.
|
|
17021
17199
|
* @alias module:purecloud-platform-client-v2/api/SearchApi
|
|
@@ -17174,7 +17352,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
17174
17352
|
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(){/**
|
|
17175
17353
|
* Settings service.
|
|
17176
17354
|
* @module purecloud-platform-client-v2/api/SettingsApi
|
|
17177
|
-
* @version
|
|
17355
|
+
* @version 241.0.0
|
|
17178
17356
|
*//**
|
|
17179
17357
|
* Constructs a new SettingsApi.
|
|
17180
17358
|
* @alias module:purecloud-platform-client-v2/api/SettingsApi
|
|
@@ -17246,7 +17424,7 @@ if(agentId===undefined||agentId===null||agentId===''){throw'Missing the required
|
|
|
17246
17424
|
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(){/**
|
|
17247
17425
|
* SocialMedia service.
|
|
17248
17426
|
* @module purecloud-platform-client-v2/api/SocialMediaApi
|
|
17249
|
-
* @version
|
|
17427
|
+
* @version 241.0.0
|
|
17250
17428
|
*//**
|
|
17251
17429
|
* Constructs a new SocialMediaApi.
|
|
17252
17430
|
* @alias module:purecloud-platform-client-v2/api/SocialMediaApi
|
|
@@ -17494,7 +17672,8 @@ if(twitterIngestionRuleId===undefined||twitterIngestionRuleId===null||twitterIng
|
|
|
17494
17672
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
17495
17673
|
* @param {Array.<String>} opts.divisionIds One or more division IDs. If nothing is provided, the social topics associated withthe list of divisions that the user has access to will be returned.
|
|
17496
17674
|
* @param {Boolean} opts.includeDeleted Determines whether to include soft-deleted items in the result.
|
|
17497
|
-
|
|
17675
|
+
* @param {String} opts.name Search for topic by name that contains the given search string, search is case insensitive
|
|
17676
|
+
*/},{key:"getSocialmediaTopics",value:function getSocialmediaTopics(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/socialmedia/topics','GET',{},{'pageNumber':opts['pageNumber'],'pageSize':opts['pageSize'],'divisionIds':this.apiClient.buildCollectionParam(opts['divisionIds'],'multi'),'includeDeleted':opts['includeDeleted'],'name':opts['name']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
17498
17677
|
* Update a social topic.
|
|
17499
17678
|
*
|
|
17500
17679
|
* @param {String} topicId topicId
|
|
@@ -17661,7 +17840,7 @@ if(topicId===undefined||topicId===null||topicId===''){throw'Missing the required
|
|
|
17661
17840
|
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(){/**
|
|
17662
17841
|
* SpeechTextAnalytics service.
|
|
17663
17842
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
17664
|
-
* @version
|
|
17843
|
+
* @version 241.0.0
|
|
17665
17844
|
*//**
|
|
17666
17845
|
* Constructs a new SpeechTextAnalyticsApi.
|
|
17667
17846
|
* @alias module:purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
@@ -18031,7 +18210,7 @@ if(topicId===undefined||topicId===null||topicId===''){throw'Missing the required
|
|
|
18031
18210
|
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(){/**
|
|
18032
18211
|
* Stations service.
|
|
18033
18212
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
18034
|
-
* @version
|
|
18213
|
+
* @version 241.0.0
|
|
18035
18214
|
*//**
|
|
18036
18215
|
* Constructs a new StationsApi.
|
|
18037
18216
|
* @alias module:purecloud-platform-client-v2/api/StationsApi
|
|
@@ -18063,7 +18242,7 @@ if(stationId===undefined||stationId===null||stationId===''){throw'Missing the re
|
|
|
18063
18242
|
*/},{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(){/**
|
|
18064
18243
|
* Suggest service.
|
|
18065
18244
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
18066
|
-
* @version
|
|
18245
|
+
* @version 241.0.0
|
|
18067
18246
|
*//**
|
|
18068
18247
|
* Constructs a new SuggestApi.
|
|
18069
18248
|
* @alias module:purecloud-platform-client-v2/api/SuggestApi
|
|
@@ -18103,7 +18282,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
18103
18282
|
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(){/**
|
|
18104
18283
|
* TaskManagement service.
|
|
18105
18284
|
* @module purecloud-platform-client-v2/api/TaskManagementApi
|
|
18106
|
-
* @version
|
|
18285
|
+
* @version 241.0.0
|
|
18107
18286
|
*//**
|
|
18108
18287
|
* Constructs a new TaskManagementApi.
|
|
18109
18288
|
* @alias module:purecloud-platform-client-v2/api/TaskManagementApi
|
|
@@ -18611,7 +18790,7 @@ if(schemaId===undefined||schemaId===null||schemaId===''){throw'Missing the requi
|
|
|
18611
18790
|
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(){/**
|
|
18612
18791
|
* Teams service.
|
|
18613
18792
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
18614
|
-
* @version
|
|
18793
|
+
* @version 241.0.0
|
|
18615
18794
|
*//**
|
|
18616
18795
|
* Constructs a new TeamsApi.
|
|
18617
18796
|
* @alias module:purecloud-platform-client-v2/api/TeamsApi
|
|
@@ -18691,7 +18870,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
18691
18870
|
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(){/**
|
|
18692
18871
|
* Telephony service.
|
|
18693
18872
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
18694
|
-
* @version
|
|
18873
|
+
* @version 241.0.0
|
|
18695
18874
|
*//**
|
|
18696
18875
|
* Constructs a new TelephonyApi.
|
|
18697
18876
|
* @alias module:purecloud-platform-client-v2/api/TelephonyApi
|
|
@@ -18762,7 +18941,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
18762
18941
|
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(){/**
|
|
18763
18942
|
* TelephonyProvidersEdge service.
|
|
18764
18943
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
18765
|
-
* @version
|
|
18944
|
+
* @version 241.0.0
|
|
18766
18945
|
*//**
|
|
18767
18946
|
* Constructs a new TelephonyProvidersEdgeApi.
|
|
18768
18947
|
* @alias module:purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
@@ -19610,7 +19789,7 @@ if(trunkBaseSettingsId===undefined||trunkBaseSettingsId===null||trunkBaseSetting
|
|
|
19610
19789
|
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(){/**
|
|
19611
19790
|
* Textbots service.
|
|
19612
19791
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
19613
|
-
* @version
|
|
19792
|
+
* @version 241.0.0
|
|
19614
19793
|
*//**
|
|
19615
19794
|
* Constructs a new TextbotsApi.
|
|
19616
19795
|
* @alias module:purecloud-platform-client-v2/api/TextbotsApi
|
|
@@ -19646,7 +19825,7 @@ if(launchRequest===undefined||launchRequest===null){throw'Missing the required p
|
|
|
19646
19825
|
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(){/**
|
|
19647
19826
|
* Tokens service.
|
|
19648
19827
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
19649
|
-
* @version
|
|
19828
|
+
* @version 241.0.0
|
|
19650
19829
|
*//**
|
|
19651
19830
|
* Constructs a new TokensApi.
|
|
19652
19831
|
* @alias module:purecloud-platform-client-v2/api/TokensApi
|
|
@@ -19680,7 +19859,7 @@ if(userId===undefined||userId===null||userId===''){throw'Missing the required pa
|
|
|
19680
19859
|
*/},{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(){/**
|
|
19681
19860
|
* Uploads service.
|
|
19682
19861
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
19683
|
-
* @version
|
|
19862
|
+
* @version 241.0.0
|
|
19684
19863
|
*//**
|
|
19685
19864
|
* Constructs a new UploadsApi.
|
|
19686
19865
|
* @alias module:purecloud-platform-client-v2/api/UploadsApi
|
|
@@ -19748,7 +19927,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
19748
19927
|
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(){/**
|
|
19749
19928
|
* Usage service.
|
|
19750
19929
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
19751
|
-
* @version
|
|
19930
|
+
* @version 241.0.0
|
|
19752
19931
|
*//**
|
|
19753
19932
|
* Constructs a new UsageApi.
|
|
19754
19933
|
* @alias module:purecloud-platform-client-v2/api/UsageApi
|
|
@@ -19832,7 +20011,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
19832
20011
|
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(){/**
|
|
19833
20012
|
* UserRecordings service.
|
|
19834
20013
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
19835
|
-
* @version
|
|
20014
|
+
* @version 241.0.0
|
|
19836
20015
|
*//**
|
|
19837
20016
|
* Constructs a new UserRecordingsApi.
|
|
19838
20017
|
* @alias module:purecloud-platform-client-v2/api/UserRecordingsApi
|
|
@@ -19880,7 +20059,7 @@ if(recordingId===undefined||recordingId===null||recordingId===''){throw'Missing
|
|
|
19880
20059
|
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(){/**
|
|
19881
20060
|
* Users service.
|
|
19882
20061
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
19883
|
-
* @version
|
|
20062
|
+
* @version 241.0.0
|
|
19884
20063
|
*//**
|
|
19885
20064
|
* Constructs a new UsersApi.
|
|
19886
20065
|
* @alias module:purecloud-platform-client-v2/api/UsersApi
|
|
@@ -20624,7 +20803,7 @@ if(verifierId===undefined||verifierId===null||verifierId===''){throw'Missing the
|
|
|
20624
20803
|
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 UsersRulesApi=/*#__PURE__*/function(){/**
|
|
20625
20804
|
* UsersRules service.
|
|
20626
20805
|
* @module purecloud-platform-client-v2/api/UsersRulesApi
|
|
20627
|
-
* @version
|
|
20806
|
+
* @version 241.0.0
|
|
20628
20807
|
*//**
|
|
20629
20808
|
* Constructs a new UsersRulesApi.
|
|
20630
20809
|
* @alias module:purecloud-platform-client-v2/api/UsersRulesApi
|
|
@@ -20707,7 +20886,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
20707
20886
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postUsersRulesQuery';}return this.apiClient.callApi('/api/v2/users/rules/query','POST',{},{'pageNumber':opts['pageNumber'],'pageSize':opts['pageSize']},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var UtilitiesApi=/*#__PURE__*/function(){/**
|
|
20708
20887
|
* Utilities service.
|
|
20709
20888
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
20710
|
-
* @version
|
|
20889
|
+
* @version 241.0.0
|
|
20711
20890
|
*//**
|
|
20712
20891
|
* Constructs a new UtilitiesApi.
|
|
20713
20892
|
* @alias module:purecloud-platform-client-v2/api/UtilitiesApi
|
|
@@ -20734,7 +20913,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
20734
20913
|
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(){/**
|
|
20735
20914
|
* Voicemail service.
|
|
20736
20915
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
20737
|
-
* @version
|
|
20916
|
+
* @version 241.0.0
|
|
20738
20917
|
*//**
|
|
20739
20918
|
* Constructs a new VoicemailApi.
|
|
20740
20919
|
* @alias module:purecloud-platform-client-v2/api/VoicemailApi
|
|
@@ -20896,7 +21075,7 @@ if(userId===undefined||userId===null||userId===''){throw'Missing the required pa
|
|
|
20896
21075
|
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(){/**
|
|
20897
21076
|
* WebChat service.
|
|
20898
21077
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
20899
|
-
* @version
|
|
21078
|
+
* @version 241.0.0
|
|
20900
21079
|
*//**
|
|
20901
21080
|
* Constructs a new WebChatApi.
|
|
20902
21081
|
* @alias module:purecloud-platform-client-v2/api/WebChatApi
|
|
@@ -21043,7 +21222,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
21043
21222
|
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(){/**
|
|
21044
21223
|
* WebDeployments service.
|
|
21045
21224
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
21046
|
-
* @version
|
|
21225
|
+
* @version 241.0.0
|
|
21047
21226
|
*//**
|
|
21048
21227
|
* Constructs a new WebDeploymentsApi.
|
|
21049
21228
|
* @alias module:purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
@@ -21176,7 +21355,7 @@ if(deploymentId===undefined||deploymentId===null||deploymentId===''){throw'Missi
|
|
|
21176
21355
|
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(){/**
|
|
21177
21356
|
* WebMessaging service.
|
|
21178
21357
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
21179
|
-
* @version
|
|
21358
|
+
* @version 241.0.0
|
|
21180
21359
|
*//**
|
|
21181
21360
|
* Constructs a new WebMessagingApi.
|
|
21182
21361
|
* @alias module:purecloud-platform-client-v2/api/WebMessagingApi
|
|
@@ -21217,7 +21396,7 @@ if(tokenId===undefined||tokenId===null||tokenId===''){throw'Missing the required
|
|
|
21217
21396
|
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(){/**
|
|
21218
21397
|
* Widgets service.
|
|
21219
21398
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
21220
|
-
* @version
|
|
21399
|
+
* @version 241.0.0
|
|
21221
21400
|
*//**
|
|
21222
21401
|
* Constructs a new WidgetsApi.
|
|
21223
21402
|
* @alias module:purecloud-platform-client-v2/api/WidgetsApi
|
|
@@ -21257,7 +21436,7 @@ if(deploymentId===undefined||deploymentId===null||deploymentId===''){throw'Missi
|
|
|
21257
21436
|
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(){/**
|
|
21258
21437
|
* WorkforceManagement service.
|
|
21259
21438
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
21260
|
-
* @version
|
|
21439
|
+
* @version 241.0.0
|
|
21261
21440
|
*//**
|
|
21262
21441
|
* Constructs a new WorkforceManagementApi.
|
|
21263
21442
|
* @alias module:purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
@@ -23229,7 +23408,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
23229
23408
|
* </pre>
|
|
23230
23409
|
* </p>
|
|
23231
23410
|
* @module purecloud-platform-client-v2/index
|
|
23232
|
-
* @version
|
|
23411
|
+
* @version 241.0.0
|
|
23233
23412
|
*/var platformClient=/*#__PURE__*/_createClass(function platformClient(){_classCallCheck(this,platformClient);/**
|
|
23234
23413
|
* The ApiClient constructor.
|
|
23235
23414
|
* @property {module:purecloud-platform-client-v2/ApiClient}
|