purecloud-platform-client-v2 239.0.0 → 241.1.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 +866 -115
- package/dist/web-amd/purecloud-platform-client-v2.js +866 -115
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +294 -118
- package/dist/web-cjs/purecloud-platform-client-v2.js +294 -118
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +1281 -752
- package/package.json +1 -1
- package/src/purecloud-platform-client-v2/ApiClient.js +47 -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 +1 -1
- package/src/purecloud-platform-client-v2/api/EventsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/FaxApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/FlowsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GamificationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GeolocationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GreetingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GroupsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/IdentityProviderApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/InfrastructureAsCodeApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +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 +1 -1
- package/src/purecloud-platform-client-v2/api/PresenceApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ProcessAutomationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/QualityApi.js +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.1.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
|
|
@@ -1019,6 +1019,12 @@ localStorage.setItem("".concat(this.settingsPrefix,"_auth_data"),JSON.stringify(
|
|
|
1019
1019
|
if(this.persistSettings!==true)return;// Ensure we can access local storage
|
|
1020
1020
|
if(!this.hasLocalStorage){return;}// Load current auth data
|
|
1021
1021
|
var tempState=this.authData.state;this.authData=localStorage.getItem("".concat(this.settingsPrefix,"_auth_data"));if(!this.authData)this.authData={};else this.authData=JSON.parse(this.authData);if(this.authData.accessToken)this.setAccessToken(this.authData.accessToken);this.authData.state=tempState;}/**
|
|
1022
|
+
* @description Clears the auth token from local storage, if enabled.
|
|
1023
|
+
*/},{key:"_clearSettings",value:function _clearSettings(){try{if(this.authData&&this.authData.accessToken)this.authData.accessToken=null;if(this.authentications['PureCloud OAuth']&&this.authentications['PureCloud OAuth'].accessToken)this.authentications['PureCloud OAuth'].accessToken=null;if(this.authData&&this.authData.state)this.authData.state=null;if(this.authData&&this.authData.error)this.authData.error=null;if(this.authData&&this.authData.error_description)this.authData.error_description=null;if(this.authData&&this.authData.tokenExpiryTime)this.authData.tokenExpiryTime=0;if(this.authData&&this.authData.tokenExpiryTimeString)this.authData.tokenExpiryTimeString=null;// Don't save settings if we aren't supposed to be persisting them
|
|
1024
|
+
if(this.persistSettings!==true)return;// Ensure we can access local storage
|
|
1025
|
+
if(!this.hasLocalStorage){return;}// Remove state from data so it's not persisted
|
|
1026
|
+
var tempData=JSON.parse(JSON.stringify(this.authData));delete tempData.state;// Save updated auth data
|
|
1027
|
+
localStorage.setItem("".concat(this.settingsPrefix,"_auth_data"),JSON.stringify(tempData));}catch(e){console.error(e);}}/**
|
|
1022
1028
|
* @description Sets the environment used by the session
|
|
1023
1029
|
* @param {string} environment - (Optional, default "mypurecloud.com") Environment the session use, e.g. mypurecloud.ie, mypurecloud.com.au, etc.
|
|
1024
1030
|
*/},{key:"setEnvironment",value:function setEnvironment(environment){this.config.setEnvironment(environment);}/**
|
|
@@ -1070,11 +1076,12 @@ var tempState=this.authData.state;this.authData=localStorage.getItem("".concat(t
|
|
|
1070
1076
|
* @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
1077
|
* @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
1078
|
* @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.
|
|
1079
|
+
* @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
1080
|
*/},{key:"loginImplicitGrant",value:function loginImplicitGrant(clientId,redirectUri,opts){var _this4=this;// Check for auth token in hash
|
|
1074
1081
|
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
1082
|
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
1083
|
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);});});}/**
|
|
1084
|
+
_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
1085
|
* @description Initiates the client credentials login flow. Only available in node apps.
|
|
1079
1086
|
* @param {string} clientId - The client ID of an OAuth Implicit Grant client
|
|
1080
1087
|
* @param {string} clientSecret - The client secret of an OAuth Implicit Grant client
|
|
@@ -1124,6 +1131,7 @@ return reject(new Error("Code Challenge Error ".concat(error)));});});}}/**
|
|
|
1124
1131
|
* @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
1132
|
* @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
1133
|
* @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.
|
|
1134
|
+
* @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
1135
|
* @param {string} codeVerifier - (optional) code verifier used to generate the code challenge
|
|
1128
1136
|
*/},{key:"loginPKCEGrant",value:function loginPKCEGrant(clientId,redirectUri,opts,codeVerifier){var _this8=this;// Need Local Storage or non null codeVerifier as parameter
|
|
1129
1137
|
if(!this.hasLocalStorage&&!codeVerifier){throw new Error("loginPKCEGrant requires Local Storage or codeVerifier as input parameter");}// Check for auth code in query
|
|
@@ -1141,7 +1149,7 @@ if(_this8.hasLocalStorage){sessionStorage.removeItem("genesys_cloud_sdk_pkce_cod
|
|
|
1141
1149
|
_this8._saveSettings({accessToken:undefined});// remove codeVerifier from session storage
|
|
1142
1150
|
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
1151
|
_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,"]")));});});}});}/**
|
|
1152
|
+
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
1153
|
* @description Parses the URL Query, grabs the code, and clears the query param. If no code is found, no action is taken.
|
|
1146
1154
|
*/},{key:"_setValuesFromUrlQuery",value:function _setValuesFromUrlQuery(){// Check for window
|
|
1147
1155
|
if(!(typeof window!=='undefined'&&window.location.search))return;// Process query string
|
|
@@ -1209,6 +1217,8 @@ document.body.scrollTop=scrollV;document.body.scrollLeft=scrollH;}this._saveSett
|
|
|
1209
1217
|
* @description Sets the access token to be used with requests
|
|
1210
1218
|
* @param {string} token - The access token
|
|
1211
1219
|
*/},{key:"setAccessToken",value:function setAccessToken(token){this._saveSettings({accessToken:token});}/**
|
|
1220
|
+
* @description Clears the access token to be used with requests
|
|
1221
|
+
*/},{key:"clearAccessToken",value:function clearAccessToken(){this._clearSettings();}/**
|
|
1212
1222
|
* @description Sets the storage key to use when persisting the access token
|
|
1213
1223
|
* @param {string} storageKey - The storage key name
|
|
1214
1224
|
*/},{key:"setStorageKey",value:function setStorageKey(storageKey){// Set storage key
|
|
@@ -1309,7 +1319,7 @@ resolve(data);})["catch"](function(error){var data=error;if(error.response&&erro
|
|
|
1309
1319
|
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
1320
|
* AIStudio service.
|
|
1311
1321
|
* @module purecloud-platform-client-v2/api/AIStudioApi
|
|
1312
|
-
* @version
|
|
1322
|
+
* @version 241.1.0
|
|
1313
1323
|
*//**
|
|
1314
1324
|
* Constructs a new AIStudioApi.
|
|
1315
1325
|
* @alias module:purecloud-platform-client-v2/api/AIStudioApi
|
|
@@ -1421,6 +1431,15 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
1421
1431
|
* @param {Object} body
|
|
1422
1432
|
*/},{key:"postConversationsSummariesSettings",value:function postConversationsSummariesSettings(body){// verify the required parameter 'body' is set
|
|
1423
1433
|
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']);}/**
|
|
1434
|
+
* Add a turn to a guide session.
|
|
1435
|
+
* 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.
|
|
1436
|
+
* @param {String} guideId Guide ID
|
|
1437
|
+
* @param {String} guideSessionId Guide Session ID
|
|
1438
|
+
* @param {Object} body
|
|
1439
|
+
*/},{key:"postGuideSessionTurns",value:function postGuideSessionTurns(guideId,guideSessionId,body){// verify the required parameter 'guideId' is set
|
|
1440
|
+
if(guideId===undefined||guideId===null||guideId===''){throw'Missing the required parameter "guideId" when calling postGuideSessionTurns';}// verify the required parameter 'guideSessionId' is set
|
|
1441
|
+
if(guideSessionId===undefined||guideSessionId===null||guideSessionId===''){throw'Missing the required parameter "guideSessionId" when calling postGuideSessionTurns';}// verify the required parameter 'body' is set
|
|
1442
|
+
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
1443
|
* Start the publishing of a guide version.
|
|
1425
1444
|
*
|
|
1426
1445
|
* @param {String} guideId Guide ID
|
|
@@ -1460,7 +1479,7 @@ if(summarySettingId===undefined||summarySettingId===null||summarySettingId==='')
|
|
|
1460
1479
|
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
1480
|
* AgentAssistants service.
|
|
1462
1481
|
* @module purecloud-platform-client-v2/api/AgentAssistantsApi
|
|
1463
|
-
* @version
|
|
1482
|
+
* @version 241.1.0
|
|
1464
1483
|
*//**
|
|
1465
1484
|
* Constructs a new AgentAssistantsApi.
|
|
1466
1485
|
* @alias module:purecloud-platform-client-v2/api/AgentAssistantsApi
|
|
@@ -1487,6 +1506,11 @@ if(queueId===undefined||queueId===null||queueId===''){throw'Missing the required
|
|
|
1487
1506
|
* @param {String} opts.queueIds Comma-separated identifiers of the queues that need to be deleted.
|
|
1488
1507
|
*/},{key:"deleteAssistantQueues",value:function deleteAssistantQueues(assistantId,opts){opts=opts||{};// verify the required parameter 'assistantId' is set
|
|
1489
1508
|
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']);}/**
|
|
1509
|
+
* Delete an agent checklist
|
|
1510
|
+
*
|
|
1511
|
+
* @param {String} agentChecklistId Agent Checklist ID
|
|
1512
|
+
*/},{key:"deleteAssistantsAgentchecklist",value:function deleteAssistantsAgentchecklist(agentChecklistId){// verify the required parameter 'agentChecklistId' is set
|
|
1513
|
+
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
1514
|
* Get an assistant.
|
|
1491
1515
|
*
|
|
1492
1516
|
* @param {String} assistantId Assistant ID
|
|
@@ -1523,6 +1547,25 @@ if(assistantId===undefined||assistantId===null||assistantId===''){throw'Missing
|
|
|
1523
1547
|
* @param {String} opts.name Return the assistant by the given name.
|
|
1524
1548
|
* @param {Object} opts.expand Which fields, if any, to expand
|
|
1525
1549
|
*/},{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']);}/**
|
|
1550
|
+
* Get an agent checklist
|
|
1551
|
+
*
|
|
1552
|
+
* @param {String} agentChecklistId Agent Checklist ID
|
|
1553
|
+
*/},{key:"getAssistantsAgentchecklist",value:function getAssistantsAgentchecklist(agentChecklistId){// verify the required parameter 'agentChecklistId' is set
|
|
1554
|
+
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']);}/**
|
|
1555
|
+
* Get the list of agent checklists
|
|
1556
|
+
*
|
|
1557
|
+
* @param {Object} opts Optional parameters
|
|
1558
|
+
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
1559
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
1560
|
+
* @param {String} opts.pageSize The page size for the listing. The max that will be returned is 100. (default to 25)
|
|
1561
|
+
* @param {String} opts.namePrefix The agent checklist name prefix filter applied to the listing.
|
|
1562
|
+
* @param {String} opts.language The agent checklist language filter applied to the listing.
|
|
1563
|
+
* @param {Object} opts.sortOrder The sort order for the listing
|
|
1564
|
+
* @param {Object} opts.sortBy The field to sort by for the listing.
|
|
1565
|
+
*/},{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']);}/**
|
|
1566
|
+
* Get the list of supported languages
|
|
1567
|
+
*
|
|
1568
|
+
*/},{key:"getAssistantsAgentchecklistsLanguages",value:function getAssistantsAgentchecklistsLanguages(){return this.apiClient.callApi('/api/v2/assistants/agentchecklists/languages','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
1526
1569
|
* Get all queues assigned to any assistant.
|
|
1527
1570
|
*
|
|
1528
1571
|
* @param {Object} opts Optional parameters
|
|
@@ -1580,6 +1623,11 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
1580
1623
|
* @param {Object} body
|
|
1581
1624
|
*/},{key:"postAssistants",value:function postAssistants(body){// verify the required parameter 'body' is set
|
|
1582
1625
|
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']);}/**
|
|
1626
|
+
* Create an agent checklist
|
|
1627
|
+
*
|
|
1628
|
+
* @param {Object} body Request body containing details of checklist to be added
|
|
1629
|
+
*/},{key:"postAssistantsAgentchecklists",value:function postAssistantsAgentchecklists(body){// verify the required parameter 'body' is set
|
|
1630
|
+
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
1631
|
* Create a queue assistant association.
|
|
1584
1632
|
*
|
|
1585
1633
|
* @param {String} assistantId Assistant ID
|
|
@@ -1588,10 +1636,17 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
1588
1636
|
*/},{key:"putAssistantQueue",value:function putAssistantQueue(assistantId,queueId,body){// verify the required parameter 'assistantId' is set
|
|
1589
1637
|
if(assistantId===undefined||assistantId===null||assistantId===''){throw'Missing the required parameter "assistantId" when calling putAssistantQueue';}// verify the required parameter 'queueId' is set
|
|
1590
1638
|
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']);}
|
|
1639
|
+
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']);}/**
|
|
1640
|
+
* Update an agent checklist
|
|
1641
|
+
*
|
|
1642
|
+
* @param {String} agentChecklistId Agent Checklist ID
|
|
1643
|
+
* @param {Object} body Request body containing details of checklist to be updated
|
|
1644
|
+
*/},{key:"putAssistantsAgentchecklist",value:function putAssistantsAgentchecklist(agentChecklistId,body){// verify the required parameter 'agentChecklistId' is set
|
|
1645
|
+
if(agentChecklistId===undefined||agentChecklistId===null||agentChecklistId===''){throw'Missing the required parameter "agentChecklistId" when calling putAssistantsAgentchecklist';}// verify the required parameter 'body' is set
|
|
1646
|
+
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
1647
|
* AgentCopilot service.
|
|
1593
1648
|
* @module purecloud-platform-client-v2/api/AgentCopilotApi
|
|
1594
|
-
* @version
|
|
1649
|
+
* @version 241.1.0
|
|
1595
1650
|
*//**
|
|
1596
1651
|
* Constructs a new AgentCopilotApi.
|
|
1597
1652
|
* @alias module:purecloud-platform-client-v2/api/AgentCopilotApi
|
|
@@ -1618,7 +1673,7 @@ if(assistantId===undefined||assistantId===null||assistantId===''){throw'Missing
|
|
|
1618
1673
|
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
1674
|
* AgentUI service.
|
|
1620
1675
|
* @module purecloud-platform-client-v2/api/AgentUIApi
|
|
1621
|
-
* @version
|
|
1676
|
+
* @version 241.1.0
|
|
1622
1677
|
*//**
|
|
1623
1678
|
* Constructs a new AgentUIApi.
|
|
1624
1679
|
* @alias module:purecloud-platform-client-v2/api/AgentUIApi
|
|
@@ -1652,7 +1707,7 @@ if(agentId===undefined||agentId===null||agentId===''){throw'Missing the required
|
|
|
1652
1707
|
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
1708
|
* Alerting service.
|
|
1654
1709
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
1655
|
-
* @version
|
|
1710
|
+
* @version 241.1.0
|
|
1656
1711
|
*//**
|
|
1657
1712
|
* Constructs a new AlertingApi.
|
|
1658
1713
|
* @alias module:purecloud-platform-client-v2/api/AlertingApi
|
|
@@ -1741,7 +1796,7 @@ if(ruleId===undefined||ruleId===null||ruleId===''){throw'Missing the required pa
|
|
|
1741
1796
|
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
1797
|
* Analytics service.
|
|
1743
1798
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
1744
|
-
* @version
|
|
1799
|
+
* @version 241.1.0
|
|
1745
1800
|
*//**
|
|
1746
1801
|
* Constructs a new AnalyticsApi.
|
|
1747
1802
|
* @alias module:purecloud-platform-client-v2/api/AnalyticsApi
|
|
@@ -1767,6 +1822,12 @@ if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required param
|
|
|
1767
1822
|
* deleteAnalyticsBotsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
1768
1823
|
*/},{key:"deleteAnalyticsBotsAggregatesJob",value:function deleteAnalyticsBotsAggregatesJob(jobId){// verify the required parameter 'jobId' is set
|
|
1769
1824
|
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']);}/**
|
|
1825
|
+
* Delete/cancel an async request for case management aggregates
|
|
1826
|
+
*
|
|
1827
|
+
* @param {String} jobId jobId
|
|
1828
|
+
* deleteAnalyticsCasemanagementAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
1829
|
+
*/},{key:"deleteAnalyticsCasemanagementAggregatesJob",value:function deleteAnalyticsCasemanagementAggregatesJob(jobId){// verify the required parameter 'jobId' is set
|
|
1830
|
+
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
1831
|
* Delete/cancel an async request for conversation aggregates
|
|
1771
1832
|
*
|
|
1772
1833
|
* @param {String} jobId jobId
|
|
@@ -1934,6 +1995,20 @@ if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required param
|
|
|
1934
1995
|
* getAnalyticsBotsAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
1935
1996
|
*/},{key:"getAnalyticsBotsAggregatesJobResults",value:function getAnalyticsBotsAggregatesJobResults(jobId,opts){opts=opts||{};// verify the required parameter 'jobId' is set
|
|
1936
1997
|
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']);}/**
|
|
1998
|
+
* Get status for async query for case management aggregates
|
|
1999
|
+
*
|
|
2000
|
+
* @param {String} jobId jobId
|
|
2001
|
+
* getAnalyticsCasemanagementAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2002
|
+
*/},{key:"getAnalyticsCasemanagementAggregatesJob",value:function getAnalyticsCasemanagementAggregatesJob(jobId){// verify the required parameter 'jobId' is set
|
|
2003
|
+
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']);}/**
|
|
2004
|
+
* Fetch a page of results for an async case management query
|
|
2005
|
+
*
|
|
2006
|
+
* @param {String} jobId jobId
|
|
2007
|
+
* @param {Object} opts Optional parameters
|
|
2008
|
+
* @param {String} opts.cursor Cursor token to retrieve next page
|
|
2009
|
+
* getAnalyticsCasemanagementAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2010
|
+
*/},{key:"getAnalyticsCasemanagementAggregatesJobResults",value:function getAnalyticsCasemanagementAggregatesJobResults(jobId,opts){opts=opts||{};// verify the required parameter 'jobId' is set
|
|
2011
|
+
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
2012
|
* Get a conversation by id
|
|
1938
2013
|
*
|
|
1939
2014
|
* @param {String} conversationId conversationId
|
|
@@ -2265,6 +2340,18 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
2265
2340
|
* @param {Object} body query
|
|
2266
2341
|
*/},{key:"postAnalyticsBotsAggregatesQuery",value:function postAnalyticsBotsAggregatesQuery(body){// verify the required parameter 'body' is set
|
|
2267
2342
|
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']);}/**
|
|
2343
|
+
* Query for case management aggregates asynchronously
|
|
2344
|
+
*
|
|
2345
|
+
* @param {Object} body query
|
|
2346
|
+
* postAnalyticsCasemanagementAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2347
|
+
*/},{key:"postAnalyticsCasemanagementAggregatesJobs",value:function postAnalyticsCasemanagementAggregatesJobs(body){// verify the required parameter 'body' is set
|
|
2348
|
+
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']);}/**
|
|
2349
|
+
* Query for case management aggregates
|
|
2350
|
+
*
|
|
2351
|
+
* @param {Object} body query
|
|
2352
|
+
* postAnalyticsCasemanagementAggregatesQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2353
|
+
*/},{key:"postAnalyticsCasemanagementAggregatesQuery",value:function postAnalyticsCasemanagementAggregatesQuery(body){// verify the required parameter 'body' is set
|
|
2354
|
+
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
2355
|
* Index conversation properties
|
|
2269
2356
|
*
|
|
2270
2357
|
* @param {String} conversationId conversationId
|
|
@@ -2517,7 +2604,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
2517
2604
|
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
2605
|
* Architect service.
|
|
2519
2606
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
2520
|
-
* @version
|
|
2607
|
+
* @version 241.1.0
|
|
2521
2608
|
*//**
|
|
2522
2609
|
* Constructs a new ArchitectApi.
|
|
2523
2610
|
* @alias module:purecloud-platform-client-v2/api/ArchitectApi
|
|
@@ -3651,7 +3738,7 @@ if(milestoneId===undefined||milestoneId===null||milestoneId===''){throw'Missing
|
|
|
3651
3738
|
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
3739
|
* Audit service.
|
|
3653
3740
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
3654
|
-
* @version
|
|
3741
|
+
* @version 241.1.0
|
|
3655
3742
|
*//**
|
|
3656
3743
|
* Constructs a new AuditApi.
|
|
3657
3744
|
* @alias module:purecloud-platform-client-v2/api/AuditApi
|
|
@@ -3701,7 +3788,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
3701
3788
|
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
3789
|
* Authorization service.
|
|
3703
3790
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
3704
|
-
* @version
|
|
3791
|
+
* @version 241.1.0
|
|
3705
3792
|
*//**
|
|
3706
3793
|
* Constructs a new AuthorizationApi.
|
|
3707
3794
|
* @alias module:purecloud-platform-client-v2/api/AuthorizationApi
|
|
@@ -3720,7 +3807,6 @@ if(divisionId===undefined||divisionId===null||divisionId===''){throw'Missing the
|
|
|
3720
3807
|
*
|
|
3721
3808
|
* @param {String} targetName The domain:entity:action target to which the policy is applied
|
|
3722
3809
|
* @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
3810
|
*/},{key:"deleteAuthorizationPoliciesTargetSubjectSubjectId",value:function deleteAuthorizationPoliciesTargetSubjectSubjectId(targetName,subjectId){// verify the required parameter 'targetName' is set
|
|
3725
3811
|
if(targetName===undefined||targetName===null||targetName===''){throw'Missing the required parameter "targetName" when calling deleteAuthorizationPoliciesTargetSubjectSubjectId';}// verify the required parameter 'subjectId' is set
|
|
3726
3812
|
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 +3913,6 @@ if(permission===undefined||permission===null){throw'Missing the required paramet
|
|
|
3827
3913
|
* @param {Object} opts Optional parameters
|
|
3828
3914
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
3829
3915
|
* @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
3916
|
*/},{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
3917
|
* Get a page of access policies for a given subject
|
|
3833
3918
|
*
|
|
@@ -3835,7 +3920,6 @@ if(permission===undefined||permission===null){throw'Missing the required paramet
|
|
|
3835
3920
|
* @param {Object} opts Optional parameters
|
|
3836
3921
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
3837
3922
|
* @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
3923
|
*/},{key:"getAuthorizationPoliciesSubjectSubjectId",value:function getAuthorizationPoliciesSubjectSubjectId(subjectId,opts){opts=opts||{};// verify the required parameter 'subjectId' is set
|
|
3840
3924
|
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
3925
|
* Get a page of access policies for a given policy target
|
|
@@ -3844,31 +3928,26 @@ if(subjectId===undefined||subjectId===null||subjectId===''){throw'Missing the re
|
|
|
3844
3928
|
* @param {Object} opts Optional parameters
|
|
3845
3929
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
3846
3930
|
* @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
3931
|
*/},{key:"getAuthorizationPoliciesTarget",value:function getAuthorizationPoliciesTarget(targetName,opts){opts=opts||{};// verify the required parameter 'targetName' is set
|
|
3849
3932
|
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
3933
|
* Get an access control policy for a specified resource target and subject
|
|
3851
3934
|
*
|
|
3852
3935
|
* @param {String} targetName The domain:entity:action resource target to which the policy is applied
|
|
3853
3936
|
* @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
3937
|
*/},{key:"getAuthorizationPoliciesTargetSubjectSubjectId",value:function getAuthorizationPoliciesTargetSubjectSubjectId(targetName,subjectId){// verify the required parameter 'targetName' is set
|
|
3856
3938
|
if(targetName===undefined||targetName===null||targetName===''){throw'Missing the required parameter "targetName" when calling getAuthorizationPoliciesTargetSubjectSubjectId';}// verify the required parameter 'subjectId' is set
|
|
3857
3939
|
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
3940
|
* Get a map of policy targets to valid attributes for those targets
|
|
3859
3941
|
*
|
|
3860
|
-
* getAuthorizationPoliciesTargets is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
3861
3942
|
*/},{key:"getAuthorizationPoliciesTargets",value:function getAuthorizationPoliciesTargets(){return this.apiClient.callApi('/api/v2/authorization/policies/targets','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
3862
3943
|
* Get an access control policy with the specified policy ID
|
|
3863
3944
|
*
|
|
3864
3945
|
* @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
3946
|
*/},{key:"getAuthorizationPolicy",value:function getAuthorizationPolicy(policyId){// verify the required parameter 'policyId' is set
|
|
3867
3947
|
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
3948
|
* Get the list of attributes used to evaluate an access control policy with the specified policy ID
|
|
3869
3949
|
*
|
|
3870
3950
|
* @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
3951
|
*/},{key:"getAuthorizationPolicyAttributes",value:function getAuthorizationPolicyAttributes(policyId){// verify the required parameter 'policyId' is set
|
|
3873
3952
|
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
3953
|
* Get the list of enabled products
|
|
@@ -3989,7 +4068,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
3989
4068
|
*
|
|
3990
4069
|
* @param {String} targetName The domain:entity:action target to which the policy will be applied
|
|
3991
4070
|
* @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
4071
|
*/},{key:"postAuthorizationPoliciesTarget",value:function postAuthorizationPoliciesTarget(targetName,body){// verify the required parameter 'targetName' is set
|
|
3994
4072
|
if(targetName===undefined||targetName===null||targetName===''){throw'Missing the required parameter "targetName" when calling postAuthorizationPoliciesTarget';}// verify the required parameter 'body' is set
|
|
3995
4073
|
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 +4075,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
3997
4075
|
*
|
|
3998
4076
|
* @param {String} targetName The domain:entity:action target to which the policy will be applied
|
|
3999
4077
|
* @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
4078
|
*/},{key:"postAuthorizationPoliciesTargetValidate",value:function postAuthorizationPoliciesTargetValidate(targetName,body){// verify the required parameter 'targetName' is set
|
|
4002
4079
|
if(targetName===undefined||targetName===null||targetName===''){throw'Missing the required parameter "targetName" when calling postAuthorizationPoliciesTargetValidate';}// verify the required parameter 'body' is set
|
|
4003
4080
|
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 +4082,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
4005
4082
|
*
|
|
4006
4083
|
* @param {String} policyId The ID of the policy to test the simulated data against
|
|
4007
4084
|
* @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
4085
|
*/},{key:"postAuthorizationPolicySimulate",value:function postAuthorizationPolicySimulate(policyId,body){// verify the required parameter 'policyId' is set
|
|
4010
4086
|
if(policyId===undefined||policyId===null||policyId===''){throw'Missing the required parameter "policyId" when calling postAuthorizationPolicySimulate';}// verify the required parameter 'body' is set
|
|
4011
4087
|
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 +4160,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
4084
4160
|
*
|
|
4085
4161
|
* @param {String} targetName The domain:entity:action target to which the policy will be applied
|
|
4086
4162
|
* @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
4163
|
*/},{key:"putAuthorizationPoliciesTarget",value:function putAuthorizationPoliciesTarget(targetName,body){// verify the required parameter 'targetName' is set
|
|
4089
4164
|
if(targetName===undefined||targetName===null||targetName===''){throw'Missing the required parameter "targetName" when calling putAuthorizationPoliciesTarget';}// verify the required parameter 'body' is set
|
|
4090
4165
|
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 +4167,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
4092
4167
|
*
|
|
4093
4168
|
* @param {String} policyId The ID of the policy to update
|
|
4094
4169
|
* @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
4170
|
*/},{key:"putAuthorizationPolicy",value:function putAuthorizationPolicy(policyId,body){// verify the required parameter 'policyId' is set
|
|
4097
4171
|
if(policyId===undefined||policyId===null||policyId===''){throw'Missing the required parameter "policyId" when calling putAuthorizationPolicy';}// verify the required parameter 'body' is set
|
|
4098
4172
|
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 +4210,7 @@ if(subjectId===undefined||subjectId===null||subjectId===''){throw'Missing the re
|
|
|
4136
4210
|
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
4211
|
* Billing service.
|
|
4138
4212
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
4139
|
-
* @version
|
|
4213
|
+
* @version 241.1.0
|
|
4140
4214
|
*//**
|
|
4141
4215
|
* Constructs a new BillingApi.
|
|
4142
4216
|
* @alias module:purecloud-platform-client-v2/api/BillingApi
|
|
@@ -4213,7 +4287,7 @@ if(endDate===undefined||endDate===null){throw'Missing the required parameter "en
|
|
|
4213
4287
|
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
4288
|
* BusinessRules service.
|
|
4215
4289
|
* @module purecloud-platform-client-v2/api/BusinessRulesApi
|
|
4216
|
-
* @version
|
|
4290
|
+
* @version 241.1.0
|
|
4217
4291
|
*//**
|
|
4218
4292
|
* Constructs a new BusinessRulesApi.
|
|
4219
4293
|
* @alias module:purecloud-platform-client-v2/api/BusinessRulesApi
|
|
@@ -4434,7 +4508,7 @@ if(schemaId===undefined||schemaId===null||schemaId===''){throw'Missing the requi
|
|
|
4434
4508
|
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
4509
|
* CarrierServices service.
|
|
4436
4510
|
* @module purecloud-platform-client-v2/api/CarrierServicesApi
|
|
4437
|
-
* @version
|
|
4511
|
+
* @version 241.1.0
|
|
4438
4512
|
*//**
|
|
4439
4513
|
* Constructs a new CarrierServicesApi.
|
|
4440
4514
|
* @alias module:purecloud-platform-client-v2/api/CarrierServicesApi
|
|
@@ -4454,7 +4528,7 @@ if(phoneNumber===undefined||phoneNumber===null){throw'Missing the required param
|
|
|
4454
4528
|
*/},{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
4529
|
* Chat service.
|
|
4456
4530
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
4457
|
-
* @version
|
|
4531
|
+
* @version 241.1.0
|
|
4458
4532
|
*//**
|
|
4459
4533
|
* Constructs a new ChatApi.
|
|
4460
4534
|
* @alias module:purecloud-platform-client-v2/api/ChatApi
|
|
@@ -4685,7 +4759,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
4685
4759
|
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
4760
|
* Coaching service.
|
|
4687
4761
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
4688
|
-
* @version
|
|
4762
|
+
* @version 241.1.0
|
|
4689
4763
|
*//**
|
|
4690
4764
|
* Constructs a new CoachingApi.
|
|
4691
4765
|
* @alias module:purecloud-platform-client-v2/api/CoachingApi
|
|
@@ -4848,7 +4922,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
4848
4922
|
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
4923
|
* ContentManagement service.
|
|
4850
4924
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
4851
|
-
* @version
|
|
4925
|
+
* @version 241.1.0
|
|
4852
4926
|
*//**
|
|
4853
4927
|
* Constructs a new ContentManagementApi.
|
|
4854
4928
|
* @alias module:purecloud-platform-client-v2/api/ContentManagementApi
|
|
@@ -5130,7 +5204,7 @@ if(tagId===undefined||tagId===null||tagId===''){throw'Missing the required param
|
|
|
5130
5204
|
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
5205
|
* Conversations service.
|
|
5132
5206
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
5133
|
-
* @version
|
|
5207
|
+
* @version 241.1.0
|
|
5134
5208
|
*//**
|
|
5135
5209
|
* Constructs a new ConversationsApi.
|
|
5136
5210
|
* @alias module:purecloud-platform-client-v2/api/ConversationsApi
|
|
@@ -5277,6 +5351,33 @@ if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required param
|
|
|
5277
5351
|
* @param {String} conversationId conversation ID
|
|
5278
5352
|
*/},{key:"getConversation",value:function getConversation(conversationId){// verify the required parameter 'conversationId' is set
|
|
5279
5353
|
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']);}/**
|
|
5354
|
+
* Get checklist info for a single checklist.
|
|
5355
|
+
*
|
|
5356
|
+
* @param {String} conversationId Conversation ID
|
|
5357
|
+
* @param {String} communicationId Communication ID
|
|
5358
|
+
* @param {String} agentChecklistId Agent Checklist ID
|
|
5359
|
+
*/},{key:"getConversationCommunicationAgentchecklist",value:function getConversationCommunicationAgentchecklist(conversationId,communicationId,agentChecklistId){// verify the required parameter 'conversationId' is set
|
|
5360
|
+
if(conversationId===undefined||conversationId===null||conversationId===''){throw'Missing the required parameter "conversationId" when calling getConversationCommunicationAgentchecklist';}// verify the required parameter 'communicationId' is set
|
|
5361
|
+
if(communicationId===undefined||communicationId===null||communicationId===''){throw'Missing the required parameter "communicationId" when calling getConversationCommunicationAgentchecklist';}// verify the required parameter 'agentChecklistId' is set
|
|
5362
|
+
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']);}/**
|
|
5363
|
+
* Get inference job status
|
|
5364
|
+
*
|
|
5365
|
+
* @param {String} conversationId Conversation ID
|
|
5366
|
+
* @param {String} communicationId Communication ID
|
|
5367
|
+
* @param {String} agentChecklistId Agent Checklist ID
|
|
5368
|
+
* @param {String} jobId Inference Job ID
|
|
5369
|
+
*/},{key:"getConversationCommunicationAgentchecklistJob",value:function getConversationCommunicationAgentchecklistJob(conversationId,communicationId,agentChecklistId,jobId){// verify the required parameter 'conversationId' is set
|
|
5370
|
+
if(conversationId===undefined||conversationId===null||conversationId===''){throw'Missing the required parameter "conversationId" when calling getConversationCommunicationAgentchecklistJob';}// verify the required parameter 'communicationId' is set
|
|
5371
|
+
if(communicationId===undefined||communicationId===null||communicationId===''){throw'Missing the required parameter "communicationId" when calling getConversationCommunicationAgentchecklistJob';}// verify the required parameter 'agentChecklistId' is set
|
|
5372
|
+
if(agentChecklistId===undefined||agentChecklistId===null||agentChecklistId===''){throw'Missing the required parameter "agentChecklistId" when calling getConversationCommunicationAgentchecklistJob';}// verify the required parameter 'jobId' is set
|
|
5373
|
+
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']);}/**
|
|
5374
|
+
* Get information of all checklists associated with a conversation.
|
|
5375
|
+
*
|
|
5376
|
+
* @param {String} conversationId Conversation ID
|
|
5377
|
+
* @param {String} communicationId Communication ID
|
|
5378
|
+
*/},{key:"getConversationCommunicationAgentchecklists",value:function getConversationCommunicationAgentchecklists(conversationId,communicationId){// verify the required parameter 'conversationId' is set
|
|
5379
|
+
if(conversationId===undefined||conversationId===null||conversationId===''){throw'Missing the required parameter "conversationId" when calling getConversationCommunicationAgentchecklists';}// verify the required parameter 'communicationId' is set
|
|
5380
|
+
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
5381
|
* Get message
|
|
5281
5382
|
*
|
|
5282
5383
|
* @param {String} conversationId conversationId
|
|
@@ -6395,6 +6496,48 @@ if(conversationId===undefined||conversationId===null||conversationId===''){throw
|
|
|
6395
6496
|
* @param {String} conversationId Conversation ID
|
|
6396
6497
|
*/},{key:"postConversationCobrowse",value:function postConversationCobrowse(conversationId){// verify the required parameter 'conversationId' is set
|
|
6397
6498
|
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']);}/**
|
|
6499
|
+
* Agent Checklist activation API
|
|
6500
|
+
*
|
|
6501
|
+
* @param {String} conversationId Conversation ID
|
|
6502
|
+
* @param {String} communicationId Communication ID
|
|
6503
|
+
* @param {String} agentChecklistId Agent Checklist ID
|
|
6504
|
+
* @param {Object} body Agent checklist activation payload
|
|
6505
|
+
*/},{key:"postConversationCommunicationAgentchecklist",value:function postConversationCommunicationAgentchecklist(conversationId,communicationId,agentChecklistId,body){// verify the required parameter 'conversationId' is set
|
|
6506
|
+
if(conversationId===undefined||conversationId===null||conversationId===''){throw'Missing the required parameter "conversationId" when calling postConversationCommunicationAgentchecklist';}// verify the required parameter 'communicationId' is set
|
|
6507
|
+
if(communicationId===undefined||communicationId===null||communicationId===''){throw'Missing the required parameter "communicationId" when calling postConversationCommunicationAgentchecklist';}// verify the required parameter 'agentChecklistId' is set
|
|
6508
|
+
if(agentChecklistId===undefined||agentChecklistId===null||agentChecklistId===''){throw'Missing the required parameter "agentChecklistId" when calling postConversationCommunicationAgentchecklist';}// verify the required parameter 'body' is set
|
|
6509
|
+
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']);}/**
|
|
6510
|
+
* API invoked to capture an agent action.
|
|
6511
|
+
*
|
|
6512
|
+
* @param {String} conversationId Conversation ID
|
|
6513
|
+
* @param {String} communicationId Communication ID
|
|
6514
|
+
* @param {String} agentChecklistId Agent Checklist ID
|
|
6515
|
+
* @param {Object} body Agent action payload
|
|
6516
|
+
*/},{key:"postConversationCommunicationAgentchecklistAgentaction",value:function postConversationCommunicationAgentchecklistAgentaction(conversationId,communicationId,agentChecklistId,body){// verify the required parameter 'conversationId' is set
|
|
6517
|
+
if(conversationId===undefined||conversationId===null||conversationId===''){throw'Missing the required parameter "conversationId" when calling postConversationCommunicationAgentchecklistAgentaction';}// verify the required parameter 'communicationId' is set
|
|
6518
|
+
if(communicationId===undefined||communicationId===null||communicationId===''){throw'Missing the required parameter "communicationId" when calling postConversationCommunicationAgentchecklistAgentaction';}// verify the required parameter 'agentChecklistId' is set
|
|
6519
|
+
if(agentChecklistId===undefined||agentChecklistId===null||agentChecklistId===''){throw'Missing the required parameter "agentChecklistId" when calling postConversationCommunicationAgentchecklistAgentaction';}// verify the required parameter 'body' is set
|
|
6520
|
+
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']);}/**
|
|
6521
|
+
* Create inference job
|
|
6522
|
+
*
|
|
6523
|
+
* @param {String} conversationId Conversation ID
|
|
6524
|
+
* @param {String} communicationId Communication ID
|
|
6525
|
+
* @param {String} agentChecklistId Agent Checklist ID
|
|
6526
|
+
* @param {Object} body Agent checklist inference job payload
|
|
6527
|
+
*/},{key:"postConversationCommunicationAgentchecklistJobs",value:function postConversationCommunicationAgentchecklistJobs(conversationId,communicationId,agentChecklistId,body){// verify the required parameter 'conversationId' is set
|
|
6528
|
+
if(conversationId===undefined||conversationId===null||conversationId===''){throw'Missing the required parameter "conversationId" when calling postConversationCommunicationAgentchecklistJobs';}// verify the required parameter 'communicationId' is set
|
|
6529
|
+
if(communicationId===undefined||communicationId===null||communicationId===''){throw'Missing the required parameter "communicationId" when calling postConversationCommunicationAgentchecklistJobs';}// verify the required parameter 'agentChecklistId' is set
|
|
6530
|
+
if(agentChecklistId===undefined||agentChecklistId===null||agentChecklistId===''){throw'Missing the required parameter "agentChecklistId" when calling postConversationCommunicationAgentchecklistJobs';}// verify the required parameter 'body' is set
|
|
6531
|
+
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']);}/**
|
|
6532
|
+
* API invoked to finalize agent checklist evaluation.
|
|
6533
|
+
*
|
|
6534
|
+
* @param {String} conversationId Conversation ID
|
|
6535
|
+
* @param {String} communicationId Communication ID
|
|
6536
|
+
* @param {Object} body Agent checklist finalize payload
|
|
6537
|
+
*/},{key:"postConversationCommunicationAgentchecklistsFinalize",value:function postConversationCommunicationAgentchecklistsFinalize(conversationId,communicationId,body){// verify the required parameter 'conversationId' is set
|
|
6538
|
+
if(conversationId===undefined||conversationId===null||conversationId===''){throw'Missing the required parameter "conversationId" when calling postConversationCommunicationAgentchecklistsFinalize';}// verify the required parameter 'communicationId' is set
|
|
6539
|
+
if(communicationId===undefined||communicationId===null||communicationId===''){throw'Missing the required parameter "communicationId" when calling postConversationCommunicationAgentchecklistsFinalize';}// verify the required parameter 'body' is set
|
|
6540
|
+
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
6541
|
* Send internal message
|
|
6399
6542
|
* Send a new internal message for an existing communication.
|
|
6400
6543
|
* @param {String} conversationId conversationId
|
|
@@ -6436,11 +6579,12 @@ if(participantId===undefined||participantId===null||participantId===''){throw'Mi
|
|
|
6436
6579
|
if(conversationId===undefined||conversationId===null||conversationId===''){throw'Missing the required parameter "conversationId" when calling postConversationParticipantInternalmessagesUsersCommunications';}// verify the required parameter 'participantId' is set
|
|
6437
6580
|
if(participantId===undefined||participantId===null||participantId===''){throw'Missing the required parameter "participantId" when calling postConversationParticipantInternalmessagesUsersCommunications';}// verify the required parameter 'body' is set
|
|
6438
6581
|
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
|
-
*
|
|
6582
|
+
* Replace this participant (Deprecated)
|
|
6583
|
+
* This endpoint is deprecated. Use one of the following endpoints instead: /transfer, /replace/agent, /replace/queue, or /replace/contact/external.
|
|
6441
6584
|
* @param {String} conversationId conversation ID
|
|
6442
6585
|
* @param {String} participantId participant ID
|
|
6443
6586
|
* @param {Object} body Transfer request
|
|
6587
|
+
* @deprecated
|
|
6444
6588
|
*/},{key:"postConversationParticipantReplace",value:function postConversationParticipantReplace(conversationId,participantId,body){// verify the required parameter 'conversationId' is set
|
|
6445
6589
|
if(conversationId===undefined||conversationId===null||conversationId===''){throw'Missing the required parameter "conversationId" when calling postConversationParticipantReplace';}// verify the required parameter 'participantId' is set
|
|
6446
6590
|
if(participantId===undefined||participantId===null||participantId===''){throw'Missing the required parameter "participantId" when calling postConversationParticipantReplace';}// verify the required parameter 'body' is set
|
|
@@ -6459,16 +6603,16 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
6459
6603
|
* @param {String} conversationId conversation ID
|
|
6460
6604
|
* @param {String} participantId participant ID
|
|
6461
6605
|
* @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
6606
|
*/},{key:"postConversationParticipantReplaceContactExternal",value:function postConversationParticipantReplaceContactExternal(conversationId,participantId,body){// verify the required parameter 'conversationId' is set
|
|
6464
6607
|
if(conversationId===undefined||conversationId===null||conversationId===''){throw'Missing the required parameter "conversationId" when calling postConversationParticipantReplaceContactExternal';}// verify the required parameter 'participantId' is set
|
|
6465
6608
|
if(participantId===undefined||participantId===null||participantId===''){throw'Missing the required parameter "participantId" when calling postConversationParticipantReplaceContactExternal';}// verify the required parameter 'body' is set
|
|
6466
6609
|
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
|
-
*
|
|
6610
|
+
* Replace this participant with the an external contact (Deprecated)
|
|
6611
|
+
* This endpoint is deprecated. Use /replace/contact/external endpoint instead.
|
|
6469
6612
|
* @param {String} conversationId conversation ID
|
|
6470
6613
|
* @param {String} participantId participant ID
|
|
6471
6614
|
* @param {Object} body Transfer request
|
|
6615
|
+
* @deprecated
|
|
6472
6616
|
*/},{key:"postConversationParticipantReplaceExternal",value:function postConversationParticipantReplaceExternal(conversationId,participantId,body){// verify the required parameter 'conversationId' is set
|
|
6473
6617
|
if(conversationId===undefined||conversationId===null||conversationId===''){throw'Missing the required parameter "conversationId" when calling postConversationParticipantReplaceExternal';}// verify the required parameter 'participantId' is set
|
|
6474
6618
|
if(participantId===undefined||participantId===null||participantId===''){throw'Missing the required parameter "participantId" when calling postConversationParticipantReplaceExternal';}// verify the required parameter 'body' is set
|
|
@@ -6496,7 +6640,6 @@ if(participantId===undefined||participantId===null||participantId===''){throw'Mi
|
|
|
6496
6640
|
* @param {String} conversationId conversation ID
|
|
6497
6641
|
* @param {String} participantId participant ID
|
|
6498
6642
|
* @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
6643
|
*/},{key:"postConversationParticipantTransfer",value:function postConversationParticipantTransfer(conversationId,participantId,body){// verify the required parameter 'conversationId' is set
|
|
6501
6644
|
if(conversationId===undefined||conversationId===null||conversationId===''){throw'Missing the required parameter "conversationId" when calling postConversationParticipantTransfer';}// verify the required parameter 'participantId' is set
|
|
6502
6645
|
if(participantId===undefined||participantId===null||participantId===''){throw'Missing the required parameter "participantId" when calling postConversationParticipantTransfer';}// verify the required parameter 'body' is set
|
|
@@ -6559,11 +6702,12 @@ if(participantId===undefined||participantId===null||participantId===''){throw'Mi
|
|
|
6559
6702
|
if(conversationId===undefined||conversationId===null||conversationId===''){throw'Missing the required parameter "conversationId" when calling postConversationsCallParticipantCommunicationWrapup';}// verify the required parameter 'participantId' is set
|
|
6560
6703
|
if(participantId===undefined||participantId===null||participantId===''){throw'Missing the required parameter "participantId" when calling postConversationsCallParticipantCommunicationWrapup';}// verify the required parameter 'communicationId' is set
|
|
6561
6704
|
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
|
-
*
|
|
6705
|
+
* Initiate and update consult transfer (Deprecated)
|
|
6706
|
+
* This endpoint is deprecated. Use one of the following endpoints instead: /voice/consult, /consult/agent, /consult/queue, or /consult/contact/external.
|
|
6564
6707
|
* @param {String} conversationId conversationId
|
|
6565
6708
|
* @param {String} participantId participantId
|
|
6566
6709
|
* @param {Object} body Destination address and initial speak to
|
|
6710
|
+
* @deprecated
|
|
6567
6711
|
*/},{key:"postConversationsCallParticipantConsult",value:function postConversationsCallParticipantConsult(conversationId,participantId,body){// verify the required parameter 'conversationId' is set
|
|
6568
6712
|
if(conversationId===undefined||conversationId===null||conversationId===''){throw'Missing the required parameter "conversationId" when calling postConversationsCallParticipantConsult';}// verify the required parameter 'participantId' is set
|
|
6569
6713
|
if(participantId===undefined||participantId===null||participantId===''){throw'Missing the required parameter "participantId" when calling postConversationsCallParticipantConsult';}// verify the required parameter 'body' is set
|
|
@@ -6582,16 +6726,16 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
6582
6726
|
* @param {String} conversationId conversationId
|
|
6583
6727
|
* @param {String} participantId participantId
|
|
6584
6728
|
* @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
6729
|
*/},{key:"postConversationsCallParticipantConsultContactExternal",value:function postConversationsCallParticipantConsultContactExternal(conversationId,participantId,body){// verify the required parameter 'conversationId' is set
|
|
6587
6730
|
if(conversationId===undefined||conversationId===null||conversationId===''){throw'Missing the required parameter "conversationId" when calling postConversationsCallParticipantConsultContactExternal';}// verify the required parameter 'participantId' is set
|
|
6588
6731
|
if(participantId===undefined||participantId===null||participantId===''){throw'Missing the required parameter "participantId" when calling postConversationsCallParticipantConsultContactExternal';}// verify the required parameter 'body' is set
|
|
6589
6732
|
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
|
-
*
|
|
6733
|
+
* Initiate a consult transfer to an external contact (Deprecated)
|
|
6734
|
+
* This endpoint is deprecated. Use /consult/contact/external endpoints instead.
|
|
6592
6735
|
* @param {String} conversationId conversationId
|
|
6593
6736
|
* @param {String} participantId participantId
|
|
6594
6737
|
* @param {Object} body Destination address and initial speak to
|
|
6738
|
+
* @deprecated
|
|
6595
6739
|
*/},{key:"postConversationsCallParticipantConsultExternal",value:function postConversationsCallParticipantConsultExternal(conversationId,participantId,body){// verify the required parameter 'conversationId' is set
|
|
6596
6740
|
if(conversationId===undefined||conversationId===null||conversationId===''){throw'Missing the required parameter "conversationId" when calling postConversationsCallParticipantConsultExternal';}// verify the required parameter 'participantId' is set
|
|
6597
6741
|
if(participantId===undefined||participantId===null||participantId===''){throw'Missing the required parameter "participantId" when calling postConversationsCallParticipantConsultExternal';}// verify the required parameter 'body' is set
|
|
@@ -6626,7 +6770,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
6626
6770
|
* @param {String} conversationId conversationId
|
|
6627
6771
|
* @param {String} participantId participantId
|
|
6628
6772
|
* @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
6773
|
*/},{key:"postConversationsCallParticipantVoiceConsult",value:function postConversationsCallParticipantVoiceConsult(conversationId,participantId,body){// verify the required parameter 'conversationId' is set
|
|
6631
6774
|
if(conversationId===undefined||conversationId===null||conversationId===''){throw'Missing the required parameter "conversationId" when calling postConversationsCallParticipantVoiceConsult';}// verify the required parameter 'participantId' is set
|
|
6632
6775
|
if(participantId===undefined||participantId===null||participantId===''){throw'Missing the required parameter "participantId" when calling postConversationsCallParticipantVoiceConsult';}// verify the required parameter 'body' is set
|
|
@@ -7231,7 +7374,7 @@ if(conversationId===undefined||conversationId===null||conversationId===''){throw
|
|
|
7231
7374
|
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
7375
|
* DataExtensions service.
|
|
7233
7376
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
7234
|
-
* @version
|
|
7377
|
+
* @version 241.1.0
|
|
7235
7378
|
*//**
|
|
7236
7379
|
* Constructs a new DataExtensionsApi.
|
|
7237
7380
|
* @alias module:purecloud-platform-client-v2/api/DataExtensionsApi
|
|
@@ -7252,7 +7395,7 @@ if(coretypeName===undefined||coretypeName===null||coretypeName===''){throw'Missi
|
|
|
7252
7395
|
*/},{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
7396
|
* DataPrivacy service.
|
|
7254
7397
|
* @module purecloud-platform-client-v2/api/DataPrivacyApi
|
|
7255
|
-
* @version
|
|
7398
|
+
* @version 241.1.0
|
|
7256
7399
|
*//**
|
|
7257
7400
|
* Constructs a new DataPrivacyApi.
|
|
7258
7401
|
* @alias module:purecloud-platform-client-v2/api/DataPrivacyApi
|
|
@@ -7292,7 +7435,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
7292
7435
|
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
7436
|
* Downloads service.
|
|
7294
7437
|
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
7295
|
-
* @version
|
|
7438
|
+
* @version 241.1.0
|
|
7296
7439
|
*//**
|
|
7297
7440
|
* Constructs a new DownloadsApi.
|
|
7298
7441
|
* @alias module:purecloud-platform-client-v2/api/DownloadsApi
|
|
@@ -7311,7 +7454,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
7311
7454
|
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
7455
|
* Emails service.
|
|
7313
7456
|
* @module purecloud-platform-client-v2/api/EmailsApi
|
|
7314
|
-
* @version
|
|
7457
|
+
* @version 241.1.0
|
|
7315
7458
|
*//**
|
|
7316
7459
|
* Constructs a new EmailsApi.
|
|
7317
7460
|
* @alias module:purecloud-platform-client-v2/api/EmailsApi
|
|
@@ -7340,7 +7483,7 @@ if(downloadId===undefined||downloadId===null||downloadId===''){throw'Missing the
|
|
|
7340
7483
|
*/},{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
7484
|
* EmployeeEngagement service.
|
|
7342
7485
|
* @module purecloud-platform-client-v2/api/EmployeeEngagementApi
|
|
7343
|
-
* @version
|
|
7486
|
+
* @version 241.1.0
|
|
7344
7487
|
*//**
|
|
7345
7488
|
* Constructs a new EmployeeEngagementApi.
|
|
7346
7489
|
* @alias module:purecloud-platform-client-v2/api/EmployeeEngagementApi
|
|
@@ -7388,7 +7531,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
7388
7531
|
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(){/**
|
|
7389
7532
|
* Events service.
|
|
7390
7533
|
* @module purecloud-platform-client-v2/api/EventsApi
|
|
7391
|
-
* @version
|
|
7534
|
+
* @version 241.1.0
|
|
7392
7535
|
*//**
|
|
7393
7536
|
* Constructs a new EventsApi.
|
|
7394
7537
|
* @alias module:purecloud-platform-client-v2/api/EventsApi
|
|
@@ -7413,7 +7556,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
7413
7556
|
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(){/**
|
|
7414
7557
|
* ExternalContacts service.
|
|
7415
7558
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
7416
|
-
* @version
|
|
7559
|
+
* @version 241.1.0
|
|
7417
7560
|
*//**
|
|
7418
7561
|
* Constructs a new ExternalContactsApi.
|
|
7419
7562
|
* @alias module:purecloud-platform-client-v2/api/ExternalContactsApi
|
|
@@ -8163,7 +8306,7 @@ if(relationshipId===undefined||relationshipId===null||relationshipId===''){throw
|
|
|
8163
8306
|
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(){/**
|
|
8164
8307
|
* Fax service.
|
|
8165
8308
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
8166
|
-
* @version
|
|
8309
|
+
* @version 241.1.0
|
|
8167
8310
|
*//**
|
|
8168
8311
|
* Constructs a new FaxApi.
|
|
8169
8312
|
* @alias module:purecloud-platform-client-v2/api/FaxApi
|
|
@@ -8212,7 +8355,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
8212
8355
|
*/},{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(){/**
|
|
8213
8356
|
* Flows service.
|
|
8214
8357
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
8215
|
-
* @version
|
|
8358
|
+
* @version 241.1.0
|
|
8216
8359
|
*//**
|
|
8217
8360
|
* Constructs a new FlowsApi.
|
|
8218
8361
|
* @alias module:purecloud-platform-client-v2/api/FlowsApi
|
|
@@ -8266,7 +8409,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
8266
8409
|
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(){/**
|
|
8267
8410
|
* Gamification service.
|
|
8268
8411
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
8269
|
-
* @version
|
|
8412
|
+
* @version 241.1.0
|
|
8270
8413
|
*//**
|
|
8271
8414
|
* Constructs a new GamificationApi.
|
|
8272
8415
|
* @alias module:purecloud-platform-client-v2/api/GamificationApi
|
|
@@ -8937,7 +9080,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
8937
9080
|
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(){/**
|
|
8938
9081
|
* GeneralDataProtectionRegulation service.
|
|
8939
9082
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
8940
|
-
* @version
|
|
9083
|
+
* @version 241.1.0
|
|
8941
9084
|
*//**
|
|
8942
9085
|
* Constructs a new GeneralDataProtectionRegulationApi.
|
|
8943
9086
|
* @alias module:purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
@@ -8972,7 +9115,7 @@ if(searchValue===undefined||searchValue===null){throw'Missing the required param
|
|
|
8972
9115
|
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(){/**
|
|
8973
9116
|
* Geolocation service.
|
|
8974
9117
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
8975
|
-
* @version
|
|
9118
|
+
* @version 241.1.0
|
|
8976
9119
|
*//**
|
|
8977
9120
|
* Constructs a new GeolocationApi.
|
|
8978
9121
|
* @alias module:purecloud-platform-client-v2/api/GeolocationApi
|
|
@@ -9006,7 +9149,7 @@ if(clientId===undefined||clientId===null||clientId===''){throw'Missing the requi
|
|
|
9006
9149
|
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(){/**
|
|
9007
9150
|
* Greetings service.
|
|
9008
9151
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
9009
|
-
* @version
|
|
9152
|
+
* @version 241.1.0
|
|
9010
9153
|
*//**
|
|
9011
9154
|
* Constructs a new GreetingsApi.
|
|
9012
9155
|
* @alias module:purecloud-platform-client-v2/api/GreetingsApi
|
|
@@ -9134,7 +9277,7 @@ if(userId===undefined||userId===null||userId===''){throw'Missing the required pa
|
|
|
9134
9277
|
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(){/**
|
|
9135
9278
|
* Groups service.
|
|
9136
9279
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
9137
|
-
* @version
|
|
9280
|
+
* @version 241.1.0
|
|
9138
9281
|
*//**
|
|
9139
9282
|
* Constructs a new GroupsApi.
|
|
9140
9283
|
* @alias module:purecloud-platform-client-v2/api/GroupsApi
|
|
@@ -9267,7 +9410,7 @@ if(groupId===undefined||groupId===null||groupId===''){throw'Missing the required
|
|
|
9267
9410
|
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(){/**
|
|
9268
9411
|
* IdentityProvider service.
|
|
9269
9412
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
9270
|
-
* @version
|
|
9413
|
+
* @version 241.1.0
|
|
9271
9414
|
*//**
|
|
9272
9415
|
* Constructs a new IdentityProviderApi.
|
|
9273
9416
|
* @alias module:purecloud-platform-client-v2/api/IdentityProviderApi
|
|
@@ -9423,7 +9566,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
9423
9566
|
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(){/**
|
|
9424
9567
|
* InfrastructureAsCode service.
|
|
9425
9568
|
* @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
9426
|
-
* @version
|
|
9569
|
+
* @version 241.1.0
|
|
9427
9570
|
*//**
|
|
9428
9571
|
* Constructs a new InfrastructureAsCodeApi.
|
|
9429
9572
|
* @alias module:purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
@@ -9477,7 +9620,7 @@ if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required param
|
|
|
9477
9620
|
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(){/**
|
|
9478
9621
|
* Integrations service.
|
|
9479
9622
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
9480
|
-
* @version
|
|
9623
|
+
* @version 241.1.0
|
|
9481
9624
|
*//**
|
|
9482
9625
|
* Constructs a new IntegrationsApi.
|
|
9483
9626
|
* @alias module:purecloud-platform-client-v2/api/IntegrationsApi
|
|
@@ -10167,7 +10310,7 @@ if(ucIntegrationId===undefined||ucIntegrationId===null||ucIntegrationId===''){th
|
|
|
10167
10310
|
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(){/**
|
|
10168
10311
|
* Journey service.
|
|
10169
10312
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
10170
|
-
* @version
|
|
10313
|
+
* @version 241.1.0
|
|
10171
10314
|
*//**
|
|
10172
10315
|
* Constructs a new JourneyApi.
|
|
10173
10316
|
* @alias module:purecloud-platform-client-v2/api/JourneyApi
|
|
@@ -10264,7 +10407,7 @@ if(actionMapId===undefined||actionMapId===null||actionMapId===''){throw'Missing
|
|
|
10264
10407
|
* @param {String} opts.filterValue Value to filter by. Requires 'filterValue' to also be set.
|
|
10265
10408
|
* @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.
|
|
10266
10409
|
* @param {Array.<String>} opts.queryFields Action Map field(s) to query on. Requires 'queryValue' to also be set.
|
|
10267
|
-
* @param {String} opts.queryValue Value to query on. Requires 'queryFields' to also be set.
|
|
10410
|
+
* @param {String} opts.queryValue Value to query on using fuzzy matching. Requires 'queryFields' to also be set.
|
|
10268
10411
|
*/},{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']);}/**
|
|
10269
10412
|
* Get status of job.
|
|
10270
10413
|
*
|
|
@@ -10301,7 +10444,7 @@ if(actionTemplateId===undefined||actionTemplateId===null||actionTemplateId==='')
|
|
|
10301
10444
|
* @param {Object} opts.mediaType Media type
|
|
10302
10445
|
* @param {Object} opts.state Action template state.
|
|
10303
10446
|
* @param {Array.<String>} opts.queryFields ActionTemplate field(s) to query on. Requires 'queryValue' to also be set.
|
|
10304
|
-
* @param {String} opts.queryValue Value to query on. Requires 'queryFields' to also be set.
|
|
10447
|
+
* @param {String} opts.queryValue Value to query on using fuzzy matching. Requires 'queryFields' to also be set.
|
|
10305
10448
|
*/},{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']);}/**
|
|
10306
10449
|
* Send a ping.
|
|
10307
10450
|
*
|
|
@@ -10329,7 +10472,7 @@ if(outcomeId===undefined||outcomeId===null||outcomeId===''){throw'Missing the re
|
|
|
10329
10472
|
* @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).
|
|
10330
10473
|
* @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.
|
|
10331
10474
|
* @param {Array.<String>} opts.queryFields Outcome field(s) to query on. Requires 'queryValue' to also be set.
|
|
10332
|
-
* @param {String} opts.queryValue Value to query on. Requires 'queryFields' to also be set.
|
|
10475
|
+
* @param {String} opts.queryValue Value to query on using fuzzy matching. Requires 'queryFields' to also be set.
|
|
10333
10476
|
*/},{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']);}/**
|
|
10334
10477
|
* Get job status.
|
|
10335
10478
|
*
|
|
@@ -10365,7 +10508,7 @@ if(segmentId===undefined||segmentId===null||segmentId===''){throw'Missing the re
|
|
|
10365
10508
|
* @param {Boolean} opts.isActive Determines whether or not to show only active segments.
|
|
10366
10509
|
* @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.
|
|
10367
10510
|
* @param {Array.<String>} opts.queryFields Segment field(s) to query on. Requires 'queryValue' to also be set.
|
|
10368
|
-
* @param {String} opts.queryValue Value to query on. Requires 'queryFields' to also be set.
|
|
10511
|
+
* @param {String} opts.queryValue Value to query on using fuzzy matching. Requires 'queryFields' to also be set.
|
|
10369
10512
|
*/},{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']);}/**
|
|
10370
10513
|
* Retrieve a single session.
|
|
10371
10514
|
*
|
|
@@ -10676,7 +10819,7 @@ if(versionId===undefined||versionId===null||versionId===''){throw'Missing the re
|
|
|
10676
10819
|
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(){/**
|
|
10677
10820
|
* Knowledge service.
|
|
10678
10821
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
10679
|
-
* @version
|
|
10822
|
+
* @version 241.1.0
|
|
10680
10823
|
*//**
|
|
10681
10824
|
* Constructs a new KnowledgeApi.
|
|
10682
10825
|
* @alias module:purecloud-platform-client-v2/api/KnowledgeApi
|
|
@@ -11504,7 +11647,7 @@ if(sourceId===undefined||sourceId===null||sourceId===''){throw'Missing the requi
|
|
|
11504
11647
|
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(){/**
|
|
11505
11648
|
* LanguageUnderstanding service.
|
|
11506
11649
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
11507
|
-
* @version
|
|
11650
|
+
* @version 241.1.0
|
|
11508
11651
|
*//**
|
|
11509
11652
|
* Constructs a new LanguageUnderstandingApi.
|
|
11510
11653
|
* @alias module:purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
@@ -11813,7 +11956,7 @@ if(domainVersionId===undefined||domainVersionId===null||domainVersionId===''){th
|
|
|
11813
11956
|
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(){/**
|
|
11814
11957
|
* Languages service.
|
|
11815
11958
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
11816
|
-
* @version
|
|
11959
|
+
* @version 241.1.0
|
|
11817
11960
|
*//**
|
|
11818
11961
|
* Constructs a new LanguagesApi.
|
|
11819
11962
|
* @alias module:purecloud-platform-client-v2/api/LanguagesApi
|
|
@@ -11868,7 +12011,7 @@ if(userId===undefined||userId===null||userId===''){throw'Missing the required pa
|
|
|
11868
12011
|
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(){/**
|
|
11869
12012
|
* Learning service.
|
|
11870
12013
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
11871
|
-
* @version
|
|
12014
|
+
* @version 241.1.0
|
|
11872
12015
|
*//**
|
|
11873
12016
|
* Constructs a new LearningApi.
|
|
11874
12017
|
* @alias module:purecloud-platform-client-v2/api/LearningApi
|
|
@@ -12157,7 +12300,7 @@ if(moduleId===undefined||moduleId===null||moduleId===''){throw'Missing the requi
|
|
|
12157
12300
|
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(){/**
|
|
12158
12301
|
* License service.
|
|
12159
12302
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
12160
|
-
* @version
|
|
12303
|
+
* @version 241.1.0
|
|
12161
12304
|
*//**
|
|
12162
12305
|
* Constructs a new LicenseApi.
|
|
12163
12306
|
* @alias module:purecloud-platform-client-v2/api/LicenseApi
|
|
@@ -12211,7 +12354,7 @@ if(featureName===undefined||featureName===null||featureName===''){throw'Missing
|
|
|
12211
12354
|
*/},{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(){/**
|
|
12212
12355
|
* Locations service.
|
|
12213
12356
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
12214
|
-
* @version
|
|
12357
|
+
* @version 241.1.0
|
|
12215
12358
|
*//**
|
|
12216
12359
|
* Constructs a new LocationsApi.
|
|
12217
12360
|
* @alias module:purecloud-platform-client-v2/api/LocationsApi
|
|
@@ -12270,7 +12413,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
12270
12413
|
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(){/**
|
|
12271
12414
|
* LogCapture service.
|
|
12272
12415
|
* @module purecloud-platform-client-v2/api/LogCaptureApi
|
|
12273
|
-
* @version
|
|
12416
|
+
* @version 241.1.0
|
|
12274
12417
|
*//**
|
|
12275
12418
|
* Constructs a new LogCaptureApi.
|
|
12276
12419
|
* @alias module:purecloud-platform-client-v2/api/LogCaptureApi
|
|
@@ -12319,7 +12462,7 @@ if(userId===undefined||userId===null||userId===''){throw'Missing the required pa
|
|
|
12319
12462
|
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(){/**
|
|
12320
12463
|
* Messaging service.
|
|
12321
12464
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
12322
|
-
* @version
|
|
12465
|
+
* @version 241.1.0
|
|
12323
12466
|
*//**
|
|
12324
12467
|
* Constructs a new MessagingApi.
|
|
12325
12468
|
* @alias module:purecloud-platform-client-v2/api/MessagingApi
|
|
@@ -12409,7 +12552,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
12409
12552
|
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(){/**
|
|
12410
12553
|
* MobileDevices service.
|
|
12411
12554
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
12412
|
-
* @version
|
|
12555
|
+
* @version 241.1.0
|
|
12413
12556
|
*//**
|
|
12414
12557
|
* Constructs a new MobileDevicesApi.
|
|
12415
12558
|
* @alias module:purecloud-platform-client-v2/api/MobileDevicesApi
|
|
@@ -12448,7 +12591,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
12448
12591
|
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(){/**
|
|
12449
12592
|
* Notifications service.
|
|
12450
12593
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
12451
|
-
* @version
|
|
12594
|
+
* @version 241.1.0
|
|
12452
12595
|
*//**
|
|
12453
12596
|
* Constructs a new NotificationsApi.
|
|
12454
12597
|
* @alias module:purecloud-platform-client-v2/api/NotificationsApi
|
|
@@ -12505,7 +12648,7 @@ if(channelId===undefined||channelId===null||channelId===''){throw'Missing the re
|
|
|
12505
12648
|
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(){/**
|
|
12506
12649
|
* OAuth service.
|
|
12507
12650
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
12508
|
-
* @version
|
|
12651
|
+
* @version 241.1.0
|
|
12509
12652
|
*//**
|
|
12510
12653
|
* Constructs a new OAuthApi.
|
|
12511
12654
|
* @alias module:purecloud-platform-client-v2/api/OAuthApi
|
|
@@ -12590,7 +12733,7 @@ if(clientId===undefined||clientId===null||clientId===''){throw'Missing the requi
|
|
|
12590
12733
|
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(){/**
|
|
12591
12734
|
* Objects service.
|
|
12592
12735
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
12593
|
-
* @version
|
|
12736
|
+
* @version 241.1.0
|
|
12594
12737
|
*//**
|
|
12595
12738
|
* Constructs a new ObjectsApi.
|
|
12596
12739
|
* @alias module:purecloud-platform-client-v2/api/ObjectsApi
|
|
@@ -12676,7 +12819,7 @@ if(divisionId===undefined||divisionId===null||divisionId===''){throw'Missing the
|
|
|
12676
12819
|
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(){/**
|
|
12677
12820
|
* OperationalEvents service.
|
|
12678
12821
|
* @module purecloud-platform-client-v2/api/OperationalEventsApi
|
|
12679
|
-
* @version
|
|
12822
|
+
* @version 241.1.0
|
|
12680
12823
|
*//**
|
|
12681
12824
|
* Constructs a new OperationalEventsApi.
|
|
12682
12825
|
* @alias module:purecloud-platform-client-v2/api/OperationalEventsApi
|
|
@@ -12707,7 +12850,7 @@ if(eventDefinitionId===undefined||eventDefinitionId===null||eventDefinitionId===
|
|
|
12707
12850
|
*/},{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(){/**
|
|
12708
12851
|
* Organization service.
|
|
12709
12852
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
12710
|
-
* @version
|
|
12853
|
+
* @version 241.1.0
|
|
12711
12854
|
*//**
|
|
12712
12855
|
* Constructs a new OrganizationApi.
|
|
12713
12856
|
* @alias module:purecloud-platform-client-v2/api/OrganizationApi
|
|
@@ -12812,7 +12955,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
12812
12955
|
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(){/**
|
|
12813
12956
|
* OrganizationAuthorization service.
|
|
12814
12957
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
12815
|
-
* @version
|
|
12958
|
+
* @version 241.1.0
|
|
12816
12959
|
*//**
|
|
12817
12960
|
* Constructs a new OrganizationAuthorizationApi.
|
|
12818
12961
|
* @alias module:purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
@@ -13146,7 +13289,7 @@ if(trustorOrgId===undefined||trustorOrgId===null||trustorOrgId===''){throw'Missi
|
|
|
13146
13289
|
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(){/**
|
|
13147
13290
|
* Outbound service.
|
|
13148
13291
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
13149
|
-
* @version
|
|
13292
|
+
* @version 241.1.0
|
|
13150
13293
|
*//**
|
|
13151
13294
|
* Constructs a new OutboundApi.
|
|
13152
13295
|
* @alias module:purecloud-platform-client-v2/api/OutboundApi
|
|
@@ -14303,7 +14446,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
14303
14446
|
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(){/**
|
|
14304
14447
|
* Presence service.
|
|
14305
14448
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
14306
|
-
* @version
|
|
14449
|
+
* @version 241.1.0
|
|
14307
14450
|
*//**
|
|
14308
14451
|
* Constructs a new PresenceApi.
|
|
14309
14452
|
* @alias module:purecloud-platform-client-v2/api/PresenceApi
|
|
@@ -14476,7 +14619,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
14476
14619
|
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(){/**
|
|
14477
14620
|
* ProcessAutomation service.
|
|
14478
14621
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
14479
|
-
* @version
|
|
14622
|
+
* @version 241.1.0
|
|
14480
14623
|
*//**
|
|
14481
14624
|
* Constructs a new ProcessAutomationApi.
|
|
14482
14625
|
* @alias module:purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
@@ -14539,7 +14682,7 @@ if(triggerId===undefined||triggerId===null||triggerId===''){throw'Missing the re
|
|
|
14539
14682
|
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(){/**
|
|
14540
14683
|
* Quality service.
|
|
14541
14684
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
14542
|
-
* @version
|
|
14685
|
+
* @version 241.1.0
|
|
14543
14686
|
*//**
|
|
14544
14687
|
* Constructs a new QualityApi.
|
|
14545
14688
|
* @alias module:purecloud-platform-client-v2/api/QualityApi
|
|
@@ -15029,7 +15172,7 @@ if(customerSurveyUrl===undefined||customerSurveyUrl===null){throw'Missing the re
|
|
|
15029
15172
|
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(){/**
|
|
15030
15173
|
* Recording service.
|
|
15031
15174
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
15032
|
-
* @version
|
|
15175
|
+
* @version 241.1.0
|
|
15033
15176
|
*//**
|
|
15034
15177
|
* Constructs a new RecordingApi.
|
|
15035
15178
|
* @alias module:purecloud-platform-client-v2/api/RecordingApi
|
|
@@ -15428,7 +15571,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
15428
15571
|
*/},{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(){/**
|
|
15429
15572
|
* ResponseManagement service.
|
|
15430
15573
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
15431
|
-
* @version
|
|
15574
|
+
* @version 241.1.0
|
|
15432
15575
|
*//**
|
|
15433
15576
|
* Constructs a new ResponseManagementApi.
|
|
15434
15577
|
* @alias module:purecloud-platform-client-v2/api/ResponseManagementApi
|
|
@@ -15549,7 +15692,7 @@ if(responseAssetId===undefined||responseAssetId===null||responseAssetId===''){th
|
|
|
15549
15692
|
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(){/**
|
|
15550
15693
|
* Routing service.
|
|
15551
15694
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
15552
|
-
* @version
|
|
15695
|
+
* @version 241.1.0
|
|
15553
15696
|
*//**
|
|
15554
15697
|
* Constructs a new RoutingApi.
|
|
15555
15698
|
* @alias module:purecloud-platform-client-v2/api/RoutingApi
|
|
@@ -15592,6 +15735,12 @@ if(languageId===undefined||languageId===null||languageId===''){throw'Missing the
|
|
|
15592
15735
|
* @param {String} predictorId Predictor ID
|
|
15593
15736
|
*/},{key:"deleteRoutingPredictor",value:function deleteRoutingPredictor(predictorId){// verify the required parameter 'predictorId' is set
|
|
15594
15737
|
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']);}/**
|
|
15738
|
+
* Delete a custom Key Performance Indicator.
|
|
15739
|
+
*
|
|
15740
|
+
* @param {String} kpiId Key Performance Indicator ID
|
|
15741
|
+
* deleteRoutingPredictorsKeyperformanceindicator is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
15742
|
+
*/},{key:"deleteRoutingPredictorsKeyperformanceindicator",value:function deleteRoutingPredictorsKeyperformanceindicator(kpiId){// verify the required parameter 'kpiId' is set
|
|
15743
|
+
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']);}/**
|
|
15595
15744
|
* Delete a queue
|
|
15596
15745
|
*
|
|
15597
15746
|
* @param {String} queueId Queue ID
|
|
@@ -15856,12 +16005,24 @@ if(predictorId===undefined||predictorId===null||predictorId===''){throw'Missing
|
|
|
15856
16005
|
* @param {String} opts.kpiId Standard or custom KPI id used to filter predictors.
|
|
15857
16006
|
* @param {Object} opts.state The state used to filter predictors.
|
|
15858
16007
|
*/},{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']);}/**
|
|
16008
|
+
* Retrieve a single Key Performance Indicator.
|
|
16009
|
+
*
|
|
16010
|
+
* @param {String} kpiId Key Performance Indicator ID
|
|
16011
|
+
* @param {Object} opts Optional parameters
|
|
16012
|
+
* @param {Array.<String>} opts.expand Parameter to request additional data to return in KPI payload
|
|
16013
|
+
* getRoutingPredictorsKeyperformanceindicator is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
16014
|
+
*/},{key:"getRoutingPredictorsKeyperformanceindicator",value:function getRoutingPredictorsKeyperformanceindicator(kpiId,opts){opts=opts||{};// verify the required parameter 'kpiId' is set
|
|
16015
|
+
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']);}/**
|
|
15859
16016
|
* Get a list of Key Performance Indicators
|
|
15860
16017
|
*
|
|
15861
16018
|
* @param {Object} opts Optional parameters
|
|
15862
16019
|
* @param {Object} opts.kpiGroup The Group of Key Performance Indicators to return
|
|
15863
16020
|
* @param {Array.<String>} opts.expand Parameter to request additional data to return in KPI payload
|
|
15864
16021
|
*/},{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']);}/**
|
|
16022
|
+
* Get a list of Key Performance Indicators Types available.
|
|
16023
|
+
*
|
|
16024
|
+
* getRoutingPredictorsKeyperformanceindicatortypes is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
16025
|
+
*/},{key:"getRoutingPredictorsKeyperformanceindicatortypes",value:function getRoutingPredictorsKeyperformanceindicatortypes(){return this.apiClient.callApi('/api/v2/routing/predictors/keyperformanceindicatortypes','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
15865
16026
|
* Get details about this queue.
|
|
15866
16027
|
*
|
|
15867
16028
|
* @param {String} queueId Queue ID
|
|
@@ -16246,6 +16407,14 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
16246
16407
|
* @param {Object} opts.body
|
|
16247
16408
|
*/},{key:"patchRoutingPredictor",value:function patchRoutingPredictor(predictorId,opts){opts=opts||{};// verify the required parameter 'predictorId' is set
|
|
16248
16409
|
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']);}/**
|
|
16410
|
+
* Update a custom Key Performance Indicator.
|
|
16411
|
+
*
|
|
16412
|
+
* @param {String} kpiId Key Performance Indicator ID
|
|
16413
|
+
* @param {Object} opts Optional parameters
|
|
16414
|
+
* @param {Object} opts.body
|
|
16415
|
+
* patchRoutingPredictorsKeyperformanceindicator is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
16416
|
+
*/},{key:"patchRoutingPredictorsKeyperformanceindicator",value:function patchRoutingPredictorsKeyperformanceindicator(kpiId,opts){opts=opts||{};// verify the required parameter 'kpiId' is set
|
|
16417
|
+
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']);}/**
|
|
16249
16418
|
* Update the ring number OR joined status for a queue member.
|
|
16250
16419
|
*
|
|
16251
16420
|
* @param {String} queueId Queue ID
|
|
@@ -16424,6 +16593,12 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
16424
16593
|
* @param {Object} opts Optional parameters
|
|
16425
16594
|
* @param {Object} opts.body
|
|
16426
16595
|
*/},{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']);}/**
|
|
16596
|
+
* Create a custom Key Performance Indicator.
|
|
16597
|
+
*
|
|
16598
|
+
* @param {Object} body request
|
|
16599
|
+
* postRoutingPredictorsKeyperformanceindicators is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
16600
|
+
*/},{key:"postRoutingPredictorsKeyperformanceindicators",value:function postRoutingPredictorsKeyperformanceindicators(body){// verify the required parameter 'body' is set
|
|
16601
|
+
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']);}/**
|
|
16427
16602
|
* Bulk add or delete up to 100 queue members
|
|
16428
16603
|
*
|
|
16429
16604
|
* @param {String} queueId Queue ID
|
|
@@ -16640,7 +16815,7 @@ if(userId===undefined||userId===null||userId===''){throw'Missing the required pa
|
|
|
16640
16815
|
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(){/**
|
|
16641
16816
|
* SCIM service.
|
|
16642
16817
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
16643
|
-
* @version
|
|
16818
|
+
* @version 241.1.0
|
|
16644
16819
|
*//**
|
|
16645
16820
|
* Constructs a new SCIMApi.
|
|
16646
16821
|
* @alias module:purecloud-platform-client-v2/api/SCIMApi
|
|
@@ -16865,7 +17040,7 @@ if(userId===undefined||userId===null||userId===''){throw'Missing the required pa
|
|
|
16865
17040
|
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(){/**
|
|
16866
17041
|
* ScreenRecording service.
|
|
16867
17042
|
* @module purecloud-platform-client-v2/api/ScreenRecordingApi
|
|
16868
|
-
* @version
|
|
17043
|
+
* @version 241.1.0
|
|
16869
17044
|
*//**
|
|
16870
17045
|
* Constructs a new ScreenRecordingApi.
|
|
16871
17046
|
* @alias module:purecloud-platform-client-v2/api/ScreenRecordingApi
|
|
@@ -16880,7 +17055,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
16880
17055
|
*/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(){/**
|
|
16881
17056
|
* Scripts service.
|
|
16882
17057
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
16883
|
-
* @version
|
|
17058
|
+
* @version 241.1.0
|
|
16884
17059
|
*//**
|
|
16885
17060
|
* Constructs a new ScriptsApi.
|
|
16886
17061
|
* @alias module:purecloud-platform-client-v2/api/ScriptsApi
|
|
@@ -17026,7 +17201,7 @@ if(scriptId===undefined||scriptId===null||scriptId===''){throw'Missing the requi
|
|
|
17026
17201
|
*/},{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(){/**
|
|
17027
17202
|
* Search service.
|
|
17028
17203
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
17029
|
-
* @version
|
|
17204
|
+
* @version 241.1.0
|
|
17030
17205
|
*//**
|
|
17031
17206
|
* Constructs a new SearchApi.
|
|
17032
17207
|
* @alias module:purecloud-platform-client-v2/api/SearchApi
|
|
@@ -17185,7 +17360,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
17185
17360
|
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(){/**
|
|
17186
17361
|
* Settings service.
|
|
17187
17362
|
* @module purecloud-platform-client-v2/api/SettingsApi
|
|
17188
|
-
* @version
|
|
17363
|
+
* @version 241.1.0
|
|
17189
17364
|
*//**
|
|
17190
17365
|
* Constructs a new SettingsApi.
|
|
17191
17366
|
* @alias module:purecloud-platform-client-v2/api/SettingsApi
|
|
@@ -17257,7 +17432,7 @@ if(agentId===undefined||agentId===null||agentId===''){throw'Missing the required
|
|
|
17257
17432
|
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(){/**
|
|
17258
17433
|
* SocialMedia service.
|
|
17259
17434
|
* @module purecloud-platform-client-v2/api/SocialMediaApi
|
|
17260
|
-
* @version
|
|
17435
|
+
* @version 241.1.0
|
|
17261
17436
|
*//**
|
|
17262
17437
|
* Constructs a new SocialMediaApi.
|
|
17263
17438
|
* @alias module:purecloud-platform-client-v2/api/SocialMediaApi
|
|
@@ -17505,7 +17680,8 @@ if(twitterIngestionRuleId===undefined||twitterIngestionRuleId===null||twitterIng
|
|
|
17505
17680
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
17506
17681
|
* @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.
|
|
17507
17682
|
* @param {Boolean} opts.includeDeleted Determines whether to include soft-deleted items in the result.
|
|
17508
|
-
|
|
17683
|
+
* @param {String} opts.name Search for topic by name that contains the given search string, search is case insensitive
|
|
17684
|
+
*/},{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']);}/**
|
|
17509
17685
|
* Update a social topic.
|
|
17510
17686
|
*
|
|
17511
17687
|
* @param {String} topicId topicId
|
|
@@ -17672,7 +17848,7 @@ if(topicId===undefined||topicId===null||topicId===''){throw'Missing the required
|
|
|
17672
17848
|
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(){/**
|
|
17673
17849
|
* SpeechTextAnalytics service.
|
|
17674
17850
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
17675
|
-
* @version
|
|
17851
|
+
* @version 241.1.0
|
|
17676
17852
|
*//**
|
|
17677
17853
|
* Constructs a new SpeechTextAnalyticsApi.
|
|
17678
17854
|
* @alias module:purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
@@ -18042,7 +18218,7 @@ if(topicId===undefined||topicId===null||topicId===''){throw'Missing the required
|
|
|
18042
18218
|
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(){/**
|
|
18043
18219
|
* Stations service.
|
|
18044
18220
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
18045
|
-
* @version
|
|
18221
|
+
* @version 241.1.0
|
|
18046
18222
|
*//**
|
|
18047
18223
|
* Constructs a new StationsApi.
|
|
18048
18224
|
* @alias module:purecloud-platform-client-v2/api/StationsApi
|
|
@@ -18074,7 +18250,7 @@ if(stationId===undefined||stationId===null||stationId===''){throw'Missing the re
|
|
|
18074
18250
|
*/},{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(){/**
|
|
18075
18251
|
* Suggest service.
|
|
18076
18252
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
18077
|
-
* @version
|
|
18253
|
+
* @version 241.1.0
|
|
18078
18254
|
*//**
|
|
18079
18255
|
* Constructs a new SuggestApi.
|
|
18080
18256
|
* @alias module:purecloud-platform-client-v2/api/SuggestApi
|
|
@@ -18114,7 +18290,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
18114
18290
|
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(){/**
|
|
18115
18291
|
* TaskManagement service.
|
|
18116
18292
|
* @module purecloud-platform-client-v2/api/TaskManagementApi
|
|
18117
|
-
* @version
|
|
18293
|
+
* @version 241.1.0
|
|
18118
18294
|
*//**
|
|
18119
18295
|
* Constructs a new TaskManagementApi.
|
|
18120
18296
|
* @alias module:purecloud-platform-client-v2/api/TaskManagementApi
|
|
@@ -18622,7 +18798,7 @@ if(schemaId===undefined||schemaId===null||schemaId===''){throw'Missing the requi
|
|
|
18622
18798
|
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(){/**
|
|
18623
18799
|
* Teams service.
|
|
18624
18800
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
18625
|
-
* @version
|
|
18801
|
+
* @version 241.1.0
|
|
18626
18802
|
*//**
|
|
18627
18803
|
* Constructs a new TeamsApi.
|
|
18628
18804
|
* @alias module:purecloud-platform-client-v2/api/TeamsApi
|
|
@@ -18702,7 +18878,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
18702
18878
|
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(){/**
|
|
18703
18879
|
* Telephony service.
|
|
18704
18880
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
18705
|
-
* @version
|
|
18881
|
+
* @version 241.1.0
|
|
18706
18882
|
*//**
|
|
18707
18883
|
* Constructs a new TelephonyApi.
|
|
18708
18884
|
* @alias module:purecloud-platform-client-v2/api/TelephonyApi
|
|
@@ -18773,7 +18949,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
18773
18949
|
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(){/**
|
|
18774
18950
|
* TelephonyProvidersEdge service.
|
|
18775
18951
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
18776
|
-
* @version
|
|
18952
|
+
* @version 241.1.0
|
|
18777
18953
|
*//**
|
|
18778
18954
|
* Constructs a new TelephonyProvidersEdgeApi.
|
|
18779
18955
|
* @alias module:purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
@@ -19621,7 +19797,7 @@ if(trunkBaseSettingsId===undefined||trunkBaseSettingsId===null||trunkBaseSetting
|
|
|
19621
19797
|
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(){/**
|
|
19622
19798
|
* Textbots service.
|
|
19623
19799
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
19624
|
-
* @version
|
|
19800
|
+
* @version 241.1.0
|
|
19625
19801
|
*//**
|
|
19626
19802
|
* Constructs a new TextbotsApi.
|
|
19627
19803
|
* @alias module:purecloud-platform-client-v2/api/TextbotsApi
|
|
@@ -19657,7 +19833,7 @@ if(launchRequest===undefined||launchRequest===null){throw'Missing the required p
|
|
|
19657
19833
|
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(){/**
|
|
19658
19834
|
* Tokens service.
|
|
19659
19835
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
19660
|
-
* @version
|
|
19836
|
+
* @version 241.1.0
|
|
19661
19837
|
*//**
|
|
19662
19838
|
* Constructs a new TokensApi.
|
|
19663
19839
|
* @alias module:purecloud-platform-client-v2/api/TokensApi
|
|
@@ -19691,7 +19867,7 @@ if(userId===undefined||userId===null||userId===''){throw'Missing the required pa
|
|
|
19691
19867
|
*/},{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(){/**
|
|
19692
19868
|
* Uploads service.
|
|
19693
19869
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
19694
|
-
* @version
|
|
19870
|
+
* @version 241.1.0
|
|
19695
19871
|
*//**
|
|
19696
19872
|
* Constructs a new UploadsApi.
|
|
19697
19873
|
* @alias module:purecloud-platform-client-v2/api/UploadsApi
|
|
@@ -19759,7 +19935,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
19759
19935
|
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(){/**
|
|
19760
19936
|
* Usage service.
|
|
19761
19937
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
19762
|
-
* @version
|
|
19938
|
+
* @version 241.1.0
|
|
19763
19939
|
*//**
|
|
19764
19940
|
* Constructs a new UsageApi.
|
|
19765
19941
|
* @alias module:purecloud-platform-client-v2/api/UsageApi
|
|
@@ -19843,7 +20019,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
19843
20019
|
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(){/**
|
|
19844
20020
|
* UserRecordings service.
|
|
19845
20021
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
19846
|
-
* @version
|
|
20022
|
+
* @version 241.1.0
|
|
19847
20023
|
*//**
|
|
19848
20024
|
* Constructs a new UserRecordingsApi.
|
|
19849
20025
|
* @alias module:purecloud-platform-client-v2/api/UserRecordingsApi
|
|
@@ -19891,7 +20067,7 @@ if(recordingId===undefined||recordingId===null||recordingId===''){throw'Missing
|
|
|
19891
20067
|
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(){/**
|
|
19892
20068
|
* Users service.
|
|
19893
20069
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
19894
|
-
* @version
|
|
20070
|
+
* @version 241.1.0
|
|
19895
20071
|
*//**
|
|
19896
20072
|
* Constructs a new UsersApi.
|
|
19897
20073
|
* @alias module:purecloud-platform-client-v2/api/UsersApi
|
|
@@ -20635,7 +20811,7 @@ if(verifierId===undefined||verifierId===null||verifierId===''){throw'Missing the
|
|
|
20635
20811
|
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(){/**
|
|
20636
20812
|
* UsersRules service.
|
|
20637
20813
|
* @module purecloud-platform-client-v2/api/UsersRulesApi
|
|
20638
|
-
* @version
|
|
20814
|
+
* @version 241.1.0
|
|
20639
20815
|
*//**
|
|
20640
20816
|
* Constructs a new UsersRulesApi.
|
|
20641
20817
|
* @alias module:purecloud-platform-client-v2/api/UsersRulesApi
|
|
@@ -20718,7 +20894,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
20718
20894
|
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(){/**
|
|
20719
20895
|
* Utilities service.
|
|
20720
20896
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
20721
|
-
* @version
|
|
20897
|
+
* @version 241.1.0
|
|
20722
20898
|
*//**
|
|
20723
20899
|
* Constructs a new UtilitiesApi.
|
|
20724
20900
|
* @alias module:purecloud-platform-client-v2/api/UtilitiesApi
|
|
@@ -20745,7 +20921,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
20745
20921
|
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(){/**
|
|
20746
20922
|
* Voicemail service.
|
|
20747
20923
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
20748
|
-
* @version
|
|
20924
|
+
* @version 241.1.0
|
|
20749
20925
|
*//**
|
|
20750
20926
|
* Constructs a new VoicemailApi.
|
|
20751
20927
|
* @alias module:purecloud-platform-client-v2/api/VoicemailApi
|
|
@@ -20907,7 +21083,7 @@ if(userId===undefined||userId===null||userId===''){throw'Missing the required pa
|
|
|
20907
21083
|
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(){/**
|
|
20908
21084
|
* WebChat service.
|
|
20909
21085
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
20910
|
-
* @version
|
|
21086
|
+
* @version 241.1.0
|
|
20911
21087
|
*//**
|
|
20912
21088
|
* Constructs a new WebChatApi.
|
|
20913
21089
|
* @alias module:purecloud-platform-client-v2/api/WebChatApi
|
|
@@ -21054,7 +21230,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
21054
21230
|
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(){/**
|
|
21055
21231
|
* WebDeployments service.
|
|
21056
21232
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
21057
|
-
* @version
|
|
21233
|
+
* @version 241.1.0
|
|
21058
21234
|
*//**
|
|
21059
21235
|
* Constructs a new WebDeploymentsApi.
|
|
21060
21236
|
* @alias module:purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
@@ -21187,7 +21363,7 @@ if(deploymentId===undefined||deploymentId===null||deploymentId===''){throw'Missi
|
|
|
21187
21363
|
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(){/**
|
|
21188
21364
|
* WebMessaging service.
|
|
21189
21365
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
21190
|
-
* @version
|
|
21366
|
+
* @version 241.1.0
|
|
21191
21367
|
*//**
|
|
21192
21368
|
* Constructs a new WebMessagingApi.
|
|
21193
21369
|
* @alias module:purecloud-platform-client-v2/api/WebMessagingApi
|
|
@@ -21228,7 +21404,7 @@ if(tokenId===undefined||tokenId===null||tokenId===''){throw'Missing the required
|
|
|
21228
21404
|
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(){/**
|
|
21229
21405
|
* Widgets service.
|
|
21230
21406
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
21231
|
-
* @version
|
|
21407
|
+
* @version 241.1.0
|
|
21232
21408
|
*//**
|
|
21233
21409
|
* Constructs a new WidgetsApi.
|
|
21234
21410
|
* @alias module:purecloud-platform-client-v2/api/WidgetsApi
|
|
@@ -21268,7 +21444,7 @@ if(deploymentId===undefined||deploymentId===null||deploymentId===''){throw'Missi
|
|
|
21268
21444
|
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(){/**
|
|
21269
21445
|
* WorkforceManagement service.
|
|
21270
21446
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
21271
|
-
* @version
|
|
21447
|
+
* @version 241.1.0
|
|
21272
21448
|
*//**
|
|
21273
21449
|
* Constructs a new WorkforceManagementApi.
|
|
21274
21450
|
* @alias module:purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
@@ -23240,7 +23416,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
23240
23416
|
* </pre>
|
|
23241
23417
|
* </p>
|
|
23242
23418
|
* @module purecloud-platform-client-v2/index
|
|
23243
|
-
* @version
|
|
23419
|
+
* @version 241.1.0
|
|
23244
23420
|
*/var platformClient=/*#__PURE__*/_createClass(function platformClient(){_classCallCheck(this,platformClient);/**
|
|
23245
23421
|
* The ApiClient constructor.
|
|
23246
23422
|
* @property {module:purecloud-platform-client-v2/ApiClient}
|