purecloud-platform-client-v2 238.0.0 → 241.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +3 -3
- package/dist/node/purecloud-platform-client-v2.js +855 -116
- package/dist/web-amd/purecloud-platform-client-v2.js +855 -116
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +298 -119
- package/dist/web-cjs/purecloud-platform-client-v2.js +298 -119
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +563 -8
- package/package.json +1 -1
- package/src/purecloud-platform-client-v2/ApiClient.js +5 -1
- package/src/purecloud-platform-client-v2/api/AIStudioApi.js +36 -1
- package/src/purecloud-platform-client-v2/api/AgentAssistantsApi.js +156 -1
- package/src/purecloud-platform-client-v2/api/AgentCopilotApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AgentUIApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AlertingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +135 -1
- package/src/purecloud-platform-client-v2/api/ArchitectApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AuditApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +1 -14
- package/src/purecloud-platform-client-v2/api/BillingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/BusinessRulesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/CarrierServicesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ChatApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/CoachingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ContentManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ConversationsApi.js +273 -13
- package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/DataPrivacyApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/DownloadsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EmailsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EmployeeEngagementApi.js +30 -1
- package/src/purecloud-platform-client-v2/api/EventsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/FaxApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/FlowsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GamificationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GeolocationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GreetingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GroupsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/IdentityProviderApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/InfrastructureAsCodeApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/JourneyApi.js +5 -5
- package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LanguagesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LearningApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LicenseApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LocationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LogCaptureApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/MessagingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/MobileDevicesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/NotificationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OAuthApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ObjectsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OperationalEventsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OrganizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OutboundApi.js +3 -2
- package/src/purecloud-platform-client-v2/api/PresenceApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ProcessAutomationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/QualityApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RecordingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RoutingApi.js +134 -1
- package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ScreenRecordingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ScriptsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SearchApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SettingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SocialMediaApi.js +3 -2
- package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/StationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SuggestApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TaskManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TeamsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TelephonyApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TextbotsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TokensApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UploadsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsageApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsersApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsersRulesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/VoicemailApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebChatApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebMessagingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WidgetsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/index.js +1 -1
|
@@ -6519,7 +6519,7 @@ if(env)this.environment=env;else this.environment=this.host?this.host:'mypureclo
|
|
|
6519
6519
|
this.environment=this.environment.replace(/\/+$/,'');// Strip protocol and subdomain
|
|
6520
6520
|
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];}}}]);}();/**
|
|
6521
6521
|
* @module purecloud-platform-client-v2/ApiClient
|
|
6522
|
-
* @version
|
|
6522
|
+
* @version 241.0.0
|
|
6523
6523
|
*/var ApiClient=/*#__PURE__*/function(){/**
|
|
6524
6524
|
* Manages low level client-server communications, parameter marshalling, etc. There should not be any need for an
|
|
6525
6525
|
* application to use this class directly - the *Api and model classes provide the public API for the service. The
|
|
@@ -6636,11 +6636,12 @@ var tempState=this.authData.state;this.authData=localStorage.getItem("".concat(t
|
|
|
6636
6636
|
* @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.
|
|
6637
6637
|
* @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.
|
|
6638
6638
|
* @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.
|
|
6639
|
+
* @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).
|
|
6639
6640
|
*/},{key:"loginImplicitGrant",value:function loginImplicitGrant(clientId,redirectUri,opts){var _this4=this;// Check for auth token in hash
|
|
6640
6641
|
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
|
|
6641
6642
|
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
|
|
6642
6643
|
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
|
|
6643
|
-
_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);});});}/**
|
|
6644
|
+
_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);});});}/**
|
|
6644
6645
|
* @description Initiates the client credentials login flow. Only available in node apps.
|
|
6645
6646
|
* @param {string} clientId - The client ID of an OAuth Implicit Grant client
|
|
6646
6647
|
* @param {string} clientSecret - The client secret of an OAuth Implicit Grant client
|
|
@@ -6690,6 +6691,7 @@ return reject(new Error("Code Challenge Error ".concat(error)));});});}}/**
|
|
|
6690
6691
|
* @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.
|
|
6691
6692
|
* @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.
|
|
6692
6693
|
* @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.
|
|
6694
|
+
* @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).
|
|
6693
6695
|
* @param {string} codeVerifier - (optional) code verifier used to generate the code challenge
|
|
6694
6696
|
*/},{key:"loginPKCEGrant",value:function loginPKCEGrant(clientId,redirectUri,opts,codeVerifier){var _this8=this;// Need Local Storage or non null codeVerifier as parameter
|
|
6695
6697
|
if(!this.hasLocalStorage&&!codeVerifier){throw new Error("loginPKCEGrant requires Local Storage or codeVerifier as input parameter");}// Check for auth code in query
|
|
@@ -6707,7 +6709,7 @@ if(_this8.hasLocalStorage){sessionStorage.removeItem("genesys_cloud_sdk_pkce_cod
|
|
|
6707
6709
|
_this8._saveSettings({accessToken:undefined});// remove codeVerifier from session storage
|
|
6708
6710
|
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
|
|
6709
6711
|
_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
|
|
6710
|
-
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,"]")));});});}});}/**
|
|
6712
|
+
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,"]")));});});}});}/**
|
|
6711
6713
|
* @description Parses the URL Query, grabs the code, and clears the query param. If no code is found, no action is taken.
|
|
6712
6714
|
*/},{key:"_setValuesFromUrlQuery",value:function _setValuesFromUrlQuery(){// Check for window
|
|
6713
6715
|
if(!(typeof window!=='undefined'&&window.location.search))return;// Process query string
|
|
@@ -6875,7 +6877,7 @@ resolve(data);})["catch"](function(error){var data=error;if(error.response&&erro
|
|
|
6875
6877
|
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(){/**
|
|
6876
6878
|
* AIStudio service.
|
|
6877
6879
|
* @module purecloud-platform-client-v2/api/AIStudioApi
|
|
6878
|
-
* @version
|
|
6880
|
+
* @version 241.0.0
|
|
6879
6881
|
*//**
|
|
6880
6882
|
* Constructs a new AIStudioApi.
|
|
6881
6883
|
* @alias module:purecloud-platform-client-v2/api/AIStudioApi
|
|
@@ -6987,6 +6989,15 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
6987
6989
|
* @param {Object} body
|
|
6988
6990
|
*/},{key:"postConversationsSummariesSettings",value:function postConversationsSummariesSettings(body){// verify the required parameter 'body' is set
|
|
6989
6991
|
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']);}/**
|
|
6992
|
+
* Add a turn to a guide session.
|
|
6993
|
+
* 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.
|
|
6994
|
+
* @param {String} guideId Guide ID
|
|
6995
|
+
* @param {String} guideSessionId Guide Session ID
|
|
6996
|
+
* @param {Object} body
|
|
6997
|
+
*/},{key:"postGuideSessionTurns",value:function postGuideSessionTurns(guideId,guideSessionId,body){// verify the required parameter 'guideId' is set
|
|
6998
|
+
if(guideId===undefined||guideId===null||guideId===''){throw'Missing the required parameter "guideId" when calling postGuideSessionTurns';}// verify the required parameter 'guideSessionId' is set
|
|
6999
|
+
if(guideSessionId===undefined||guideSessionId===null||guideSessionId===''){throw'Missing the required parameter "guideSessionId" when calling postGuideSessionTurns';}// verify the required parameter 'body' is set
|
|
7000
|
+
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']);}/**
|
|
6990
7001
|
* Start the publishing of a guide version.
|
|
6991
7002
|
*
|
|
6992
7003
|
* @param {String} guideId Guide ID
|
|
@@ -7026,7 +7037,7 @@ if(summarySettingId===undefined||summarySettingId===null||summarySettingId==='')
|
|
|
7026
7037
|
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(){/**
|
|
7027
7038
|
* AgentAssistants service.
|
|
7028
7039
|
* @module purecloud-platform-client-v2/api/AgentAssistantsApi
|
|
7029
|
-
* @version
|
|
7040
|
+
* @version 241.0.0
|
|
7030
7041
|
*//**
|
|
7031
7042
|
* Constructs a new AgentAssistantsApi.
|
|
7032
7043
|
* @alias module:purecloud-platform-client-v2/api/AgentAssistantsApi
|
|
@@ -7053,6 +7064,11 @@ if(queueId===undefined||queueId===null||queueId===''){throw'Missing the required
|
|
|
7053
7064
|
* @param {String} opts.queueIds Comma-separated identifiers of the queues that need to be deleted.
|
|
7054
7065
|
*/},{key:"deleteAssistantQueues",value:function deleteAssistantQueues(assistantId,opts){opts=opts||{};// verify the required parameter 'assistantId' is set
|
|
7055
7066
|
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']);}/**
|
|
7067
|
+
* Delete an agent checklist
|
|
7068
|
+
*
|
|
7069
|
+
* @param {String} agentChecklistId Agent Checklist ID
|
|
7070
|
+
*/},{key:"deleteAssistantsAgentchecklist",value:function deleteAssistantsAgentchecklist(agentChecklistId){// verify the required parameter 'agentChecklistId' is set
|
|
7071
|
+
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']);}/**
|
|
7056
7072
|
* Get an assistant.
|
|
7057
7073
|
*
|
|
7058
7074
|
* @param {String} assistantId Assistant ID
|
|
@@ -7089,6 +7105,25 @@ if(assistantId===undefined||assistantId===null||assistantId===''){throw'Missing
|
|
|
7089
7105
|
* @param {String} opts.name Return the assistant by the given name.
|
|
7090
7106
|
* @param {Object} opts.expand Which fields, if any, to expand
|
|
7091
7107
|
*/},{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']);}/**
|
|
7108
|
+
* Get an agent checklist
|
|
7109
|
+
*
|
|
7110
|
+
* @param {String} agentChecklistId Agent Checklist ID
|
|
7111
|
+
*/},{key:"getAssistantsAgentchecklist",value:function getAssistantsAgentchecklist(agentChecklistId){// verify the required parameter 'agentChecklistId' is set
|
|
7112
|
+
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']);}/**
|
|
7113
|
+
* Get the list of agent checklists
|
|
7114
|
+
*
|
|
7115
|
+
* @param {Object} opts Optional parameters
|
|
7116
|
+
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
7117
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
7118
|
+
* @param {String} opts.pageSize The page size for the listing. The max that will be returned is 100. (default to 25)
|
|
7119
|
+
* @param {String} opts.namePrefix The agent checklist name prefix filter applied to the listing.
|
|
7120
|
+
* @param {String} opts.language The agent checklist language filter applied to the listing.
|
|
7121
|
+
* @param {Object} opts.sortOrder The sort order for the listing
|
|
7122
|
+
* @param {Object} opts.sortBy The field to sort by for the listing.
|
|
7123
|
+
*/},{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']);}/**
|
|
7124
|
+
* Get the list of supported languages
|
|
7125
|
+
*
|
|
7126
|
+
*/},{key:"getAssistantsAgentchecklistsLanguages",value:function getAssistantsAgentchecklistsLanguages(){return this.apiClient.callApi('/api/v2/assistants/agentchecklists/languages','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
7092
7127
|
* Get all queues assigned to any assistant.
|
|
7093
7128
|
*
|
|
7094
7129
|
* @param {Object} opts Optional parameters
|
|
@@ -7146,6 +7181,11 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
7146
7181
|
* @param {Object} body
|
|
7147
7182
|
*/},{key:"postAssistants",value:function postAssistants(body){// verify the required parameter 'body' is set
|
|
7148
7183
|
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']);}/**
|
|
7184
|
+
* Create an agent checklist
|
|
7185
|
+
*
|
|
7186
|
+
* @param {Object} body Request body containing details of checklist to be added
|
|
7187
|
+
*/},{key:"postAssistantsAgentchecklists",value:function postAssistantsAgentchecklists(body){// verify the required parameter 'body' is set
|
|
7188
|
+
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']);}/**
|
|
7149
7189
|
* Create a queue assistant association.
|
|
7150
7190
|
*
|
|
7151
7191
|
* @param {String} assistantId Assistant ID
|
|
@@ -7154,10 +7194,17 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
7154
7194
|
*/},{key:"putAssistantQueue",value:function putAssistantQueue(assistantId,queueId,body){// verify the required parameter 'assistantId' is set
|
|
7155
7195
|
if(assistantId===undefined||assistantId===null||assistantId===''){throw'Missing the required parameter "assistantId" when calling putAssistantQueue';}// verify the required parameter 'queueId' is set
|
|
7156
7196
|
if(queueId===undefined||queueId===null||queueId===''){throw'Missing the required parameter "queueId" when calling putAssistantQueue';}// verify the required parameter 'body' is set
|
|
7157
|
-
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']);}
|
|
7197
|
+
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']);}/**
|
|
7198
|
+
* Update an agent checklist
|
|
7199
|
+
*
|
|
7200
|
+
* @param {String} agentChecklistId Agent Checklist ID
|
|
7201
|
+
* @param {Object} body Request body containing details of checklist to be updated
|
|
7202
|
+
*/},{key:"putAssistantsAgentchecklist",value:function putAssistantsAgentchecklist(agentChecklistId,body){// verify the required parameter 'agentChecklistId' is set
|
|
7203
|
+
if(agentChecklistId===undefined||agentChecklistId===null||agentChecklistId===''){throw'Missing the required parameter "agentChecklistId" when calling putAssistantsAgentchecklist';}// verify the required parameter 'body' is set
|
|
7204
|
+
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(){/**
|
|
7158
7205
|
* AgentCopilot service.
|
|
7159
7206
|
* @module purecloud-platform-client-v2/api/AgentCopilotApi
|
|
7160
|
-
* @version
|
|
7207
|
+
* @version 241.0.0
|
|
7161
7208
|
*//**
|
|
7162
7209
|
* Constructs a new AgentCopilotApi.
|
|
7163
7210
|
* @alias module:purecloud-platform-client-v2/api/AgentCopilotApi
|
|
@@ -7184,7 +7231,7 @@ if(assistantId===undefined||assistantId===null||assistantId===''){throw'Missing
|
|
|
7184
7231
|
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(){/**
|
|
7185
7232
|
* AgentUI service.
|
|
7186
7233
|
* @module purecloud-platform-client-v2/api/AgentUIApi
|
|
7187
|
-
* @version
|
|
7234
|
+
* @version 241.0.0
|
|
7188
7235
|
*//**
|
|
7189
7236
|
* Constructs a new AgentUIApi.
|
|
7190
7237
|
* @alias module:purecloud-platform-client-v2/api/AgentUIApi
|
|
@@ -7218,7 +7265,7 @@ if(agentId===undefined||agentId===null||agentId===''){throw'Missing the required
|
|
|
7218
7265
|
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(){/**
|
|
7219
7266
|
* Alerting service.
|
|
7220
7267
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
7221
|
-
* @version
|
|
7268
|
+
* @version 241.0.0
|
|
7222
7269
|
*//**
|
|
7223
7270
|
* Constructs a new AlertingApi.
|
|
7224
7271
|
* @alias module:purecloud-platform-client-v2/api/AlertingApi
|
|
@@ -7307,7 +7354,7 @@ if(ruleId===undefined||ruleId===null||ruleId===''){throw'Missing the required pa
|
|
|
7307
7354
|
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(){/**
|
|
7308
7355
|
* Analytics service.
|
|
7309
7356
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
7310
|
-
* @version
|
|
7357
|
+
* @version 241.0.0
|
|
7311
7358
|
*//**
|
|
7312
7359
|
* Constructs a new AnalyticsApi.
|
|
7313
7360
|
* @alias module:purecloud-platform-client-v2/api/AnalyticsApi
|
|
@@ -7333,6 +7380,12 @@ if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required param
|
|
|
7333
7380
|
* deleteAnalyticsBotsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
7334
7381
|
*/},{key:"deleteAnalyticsBotsAggregatesJob",value:function deleteAnalyticsBotsAggregatesJob(jobId){// verify the required parameter 'jobId' is set
|
|
7335
7382
|
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']);}/**
|
|
7383
|
+
* Delete/cancel an async request for case management aggregates
|
|
7384
|
+
*
|
|
7385
|
+
* @param {String} jobId jobId
|
|
7386
|
+
* deleteAnalyticsCasemanagementAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
7387
|
+
*/},{key:"deleteAnalyticsCasemanagementAggregatesJob",value:function deleteAnalyticsCasemanagementAggregatesJob(jobId){// verify the required parameter 'jobId' is set
|
|
7388
|
+
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']);}/**
|
|
7336
7389
|
* Delete/cancel an async request for conversation aggregates
|
|
7337
7390
|
*
|
|
7338
7391
|
* @param {String} jobId jobId
|
|
@@ -7500,6 +7553,20 @@ if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required param
|
|
|
7500
7553
|
* getAnalyticsBotsAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
7501
7554
|
*/},{key:"getAnalyticsBotsAggregatesJobResults",value:function getAnalyticsBotsAggregatesJobResults(jobId,opts){opts=opts||{};// verify the required parameter 'jobId' is set
|
|
7502
7555
|
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']);}/**
|
|
7556
|
+
* Get status for async query for case management aggregates
|
|
7557
|
+
*
|
|
7558
|
+
* @param {String} jobId jobId
|
|
7559
|
+
* getAnalyticsCasemanagementAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
7560
|
+
*/},{key:"getAnalyticsCasemanagementAggregatesJob",value:function getAnalyticsCasemanagementAggregatesJob(jobId){// verify the required parameter 'jobId' is set
|
|
7561
|
+
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']);}/**
|
|
7562
|
+
* Fetch a page of results for an async case management query
|
|
7563
|
+
*
|
|
7564
|
+
* @param {String} jobId jobId
|
|
7565
|
+
* @param {Object} opts Optional parameters
|
|
7566
|
+
* @param {String} opts.cursor Cursor token to retrieve next page
|
|
7567
|
+
* getAnalyticsCasemanagementAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
7568
|
+
*/},{key:"getAnalyticsCasemanagementAggregatesJobResults",value:function getAnalyticsCasemanagementAggregatesJobResults(jobId,opts){opts=opts||{};// verify the required parameter 'jobId' is set
|
|
7569
|
+
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']);}/**
|
|
7503
7570
|
* Get a conversation by id
|
|
7504
7571
|
*
|
|
7505
7572
|
* @param {String} conversationId conversationId
|
|
@@ -7831,6 +7898,18 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
7831
7898
|
* @param {Object} body query
|
|
7832
7899
|
*/},{key:"postAnalyticsBotsAggregatesQuery",value:function postAnalyticsBotsAggregatesQuery(body){// verify the required parameter 'body' is set
|
|
7833
7900
|
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']);}/**
|
|
7901
|
+
* Query for case management aggregates asynchronously
|
|
7902
|
+
*
|
|
7903
|
+
* @param {Object} body query
|
|
7904
|
+
* postAnalyticsCasemanagementAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
7905
|
+
*/},{key:"postAnalyticsCasemanagementAggregatesJobs",value:function postAnalyticsCasemanagementAggregatesJobs(body){// verify the required parameter 'body' is set
|
|
7906
|
+
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']);}/**
|
|
7907
|
+
* Query for case management aggregates
|
|
7908
|
+
*
|
|
7909
|
+
* @param {Object} body query
|
|
7910
|
+
* postAnalyticsCasemanagementAggregatesQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
7911
|
+
*/},{key:"postAnalyticsCasemanagementAggregatesQuery",value:function postAnalyticsCasemanagementAggregatesQuery(body){// verify the required parameter 'body' is set
|
|
7912
|
+
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']);}/**
|
|
7834
7913
|
* Index conversation properties
|
|
7835
7914
|
*
|
|
7836
7915
|
* @param {String} conversationId conversationId
|
|
@@ -8083,7 +8162,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
8083
8162
|
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(){/**
|
|
8084
8163
|
* Architect service.
|
|
8085
8164
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
8086
|
-
* @version
|
|
8165
|
+
* @version 241.0.0
|
|
8087
8166
|
*//**
|
|
8088
8167
|
* Constructs a new ArchitectApi.
|
|
8089
8168
|
* @alias module:purecloud-platform-client-v2/api/ArchitectApi
|
|
@@ -9217,7 +9296,7 @@ if(milestoneId===undefined||milestoneId===null||milestoneId===''){throw'Missing
|
|
|
9217
9296
|
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(){/**
|
|
9218
9297
|
* Audit service.
|
|
9219
9298
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
9220
|
-
* @version
|
|
9299
|
+
* @version 241.0.0
|
|
9221
9300
|
*//**
|
|
9222
9301
|
* Constructs a new AuditApi.
|
|
9223
9302
|
* @alias module:purecloud-platform-client-v2/api/AuditApi
|
|
@@ -9267,7 +9346,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
9267
9346
|
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(){/**
|
|
9268
9347
|
* Authorization service.
|
|
9269
9348
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
9270
|
-
* @version
|
|
9349
|
+
* @version 241.0.0
|
|
9271
9350
|
*//**
|
|
9272
9351
|
* Constructs a new AuthorizationApi.
|
|
9273
9352
|
* @alias module:purecloud-platform-client-v2/api/AuthorizationApi
|
|
@@ -9286,7 +9365,6 @@ if(divisionId===undefined||divisionId===null||divisionId===''){throw'Missing the
|
|
|
9286
9365
|
*
|
|
9287
9366
|
* @param {String} targetName The domain:entity:action target to which the policy is applied
|
|
9288
9367
|
* @param {String} subjectId The ID of the subject to which the policy is applied
|
|
9289
|
-
* deleteAuthorizationPoliciesTargetSubjectSubjectId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
9290
9368
|
*/},{key:"deleteAuthorizationPoliciesTargetSubjectSubjectId",value:function deleteAuthorizationPoliciesTargetSubjectSubjectId(targetName,subjectId){// verify the required parameter 'targetName' is set
|
|
9291
9369
|
if(targetName===undefined||targetName===null||targetName===''){throw'Missing the required parameter "targetName" when calling deleteAuthorizationPoliciesTargetSubjectSubjectId';}// verify the required parameter 'subjectId' is set
|
|
9292
9370
|
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']);}/**
|
|
@@ -9393,7 +9471,6 @@ if(permission===undefined||permission===null){throw'Missing the required paramet
|
|
|
9393
9471
|
* @param {Object} opts Optional parameters
|
|
9394
9472
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
9395
9473
|
* @param {Number} opts.pageSize Number of entities to return. Maximum of 200. (default to 25)
|
|
9396
|
-
* getAuthorizationPolicies is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
9397
9474
|
*/},{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']);}/**
|
|
9398
9475
|
* Get a page of access policies for a given subject
|
|
9399
9476
|
*
|
|
@@ -9401,7 +9478,6 @@ if(permission===undefined||permission===null){throw'Missing the required paramet
|
|
|
9401
9478
|
* @param {Object} opts Optional parameters
|
|
9402
9479
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
9403
9480
|
* @param {Number} opts.pageSize Number of entities to return. Maximum of 200. (default to 25)
|
|
9404
|
-
* getAuthorizationPoliciesSubjectSubjectId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
9405
9481
|
*/},{key:"getAuthorizationPoliciesSubjectSubjectId",value:function getAuthorizationPoliciesSubjectSubjectId(subjectId,opts){opts=opts||{};// verify the required parameter 'subjectId' is set
|
|
9406
9482
|
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']);}/**
|
|
9407
9483
|
* Get a page of access policies for a given policy target
|
|
@@ -9410,31 +9486,26 @@ if(subjectId===undefined||subjectId===null||subjectId===''){throw'Missing the re
|
|
|
9410
9486
|
* @param {Object} opts Optional parameters
|
|
9411
9487
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
9412
9488
|
* @param {Number} opts.pageSize Number of entities to return. Maximum of 200. (default to 25)
|
|
9413
|
-
* getAuthorizationPoliciesTarget is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
9414
9489
|
*/},{key:"getAuthorizationPoliciesTarget",value:function getAuthorizationPoliciesTarget(targetName,opts){opts=opts||{};// verify the required parameter 'targetName' is set
|
|
9415
9490
|
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']);}/**
|
|
9416
9491
|
* Get an access control policy for a specified resource target and subject
|
|
9417
9492
|
*
|
|
9418
9493
|
* @param {String} targetName The domain:entity:action resource target to which the policy is applied
|
|
9419
9494
|
* @param {String} subjectId The ID of the subject to which the policy is applied
|
|
9420
|
-
* getAuthorizationPoliciesTargetSubjectSubjectId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
9421
9495
|
*/},{key:"getAuthorizationPoliciesTargetSubjectSubjectId",value:function getAuthorizationPoliciesTargetSubjectSubjectId(targetName,subjectId){// verify the required parameter 'targetName' is set
|
|
9422
9496
|
if(targetName===undefined||targetName===null||targetName===''){throw'Missing the required parameter "targetName" when calling getAuthorizationPoliciesTargetSubjectSubjectId';}// verify the required parameter 'subjectId' is set
|
|
9423
9497
|
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']);}/**
|
|
9424
9498
|
* Get a map of policy targets to valid attributes for those targets
|
|
9425
9499
|
*
|
|
9426
|
-
* getAuthorizationPoliciesTargets is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
9427
9500
|
*/},{key:"getAuthorizationPoliciesTargets",value:function getAuthorizationPoliciesTargets(){return this.apiClient.callApi('/api/v2/authorization/policies/targets','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
9428
9501
|
* Get an access control policy with the specified policy ID
|
|
9429
9502
|
*
|
|
9430
9503
|
* @param {String} policyId The ID of the policy to retrieve
|
|
9431
|
-
* getAuthorizationPolicy is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
9432
9504
|
*/},{key:"getAuthorizationPolicy",value:function getAuthorizationPolicy(policyId){// verify the required parameter 'policyId' is set
|
|
9433
9505
|
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']);}/**
|
|
9434
9506
|
* Get the list of attributes used to evaluate an access control policy with the specified policy ID
|
|
9435
9507
|
*
|
|
9436
9508
|
* @param {String} policyId The ID of the policy to retrieve attributes
|
|
9437
|
-
* getAuthorizationPolicyAttributes is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
9438
9509
|
*/},{key:"getAuthorizationPolicyAttributes",value:function getAuthorizationPolicyAttributes(policyId){// verify the required parameter 'policyId' is set
|
|
9439
9510
|
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']);}/**
|
|
9440
9511
|
* Get the list of enabled products
|
|
@@ -9555,7 +9626,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
9555
9626
|
*
|
|
9556
9627
|
* @param {String} targetName The domain:entity:action target to which the policy will be applied
|
|
9557
9628
|
* @param {Object} body Access control policy
|
|
9558
|
-
* postAuthorizationPoliciesTarget is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
9559
9629
|
*/},{key:"postAuthorizationPoliciesTarget",value:function postAuthorizationPoliciesTarget(targetName,body){// verify the required parameter 'targetName' is set
|
|
9560
9630
|
if(targetName===undefined||targetName===null||targetName===''){throw'Missing the required parameter "targetName" when calling postAuthorizationPoliciesTarget';}// verify the required parameter 'body' is set
|
|
9561
9631
|
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']);}/**
|
|
@@ -9563,7 +9633,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
9563
9633
|
*
|
|
9564
9634
|
* @param {String} targetName The domain:entity:action target to which the policy will be applied
|
|
9565
9635
|
* @param {Object} body Access control policy
|
|
9566
|
-
* postAuthorizationPoliciesTargetValidate is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
9567
9636
|
*/},{key:"postAuthorizationPoliciesTargetValidate",value:function postAuthorizationPoliciesTargetValidate(targetName,body){// verify the required parameter 'targetName' is set
|
|
9568
9637
|
if(targetName===undefined||targetName===null||targetName===''){throw'Missing the required parameter "targetName" when calling postAuthorizationPoliciesTargetValidate';}// verify the required parameter 'body' is set
|
|
9569
9638
|
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']);}/**
|
|
@@ -9571,7 +9640,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
9571
9640
|
*
|
|
9572
9641
|
* @param {String} policyId The ID of the policy to test the simulated data against
|
|
9573
9642
|
* @param {Object} body A map of attribute names to type and simulated data value
|
|
9574
|
-
* postAuthorizationPolicySimulate is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
9575
9643
|
*/},{key:"postAuthorizationPolicySimulate",value:function postAuthorizationPolicySimulate(policyId,body){// verify the required parameter 'policyId' is set
|
|
9576
9644
|
if(policyId===undefined||policyId===null||policyId===''){throw'Missing the required parameter "policyId" when calling postAuthorizationPolicySimulate';}// verify the required parameter 'body' is set
|
|
9577
9645
|
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']);}/**
|
|
@@ -9650,7 +9718,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
9650
9718
|
*
|
|
9651
9719
|
* @param {String} targetName The domain:entity:action target to which the policy will be applied
|
|
9652
9720
|
* @param {Object} body Access control policy
|
|
9653
|
-
* putAuthorizationPoliciesTarget is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
9654
9721
|
*/},{key:"putAuthorizationPoliciesTarget",value:function putAuthorizationPoliciesTarget(targetName,body){// verify the required parameter 'targetName' is set
|
|
9655
9722
|
if(targetName===undefined||targetName===null||targetName===''){throw'Missing the required parameter "targetName" when calling putAuthorizationPoliciesTarget';}// verify the required parameter 'body' is set
|
|
9656
9723
|
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']);}/**
|
|
@@ -9658,7 +9725,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
9658
9725
|
*
|
|
9659
9726
|
* @param {String} policyId The ID of the policy to update
|
|
9660
9727
|
* @param {Object} body Access control policy
|
|
9661
|
-
* putAuthorizationPolicy is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
9662
9728
|
*/},{key:"putAuthorizationPolicy",value:function putAuthorizationPolicy(policyId,body){// verify the required parameter 'policyId' is set
|
|
9663
9729
|
if(policyId===undefined||policyId===null||policyId===''){throw'Missing the required parameter "policyId" when calling putAuthorizationPolicy';}// verify the required parameter 'body' is set
|
|
9664
9730
|
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']);}/**
|
|
@@ -9702,7 +9768,7 @@ if(subjectId===undefined||subjectId===null||subjectId===''){throw'Missing the re
|
|
|
9702
9768
|
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(){/**
|
|
9703
9769
|
* Billing service.
|
|
9704
9770
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
9705
|
-
* @version
|
|
9771
|
+
* @version 241.0.0
|
|
9706
9772
|
*//**
|
|
9707
9773
|
* Constructs a new BillingApi.
|
|
9708
9774
|
* @alias module:purecloud-platform-client-v2/api/BillingApi
|
|
@@ -9779,7 +9845,7 @@ if(endDate===undefined||endDate===null){throw'Missing the required parameter "en
|
|
|
9779
9845
|
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(){/**
|
|
9780
9846
|
* BusinessRules service.
|
|
9781
9847
|
* @module purecloud-platform-client-v2/api/BusinessRulesApi
|
|
9782
|
-
* @version
|
|
9848
|
+
* @version 241.0.0
|
|
9783
9849
|
*//**
|
|
9784
9850
|
* Constructs a new BusinessRulesApi.
|
|
9785
9851
|
* @alias module:purecloud-platform-client-v2/api/BusinessRulesApi
|
|
@@ -10000,7 +10066,7 @@ if(schemaId===undefined||schemaId===null||schemaId===''){throw'Missing the requi
|
|
|
10000
10066
|
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(){/**
|
|
10001
10067
|
* CarrierServices service.
|
|
10002
10068
|
* @module purecloud-platform-client-v2/api/CarrierServicesApi
|
|
10003
|
-
* @version
|
|
10069
|
+
* @version 241.0.0
|
|
10004
10070
|
*//**
|
|
10005
10071
|
* Constructs a new CarrierServicesApi.
|
|
10006
10072
|
* @alias module:purecloud-platform-client-v2/api/CarrierServicesApi
|
|
@@ -10020,7 +10086,7 @@ if(phoneNumber===undefined||phoneNumber===null){throw'Missing the required param
|
|
|
10020
10086
|
*/},{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(){/**
|
|
10021
10087
|
* Chat service.
|
|
10022
10088
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
10023
|
-
* @version
|
|
10089
|
+
* @version 241.0.0
|
|
10024
10090
|
*//**
|
|
10025
10091
|
* Constructs a new ChatApi.
|
|
10026
10092
|
* @alias module:purecloud-platform-client-v2/api/ChatApi
|
|
@@ -10251,7 +10317,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
10251
10317
|
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(){/**
|
|
10252
10318
|
* Coaching service.
|
|
10253
10319
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
10254
|
-
* @version
|
|
10320
|
+
* @version 241.0.0
|
|
10255
10321
|
*//**
|
|
10256
10322
|
* Constructs a new CoachingApi.
|
|
10257
10323
|
* @alias module:purecloud-platform-client-v2/api/CoachingApi
|
|
@@ -10414,7 +10480,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
10414
10480
|
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(){/**
|
|
10415
10481
|
* ContentManagement service.
|
|
10416
10482
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
10417
|
-
* @version
|
|
10483
|
+
* @version 241.0.0
|
|
10418
10484
|
*//**
|
|
10419
10485
|
* Constructs a new ContentManagementApi.
|
|
10420
10486
|
* @alias module:purecloud-platform-client-v2/api/ContentManagementApi
|
|
@@ -10696,7 +10762,7 @@ if(tagId===undefined||tagId===null||tagId===''){throw'Missing the required param
|
|
|
10696
10762
|
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(){/**
|
|
10697
10763
|
* Conversations service.
|
|
10698
10764
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
10699
|
-
* @version
|
|
10765
|
+
* @version 241.0.0
|
|
10700
10766
|
*//**
|
|
10701
10767
|
* Constructs a new ConversationsApi.
|
|
10702
10768
|
* @alias module:purecloud-platform-client-v2/api/ConversationsApi
|
|
@@ -10843,6 +10909,33 @@ if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required param
|
|
|
10843
10909
|
* @param {String} conversationId conversation ID
|
|
10844
10910
|
*/},{key:"getConversation",value:function getConversation(conversationId){// verify the required parameter 'conversationId' is set
|
|
10845
10911
|
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']);}/**
|
|
10912
|
+
* Get checklist info for a single checklist.
|
|
10913
|
+
*
|
|
10914
|
+
* @param {String} conversationId Conversation ID
|
|
10915
|
+
* @param {String} communicationId Communication ID
|
|
10916
|
+
* @param {String} agentChecklistId Agent Checklist ID
|
|
10917
|
+
*/},{key:"getConversationCommunicationAgentchecklist",value:function getConversationCommunicationAgentchecklist(conversationId,communicationId,agentChecklistId){// verify the required parameter 'conversationId' is set
|
|
10918
|
+
if(conversationId===undefined||conversationId===null||conversationId===''){throw'Missing the required parameter "conversationId" when calling getConversationCommunicationAgentchecklist';}// verify the required parameter 'communicationId' is set
|
|
10919
|
+
if(communicationId===undefined||communicationId===null||communicationId===''){throw'Missing the required parameter "communicationId" when calling getConversationCommunicationAgentchecklist';}// verify the required parameter 'agentChecklistId' is set
|
|
10920
|
+
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']);}/**
|
|
10921
|
+
* Get inference job status
|
|
10922
|
+
*
|
|
10923
|
+
* @param {String} conversationId Conversation ID
|
|
10924
|
+
* @param {String} communicationId Communication ID
|
|
10925
|
+
* @param {String} agentChecklistId Agent Checklist ID
|
|
10926
|
+
* @param {String} jobId Inference Job ID
|
|
10927
|
+
*/},{key:"getConversationCommunicationAgentchecklistJob",value:function getConversationCommunicationAgentchecklistJob(conversationId,communicationId,agentChecklistId,jobId){// verify the required parameter 'conversationId' is set
|
|
10928
|
+
if(conversationId===undefined||conversationId===null||conversationId===''){throw'Missing the required parameter "conversationId" when calling getConversationCommunicationAgentchecklistJob';}// verify the required parameter 'communicationId' is set
|
|
10929
|
+
if(communicationId===undefined||communicationId===null||communicationId===''){throw'Missing the required parameter "communicationId" when calling getConversationCommunicationAgentchecklistJob';}// verify the required parameter 'agentChecklistId' is set
|
|
10930
|
+
if(agentChecklistId===undefined||agentChecklistId===null||agentChecklistId===''){throw'Missing the required parameter "agentChecklistId" when calling getConversationCommunicationAgentchecklistJob';}// verify the required parameter 'jobId' is set
|
|
10931
|
+
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']);}/**
|
|
10932
|
+
* Get information of all checklists associated with a conversation.
|
|
10933
|
+
*
|
|
10934
|
+
* @param {String} conversationId Conversation ID
|
|
10935
|
+
* @param {String} communicationId Communication ID
|
|
10936
|
+
*/},{key:"getConversationCommunicationAgentchecklists",value:function getConversationCommunicationAgentchecklists(conversationId,communicationId){// verify the required parameter 'conversationId' is set
|
|
10937
|
+
if(conversationId===undefined||conversationId===null||conversationId===''){throw'Missing the required parameter "conversationId" when calling getConversationCommunicationAgentchecklists';}// verify the required parameter 'communicationId' is set
|
|
10938
|
+
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']);}/**
|
|
10846
10939
|
* Get message
|
|
10847
10940
|
*
|
|
10848
10941
|
* @param {String} conversationId conversationId
|
|
@@ -11961,6 +12054,48 @@ if(conversationId===undefined||conversationId===null||conversationId===''){throw
|
|
|
11961
12054
|
* @param {String} conversationId Conversation ID
|
|
11962
12055
|
*/},{key:"postConversationCobrowse",value:function postConversationCobrowse(conversationId){// verify the required parameter 'conversationId' is set
|
|
11963
12056
|
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']);}/**
|
|
12057
|
+
* Agent Checklist activation API
|
|
12058
|
+
*
|
|
12059
|
+
* @param {String} conversationId Conversation ID
|
|
12060
|
+
* @param {String} communicationId Communication ID
|
|
12061
|
+
* @param {String} agentChecklistId Agent Checklist ID
|
|
12062
|
+
* @param {Object} body Agent checklist activation payload
|
|
12063
|
+
*/},{key:"postConversationCommunicationAgentchecklist",value:function postConversationCommunicationAgentchecklist(conversationId,communicationId,agentChecklistId,body){// verify the required parameter 'conversationId' is set
|
|
12064
|
+
if(conversationId===undefined||conversationId===null||conversationId===''){throw'Missing the required parameter "conversationId" when calling postConversationCommunicationAgentchecklist';}// verify the required parameter 'communicationId' is set
|
|
12065
|
+
if(communicationId===undefined||communicationId===null||communicationId===''){throw'Missing the required parameter "communicationId" when calling postConversationCommunicationAgentchecklist';}// verify the required parameter 'agentChecklistId' is set
|
|
12066
|
+
if(agentChecklistId===undefined||agentChecklistId===null||agentChecklistId===''){throw'Missing the required parameter "agentChecklistId" when calling postConversationCommunicationAgentchecklist';}// verify the required parameter 'body' is set
|
|
12067
|
+
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']);}/**
|
|
12068
|
+
* API invoked to capture an agent action.
|
|
12069
|
+
*
|
|
12070
|
+
* @param {String} conversationId Conversation ID
|
|
12071
|
+
* @param {String} communicationId Communication ID
|
|
12072
|
+
* @param {String} agentChecklistId Agent Checklist ID
|
|
12073
|
+
* @param {Object} body Agent action payload
|
|
12074
|
+
*/},{key:"postConversationCommunicationAgentchecklistAgentaction",value:function postConversationCommunicationAgentchecklistAgentaction(conversationId,communicationId,agentChecklistId,body){// verify the required parameter 'conversationId' is set
|
|
12075
|
+
if(conversationId===undefined||conversationId===null||conversationId===''){throw'Missing the required parameter "conversationId" when calling postConversationCommunicationAgentchecklistAgentaction';}// verify the required parameter 'communicationId' is set
|
|
12076
|
+
if(communicationId===undefined||communicationId===null||communicationId===''){throw'Missing the required parameter "communicationId" when calling postConversationCommunicationAgentchecklistAgentaction';}// verify the required parameter 'agentChecklistId' is set
|
|
12077
|
+
if(agentChecklistId===undefined||agentChecklistId===null||agentChecklistId===''){throw'Missing the required parameter "agentChecklistId" when calling postConversationCommunicationAgentchecklistAgentaction';}// verify the required parameter 'body' is set
|
|
12078
|
+
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']);}/**
|
|
12079
|
+
* Create inference job
|
|
12080
|
+
*
|
|
12081
|
+
* @param {String} conversationId Conversation ID
|
|
12082
|
+
* @param {String} communicationId Communication ID
|
|
12083
|
+
* @param {String} agentChecklistId Agent Checklist ID
|
|
12084
|
+
* @param {Object} body Agent checklist inference job payload
|
|
12085
|
+
*/},{key:"postConversationCommunicationAgentchecklistJobs",value:function postConversationCommunicationAgentchecklistJobs(conversationId,communicationId,agentChecklistId,body){// verify the required parameter 'conversationId' is set
|
|
12086
|
+
if(conversationId===undefined||conversationId===null||conversationId===''){throw'Missing the required parameter "conversationId" when calling postConversationCommunicationAgentchecklistJobs';}// verify the required parameter 'communicationId' is set
|
|
12087
|
+
if(communicationId===undefined||communicationId===null||communicationId===''){throw'Missing the required parameter "communicationId" when calling postConversationCommunicationAgentchecklistJobs';}// verify the required parameter 'agentChecklistId' is set
|
|
12088
|
+
if(agentChecklistId===undefined||agentChecklistId===null||agentChecklistId===''){throw'Missing the required parameter "agentChecklistId" when calling postConversationCommunicationAgentchecklistJobs';}// verify the required parameter 'body' is set
|
|
12089
|
+
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']);}/**
|
|
12090
|
+
* API invoked to finalize agent checklist evaluation.
|
|
12091
|
+
*
|
|
12092
|
+
* @param {String} conversationId Conversation ID
|
|
12093
|
+
* @param {String} communicationId Communication ID
|
|
12094
|
+
* @param {Object} body Agent checklist finalize payload
|
|
12095
|
+
*/},{key:"postConversationCommunicationAgentchecklistsFinalize",value:function postConversationCommunicationAgentchecklistsFinalize(conversationId,communicationId,body){// verify the required parameter 'conversationId' is set
|
|
12096
|
+
if(conversationId===undefined||conversationId===null||conversationId===''){throw'Missing the required parameter "conversationId" when calling postConversationCommunicationAgentchecklistsFinalize';}// verify the required parameter 'communicationId' is set
|
|
12097
|
+
if(communicationId===undefined||communicationId===null||communicationId===''){throw'Missing the required parameter "communicationId" when calling postConversationCommunicationAgentchecklistsFinalize';}// verify the required parameter 'body' is set
|
|
12098
|
+
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']);}/**
|
|
11964
12099
|
* Send internal message
|
|
11965
12100
|
* Send a new internal message for an existing communication.
|
|
11966
12101
|
* @param {String} conversationId conversationId
|
|
@@ -12002,11 +12137,12 @@ if(participantId===undefined||participantId===null||participantId===''){throw'Mi
|
|
|
12002
12137
|
if(conversationId===undefined||conversationId===null||conversationId===''){throw'Missing the required parameter "conversationId" when calling postConversationParticipantInternalmessagesUsersCommunications';}// verify the required parameter 'participantId' is set
|
|
12003
12138
|
if(participantId===undefined||participantId===null||participantId===''){throw'Missing the required parameter "participantId" when calling postConversationParticipantInternalmessagesUsersCommunications';}// verify the required parameter 'body' is set
|
|
12004
12139
|
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']);}/**
|
|
12005
|
-
* Replace this participant
|
|
12006
|
-
*
|
|
12140
|
+
* Replace this participant (Deprecated)
|
|
12141
|
+
* This endpoint is deprecated. Use one of the following endpoints instead: /transfer, /replace/agent, /replace/queue, or /replace/contact/external.
|
|
12007
12142
|
* @param {String} conversationId conversation ID
|
|
12008
12143
|
* @param {String} participantId participant ID
|
|
12009
12144
|
* @param {Object} body Transfer request
|
|
12145
|
+
* @deprecated
|
|
12010
12146
|
*/},{key:"postConversationParticipantReplace",value:function postConversationParticipantReplace(conversationId,participantId,body){// verify the required parameter 'conversationId' is set
|
|
12011
12147
|
if(conversationId===undefined||conversationId===null||conversationId===''){throw'Missing the required parameter "conversationId" when calling postConversationParticipantReplace';}// verify the required parameter 'participantId' is set
|
|
12012
12148
|
if(participantId===undefined||participantId===null||participantId===''){throw'Missing the required parameter "participantId" when calling postConversationParticipantReplace';}// verify the required parameter 'body' is set
|
|
@@ -12025,16 +12161,16 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
12025
12161
|
* @param {String} conversationId conversation ID
|
|
12026
12162
|
* @param {String} participantId participant ID
|
|
12027
12163
|
* @param {Object} body Transfer request
|
|
12028
|
-
* postConversationParticipantReplaceContactExternal is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
12029
12164
|
*/},{key:"postConversationParticipantReplaceContactExternal",value:function postConversationParticipantReplaceContactExternal(conversationId,participantId,body){// verify the required parameter 'conversationId' is set
|
|
12030
12165
|
if(conversationId===undefined||conversationId===null||conversationId===''){throw'Missing the required parameter "conversationId" when calling postConversationParticipantReplaceContactExternal';}// verify the required parameter 'participantId' is set
|
|
12031
12166
|
if(participantId===undefined||participantId===null||participantId===''){throw'Missing the required parameter "participantId" when calling postConversationParticipantReplaceContactExternal';}// verify the required parameter 'body' is set
|
|
12032
12167
|
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']);}/**
|
|
12033
|
-
* Replace this participant with the an external contact
|
|
12034
|
-
*
|
|
12168
|
+
* Replace this participant with the an external contact (Deprecated)
|
|
12169
|
+
* This endpoint is deprecated. Use /replace/contact/external endpoint instead.
|
|
12035
12170
|
* @param {String} conversationId conversation ID
|
|
12036
12171
|
* @param {String} participantId participant ID
|
|
12037
12172
|
* @param {Object} body Transfer request
|
|
12173
|
+
* @deprecated
|
|
12038
12174
|
*/},{key:"postConversationParticipantReplaceExternal",value:function postConversationParticipantReplaceExternal(conversationId,participantId,body){// verify the required parameter 'conversationId' is set
|
|
12039
12175
|
if(conversationId===undefined||conversationId===null||conversationId===''){throw'Missing the required parameter "conversationId" when calling postConversationParticipantReplaceExternal';}// verify the required parameter 'participantId' is set
|
|
12040
12176
|
if(participantId===undefined||participantId===null||participantId===''){throw'Missing the required parameter "participantId" when calling postConversationParticipantReplaceExternal';}// verify the required parameter 'body' is set
|
|
@@ -12062,7 +12198,6 @@ if(participantId===undefined||participantId===null||participantId===''){throw'Mi
|
|
|
12062
12198
|
* @param {String} conversationId conversation ID
|
|
12063
12199
|
* @param {String} participantId participant ID
|
|
12064
12200
|
* @param {Object} body Transfer request
|
|
12065
|
-
* postConversationParticipantTransfer is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
12066
12201
|
*/},{key:"postConversationParticipantTransfer",value:function postConversationParticipantTransfer(conversationId,participantId,body){// verify the required parameter 'conversationId' is set
|
|
12067
12202
|
if(conversationId===undefined||conversationId===null||conversationId===''){throw'Missing the required parameter "conversationId" when calling postConversationParticipantTransfer';}// verify the required parameter 'participantId' is set
|
|
12068
12203
|
if(participantId===undefined||participantId===null||participantId===''){throw'Missing the required parameter "participantId" when calling postConversationParticipantTransfer';}// verify the required parameter 'body' is set
|
|
@@ -12125,11 +12260,12 @@ if(participantId===undefined||participantId===null||participantId===''){throw'Mi
|
|
|
12125
12260
|
if(conversationId===undefined||conversationId===null||conversationId===''){throw'Missing the required parameter "conversationId" when calling postConversationsCallParticipantCommunicationWrapup';}// verify the required parameter 'participantId' is set
|
|
12126
12261
|
if(participantId===undefined||participantId===null||participantId===''){throw'Missing the required parameter "participantId" when calling postConversationsCallParticipantCommunicationWrapup';}// verify the required parameter 'communicationId' is set
|
|
12127
12262
|
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']);}/**
|
|
12128
|
-
* Initiate and update consult transfer
|
|
12129
|
-
*
|
|
12263
|
+
* Initiate and update consult transfer (Deprecated)
|
|
12264
|
+
* This endpoint is deprecated. Use one of the following endpoints instead: /voice/consult, /consult/agent, /consult/queue, or /consult/contact/external.
|
|
12130
12265
|
* @param {String} conversationId conversationId
|
|
12131
12266
|
* @param {String} participantId participantId
|
|
12132
12267
|
* @param {Object} body Destination address and initial speak to
|
|
12268
|
+
* @deprecated
|
|
12133
12269
|
*/},{key:"postConversationsCallParticipantConsult",value:function postConversationsCallParticipantConsult(conversationId,participantId,body){// verify the required parameter 'conversationId' is set
|
|
12134
12270
|
if(conversationId===undefined||conversationId===null||conversationId===''){throw'Missing the required parameter "conversationId" when calling postConversationsCallParticipantConsult';}// verify the required parameter 'participantId' is set
|
|
12135
12271
|
if(participantId===undefined||participantId===null||participantId===''){throw'Missing the required parameter "participantId" when calling postConversationsCallParticipantConsult';}// verify the required parameter 'body' is set
|
|
@@ -12148,16 +12284,16 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
12148
12284
|
* @param {String} conversationId conversationId
|
|
12149
12285
|
* @param {String} participantId participantId
|
|
12150
12286
|
* @param {Object} body Destination address and initial speak to
|
|
12151
|
-
* postConversationsCallParticipantConsultContactExternal is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
12152
12287
|
*/},{key:"postConversationsCallParticipantConsultContactExternal",value:function postConversationsCallParticipantConsultContactExternal(conversationId,participantId,body){// verify the required parameter 'conversationId' is set
|
|
12153
12288
|
if(conversationId===undefined||conversationId===null||conversationId===''){throw'Missing the required parameter "conversationId" when calling postConversationsCallParticipantConsultContactExternal';}// verify the required parameter 'participantId' is set
|
|
12154
12289
|
if(participantId===undefined||participantId===null||participantId===''){throw'Missing the required parameter "participantId" when calling postConversationsCallParticipantConsultContactExternal';}// verify the required parameter 'body' is set
|
|
12155
12290
|
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']);}/**
|
|
12156
|
-
* Initiate a consult transfer to an external contact
|
|
12157
|
-
*
|
|
12291
|
+
* Initiate a consult transfer to an external contact (Deprecated)
|
|
12292
|
+
* This endpoint is deprecated. Use /consult/contact/external endpoints instead.
|
|
12158
12293
|
* @param {String} conversationId conversationId
|
|
12159
12294
|
* @param {String} participantId participantId
|
|
12160
12295
|
* @param {Object} body Destination address and initial speak to
|
|
12296
|
+
* @deprecated
|
|
12161
12297
|
*/},{key:"postConversationsCallParticipantConsultExternal",value:function postConversationsCallParticipantConsultExternal(conversationId,participantId,body){// verify the required parameter 'conversationId' is set
|
|
12162
12298
|
if(conversationId===undefined||conversationId===null||conversationId===''){throw'Missing the required parameter "conversationId" when calling postConversationsCallParticipantConsultExternal';}// verify the required parameter 'participantId' is set
|
|
12163
12299
|
if(participantId===undefined||participantId===null||participantId===''){throw'Missing the required parameter "participantId" when calling postConversationsCallParticipantConsultExternal';}// verify the required parameter 'body' is set
|
|
@@ -12192,7 +12328,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
12192
12328
|
* @param {String} conversationId conversationId
|
|
12193
12329
|
* @param {String} participantId participantId
|
|
12194
12330
|
* @param {Object} body Destination address and initial speak to
|
|
12195
|
-
* postConversationsCallParticipantVoiceConsult is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
12196
12331
|
*/},{key:"postConversationsCallParticipantVoiceConsult",value:function postConversationsCallParticipantVoiceConsult(conversationId,participantId,body){// verify the required parameter 'conversationId' is set
|
|
12197
12332
|
if(conversationId===undefined||conversationId===null||conversationId===''){throw'Missing the required parameter "conversationId" when calling postConversationsCallParticipantVoiceConsult';}// verify the required parameter 'participantId' is set
|
|
12198
12333
|
if(participantId===undefined||participantId===null||participantId===''){throw'Missing the required parameter "participantId" when calling postConversationsCallParticipantVoiceConsult';}// verify the required parameter 'body' is set
|
|
@@ -12797,7 +12932,7 @@ if(conversationId===undefined||conversationId===null||conversationId===''){throw
|
|
|
12797
12932
|
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(){/**
|
|
12798
12933
|
* DataExtensions service.
|
|
12799
12934
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
12800
|
-
* @version
|
|
12935
|
+
* @version 241.0.0
|
|
12801
12936
|
*//**
|
|
12802
12937
|
* Constructs a new DataExtensionsApi.
|
|
12803
12938
|
* @alias module:purecloud-platform-client-v2/api/DataExtensionsApi
|
|
@@ -12818,7 +12953,7 @@ if(coretypeName===undefined||coretypeName===null||coretypeName===''){throw'Missi
|
|
|
12818
12953
|
*/},{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(){/**
|
|
12819
12954
|
* DataPrivacy service.
|
|
12820
12955
|
* @module purecloud-platform-client-v2/api/DataPrivacyApi
|
|
12821
|
-
* @version
|
|
12956
|
+
* @version 241.0.0
|
|
12822
12957
|
*//**
|
|
12823
12958
|
* Constructs a new DataPrivacyApi.
|
|
12824
12959
|
* @alias module:purecloud-platform-client-v2/api/DataPrivacyApi
|
|
@@ -12858,7 +12993,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
12858
12993
|
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(){/**
|
|
12859
12994
|
* Downloads service.
|
|
12860
12995
|
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
12861
|
-
* @version
|
|
12996
|
+
* @version 241.0.0
|
|
12862
12997
|
*//**
|
|
12863
12998
|
* Constructs a new DownloadsApi.
|
|
12864
12999
|
* @alias module:purecloud-platform-client-v2/api/DownloadsApi
|
|
@@ -12877,7 +13012,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
12877
13012
|
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(){/**
|
|
12878
13013
|
* Emails service.
|
|
12879
13014
|
* @module purecloud-platform-client-v2/api/EmailsApi
|
|
12880
|
-
* @version
|
|
13015
|
+
* @version 241.0.0
|
|
12881
13016
|
*//**
|
|
12882
13017
|
* Constructs a new EmailsApi.
|
|
12883
13018
|
* @alias module:purecloud-platform-client-v2/api/EmailsApi
|
|
@@ -12906,7 +13041,7 @@ if(downloadId===undefined||downloadId===null||downloadId===''){throw'Missing the
|
|
|
12906
13041
|
*/},{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(){/**
|
|
12907
13042
|
* EmployeeEngagement service.
|
|
12908
13043
|
* @module purecloud-platform-client-v2/api/EmployeeEngagementApi
|
|
12909
|
-
* @version
|
|
13044
|
+
* @version 241.0.0
|
|
12910
13045
|
*//**
|
|
12911
13046
|
* Constructs a new EmployeeEngagementApi.
|
|
12912
13047
|
* @alias module:purecloud-platform-client-v2/api/EmployeeEngagementApi
|
|
@@ -12930,6 +13065,16 @@ if(celebrationId===undefined||celebrationId===null||celebrationId===''){throw'Mi
|
|
|
12930
13065
|
* @param {String} recognitionId The Recognition ID
|
|
12931
13066
|
*/},{key:"getEmployeeengagementRecognition",value:function getEmployeeengagementRecognition(recognitionId){// verify the required parameter 'recognitionId' is set
|
|
12932
13067
|
if(recognitionId===undefined||recognitionId===null||recognitionId===''){throw'Missing the required parameter "recognitionId" when calling getEmployeeengagementRecognition';}return this.apiClient.callApi('/api/v2/employeeengagement/recognitions/{recognitionId}','GET',{'recognitionId':recognitionId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
13068
|
+
* Gets sent recognitions
|
|
13069
|
+
*
|
|
13070
|
+
* @param {Object} opts Optional parameters
|
|
13071
|
+
* @param {Object} opts.direction The direction of the recognitions. (default to received)
|
|
13072
|
+
* @param {String} opts.recipient The ID of the recipient (when direction is sent).
|
|
13073
|
+
* @param {Date} opts.dateStart The start date of the search range. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
|
|
13074
|
+
* @param {Date} opts.dateEnd The end date of the search range. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
|
|
13075
|
+
* @param {Number} opts.pageSize Page size (default to 100)
|
|
13076
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
13077
|
+
*/},{key:"getEmployeeengagementRecognitions",value:function getEmployeeengagementRecognitions(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/employeeengagement/recognitions','GET',{},{'direction':opts['direction'],'recipient':opts['recipient'],'dateStart':opts['dateStart'],'dateEnd':opts['dateEnd'],'pageSize':opts['pageSize'],'pageNumber':opts['pageNumber']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
12933
13078
|
* Set a state for a celebration
|
|
12934
13079
|
*
|
|
12935
13080
|
* @param {String} celebrationId The ID of the celebration
|
|
@@ -12944,7 +13089,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
12944
13089
|
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(){/**
|
|
12945
13090
|
* Events service.
|
|
12946
13091
|
* @module purecloud-platform-client-v2/api/EventsApi
|
|
12947
|
-
* @version
|
|
13092
|
+
* @version 241.0.0
|
|
12948
13093
|
*//**
|
|
12949
13094
|
* Constructs a new EventsApi.
|
|
12950
13095
|
* @alias module:purecloud-platform-client-v2/api/EventsApi
|
|
@@ -12969,7 +13114,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
12969
13114
|
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(){/**
|
|
12970
13115
|
* ExternalContacts service.
|
|
12971
13116
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
12972
|
-
* @version
|
|
13117
|
+
* @version 241.0.0
|
|
12973
13118
|
*//**
|
|
12974
13119
|
* Constructs a new ExternalContactsApi.
|
|
12975
13120
|
* @alias module:purecloud-platform-client-v2/api/ExternalContactsApi
|
|
@@ -13719,7 +13864,7 @@ if(relationshipId===undefined||relationshipId===null||relationshipId===''){throw
|
|
|
13719
13864
|
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(){/**
|
|
13720
13865
|
* Fax service.
|
|
13721
13866
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
13722
|
-
* @version
|
|
13867
|
+
* @version 241.0.0
|
|
13723
13868
|
*//**
|
|
13724
13869
|
* Constructs a new FaxApi.
|
|
13725
13870
|
* @alias module:purecloud-platform-client-v2/api/FaxApi
|
|
@@ -13768,7 +13913,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
13768
13913
|
*/},{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(){/**
|
|
13769
13914
|
* Flows service.
|
|
13770
13915
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
13771
|
-
* @version
|
|
13916
|
+
* @version 241.0.0
|
|
13772
13917
|
*//**
|
|
13773
13918
|
* Constructs a new FlowsApi.
|
|
13774
13919
|
* @alias module:purecloud-platform-client-v2/api/FlowsApi
|
|
@@ -13822,7 +13967,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
13822
13967
|
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(){/**
|
|
13823
13968
|
* Gamification service.
|
|
13824
13969
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
13825
|
-
* @version
|
|
13970
|
+
* @version 241.0.0
|
|
13826
13971
|
*//**
|
|
13827
13972
|
* Constructs a new GamificationApi.
|
|
13828
13973
|
* @alias module:purecloud-platform-client-v2/api/GamificationApi
|
|
@@ -14493,7 +14638,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
14493
14638
|
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(){/**
|
|
14494
14639
|
* GeneralDataProtectionRegulation service.
|
|
14495
14640
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
14496
|
-
* @version
|
|
14641
|
+
* @version 241.0.0
|
|
14497
14642
|
*//**
|
|
14498
14643
|
* Constructs a new GeneralDataProtectionRegulationApi.
|
|
14499
14644
|
* @alias module:purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
@@ -14528,7 +14673,7 @@ if(searchValue===undefined||searchValue===null){throw'Missing the required param
|
|
|
14528
14673
|
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(){/**
|
|
14529
14674
|
* Geolocation service.
|
|
14530
14675
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
14531
|
-
* @version
|
|
14676
|
+
* @version 241.0.0
|
|
14532
14677
|
*//**
|
|
14533
14678
|
* Constructs a new GeolocationApi.
|
|
14534
14679
|
* @alias module:purecloud-platform-client-v2/api/GeolocationApi
|
|
@@ -14562,7 +14707,7 @@ if(clientId===undefined||clientId===null||clientId===''){throw'Missing the requi
|
|
|
14562
14707
|
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(){/**
|
|
14563
14708
|
* Greetings service.
|
|
14564
14709
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
14565
|
-
* @version
|
|
14710
|
+
* @version 241.0.0
|
|
14566
14711
|
*//**
|
|
14567
14712
|
* Constructs a new GreetingsApi.
|
|
14568
14713
|
* @alias module:purecloud-platform-client-v2/api/GreetingsApi
|
|
@@ -14690,7 +14835,7 @@ if(userId===undefined||userId===null||userId===''){throw'Missing the required pa
|
|
|
14690
14835
|
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(){/**
|
|
14691
14836
|
* Groups service.
|
|
14692
14837
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
14693
|
-
* @version
|
|
14838
|
+
* @version 241.0.0
|
|
14694
14839
|
*//**
|
|
14695
14840
|
* Constructs a new GroupsApi.
|
|
14696
14841
|
* @alias module:purecloud-platform-client-v2/api/GroupsApi
|
|
@@ -14823,7 +14968,7 @@ if(groupId===undefined||groupId===null||groupId===''){throw'Missing the required
|
|
|
14823
14968
|
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(){/**
|
|
14824
14969
|
* IdentityProvider service.
|
|
14825
14970
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
14826
|
-
* @version
|
|
14971
|
+
* @version 241.0.0
|
|
14827
14972
|
*//**
|
|
14828
14973
|
* Constructs a new IdentityProviderApi.
|
|
14829
14974
|
* @alias module:purecloud-platform-client-v2/api/IdentityProviderApi
|
|
@@ -14979,7 +15124,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
14979
15124
|
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(){/**
|
|
14980
15125
|
* InfrastructureAsCode service.
|
|
14981
15126
|
* @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
14982
|
-
* @version
|
|
15127
|
+
* @version 241.0.0
|
|
14983
15128
|
*//**
|
|
14984
15129
|
* Constructs a new InfrastructureAsCodeApi.
|
|
14985
15130
|
* @alias module:purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
@@ -15033,7 +15178,7 @@ if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required param
|
|
|
15033
15178
|
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(){/**
|
|
15034
15179
|
* Integrations service.
|
|
15035
15180
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
15036
|
-
* @version
|
|
15181
|
+
* @version 241.0.0
|
|
15037
15182
|
*//**
|
|
15038
15183
|
* Constructs a new IntegrationsApi.
|
|
15039
15184
|
* @alias module:purecloud-platform-client-v2/api/IntegrationsApi
|
|
@@ -15723,7 +15868,7 @@ if(ucIntegrationId===undefined||ucIntegrationId===null||ucIntegrationId===''){th
|
|
|
15723
15868
|
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(){/**
|
|
15724
15869
|
* Journey service.
|
|
15725
15870
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
15726
|
-
* @version
|
|
15871
|
+
* @version 241.0.0
|
|
15727
15872
|
*//**
|
|
15728
15873
|
* Constructs a new JourneyApi.
|
|
15729
15874
|
* @alias module:purecloud-platform-client-v2/api/JourneyApi
|
|
@@ -15820,7 +15965,7 @@ if(actionMapId===undefined||actionMapId===null||actionMapId===''){throw'Missing
|
|
|
15820
15965
|
* @param {String} opts.filterValue Value to filter by. Requires 'filterValue' to also be set.
|
|
15821
15966
|
* @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.
|
|
15822
15967
|
* @param {Array.<String>} opts.queryFields Action Map field(s) to query on. Requires 'queryValue' to also be set.
|
|
15823
|
-
* @param {String} opts.queryValue Value to query on. Requires 'queryFields' to also be set.
|
|
15968
|
+
* @param {String} opts.queryValue Value to query on using fuzzy matching. Requires 'queryFields' to also be set.
|
|
15824
15969
|
*/},{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']);}/**
|
|
15825
15970
|
* Get status of job.
|
|
15826
15971
|
*
|
|
@@ -15857,7 +16002,7 @@ if(actionTemplateId===undefined||actionTemplateId===null||actionTemplateId==='')
|
|
|
15857
16002
|
* @param {Object} opts.mediaType Media type
|
|
15858
16003
|
* @param {Object} opts.state Action template state.
|
|
15859
16004
|
* @param {Array.<String>} opts.queryFields ActionTemplate field(s) to query on. Requires 'queryValue' to also be set.
|
|
15860
|
-
* @param {String} opts.queryValue Value to query on. Requires 'queryFields' to also be set.
|
|
16005
|
+
* @param {String} opts.queryValue Value to query on using fuzzy matching. Requires 'queryFields' to also be set.
|
|
15861
16006
|
*/},{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']);}/**
|
|
15862
16007
|
* Send a ping.
|
|
15863
16008
|
*
|
|
@@ -15885,7 +16030,7 @@ if(outcomeId===undefined||outcomeId===null||outcomeId===''){throw'Missing the re
|
|
|
15885
16030
|
* @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).
|
|
15886
16031
|
* @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.
|
|
15887
16032
|
* @param {Array.<String>} opts.queryFields Outcome field(s) to query on. Requires 'queryValue' to also be set.
|
|
15888
|
-
* @param {String} opts.queryValue Value to query on. Requires 'queryFields' to also be set.
|
|
16033
|
+
* @param {String} opts.queryValue Value to query on using fuzzy matching. Requires 'queryFields' to also be set.
|
|
15889
16034
|
*/},{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']);}/**
|
|
15890
16035
|
* Get job status.
|
|
15891
16036
|
*
|
|
@@ -15921,7 +16066,7 @@ if(segmentId===undefined||segmentId===null||segmentId===''){throw'Missing the re
|
|
|
15921
16066
|
* @param {Boolean} opts.isActive Determines whether or not to show only active segments.
|
|
15922
16067
|
* @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.
|
|
15923
16068
|
* @param {Array.<String>} opts.queryFields Segment field(s) to query on. Requires 'queryValue' to also be set.
|
|
15924
|
-
* @param {String} opts.queryValue Value to query on. Requires 'queryFields' to also be set.
|
|
16069
|
+
* @param {String} opts.queryValue Value to query on using fuzzy matching. Requires 'queryFields' to also be set.
|
|
15925
16070
|
*/},{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']);}/**
|
|
15926
16071
|
* Retrieve a single session.
|
|
15927
16072
|
*
|
|
@@ -16232,7 +16377,7 @@ if(versionId===undefined||versionId===null||versionId===''){throw'Missing the re
|
|
|
16232
16377
|
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(){/**
|
|
16233
16378
|
* Knowledge service.
|
|
16234
16379
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
16235
|
-
* @version
|
|
16380
|
+
* @version 241.0.0
|
|
16236
16381
|
*//**
|
|
16237
16382
|
* Constructs a new KnowledgeApi.
|
|
16238
16383
|
* @alias module:purecloud-platform-client-v2/api/KnowledgeApi
|
|
@@ -17060,7 +17205,7 @@ if(sourceId===undefined||sourceId===null||sourceId===''){throw'Missing the requi
|
|
|
17060
17205
|
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(){/**
|
|
17061
17206
|
* LanguageUnderstanding service.
|
|
17062
17207
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
17063
|
-
* @version
|
|
17208
|
+
* @version 241.0.0
|
|
17064
17209
|
*//**
|
|
17065
17210
|
* Constructs a new LanguageUnderstandingApi.
|
|
17066
17211
|
* @alias module:purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
@@ -17369,7 +17514,7 @@ if(domainVersionId===undefined||domainVersionId===null||domainVersionId===''){th
|
|
|
17369
17514
|
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(){/**
|
|
17370
17515
|
* Languages service.
|
|
17371
17516
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
17372
|
-
* @version
|
|
17517
|
+
* @version 241.0.0
|
|
17373
17518
|
*//**
|
|
17374
17519
|
* Constructs a new LanguagesApi.
|
|
17375
17520
|
* @alias module:purecloud-platform-client-v2/api/LanguagesApi
|
|
@@ -17424,7 +17569,7 @@ if(userId===undefined||userId===null||userId===''){throw'Missing the required pa
|
|
|
17424
17569
|
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(){/**
|
|
17425
17570
|
* Learning service.
|
|
17426
17571
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
17427
|
-
* @version
|
|
17572
|
+
* @version 241.0.0
|
|
17428
17573
|
*//**
|
|
17429
17574
|
* Constructs a new LearningApi.
|
|
17430
17575
|
* @alias module:purecloud-platform-client-v2/api/LearningApi
|
|
@@ -17713,7 +17858,7 @@ if(moduleId===undefined||moduleId===null||moduleId===''){throw'Missing the requi
|
|
|
17713
17858
|
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(){/**
|
|
17714
17859
|
* License service.
|
|
17715
17860
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
17716
|
-
* @version
|
|
17861
|
+
* @version 241.0.0
|
|
17717
17862
|
*//**
|
|
17718
17863
|
* Constructs a new LicenseApi.
|
|
17719
17864
|
* @alias module:purecloud-platform-client-v2/api/LicenseApi
|
|
@@ -17767,7 +17912,7 @@ if(featureName===undefined||featureName===null||featureName===''){throw'Missing
|
|
|
17767
17912
|
*/},{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(){/**
|
|
17768
17913
|
* Locations service.
|
|
17769
17914
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
17770
|
-
* @version
|
|
17915
|
+
* @version 241.0.0
|
|
17771
17916
|
*//**
|
|
17772
17917
|
* Constructs a new LocationsApi.
|
|
17773
17918
|
* @alias module:purecloud-platform-client-v2/api/LocationsApi
|
|
@@ -17826,7 +17971,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
17826
17971
|
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(){/**
|
|
17827
17972
|
* LogCapture service.
|
|
17828
17973
|
* @module purecloud-platform-client-v2/api/LogCaptureApi
|
|
17829
|
-
* @version
|
|
17974
|
+
* @version 241.0.0
|
|
17830
17975
|
*//**
|
|
17831
17976
|
* Constructs a new LogCaptureApi.
|
|
17832
17977
|
* @alias module:purecloud-platform-client-v2/api/LogCaptureApi
|
|
@@ -17875,7 +18020,7 @@ if(userId===undefined||userId===null||userId===''){throw'Missing the required pa
|
|
|
17875
18020
|
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(){/**
|
|
17876
18021
|
* Messaging service.
|
|
17877
18022
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
17878
|
-
* @version
|
|
18023
|
+
* @version 241.0.0
|
|
17879
18024
|
*//**
|
|
17880
18025
|
* Constructs a new MessagingApi.
|
|
17881
18026
|
* @alias module:purecloud-platform-client-v2/api/MessagingApi
|
|
@@ -17965,7 +18110,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
17965
18110
|
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(){/**
|
|
17966
18111
|
* MobileDevices service.
|
|
17967
18112
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
17968
|
-
* @version
|
|
18113
|
+
* @version 241.0.0
|
|
17969
18114
|
*//**
|
|
17970
18115
|
* Constructs a new MobileDevicesApi.
|
|
17971
18116
|
* @alias module:purecloud-platform-client-v2/api/MobileDevicesApi
|
|
@@ -18004,7 +18149,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
18004
18149
|
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(){/**
|
|
18005
18150
|
* Notifications service.
|
|
18006
18151
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
18007
|
-
* @version
|
|
18152
|
+
* @version 241.0.0
|
|
18008
18153
|
*//**
|
|
18009
18154
|
* Constructs a new NotificationsApi.
|
|
18010
18155
|
* @alias module:purecloud-platform-client-v2/api/NotificationsApi
|
|
@@ -18061,7 +18206,7 @@ if(channelId===undefined||channelId===null||channelId===''){throw'Missing the re
|
|
|
18061
18206
|
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(){/**
|
|
18062
18207
|
* OAuth service.
|
|
18063
18208
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
18064
|
-
* @version
|
|
18209
|
+
* @version 241.0.0
|
|
18065
18210
|
*//**
|
|
18066
18211
|
* Constructs a new OAuthApi.
|
|
18067
18212
|
* @alias module:purecloud-platform-client-v2/api/OAuthApi
|
|
@@ -18146,7 +18291,7 @@ if(clientId===undefined||clientId===null||clientId===''){throw'Missing the requi
|
|
|
18146
18291
|
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(){/**
|
|
18147
18292
|
* Objects service.
|
|
18148
18293
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
18149
|
-
* @version
|
|
18294
|
+
* @version 241.0.0
|
|
18150
18295
|
*//**
|
|
18151
18296
|
* Constructs a new ObjectsApi.
|
|
18152
18297
|
* @alias module:purecloud-platform-client-v2/api/ObjectsApi
|
|
@@ -18232,7 +18377,7 @@ if(divisionId===undefined||divisionId===null||divisionId===''){throw'Missing the
|
|
|
18232
18377
|
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(){/**
|
|
18233
18378
|
* OperationalEvents service.
|
|
18234
18379
|
* @module purecloud-platform-client-v2/api/OperationalEventsApi
|
|
18235
|
-
* @version
|
|
18380
|
+
* @version 241.0.0
|
|
18236
18381
|
*//**
|
|
18237
18382
|
* Constructs a new OperationalEventsApi.
|
|
18238
18383
|
* @alias module:purecloud-platform-client-v2/api/OperationalEventsApi
|
|
@@ -18263,7 +18408,7 @@ if(eventDefinitionId===undefined||eventDefinitionId===null||eventDefinitionId===
|
|
|
18263
18408
|
*/},{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(){/**
|
|
18264
18409
|
* Organization service.
|
|
18265
18410
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
18266
|
-
* @version
|
|
18411
|
+
* @version 241.0.0
|
|
18267
18412
|
*//**
|
|
18268
18413
|
* Constructs a new OrganizationApi.
|
|
18269
18414
|
* @alias module:purecloud-platform-client-v2/api/OrganizationApi
|
|
@@ -18368,7 +18513,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
18368
18513
|
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(){/**
|
|
18369
18514
|
* OrganizationAuthorization service.
|
|
18370
18515
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
18371
|
-
* @version
|
|
18516
|
+
* @version 241.0.0
|
|
18372
18517
|
*//**
|
|
18373
18518
|
* Constructs a new OrganizationAuthorizationApi.
|
|
18374
18519
|
* @alias module:purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
@@ -18702,7 +18847,7 @@ if(trustorOrgId===undefined||trustorOrgId===null||trustorOrgId===''){throw'Missi
|
|
|
18702
18847
|
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(){/**
|
|
18703
18848
|
* Outbound service.
|
|
18704
18849
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
18705
|
-
* @version
|
|
18850
|
+
* @version 241.0.0
|
|
18706
18851
|
*//**
|
|
18707
18852
|
* Constructs a new OutboundApi.
|
|
18708
18853
|
* @alias module:purecloud-platform-client-v2/api/OutboundApi
|
|
@@ -19325,7 +19470,8 @@ if(messagingCampaignId===undefined||messagingCampaignId===null||messagingCampaig
|
|
|
19325
19470
|
* @param {Array.<String>} opts.id A list of messaging campaign ids to bulk fetch
|
|
19326
19471
|
* @param {String} opts.contentTemplateId Content template ID
|
|
19327
19472
|
* @param {Object} opts.campaignStatus Campaign Status
|
|
19328
|
-
|
|
19473
|
+
* @param {Array.<String>} opts.ruleSetIds Ruleset ID(s)
|
|
19474
|
+
*/},{key:"getOutboundMessagingcampaigns",value:function getOutboundMessagingcampaigns(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/outbound/messagingcampaigns','GET',{},{'pageSize':opts['pageSize'],'pageNumber':opts['pageNumber'],'sortBy':opts['sortBy'],'sortOrder':opts['sortOrder'],'name':opts['name'],'contactListId':opts['contactListId'],'divisionId':this.apiClient.buildCollectionParam(opts['divisionId'],'multi'),'type':opts['type'],'senderSmsPhoneNumber':opts['senderSmsPhoneNumber'],'id':this.apiClient.buildCollectionParam(opts['id'],'multi'),'contentTemplateId':opts['contentTemplateId'],'campaignStatus':opts['campaignStatus'],'ruleSetIds':this.apiClient.buildCollectionParam(opts['ruleSetIds'],'multi')},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
19329
19475
|
* Get a basic Messaging Campaign information object
|
|
19330
19476
|
* This returns a simplified version of a Messaging Campaign, consisting of id, name, and division.
|
|
19331
19477
|
* @param {String} messagingCampaignId The Messaging Campaign ID
|
|
@@ -19858,7 +20004,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
19858
20004
|
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(){/**
|
|
19859
20005
|
* Presence service.
|
|
19860
20006
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
19861
|
-
* @version
|
|
20007
|
+
* @version 241.0.0
|
|
19862
20008
|
*//**
|
|
19863
20009
|
* Constructs a new PresenceApi.
|
|
19864
20010
|
* @alias module:purecloud-platform-client-v2/api/PresenceApi
|
|
@@ -20031,7 +20177,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
20031
20177
|
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(){/**
|
|
20032
20178
|
* ProcessAutomation service.
|
|
20033
20179
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
20034
|
-
* @version
|
|
20180
|
+
* @version 241.0.0
|
|
20035
20181
|
*//**
|
|
20036
20182
|
* Constructs a new ProcessAutomationApi.
|
|
20037
20183
|
* @alias module:purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
@@ -20094,7 +20240,7 @@ if(triggerId===undefined||triggerId===null||triggerId===''){throw'Missing the re
|
|
|
20094
20240
|
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(){/**
|
|
20095
20241
|
* Quality service.
|
|
20096
20242
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
20097
|
-
* @version
|
|
20243
|
+
* @version 241.0.0
|
|
20098
20244
|
*//**
|
|
20099
20245
|
* Constructs a new QualityApi.
|
|
20100
20246
|
* @alias module:purecloud-platform-client-v2/api/QualityApi
|
|
@@ -20584,7 +20730,7 @@ if(customerSurveyUrl===undefined||customerSurveyUrl===null){throw'Missing the re
|
|
|
20584
20730
|
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(){/**
|
|
20585
20731
|
* Recording service.
|
|
20586
20732
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
20587
|
-
* @version
|
|
20733
|
+
* @version 241.0.0
|
|
20588
20734
|
*//**
|
|
20589
20735
|
* Constructs a new RecordingApi.
|
|
20590
20736
|
* @alias module:purecloud-platform-client-v2/api/RecordingApi
|
|
@@ -20983,7 +21129,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
20983
21129
|
*/},{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(){/**
|
|
20984
21130
|
* ResponseManagement service.
|
|
20985
21131
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
20986
|
-
* @version
|
|
21132
|
+
* @version 241.0.0
|
|
20987
21133
|
*//**
|
|
20988
21134
|
* Constructs a new ResponseManagementApi.
|
|
20989
21135
|
* @alias module:purecloud-platform-client-v2/api/ResponseManagementApi
|
|
@@ -21104,7 +21250,7 @@ if(responseAssetId===undefined||responseAssetId===null||responseAssetId===''){th
|
|
|
21104
21250
|
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(){/**
|
|
21105
21251
|
* Routing service.
|
|
21106
21252
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
21107
|
-
* @version
|
|
21253
|
+
* @version 241.0.0
|
|
21108
21254
|
*//**
|
|
21109
21255
|
* Constructs a new RoutingApi.
|
|
21110
21256
|
* @alias module:purecloud-platform-client-v2/api/RoutingApi
|
|
@@ -21147,6 +21293,12 @@ if(languageId===undefined||languageId===null||languageId===''){throw'Missing the
|
|
|
21147
21293
|
* @param {String} predictorId Predictor ID
|
|
21148
21294
|
*/},{key:"deleteRoutingPredictor",value:function deleteRoutingPredictor(predictorId){// verify the required parameter 'predictorId' is set
|
|
21149
21295
|
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']);}/**
|
|
21296
|
+
* Delete a custom Key Performance Indicator.
|
|
21297
|
+
*
|
|
21298
|
+
* @param {String} kpiId Key Performance Indicator ID
|
|
21299
|
+
* deleteRoutingPredictorsKeyperformanceindicator is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
21300
|
+
*/},{key:"deleteRoutingPredictorsKeyperformanceindicator",value:function deleteRoutingPredictorsKeyperformanceindicator(kpiId){// verify the required parameter 'kpiId' is set
|
|
21301
|
+
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']);}/**
|
|
21150
21302
|
* Delete a queue
|
|
21151
21303
|
*
|
|
21152
21304
|
* @param {String} queueId Queue ID
|
|
@@ -21411,12 +21563,24 @@ if(predictorId===undefined||predictorId===null||predictorId===''){throw'Missing
|
|
|
21411
21563
|
* @param {String} opts.kpiId Standard or custom KPI id used to filter predictors.
|
|
21412
21564
|
* @param {Object} opts.state The state used to filter predictors.
|
|
21413
21565
|
*/},{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']);}/**
|
|
21566
|
+
* Retrieve a single Key Performance Indicator.
|
|
21567
|
+
*
|
|
21568
|
+
* @param {String} kpiId Key Performance Indicator ID
|
|
21569
|
+
* @param {Object} opts Optional parameters
|
|
21570
|
+
* @param {Array.<String>} opts.expand Parameter to request additional data to return in KPI payload
|
|
21571
|
+
* getRoutingPredictorsKeyperformanceindicator is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
21572
|
+
*/},{key:"getRoutingPredictorsKeyperformanceindicator",value:function getRoutingPredictorsKeyperformanceindicator(kpiId,opts){opts=opts||{};// verify the required parameter 'kpiId' is set
|
|
21573
|
+
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']);}/**
|
|
21414
21574
|
* Get a list of Key Performance Indicators
|
|
21415
21575
|
*
|
|
21416
21576
|
* @param {Object} opts Optional parameters
|
|
21417
21577
|
* @param {Object} opts.kpiGroup The Group of Key Performance Indicators to return
|
|
21418
21578
|
* @param {Array.<String>} opts.expand Parameter to request additional data to return in KPI payload
|
|
21419
21579
|
*/},{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']);}/**
|
|
21580
|
+
* Get a list of Key Performance Indicators Types available.
|
|
21581
|
+
*
|
|
21582
|
+
* getRoutingPredictorsKeyperformanceindicatortypes is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
21583
|
+
*/},{key:"getRoutingPredictorsKeyperformanceindicatortypes",value:function getRoutingPredictorsKeyperformanceindicatortypes(){return this.apiClient.callApi('/api/v2/routing/predictors/keyperformanceindicatortypes','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
21420
21584
|
* Get details about this queue.
|
|
21421
21585
|
*
|
|
21422
21586
|
* @param {String} queueId Queue ID
|
|
@@ -21801,6 +21965,14 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
21801
21965
|
* @param {Object} opts.body
|
|
21802
21966
|
*/},{key:"patchRoutingPredictor",value:function patchRoutingPredictor(predictorId,opts){opts=opts||{};// verify the required parameter 'predictorId' is set
|
|
21803
21967
|
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']);}/**
|
|
21968
|
+
* Update a custom Key Performance Indicator.
|
|
21969
|
+
*
|
|
21970
|
+
* @param {String} kpiId Key Performance Indicator ID
|
|
21971
|
+
* @param {Object} opts Optional parameters
|
|
21972
|
+
* @param {Object} opts.body
|
|
21973
|
+
* patchRoutingPredictorsKeyperformanceindicator is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
21974
|
+
*/},{key:"patchRoutingPredictorsKeyperformanceindicator",value:function patchRoutingPredictorsKeyperformanceindicator(kpiId,opts){opts=opts||{};// verify the required parameter 'kpiId' is set
|
|
21975
|
+
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']);}/**
|
|
21804
21976
|
* Update the ring number OR joined status for a queue member.
|
|
21805
21977
|
*
|
|
21806
21978
|
* @param {String} queueId Queue ID
|
|
@@ -21979,6 +22151,12 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
21979
22151
|
* @param {Object} opts Optional parameters
|
|
21980
22152
|
* @param {Object} opts.body
|
|
21981
22153
|
*/},{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']);}/**
|
|
22154
|
+
* Create a custom Key Performance Indicator.
|
|
22155
|
+
*
|
|
22156
|
+
* @param {Object} body request
|
|
22157
|
+
* postRoutingPredictorsKeyperformanceindicators is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
22158
|
+
*/},{key:"postRoutingPredictorsKeyperformanceindicators",value:function postRoutingPredictorsKeyperformanceindicators(body){// verify the required parameter 'body' is set
|
|
22159
|
+
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']);}/**
|
|
21982
22160
|
* Bulk add or delete up to 100 queue members
|
|
21983
22161
|
*
|
|
21984
22162
|
* @param {String} queueId Queue ID
|
|
@@ -22195,7 +22373,7 @@ if(userId===undefined||userId===null||userId===''){throw'Missing the required pa
|
|
|
22195
22373
|
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(){/**
|
|
22196
22374
|
* SCIM service.
|
|
22197
22375
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
22198
|
-
* @version
|
|
22376
|
+
* @version 241.0.0
|
|
22199
22377
|
*//**
|
|
22200
22378
|
* Constructs a new SCIMApi.
|
|
22201
22379
|
* @alias module:purecloud-platform-client-v2/api/SCIMApi
|
|
@@ -22420,7 +22598,7 @@ if(userId===undefined||userId===null||userId===''){throw'Missing the required pa
|
|
|
22420
22598
|
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(){/**
|
|
22421
22599
|
* ScreenRecording service.
|
|
22422
22600
|
* @module purecloud-platform-client-v2/api/ScreenRecordingApi
|
|
22423
|
-
* @version
|
|
22601
|
+
* @version 241.0.0
|
|
22424
22602
|
*//**
|
|
22425
22603
|
* Constructs a new ScreenRecordingApi.
|
|
22426
22604
|
* @alias module:purecloud-platform-client-v2/api/ScreenRecordingApi
|
|
@@ -22435,7 +22613,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
22435
22613
|
*/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(){/**
|
|
22436
22614
|
* Scripts service.
|
|
22437
22615
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
22438
|
-
* @version
|
|
22616
|
+
* @version 241.0.0
|
|
22439
22617
|
*//**
|
|
22440
22618
|
* Constructs a new ScriptsApi.
|
|
22441
22619
|
* @alias module:purecloud-platform-client-v2/api/ScriptsApi
|
|
@@ -22581,7 +22759,7 @@ if(scriptId===undefined||scriptId===null||scriptId===''){throw'Missing the requi
|
|
|
22581
22759
|
*/},{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(){/**
|
|
22582
22760
|
* Search service.
|
|
22583
22761
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
22584
|
-
* @version
|
|
22762
|
+
* @version 241.0.0
|
|
22585
22763
|
*//**
|
|
22586
22764
|
* Constructs a new SearchApi.
|
|
22587
22765
|
* @alias module:purecloud-platform-client-v2/api/SearchApi
|
|
@@ -22740,7 +22918,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
22740
22918
|
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(){/**
|
|
22741
22919
|
* Settings service.
|
|
22742
22920
|
* @module purecloud-platform-client-v2/api/SettingsApi
|
|
22743
|
-
* @version
|
|
22921
|
+
* @version 241.0.0
|
|
22744
22922
|
*//**
|
|
22745
22923
|
* Constructs a new SettingsApi.
|
|
22746
22924
|
* @alias module:purecloud-platform-client-v2/api/SettingsApi
|
|
@@ -22812,7 +22990,7 @@ if(agentId===undefined||agentId===null||agentId===''){throw'Missing the required
|
|
|
22812
22990
|
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(){/**
|
|
22813
22991
|
* SocialMedia service.
|
|
22814
22992
|
* @module purecloud-platform-client-v2/api/SocialMediaApi
|
|
22815
|
-
* @version
|
|
22993
|
+
* @version 241.0.0
|
|
22816
22994
|
*//**
|
|
22817
22995
|
* Constructs a new SocialMediaApi.
|
|
22818
22996
|
* @alias module:purecloud-platform-client-v2/api/SocialMediaApi
|
|
@@ -23060,7 +23238,8 @@ if(twitterIngestionRuleId===undefined||twitterIngestionRuleId===null||twitterIng
|
|
|
23060
23238
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
23061
23239
|
* @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.
|
|
23062
23240
|
* @param {Boolean} opts.includeDeleted Determines whether to include soft-deleted items in the result.
|
|
23063
|
-
|
|
23241
|
+
* @param {String} opts.name Search for topic by name that contains the given search string, search is case insensitive
|
|
23242
|
+
*/},{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']);}/**
|
|
23064
23243
|
* Update a social topic.
|
|
23065
23244
|
*
|
|
23066
23245
|
* @param {String} topicId topicId
|
|
@@ -23227,7 +23406,7 @@ if(topicId===undefined||topicId===null||topicId===''){throw'Missing the required
|
|
|
23227
23406
|
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(){/**
|
|
23228
23407
|
* SpeechTextAnalytics service.
|
|
23229
23408
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
23230
|
-
* @version
|
|
23409
|
+
* @version 241.0.0
|
|
23231
23410
|
*//**
|
|
23232
23411
|
* Constructs a new SpeechTextAnalyticsApi.
|
|
23233
23412
|
* @alias module:purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
@@ -23597,7 +23776,7 @@ if(topicId===undefined||topicId===null||topicId===''){throw'Missing the required
|
|
|
23597
23776
|
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(){/**
|
|
23598
23777
|
* Stations service.
|
|
23599
23778
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
23600
|
-
* @version
|
|
23779
|
+
* @version 241.0.0
|
|
23601
23780
|
*//**
|
|
23602
23781
|
* Constructs a new StationsApi.
|
|
23603
23782
|
* @alias module:purecloud-platform-client-v2/api/StationsApi
|
|
@@ -23629,7 +23808,7 @@ if(stationId===undefined||stationId===null||stationId===''){throw'Missing the re
|
|
|
23629
23808
|
*/},{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(){/**
|
|
23630
23809
|
* Suggest service.
|
|
23631
23810
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
23632
|
-
* @version
|
|
23811
|
+
* @version 241.0.0
|
|
23633
23812
|
*//**
|
|
23634
23813
|
* Constructs a new SuggestApi.
|
|
23635
23814
|
* @alias module:purecloud-platform-client-v2/api/SuggestApi
|
|
@@ -23669,7 +23848,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
23669
23848
|
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(){/**
|
|
23670
23849
|
* TaskManagement service.
|
|
23671
23850
|
* @module purecloud-platform-client-v2/api/TaskManagementApi
|
|
23672
|
-
* @version
|
|
23851
|
+
* @version 241.0.0
|
|
23673
23852
|
*//**
|
|
23674
23853
|
* Constructs a new TaskManagementApi.
|
|
23675
23854
|
* @alias module:purecloud-platform-client-v2/api/TaskManagementApi
|
|
@@ -24177,7 +24356,7 @@ if(schemaId===undefined||schemaId===null||schemaId===''){throw'Missing the requi
|
|
|
24177
24356
|
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(){/**
|
|
24178
24357
|
* Teams service.
|
|
24179
24358
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
24180
|
-
* @version
|
|
24359
|
+
* @version 241.0.0
|
|
24181
24360
|
*//**
|
|
24182
24361
|
* Constructs a new TeamsApi.
|
|
24183
24362
|
* @alias module:purecloud-platform-client-v2/api/TeamsApi
|
|
@@ -24257,7 +24436,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
24257
24436
|
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(){/**
|
|
24258
24437
|
* Telephony service.
|
|
24259
24438
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
24260
|
-
* @version
|
|
24439
|
+
* @version 241.0.0
|
|
24261
24440
|
*//**
|
|
24262
24441
|
* Constructs a new TelephonyApi.
|
|
24263
24442
|
* @alias module:purecloud-platform-client-v2/api/TelephonyApi
|
|
@@ -24328,7 +24507,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
24328
24507
|
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(){/**
|
|
24329
24508
|
* TelephonyProvidersEdge service.
|
|
24330
24509
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
24331
|
-
* @version
|
|
24510
|
+
* @version 241.0.0
|
|
24332
24511
|
*//**
|
|
24333
24512
|
* Constructs a new TelephonyProvidersEdgeApi.
|
|
24334
24513
|
* @alias module:purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
@@ -25176,7 +25355,7 @@ if(trunkBaseSettingsId===undefined||trunkBaseSettingsId===null||trunkBaseSetting
|
|
|
25176
25355
|
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(){/**
|
|
25177
25356
|
* Textbots service.
|
|
25178
25357
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
25179
|
-
* @version
|
|
25358
|
+
* @version 241.0.0
|
|
25180
25359
|
*//**
|
|
25181
25360
|
* Constructs a new TextbotsApi.
|
|
25182
25361
|
* @alias module:purecloud-platform-client-v2/api/TextbotsApi
|
|
@@ -25212,7 +25391,7 @@ if(launchRequest===undefined||launchRequest===null){throw'Missing the required p
|
|
|
25212
25391
|
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(){/**
|
|
25213
25392
|
* Tokens service.
|
|
25214
25393
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
25215
|
-
* @version
|
|
25394
|
+
* @version 241.0.0
|
|
25216
25395
|
*//**
|
|
25217
25396
|
* Constructs a new TokensApi.
|
|
25218
25397
|
* @alias module:purecloud-platform-client-v2/api/TokensApi
|
|
@@ -25246,7 +25425,7 @@ if(userId===undefined||userId===null||userId===''){throw'Missing the required pa
|
|
|
25246
25425
|
*/},{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(){/**
|
|
25247
25426
|
* Uploads service.
|
|
25248
25427
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
25249
|
-
* @version
|
|
25428
|
+
* @version 241.0.0
|
|
25250
25429
|
*//**
|
|
25251
25430
|
* Constructs a new UploadsApi.
|
|
25252
25431
|
* @alias module:purecloud-platform-client-v2/api/UploadsApi
|
|
@@ -25314,7 +25493,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
25314
25493
|
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(){/**
|
|
25315
25494
|
* Usage service.
|
|
25316
25495
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
25317
|
-
* @version
|
|
25496
|
+
* @version 241.0.0
|
|
25318
25497
|
*//**
|
|
25319
25498
|
* Constructs a new UsageApi.
|
|
25320
25499
|
* @alias module:purecloud-platform-client-v2/api/UsageApi
|
|
@@ -25398,7 +25577,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
25398
25577
|
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(){/**
|
|
25399
25578
|
* UserRecordings service.
|
|
25400
25579
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
25401
|
-
* @version
|
|
25580
|
+
* @version 241.0.0
|
|
25402
25581
|
*//**
|
|
25403
25582
|
* Constructs a new UserRecordingsApi.
|
|
25404
25583
|
* @alias module:purecloud-platform-client-v2/api/UserRecordingsApi
|
|
@@ -25446,7 +25625,7 @@ if(recordingId===undefined||recordingId===null||recordingId===''){throw'Missing
|
|
|
25446
25625
|
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(){/**
|
|
25447
25626
|
* Users service.
|
|
25448
25627
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
25449
|
-
* @version
|
|
25628
|
+
* @version 241.0.0
|
|
25450
25629
|
*//**
|
|
25451
25630
|
* Constructs a new UsersApi.
|
|
25452
25631
|
* @alias module:purecloud-platform-client-v2/api/UsersApi
|
|
@@ -26190,7 +26369,7 @@ if(verifierId===undefined||verifierId===null||verifierId===''){throw'Missing the
|
|
|
26190
26369
|
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(){/**
|
|
26191
26370
|
* UsersRules service.
|
|
26192
26371
|
* @module purecloud-platform-client-v2/api/UsersRulesApi
|
|
26193
|
-
* @version
|
|
26372
|
+
* @version 241.0.0
|
|
26194
26373
|
*//**
|
|
26195
26374
|
* Constructs a new UsersRulesApi.
|
|
26196
26375
|
* @alias module:purecloud-platform-client-v2/api/UsersRulesApi
|
|
@@ -26273,7 +26452,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
26273
26452
|
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(){/**
|
|
26274
26453
|
* Utilities service.
|
|
26275
26454
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
26276
|
-
* @version
|
|
26455
|
+
* @version 241.0.0
|
|
26277
26456
|
*//**
|
|
26278
26457
|
* Constructs a new UtilitiesApi.
|
|
26279
26458
|
* @alias module:purecloud-platform-client-v2/api/UtilitiesApi
|
|
@@ -26300,7 +26479,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
26300
26479
|
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(){/**
|
|
26301
26480
|
* Voicemail service.
|
|
26302
26481
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
26303
|
-
* @version
|
|
26482
|
+
* @version 241.0.0
|
|
26304
26483
|
*//**
|
|
26305
26484
|
* Constructs a new VoicemailApi.
|
|
26306
26485
|
* @alias module:purecloud-platform-client-v2/api/VoicemailApi
|
|
@@ -26462,7 +26641,7 @@ if(userId===undefined||userId===null||userId===''){throw'Missing the required pa
|
|
|
26462
26641
|
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(){/**
|
|
26463
26642
|
* WebChat service.
|
|
26464
26643
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
26465
|
-
* @version
|
|
26644
|
+
* @version 241.0.0
|
|
26466
26645
|
*//**
|
|
26467
26646
|
* Constructs a new WebChatApi.
|
|
26468
26647
|
* @alias module:purecloud-platform-client-v2/api/WebChatApi
|
|
@@ -26609,7 +26788,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
26609
26788
|
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(){/**
|
|
26610
26789
|
* WebDeployments service.
|
|
26611
26790
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
26612
|
-
* @version
|
|
26791
|
+
* @version 241.0.0
|
|
26613
26792
|
*//**
|
|
26614
26793
|
* Constructs a new WebDeploymentsApi.
|
|
26615
26794
|
* @alias module:purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
@@ -26742,7 +26921,7 @@ if(deploymentId===undefined||deploymentId===null||deploymentId===''){throw'Missi
|
|
|
26742
26921
|
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(){/**
|
|
26743
26922
|
* WebMessaging service.
|
|
26744
26923
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
26745
|
-
* @version
|
|
26924
|
+
* @version 241.0.0
|
|
26746
26925
|
*//**
|
|
26747
26926
|
* Constructs a new WebMessagingApi.
|
|
26748
26927
|
* @alias module:purecloud-platform-client-v2/api/WebMessagingApi
|
|
@@ -26783,7 +26962,7 @@ if(tokenId===undefined||tokenId===null||tokenId===''){throw'Missing the required
|
|
|
26783
26962
|
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(){/**
|
|
26784
26963
|
* Widgets service.
|
|
26785
26964
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
26786
|
-
* @version
|
|
26965
|
+
* @version 241.0.0
|
|
26787
26966
|
*//**
|
|
26788
26967
|
* Constructs a new WidgetsApi.
|
|
26789
26968
|
* @alias module:purecloud-platform-client-v2/api/WidgetsApi
|
|
@@ -26823,7 +27002,7 @@ if(deploymentId===undefined||deploymentId===null||deploymentId===''){throw'Missi
|
|
|
26823
27002
|
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(){/**
|
|
26824
27003
|
* WorkforceManagement service.
|
|
26825
27004
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
26826
|
-
* @version
|
|
27005
|
+
* @version 241.0.0
|
|
26827
27006
|
*//**
|
|
26828
27007
|
* Constructs a new WorkforceManagementApi.
|
|
26829
27008
|
* @alias module:purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
@@ -28795,7 +28974,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
28795
28974
|
* </pre>
|
|
28796
28975
|
* </p>
|
|
28797
28976
|
* @module purecloud-platform-client-v2/index
|
|
28798
|
-
* @version
|
|
28977
|
+
* @version 241.0.0
|
|
28799
28978
|
*/var platformClient=/*#__PURE__*/_createClass(function platformClient(){_classCallCheck(this,platformClient);/**
|
|
28800
28979
|
* The ApiClient constructor.
|
|
28801
28980
|
* @property {module:purecloud-platform-client-v2/ApiClient}
|