purecloud-platform-client-v2 252.0.0 → 253.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 +916 -345
- package/dist/web-amd/purecloud-platform-client-v2.js +916 -345
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +338 -179
- package/dist/web-cjs/purecloud-platform-client-v2.js +338 -179
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +632 -102
- package/package.json +5 -5
- package/src/purecloud-platform-client-v2/ApiClient.js +9 -6
- package/src/purecloud-platform-client-v2/api/AIStudioApi.js +6 -6
- package/src/purecloud-platform-client-v2/api/AgentAssistantsApi.js +3 -2
- 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 +1 -1
- package/src/purecloud-platform-client-v2/api/ArchitectApi.js +3 -2
- package/src/purecloud-platform-client-v2/api/AssistantCopilotVariationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AuditApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/BackgroundAssistantApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/BillingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/BusinessRulesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/CarrierServicesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/CaseManagementApi.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 +1 -1
- package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/DataPrivacyApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/DownloadsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EmailsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EmployeeEngagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EventsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/FaxApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/FlowsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GamificationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GeolocationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GreetingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GroupsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/IdentityProviderApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/InfrastructureAsCodeApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/IntentsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/JourneyApi.js +122 -7
- package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +42 -1
- package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LanguagesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LearningApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LicenseApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LocationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LogCaptureApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/MessagingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/MobileDevicesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/NotificationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OAuthApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ObjectsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OperationalEventsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OrganizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OutboundApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/PresenceApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ProcessAutomationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/QualityApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RecordingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RoutingApi.js +179 -156
- package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ScriptsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SearchApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SettingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SocialMediaApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/StationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SuggestApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TaskManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TeamsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TelephonyApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +1 -47
- 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 +472 -39
- package/src/purecloud-platform-client-v2/index.js +1 -1
package/dist/web-cjs/bundle.js
CHANGED
|
@@ -1082,7 +1082,7 @@ if(env)this.environment=env;else this.environment=this.host?this.host:'mypureclo
|
|
|
1082
1082
|
this.environment=this.environment.replace(/\/+$/,'');// Strip protocol and subdomain
|
|
1083
1083
|
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];}}}]);}();/**
|
|
1084
1084
|
* @module purecloud-platform-client-v2/ApiClient
|
|
1085
|
-
* @version
|
|
1085
|
+
* @version 253.0.0
|
|
1086
1086
|
*/var ApiClient=/*#__PURE__*/function(){/**
|
|
1087
1087
|
* Manages low level client-server communications, parameter marshalling, etc. There should not be any need for an
|
|
1088
1088
|
* application to use this class directly - the *Api and model classes provide the public API for the service. The
|
|
@@ -1240,7 +1240,7 @@ if(error.response){_this8.config.logger.log('error',error.response.status,'POST'
|
|
|
1240
1240
|
*/},{key:"authorizePKCEGrant",value:function authorizePKCEGrant(clientId,codeVerifier,authCode,redirectUri){var _this9=this;this.clientId=clientId;var loginBasePath=this.config.getConfUrl('login',"https://login.".concat(this.config.environment));return new Promise(function(resolve,reject){var headers={'Content-Type':'application/x-www-form-urlencoded'};var data=qs__default["default"].stringify({grant_type:'authorization_code',code:authCode,code_verifier:codeVerifier,client_id:clientId,redirect_uri:redirectUri});var requestOptions=new HttpRequestOptions("".concat(loginBasePath,"/oauth/token"),"POST",headers,null,data,_this9.timeout);var httpClient=_this9.getHttpClient();var bodyParam={grant_type:'authorization_code',code:authCode,code_verifier:codeVerifier,client_id:clientId,redirect_uri:redirectUri};// Handle response
|
|
1241
1241
|
httpClient.request(requestOptions).then(function(response){// Logging
|
|
1242
1242
|
_this9.config.logger.log('trace',response.status,'POST',"".concat(loginBasePath,"/oauth/token"),requestOptions.headers,response.headers,bodyParam,undefined);_this9.config.logger.log('debug',response.status,'POST',"".concat(loginBasePath,"/oauth/token"),requestOptions.headers,undefined,bodyParam,undefined);// Get access token from response
|
|
1243
|
-
var access_token=response.data.access_token;
|
|
1243
|
+
var access_token=response.data.access_token;var optsSettings={accessToken:access_token};if(response.data['expires_in']!==null&&response.data['expires_in']!==undefined){optsSettings.tokenExpiryTime=new Date().getTime()+response.data['expires_in']*1000;optsSettings.tokenExpiryTimeString=new Date(optsSettings.tokenExpiryTime).toUTCString();}_this9._saveSettings(optsSettings);// Return auth data
|
|
1244
1244
|
resolve(_this9.authData);})["catch"](function(error){// Log error
|
|
1245
1245
|
if(error.response){_this9.config.logger.log('error',error.response.status,'POST',"".concat(loginBasePath,"/oauth/token"),requestOptions.headers,error.response.headers,bodyParam,error.response.data);}reject(error);});});}/**
|
|
1246
1246
|
* @description Generate a random string used as PKCE Code Verifier - length = 43 to 128.
|
|
@@ -1265,7 +1265,7 @@ return reject(new Error("Code Challenge Error ".concat(error)));});});}}/**
|
|
|
1265
1265
|
*/},{key:"loginPKCEGrant",value:function loginPKCEGrant(clientId,redirectUri,opts,codeVerifier){var _this0=this;// Need Local Storage or non null codeVerifier as parameter
|
|
1266
1266
|
if(!this.hasLocalStorage&&!codeVerifier){throw new Error("loginPKCEGrant requires Local Storage or codeVerifier as input parameter");}// Check for auth code in query
|
|
1267
1267
|
var query=this._setValuesFromUrlQuery();this.clientId=clientId;this.redirectUri=redirectUri;this.codeVerifier=codeVerifier;if(!opts)opts={};return new Promise(function(resolve,reject){// Abort if org and provider are not set together
|
|
1268
|
-
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
|
|
1268
|
+
if(opts.org&&!opts.provider){return reject(new Error('opts.provider must be set if opts.org is set'));}else if(opts.provider&&!opts.org){return reject(new Error('opts.org must be set if opts.provider is set'));}// Abort on auth error
|
|
1269
1269
|
if(query&&query.error){// remove codeVerifier from session storage
|
|
1270
1270
|
if(_this0.hasLocalStorage){sessionStorage.removeItem("genesys_cloud_sdk_pkce_code_verifier");}// reset access token if any was stored
|
|
1271
1271
|
_this0._saveSettings({accessToken:undefined});return reject(new Error("[".concat(query.error,"] ").concat(query.error_description)));}// Get token on auth code
|
|
@@ -1451,7 +1451,7 @@ resolve(data);})["catch"](function(error){var data=error;if(error.response&&erro
|
|
|
1451
1451
|
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(){/**
|
|
1452
1452
|
* AIStudio service.
|
|
1453
1453
|
* @module purecloud-platform-client-v2/api/AIStudioApi
|
|
1454
|
-
* @version
|
|
1454
|
+
* @version 253.0.0
|
|
1455
1455
|
*//**
|
|
1456
1456
|
* Constructs a new AIStudioApi.
|
|
1457
1457
|
* @alias module:purecloud-platform-client-v2/api/AIStudioApi
|
|
@@ -1483,14 +1483,14 @@ if(summarySettingId===undefined||summarySettingId===null||summarySettingId==='')
|
|
|
1483
1483
|
* Get all summary settings.
|
|
1484
1484
|
*
|
|
1485
1485
|
* @param {Object} opts Optional parameters
|
|
1486
|
-
* @param {String} opts.language Filter by matching language - case insensitive.
|
|
1487
|
-
* @param {String} opts.name Filter by partially matching name - case insensitive.
|
|
1488
|
-
* @param {Object} opts.sortBy Sort by. Default value dateModified. (default to dateModified)
|
|
1489
|
-
* @param {Object} opts.sortOrder Sort Order. Default value desc. (default to desc)
|
|
1490
1486
|
* @param {Number} opts.pageNumber Page number. (default to 1)
|
|
1491
1487
|
* @param {Number} opts.pageSize Page size. The maximum page size is 100. (default to 25)
|
|
1488
|
+
* @param {String} opts.name Filter by partially matching name - case insensitive.
|
|
1489
|
+
* @param {Object} opts.sortOrder Sort Order. Default value desc. (default to desc)
|
|
1490
|
+
* @param {String} opts.language Filter by matching language - case insensitive.
|
|
1491
|
+
* @param {Object} opts.sortBy Sort by. Default value dateModified. (default to dateModified)
|
|
1492
1492
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1493
|
-
*/},{key:"getConversationsSummariesSettings",value:function getConversationsSummariesSettings(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/conversations/summaries/settings','GET',{},{'
|
|
1493
|
+
*/},{key:"getConversationsSummariesSettings",value:function getConversationsSummariesSettings(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/conversations/summaries/settings','GET',{},{'pageNumber':opts['pageNumber'],'pageSize':opts['pageSize'],'name':opts['name'],'sortOrder':opts['sortOrder'],'language':opts['language'],'sortBy':opts['sortBy']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
1494
1494
|
* Get guide.
|
|
1495
1495
|
*
|
|
1496
1496
|
* @param {String} guideId Guide ID
|
|
@@ -1642,7 +1642,7 @@ if(summarySettingId===undefined||summarySettingId===null||summarySettingId==='')
|
|
|
1642
1642
|
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'],opts['customHeaders']);}}]);}();var AgentAssistantsApi=/*#__PURE__*/function(){/**
|
|
1643
1643
|
* AgentAssistants service.
|
|
1644
1644
|
* @module purecloud-platform-client-v2/api/AgentAssistantsApi
|
|
1645
|
-
* @version
|
|
1645
|
+
* @version 253.0.0
|
|
1646
1646
|
*//**
|
|
1647
1647
|
* Constructs a new AgentAssistantsApi.
|
|
1648
1648
|
* @alias module:purecloud-platform-client-v2/api/AgentAssistantsApi
|
|
@@ -1751,8 +1751,9 @@ if(agentChecklistId===undefined||agentChecklistId===null||agentChecklistId==='')
|
|
|
1751
1751
|
* @param {String} opts.language The agent checklist language filter applied to the listing.
|
|
1752
1752
|
* @param {Object} opts.sortOrder The sort order for the listing
|
|
1753
1753
|
* @param {Object} opts.sortBy The field to sort by for the listing.
|
|
1754
|
+
* @param {Array.<String>} opts.agentChecklistIds Agent checklist IDs (repeat param or comma-separated). Do not use with other optional filters.
|
|
1754
1755
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1755
|
-
*/},{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'],opts['customHeaders']);}/**
|
|
1756
|
+
*/},{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'],'agentChecklistIds':this.apiClient.buildCollectionParam(opts['agentChecklistIds'],'multi')},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
1756
1757
|
* Get the list of supported languages
|
|
1757
1758
|
*
|
|
1758
1759
|
* @param {Object} opts Optional parameters
|
|
@@ -1867,7 +1868,7 @@ if(agentChecklistId===undefined||agentChecklistId===null||agentChecklistId==='')
|
|
|
1867
1868
|
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'],opts['customHeaders']);}}]);}();var AgentCopilotApi=/*#__PURE__*/function(){/**
|
|
1868
1869
|
* AgentCopilot service.
|
|
1869
1870
|
* @module purecloud-platform-client-v2/api/AgentCopilotApi
|
|
1870
|
-
* @version
|
|
1871
|
+
* @version 253.0.0
|
|
1871
1872
|
*//**
|
|
1872
1873
|
* Constructs a new AgentCopilotApi.
|
|
1873
1874
|
* @alias module:purecloud-platform-client-v2/api/AgentCopilotApi
|
|
@@ -1899,7 +1900,7 @@ if(assistantId===undefined||assistantId===null||assistantId===''){throw'Missing
|
|
|
1899
1900
|
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'],opts['customHeaders']);}}]);}();var AgentUIApi=/*#__PURE__*/function(){/**
|
|
1900
1901
|
* AgentUI service.
|
|
1901
1902
|
* @module purecloud-platform-client-v2/api/AgentUIApi
|
|
1902
|
-
* @version
|
|
1903
|
+
* @version 253.0.0
|
|
1903
1904
|
*//**
|
|
1904
1905
|
* Constructs a new AgentUIApi.
|
|
1905
1906
|
* @alias module:purecloud-platform-client-v2/api/AgentUIApi
|
|
@@ -1941,7 +1942,7 @@ if(agentId===undefined||agentId===null||agentId===''){throw'Missing the required
|
|
|
1941
1942
|
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'],opts['customHeaders']);}}]);}();var AlertingApi=/*#__PURE__*/function(){/**
|
|
1942
1943
|
* Alerting service.
|
|
1943
1944
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
1944
|
-
* @version
|
|
1945
|
+
* @version 253.0.0
|
|
1945
1946
|
*//**
|
|
1946
1947
|
* Constructs a new AlertingApi.
|
|
1947
1948
|
* @alias module:purecloud-platform-client-v2/api/AlertingApi
|
|
@@ -2055,7 +2056,7 @@ if(ruleId===undefined||ruleId===null||ruleId===''){throw'Missing the required pa
|
|
|
2055
2056
|
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'],opts['customHeaders']);}}]);}();var AnalyticsApi=/*#__PURE__*/function(){/**
|
|
2056
2057
|
* Analytics service.
|
|
2057
2058
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
2058
|
-
* @version
|
|
2059
|
+
* @version 253.0.0
|
|
2059
2060
|
*//**
|
|
2060
2061
|
* Constructs a new AnalyticsApi.
|
|
2061
2062
|
* @alias module:purecloud-platform-client-v2/api/AnalyticsApi
|
|
@@ -3177,7 +3178,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
3177
3178
|
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'],opts['customHeaders']);}}]);}();var ArchitectApi=/*#__PURE__*/function(){/**
|
|
3178
3179
|
* Architect service.
|
|
3179
3180
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
3180
|
-
* @version
|
|
3181
|
+
* @version 253.0.0
|
|
3181
3182
|
*//**
|
|
3182
3183
|
* Constructs a new ArchitectApi.
|
|
3183
3184
|
* @alias module:purecloud-platform-client-v2/api/ArchitectApi
|
|
@@ -4391,8 +4392,9 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
4391
4392
|
* Register Architect Job. Returns a URL where a file, such as an Architect flow YAML file, can be PUT which will then initiate the job.
|
|
4392
4393
|
*
|
|
4393
4394
|
* @param {Object} opts Optional parameters
|
|
4395
|
+
* @param {Object} opts.body
|
|
4394
4396
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
4395
|
-
*/},{key:"postFlowsJobs",value:function postFlowsJobs(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/flows/jobs','POST',{},{},{},{},
|
|
4397
|
+
*/},{key:"postFlowsJobs",value:function postFlowsJobs(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/flows/jobs','POST',{},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
4396
4398
|
* Create a flow milestone
|
|
4397
4399
|
*
|
|
4398
4400
|
* @param {Object} opts Optional parameters
|
|
@@ -4546,7 +4548,7 @@ if(milestoneId===undefined||milestoneId===null||milestoneId===''){throw'Missing
|
|
|
4546
4548
|
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'],opts['customHeaders']);}}]);}();var AssistantCopilotVariationsApi=/*#__PURE__*/function(){/**
|
|
4547
4549
|
* AssistantCopilotVariations service.
|
|
4548
4550
|
* @module purecloud-platform-client-v2/api/AssistantCopilotVariationsApi
|
|
4549
|
-
* @version
|
|
4551
|
+
* @version 253.0.0
|
|
4550
4552
|
*//**
|
|
4551
4553
|
* Constructs a new AssistantCopilotVariationsApi.
|
|
4552
4554
|
* @alias module:purecloud-platform-client-v2/api/AssistantCopilotVariationsApi
|
|
@@ -4601,7 +4603,7 @@ if(variationId===undefined||variationId===null||variationId===''){throw'Missing
|
|
|
4601
4603
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putAssistantVariation';}return this.apiClient.callApi('/api/v2/assistants/{assistantId}/variations/{variationId}','PUT',{'assistantId':assistantId,'variationId':variationId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}}]);}();var AuditApi=/*#__PURE__*/function(){/**
|
|
4602
4604
|
* Audit service.
|
|
4603
4605
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
4604
|
-
* @version
|
|
4606
|
+
* @version 253.0.0
|
|
4605
4607
|
*//**
|
|
4606
4608
|
* Constructs a new AuditApi.
|
|
4607
4609
|
* @alias module:purecloud-platform-client-v2/api/AuditApi
|
|
@@ -4662,7 +4664,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
4662
4664
|
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'],opts['customHeaders']);}}]);}();var AuthorizationApi=/*#__PURE__*/function(){/**
|
|
4663
4665
|
* Authorization service.
|
|
4664
4666
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
4665
|
-
* @version
|
|
4667
|
+
* @version 253.0.0
|
|
4666
4668
|
*//**
|
|
4667
4669
|
* Constructs a new AuthorizationApi.
|
|
4668
4670
|
* @alias module:purecloud-platform-client-v2/api/AuthorizationApi
|
|
@@ -5180,7 +5182,7 @@ if(subjectId===undefined||subjectId===null||subjectId===''){throw'Missing the re
|
|
|
5180
5182
|
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'],opts['customHeaders']);}}]);}();var BackgroundAssistantApi=/*#__PURE__*/function(){/**
|
|
5181
5183
|
* BackgroundAssistant service.
|
|
5182
5184
|
* @module purecloud-platform-client-v2/api/BackgroundAssistantApi
|
|
5183
|
-
* @version
|
|
5185
|
+
* @version 253.0.0
|
|
5184
5186
|
*//**
|
|
5185
5187
|
* Constructs a new BackgroundAssistantApi.
|
|
5186
5188
|
* @alias module:purecloud-platform-client-v2/api/BackgroundAssistantApi
|
|
@@ -5203,7 +5205,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
5203
5205
|
*/},{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'],opts['customHeaders']);}}]);}();var BillingApi=/*#__PURE__*/function(){/**
|
|
5204
5206
|
* Billing service.
|
|
5205
5207
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
5206
|
-
* @version
|
|
5208
|
+
* @version 253.0.0
|
|
5207
5209
|
*//**
|
|
5208
5210
|
* Constructs a new BillingApi.
|
|
5209
5211
|
* @alias module:purecloud-platform-client-v2/api/BillingApi
|
|
@@ -5292,7 +5294,7 @@ if(endDate===undefined||endDate===null){throw'Missing the required parameter "en
|
|
|
5292
5294
|
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'],opts['customHeaders']);}}]);}();var BusinessRulesApi=/*#__PURE__*/function(){/**
|
|
5293
5295
|
* BusinessRules service.
|
|
5294
5296
|
* @module purecloud-platform-client-v2/api/BusinessRulesApi
|
|
5295
|
-
* @version
|
|
5297
|
+
* @version 253.0.0
|
|
5296
5298
|
*//**
|
|
5297
5299
|
* Constructs a new BusinessRulesApi.
|
|
5298
5300
|
* @alias module:purecloud-platform-client-v2/api/BusinessRulesApi
|
|
@@ -5565,7 +5567,7 @@ if(schemaId===undefined||schemaId===null||schemaId===''){throw'Missing the requi
|
|
|
5565
5567
|
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'],opts['customHeaders']);}}]);}();var CarrierServicesApi=/*#__PURE__*/function(){/**
|
|
5566
5568
|
* CarrierServices service.
|
|
5567
5569
|
* @module purecloud-platform-client-v2/api/CarrierServicesApi
|
|
5568
|
-
* @version
|
|
5570
|
+
* @version 253.0.0
|
|
5569
5571
|
*//**
|
|
5570
5572
|
* Constructs a new CarrierServicesApi.
|
|
5571
5573
|
* @alias module:purecloud-platform-client-v2/api/CarrierServicesApi
|
|
@@ -5588,7 +5590,7 @@ if(phoneNumber===undefined||phoneNumber===null){throw'Missing the required param
|
|
|
5588
5590
|
*/},{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'],opts['customHeaders']);}}]);}();var CaseManagementApi=/*#__PURE__*/function(){/**
|
|
5589
5591
|
* CaseManagement service.
|
|
5590
5592
|
* @module purecloud-platform-client-v2/api/CaseManagementApi
|
|
5591
|
-
* @version
|
|
5593
|
+
* @version 253.0.0
|
|
5592
5594
|
*//**
|
|
5593
5595
|
* Constructs a new CaseManagementApi.
|
|
5594
5596
|
* @alias module:purecloud-platform-client-v2/api/CaseManagementApi
|
|
@@ -5967,7 +5969,7 @@ if(caseplanId===undefined||caseplanId===null||caseplanId===''){throw'Missing the
|
|
|
5967
5969
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putCasemanagementCaseplanIntakesettings';}return this.apiClient.callApi('/api/v2/casemanagement/caseplans/{caseplanId}/intakesettings','PUT',{'caseplanId':caseplanId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}}]);}();var ChatApi=/*#__PURE__*/function(){/**
|
|
5968
5970
|
* Chat service.
|
|
5969
5971
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
5970
|
-
* @version
|
|
5972
|
+
* @version 253.0.0
|
|
5971
5973
|
*//**
|
|
5972
5974
|
* Constructs a new ChatApi.
|
|
5973
5975
|
* @alias module:purecloud-platform-client-v2/api/ChatApi
|
|
@@ -6262,7 +6264,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
6262
6264
|
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'],opts['customHeaders']);}}]);}();var CoachingApi=/*#__PURE__*/function(){/**
|
|
6263
6265
|
* Coaching service.
|
|
6264
6266
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
6265
|
-
* @version
|
|
6267
|
+
* @version 253.0.0
|
|
6266
6268
|
*//**
|
|
6267
6269
|
* Constructs a new CoachingApi.
|
|
6268
6270
|
* @alias module:purecloud-platform-client-v2/api/CoachingApi
|
|
@@ -6461,7 +6463,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
6461
6463
|
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'],opts['customHeaders']);}}]);}();var ContentManagementApi=/*#__PURE__*/function(){/**
|
|
6462
6464
|
* ContentManagement service.
|
|
6463
6465
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
6464
|
-
* @version
|
|
6466
|
+
* @version 253.0.0
|
|
6465
6467
|
*//**
|
|
6466
6468
|
* Constructs a new ContentManagementApi.
|
|
6467
6469
|
* @alias module:purecloud-platform-client-v2/api/ContentManagementApi
|
|
@@ -6793,7 +6795,7 @@ if(tagId===undefined||tagId===null||tagId===''){throw'Missing the required param
|
|
|
6793
6795
|
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'],opts['customHeaders']);}}]);}();var ConversationsApi=/*#__PURE__*/function(){/**
|
|
6794
6796
|
* Conversations service.
|
|
6795
6797
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
6796
|
-
* @version
|
|
6798
|
+
* @version 253.0.0
|
|
6797
6799
|
*//**
|
|
6798
6800
|
* Constructs a new ConversationsApi.
|
|
6799
6801
|
* @alias module:purecloud-platform-client-v2/api/ConversationsApi
|
|
@@ -9725,7 +9727,7 @@ if(conversationId===undefined||conversationId===null||conversationId===''){throw
|
|
|
9725
9727
|
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'],opts['customHeaders']);}}]);}();var DataExtensionsApi=/*#__PURE__*/function(){/**
|
|
9726
9728
|
* DataExtensions service.
|
|
9727
9729
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
9728
|
-
* @version
|
|
9730
|
+
* @version 253.0.0
|
|
9729
9731
|
*//**
|
|
9730
9732
|
* Constructs a new DataExtensionsApi.
|
|
9731
9733
|
* @alias module:purecloud-platform-client-v2/api/DataExtensionsApi
|
|
@@ -9752,7 +9754,7 @@ if(coretypeName===undefined||coretypeName===null||coretypeName===''){throw'Missi
|
|
|
9752
9754
|
*/},{key:"getDataextensionsLimits",value:function getDataextensionsLimits(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/dataextensions/limits','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}}]);}();var DataPrivacyApi=/*#__PURE__*/function(){/**
|
|
9753
9755
|
* DataPrivacy service.
|
|
9754
9756
|
* @module purecloud-platform-client-v2/api/DataPrivacyApi
|
|
9755
|
-
* @version
|
|
9757
|
+
* @version 253.0.0
|
|
9756
9758
|
*//**
|
|
9757
9759
|
* Constructs a new DataPrivacyApi.
|
|
9758
9760
|
* @alias module:purecloud-platform-client-v2/api/DataPrivacyApi
|
|
@@ -9803,7 +9805,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
9803
9805
|
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'],opts['customHeaders']);}}]);}();var DownloadsApi=/*#__PURE__*/function(){/**
|
|
9804
9806
|
* Downloads service.
|
|
9805
9807
|
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
9806
|
-
* @version
|
|
9808
|
+
* @version 253.0.0
|
|
9807
9809
|
*//**
|
|
9808
9810
|
* Constructs a new DownloadsApi.
|
|
9809
9811
|
* @alias module:purecloud-platform-client-v2/api/DownloadsApi
|
|
@@ -9823,7 +9825,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
9823
9825
|
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'],opts['customHeaders']);}}]);}();var EmailsApi=/*#__PURE__*/function(){/**
|
|
9824
9826
|
* Emails service.
|
|
9825
9827
|
* @module purecloud-platform-client-v2/api/EmailsApi
|
|
9826
|
-
* @version
|
|
9828
|
+
* @version 253.0.0
|
|
9827
9829
|
*//**
|
|
9828
9830
|
* Constructs a new EmailsApi.
|
|
9829
9831
|
* @alias module:purecloud-platform-client-v2/api/EmailsApi
|
|
@@ -9860,7 +9862,7 @@ if(downloadId===undefined||downloadId===null||downloadId===''){throw'Missing the
|
|
|
9860
9862
|
*/},{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'],opts['customHeaders']);}}]);}();var EmployeeEngagementApi=/*#__PURE__*/function(){/**
|
|
9861
9863
|
* EmployeeEngagement service.
|
|
9862
9864
|
* @module purecloud-platform-client-v2/api/EmployeeEngagementApi
|
|
9863
|
-
* @version
|
|
9865
|
+
* @version 253.0.0
|
|
9864
9866
|
*//**
|
|
9865
9867
|
* Constructs a new EmployeeEngagementApi.
|
|
9866
9868
|
* @alias module:purecloud-platform-client-v2/api/EmployeeEngagementApi
|
|
@@ -9918,7 +9920,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
9918
9920
|
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'],opts['customHeaders']);}}]);}();var EventsApi=/*#__PURE__*/function(){/**
|
|
9919
9921
|
* Events service.
|
|
9920
9922
|
* @module purecloud-platform-client-v2/api/EventsApi
|
|
9921
|
-
* @version
|
|
9923
|
+
* @version 253.0.0
|
|
9922
9924
|
*//**
|
|
9923
9925
|
* Constructs a new EventsApi.
|
|
9924
9926
|
* @alias module:purecloud-platform-client-v2/api/EventsApi
|
|
@@ -9957,7 +9959,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
9957
9959
|
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'],opts['customHeaders']);}}]);}();var ExternalContactsApi=/*#__PURE__*/function(){/**
|
|
9958
9960
|
* ExternalContacts service.
|
|
9959
9961
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
9960
|
-
* @version
|
|
9962
|
+
* @version 253.0.0
|
|
9961
9963
|
*//**
|
|
9962
9964
|
* Constructs a new ExternalContactsApi.
|
|
9963
9965
|
* @alias module:purecloud-platform-client-v2/api/ExternalContactsApi
|
|
@@ -10919,7 +10921,7 @@ if(relationshipId===undefined||relationshipId===null||relationshipId===''){throw
|
|
|
10919
10921
|
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'],opts['customHeaders']);}}]);}();var FaxApi=/*#__PURE__*/function(){/**
|
|
10920
10922
|
* Fax service.
|
|
10921
10923
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
10922
|
-
* @version
|
|
10924
|
+
* @version 253.0.0
|
|
10923
10925
|
*//**
|
|
10924
10926
|
* Constructs a new FaxApi.
|
|
10925
10927
|
* @alias module:purecloud-platform-client-v2/api/FaxApi
|
|
@@ -10982,7 +10984,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
10982
10984
|
*/},{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'],opts['customHeaders']);}}]);}();var FlowsApi=/*#__PURE__*/function(){/**
|
|
10983
10985
|
* Flows service.
|
|
10984
10986
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
10985
|
-
* @version
|
|
10987
|
+
* @version 253.0.0
|
|
10986
10988
|
*//**
|
|
10987
10989
|
* Constructs a new FlowsApi.
|
|
10988
10990
|
* @alias module:purecloud-platform-client-v2/api/FlowsApi
|
|
@@ -11048,7 +11050,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
11048
11050
|
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'],opts['customHeaders']);}}]);}();var GamificationApi=/*#__PURE__*/function(){/**
|
|
11049
11051
|
* Gamification service.
|
|
11050
11052
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
11051
|
-
* @version
|
|
11053
|
+
* @version 253.0.0
|
|
11052
11054
|
*//**
|
|
11053
11055
|
* Constructs a new GamificationApi.
|
|
11054
11056
|
* @alias module:purecloud-platform-client-v2/api/GamificationApi
|
|
@@ -11843,7 +11845,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
11843
11845
|
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'],opts['customHeaders']);}}]);}();var GeneralDataProtectionRegulationApi=/*#__PURE__*/function(){/**
|
|
11844
11846
|
* GeneralDataProtectionRegulation service.
|
|
11845
11847
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
11846
|
-
* @version
|
|
11848
|
+
* @version 253.0.0
|
|
11847
11849
|
*//**
|
|
11848
11850
|
* Constructs a new GeneralDataProtectionRegulationApi.
|
|
11849
11851
|
* @alias module:purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
@@ -11884,7 +11886,7 @@ if(searchValue===undefined||searchValue===null){throw'Missing the required param
|
|
|
11884
11886
|
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'],opts['customHeaders']);}}]);}();var GeolocationApi=/*#__PURE__*/function(){/**
|
|
11885
11887
|
* Geolocation service.
|
|
11886
11888
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
11887
|
-
* @version
|
|
11889
|
+
* @version 253.0.0
|
|
11888
11890
|
*//**
|
|
11889
11891
|
* Constructs a new GeolocationApi.
|
|
11890
11892
|
* @alias module:purecloud-platform-client-v2/api/GeolocationApi
|
|
@@ -11926,7 +11928,7 @@ if(clientId===undefined||clientId===null||clientId===''){throw'Missing the requi
|
|
|
11926
11928
|
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'],opts['customHeaders']);}}]);}();var GreetingsApi=/*#__PURE__*/function(){/**
|
|
11927
11929
|
* Greetings service.
|
|
11928
11930
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
11929
|
-
* @version
|
|
11931
|
+
* @version 253.0.0
|
|
11930
11932
|
*//**
|
|
11931
11933
|
* Constructs a new GreetingsApi.
|
|
11932
11934
|
* @alias module:purecloud-platform-client-v2/api/GreetingsApi
|
|
@@ -12085,7 +12087,7 @@ if(userId===undefined||userId===null||userId===''){throw'Missing the required pa
|
|
|
12085
12087
|
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'],opts['customHeaders']);}}]);}();var GroupsApi=/*#__PURE__*/function(){/**
|
|
12086
12088
|
* Groups service.
|
|
12087
12089
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
12088
|
-
* @version
|
|
12090
|
+
* @version 253.0.0
|
|
12089
12091
|
*//**
|
|
12090
12092
|
* Constructs a new GroupsApi.
|
|
12091
12093
|
* @alias module:purecloud-platform-client-v2/api/GroupsApi
|
|
@@ -12248,7 +12250,7 @@ if(groupId===undefined||groupId===null||groupId===''){throw'Missing the required
|
|
|
12248
12250
|
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'],opts['customHeaders']);}}]);}();var IdentityProviderApi=/*#__PURE__*/function(){/**
|
|
12249
12251
|
* IdentityProvider service.
|
|
12250
12252
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
12251
|
-
* @version
|
|
12253
|
+
* @version 253.0.0
|
|
12252
12254
|
*//**
|
|
12253
12255
|
* Constructs a new IdentityProviderApi.
|
|
12254
12256
|
* @alias module:purecloud-platform-client-v2/api/IdentityProviderApi
|
|
@@ -12480,7 +12482,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
12480
12482
|
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'],opts['customHeaders']);}}]);}();var InfrastructureAsCodeApi=/*#__PURE__*/function(){/**
|
|
12481
12483
|
* InfrastructureAsCode service.
|
|
12482
12484
|
* @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
12483
|
-
* @version
|
|
12485
|
+
* @version 253.0.0
|
|
12484
12486
|
*//**
|
|
12485
12487
|
* Constructs a new InfrastructureAsCodeApi.
|
|
12486
12488
|
* @alias module:purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
@@ -12540,7 +12542,7 @@ if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required param
|
|
|
12540
12542
|
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'],opts['customHeaders']);}}]);}();var IntegrationsApi=/*#__PURE__*/function(){/**
|
|
12541
12543
|
* Integrations service.
|
|
12542
12544
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
12543
|
-
* @version
|
|
12545
|
+
* @version 253.0.0
|
|
12544
12546
|
*//**
|
|
12545
12547
|
* Constructs a new IntegrationsApi.
|
|
12546
12548
|
* @alias module:purecloud-platform-client-v2/api/IntegrationsApi
|
|
@@ -13370,7 +13372,7 @@ if(ucIntegrationId===undefined||ucIntegrationId===null||ucIntegrationId===''){th
|
|
|
13370
13372
|
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'],opts['customHeaders']);}}]);}();var IntentsApi=/*#__PURE__*/function(){/**
|
|
13371
13373
|
* Intents service.
|
|
13372
13374
|
* @module purecloud-platform-client-v2/api/IntentsApi
|
|
13373
|
-
* @version
|
|
13375
|
+
* @version 253.0.0
|
|
13374
13376
|
*//**
|
|
13375
13377
|
* Constructs a new IntentsApi.
|
|
13376
13378
|
* @alias module:purecloud-platform-client-v2/api/IntentsApi
|
|
@@ -13514,7 +13516,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
13514
13516
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postIntentsCustomerintents';}return this.apiClient.callApi('/api/v2/intents/customerintents','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}}]);}();var JourneyApi=/*#__PURE__*/function(){/**
|
|
13515
13517
|
* Journey service.
|
|
13516
13518
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
13517
|
-
* @version
|
|
13519
|
+
* @version 253.0.0
|
|
13518
13520
|
*//**
|
|
13519
13521
|
* Constructs a new JourneyApi.
|
|
13520
13522
|
* @alias module:purecloud-platform-client-v2/api/JourneyApi
|
|
@@ -13668,19 +13670,21 @@ if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required param
|
|
|
13668
13670
|
* @deprecated
|
|
13669
13671
|
*/},{key:"getJourneyActionmapsEstimatesJobResults",value:function getJourneyActionmapsEstimatesJobResults(jobId,opts){opts=opts||{};// verify the required parameter 'jobId' is set
|
|
13670
13672
|
if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required parameter "jobId" when calling getJourneyActionmapsEstimatesJobResults';}return this.apiClient.callApi('/api/v2/journey/actionmaps/estimates/jobs/{jobId}/results','GET',{'jobId':jobId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
13671
|
-
* Retrieve a single action target.
|
|
13672
|
-
*
|
|
13673
|
+
* Deprecated. Retrieve a single action target.
|
|
13674
|
+
* ACD Chat v2.0 in Genesys Predictive Engagement is deprecated and being removed. See https://community.genesys.com/discussion/deprecation-acd-chat-v20-support-in-genesys-predictive-engagement
|
|
13673
13675
|
* @param {String} actionTargetId ID of the action target.
|
|
13674
13676
|
* @param {Object} opts Optional parameters
|
|
13675
13677
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
13678
|
+
* @deprecated
|
|
13676
13679
|
*/},{key:"getJourneyActiontarget",value:function getJourneyActiontarget(actionTargetId,opts){opts=opts||{};// verify the required parameter 'actionTargetId' is set
|
|
13677
13680
|
if(actionTargetId===undefined||actionTargetId===null||actionTargetId===''){throw'Missing the required parameter "actionTargetId" when calling getJourneyActiontarget';}return this.apiClient.callApi('/api/v2/journey/actiontargets/{actionTargetId}','GET',{'actionTargetId':actionTargetId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
13678
|
-
* Retrieve all action targets.
|
|
13679
|
-
*
|
|
13681
|
+
* Deprecated. Retrieve all action targets.
|
|
13682
|
+
* ACD Chat v2.0 in Genesys Predictive Engagement is deprecated and being removed. See https://community.genesys.com/discussion/deprecation-acd-chat-v20-support-in-genesys-predictive-engagement
|
|
13680
13683
|
* @param {Object} opts Optional parameters
|
|
13681
13684
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
13682
13685
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
13683
13686
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
13687
|
+
* @deprecated
|
|
13684
13688
|
*/},{key:"getJourneyActiontargets",value:function getJourneyActiontargets(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/journey/actiontargets','GET',{},{'pageNumber':opts['pageNumber'],'pageSize':opts['pageSize']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
13685
13689
|
* Retrieve a single action template.
|
|
13686
13690
|
*
|
|
@@ -13988,6 +13992,16 @@ if(eventDefinitionId===undefined||eventDefinitionId===null||eventDefinitionId===
|
|
|
13988
13992
|
* @param {Object} opts Optional parameters
|
|
13989
13993
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
13990
13994
|
*/},{key:"getJourneyViewsEventdefinitions",value:function getJourneyViewsEventdefinitions(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/journey/views/eventdefinitions','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
13995
|
+
* Get external events for journey views
|
|
13996
|
+
*
|
|
13997
|
+
* @param {Object} opts Optional parameters
|
|
13998
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
13999
|
+
*/},{key:"getJourneyViewsEventdefinitionsExternal",value:function getJourneyViewsEventdefinitionsExternal(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/journey/views/eventdefinitions/external','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
14000
|
+
* Get changes in external event definitions
|
|
14001
|
+
*
|
|
14002
|
+
* @param {Object} opts Optional parameters
|
|
14003
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
14004
|
+
*/},{key:"getJourneyViewsEventdefinitionsExternalChanges",value:function getJourneyViewsEventdefinitionsExternalChanges(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/journey/views/eventdefinitions/external/changes','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
13991
14005
|
* Get the jobs for an organization.
|
|
13992
14006
|
*
|
|
13993
14007
|
* @param {Object} opts Optional parameters
|
|
@@ -14021,12 +14035,13 @@ if(eventDefinitionId===undefined||eventDefinitionId===null||eventDefinitionId===
|
|
|
14021
14035
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
14022
14036
|
*/},{key:"patchJourneyActionmap",value:function patchJourneyActionmap(actionMapId,opts){opts=opts||{};// verify the required parameter 'actionMapId' is set
|
|
14023
14037
|
if(actionMapId===undefined||actionMapId===null||actionMapId===''){throw'Missing the required parameter "actionMapId" when calling patchJourneyActionmap';}return this.apiClient.callApi('/api/v2/journey/actionmaps/{actionMapId}','PATCH',{'actionMapId':actionMapId},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
14024
|
-
* Update a single action target.
|
|
14025
|
-
*
|
|
14038
|
+
* Deprecated. Update a single action target.
|
|
14039
|
+
* ACD Chat v2.0 in Genesys Predictive Engagement is deprecated and being removed. See https://community.genesys.com/discussion/deprecation-acd-chat-v20-support-in-genesys-predictive-engagement
|
|
14026
14040
|
* @param {String} actionTargetId ID of the action target.
|
|
14027
14041
|
* @param {Object} opts Optional parameters
|
|
14028
14042
|
* @param {Object} opts.body
|
|
14029
14043
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
14044
|
+
* @deprecated
|
|
14030
14045
|
*/},{key:"patchJourneyActiontarget",value:function patchJourneyActiontarget(actionTargetId,opts){opts=opts||{};// verify the required parameter 'actionTargetId' is set
|
|
14031
14046
|
if(actionTargetId===undefined||actionTargetId===null||actionTargetId===''){throw'Missing the required parameter "actionTargetId" when calling patchJourneyActiontarget';}return this.apiClient.callApi('/api/v2/journey/actiontargets/{actionTargetId}','PATCH',{'actionTargetId':actionTargetId},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
14032
14047
|
* Update a single action template.
|
|
@@ -14266,10 +14281,26 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
14266
14281
|
*/},{key:"putJourneyViewVersion",value:function putJourneyViewVersion(viewId,versionId,body,opts){opts=opts||{};// verify the required parameter 'viewId' is set
|
|
14267
14282
|
if(viewId===undefined||viewId===null||viewId===''){throw'Missing the required parameter "viewId" when calling putJourneyViewVersion';}// verify the required parameter 'versionId' is set
|
|
14268
14283
|
if(versionId===undefined||versionId===null||versionId===''){throw'Missing the required parameter "versionId" when calling putJourneyViewVersion';}// verify the required parameter 'body' is set
|
|
14269
|
-
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'],opts['customHeaders']);}
|
|
14284
|
+
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'],opts['customHeaders']);}/**
|
|
14285
|
+
* Update external event for journey views
|
|
14286
|
+
*
|
|
14287
|
+
* @param {String} eventDefinitionId Event Definition ID
|
|
14288
|
+
* @param {Object} opts Optional parameters
|
|
14289
|
+
* @param {Object} opts.body
|
|
14290
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
14291
|
+
*/},{key:"putJourneyViewsEventdefinition",value:function putJourneyViewsEventdefinition(eventDefinitionId,opts){opts=opts||{};// verify the required parameter 'eventDefinitionId' is set
|
|
14292
|
+
if(eventDefinitionId===undefined||eventDefinitionId===null||eventDefinitionId===''){throw'Missing the required parameter "eventDefinitionId" when calling putJourneyViewsEventdefinition';}return this.apiClient.callApi('/api/v2/journey/views/eventdefinitions/{eventDefinitionId}','PUT',{'eventDefinitionId':eventDefinitionId},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
14293
|
+
* Activate external event for journey views
|
|
14294
|
+
*
|
|
14295
|
+
* @param {String} eventDefinitionId Event Definition ID
|
|
14296
|
+
* @param {Object} opts Optional parameters
|
|
14297
|
+
* @param {Object} opts.body
|
|
14298
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
14299
|
+
*/},{key:"putJourneyViewsEventdefinitionActivate",value:function putJourneyViewsEventdefinitionActivate(eventDefinitionId,opts){opts=opts||{};// verify the required parameter 'eventDefinitionId' is set
|
|
14300
|
+
if(eventDefinitionId===undefined||eventDefinitionId===null||eventDefinitionId===''){throw'Missing the required parameter "eventDefinitionId" when calling putJourneyViewsEventdefinitionActivate';}return this.apiClient.callApi('/api/v2/journey/views/eventdefinitions/{eventDefinitionId}/activate','PUT',{'eventDefinitionId':eventDefinitionId},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}}]);}();var KnowledgeApi=/*#__PURE__*/function(){/**
|
|
14270
14301
|
* Knowledge service.
|
|
14271
14302
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
14272
|
-
* @version
|
|
14303
|
+
* @version 253.0.0
|
|
14273
14304
|
*//**
|
|
14274
14305
|
* Constructs a new KnowledgeApi.
|
|
14275
14306
|
* @alias module:purecloud-platform-client-v2/api/KnowledgeApi
|
|
@@ -14624,6 +14655,24 @@ if(documentId===undefined||documentId===null||documentId===''){throw'Missing the
|
|
|
14624
14655
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
14625
14656
|
*/},{key:"getKnowledgeKnowledgebaseDocuments",value:function getKnowledgeKnowledgebaseDocuments(knowledgeBaseId,opts){opts=opts||{};// verify the required parameter 'knowledgeBaseId' is set
|
|
14626
14657
|
if(knowledgeBaseId===undefined||knowledgeBaseId===null||knowledgeBaseId===''){throw'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseDocuments';}return this.apiClient.callApi('/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents','GET',{'knowledgeBaseId':knowledgeBaseId},{'before':opts['before'],'after':opts['after'],'pageSize':opts['pageSize'],'interval':opts['interval'],'documentId':this.apiClient.buildCollectionParam(opts['documentId'],'multi'),'categoryId':this.apiClient.buildCollectionParam(opts['categoryId'],'multi'),'includeSubcategories':opts['includeSubcategories'],'includeDrafts':opts['includeDrafts'],'labelIds':this.apiClient.buildCollectionParam(opts['labelIds'],'multi'),'expand':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'externalIds':this.apiClient.buildCollectionParam(opts['externalIds'],'multi')},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
14658
|
+
* Get a list of feedback records given on documents in a knowledge base
|
|
14659
|
+
*
|
|
14660
|
+
* @param {String} knowledgeBaseId Knowledge base ID.
|
|
14661
|
+
* @param {Object} opts Optional parameters
|
|
14662
|
+
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
14663
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
14664
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
14665
|
+
* @param {Boolean} opts.onlyCommented If true, only feedback records that have comment are returned. If false, feedback records with and without comment are returned. Default: false.
|
|
14666
|
+
* @param {String} opts.documentVersionId Document version ID to filter by. Supported only if onlyCommented=true is set.
|
|
14667
|
+
* @param {String} opts.documentVariationId Document variation ID to filter by. Supported only if onlyCommented=true is set.
|
|
14668
|
+
* @param {Object} opts.appType Application type to filter by. Supported only if onlyCommented=true is set.
|
|
14669
|
+
* @param {Object} opts.queryType Query type to filter by. Supported only if onlyCommented=true is set.
|
|
14670
|
+
* @param {String} opts.userId The ID of the user, who created the feedback, to filter by. Supported only if onlyCommented=true is set.
|
|
14671
|
+
* @param {String} opts.queueId Queue ID to filter by. Supported only if onlyCommented=true is set.
|
|
14672
|
+
* @param {Object} opts.state State to filter by. Supported only if onlyCommented=true is set. Default: Final
|
|
14673
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
14674
|
+
*/},{key:"getKnowledgeKnowledgebaseDocumentsFeedback",value:function getKnowledgeKnowledgebaseDocumentsFeedback(knowledgeBaseId,opts){opts=opts||{};// verify the required parameter 'knowledgeBaseId' is set
|
|
14675
|
+
if(knowledgeBaseId===undefined||knowledgeBaseId===null||knowledgeBaseId===''){throw'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseDocumentsFeedback';}return this.apiClient.callApi('/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/feedback','GET',{'knowledgeBaseId':knowledgeBaseId},{'before':opts['before'],'after':opts['after'],'pageSize':opts['pageSize'],'onlyCommented':opts['onlyCommented'],'documentVersionId':opts['documentVersionId'],'documentVariationId':opts['documentVariationId'],'appType':opts['appType'],'queryType':opts['queryType'],'userId':opts['userId'],'queueId':opts['queueId'],'state':opts['state']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
14627
14676
|
* Get export job report
|
|
14628
14677
|
*
|
|
14629
14678
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
@@ -15446,7 +15495,7 @@ if(sourceId===undefined||sourceId===null||sourceId===''){throw'Missing the requi
|
|
|
15446
15495
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putKnowledgeSource';}return this.apiClient.callApi('/api/v2/knowledge/sources/{sourceId}','PUT',{'sourceId':sourceId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}}]);}();var LanguageUnderstandingApi=/*#__PURE__*/function(){/**
|
|
15447
15496
|
* LanguageUnderstanding service.
|
|
15448
15497
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
15449
|
-
* @version
|
|
15498
|
+
* @version 253.0.0
|
|
15450
15499
|
*//**
|
|
15451
15500
|
* Constructs a new LanguageUnderstandingApi.
|
|
15452
15501
|
* @alias module:purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
@@ -15820,7 +15869,7 @@ if(domainVersionId===undefined||domainVersionId===null||domainVersionId===''){th
|
|
|
15820
15869
|
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'],opts['customHeaders']);}}]);}();var LanguagesApi=/*#__PURE__*/function(){/**
|
|
15821
15870
|
* Languages service.
|
|
15822
15871
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
15823
|
-
* @version
|
|
15872
|
+
* @version 253.0.0
|
|
15824
15873
|
*//**
|
|
15825
15874
|
* Constructs a new LanguagesApi.
|
|
15826
15875
|
* @alias module:purecloud-platform-client-v2/api/LanguagesApi
|
|
@@ -15890,7 +15939,7 @@ if(userId===undefined||userId===null||userId===''){throw'Missing the required pa
|
|
|
15890
15939
|
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'],opts['customHeaders']);}}]);}();var LearningApi=/*#__PURE__*/function(){/**
|
|
15891
15940
|
* Learning service.
|
|
15892
15941
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
15893
|
-
* @version
|
|
15942
|
+
* @version 253.0.0
|
|
15894
15943
|
*//**
|
|
15895
15944
|
* Constructs a new LearningApi.
|
|
15896
15945
|
* @alias module:purecloud-platform-client-v2/api/LearningApi
|
|
@@ -16238,7 +16287,7 @@ if(moduleId===undefined||moduleId===null||moduleId===''){throw'Missing the requi
|
|
|
16238
16287
|
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'],opts['customHeaders']);}}]);}();var LicenseApi=/*#__PURE__*/function(){/**
|
|
16239
16288
|
* License service.
|
|
16240
16289
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
16241
|
-
* @version
|
|
16290
|
+
* @version 253.0.0
|
|
16242
16291
|
*//**
|
|
16243
16292
|
* Constructs a new LicenseApi.
|
|
16244
16293
|
* @alias module:purecloud-platform-client-v2/api/LicenseApi
|
|
@@ -16313,7 +16362,7 @@ if(featureName===undefined||featureName===null||featureName===''){throw'Missing
|
|
|
16313
16362
|
*/},{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'],opts['customHeaders']);}}]);}();var LocationsApi=/*#__PURE__*/function(){/**
|
|
16314
16363
|
* Locations service.
|
|
16315
16364
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
16316
|
-
* @version
|
|
16365
|
+
* @version 253.0.0
|
|
16317
16366
|
*//**
|
|
16318
16367
|
* Constructs a new LocationsApi.
|
|
16319
16368
|
* @alias module:purecloud-platform-client-v2/api/LocationsApi
|
|
@@ -16385,7 +16434,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
16385
16434
|
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'],opts['customHeaders']);}}]);}();var LogCaptureApi=/*#__PURE__*/function(){/**
|
|
16386
16435
|
* LogCapture service.
|
|
16387
16436
|
* @module purecloud-platform-client-v2/api/LogCaptureApi
|
|
16388
|
-
* @version
|
|
16437
|
+
* @version 253.0.0
|
|
16389
16438
|
*//**
|
|
16390
16439
|
* Constructs a new LogCaptureApi.
|
|
16391
16440
|
* @alias module:purecloud-platform-client-v2/api/LogCaptureApi
|
|
@@ -16444,7 +16493,7 @@ if(userId===undefined||userId===null||userId===''){throw'Missing the required pa
|
|
|
16444
16493
|
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'],opts['customHeaders']);}}]);}();var MessagingApi=/*#__PURE__*/function(){/**
|
|
16445
16494
|
* Messaging service.
|
|
16446
16495
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
16447
|
-
* @version
|
|
16496
|
+
* @version 253.0.0
|
|
16448
16497
|
*//**
|
|
16449
16498
|
* Constructs a new MessagingApi.
|
|
16450
16499
|
* @alias module:purecloud-platform-client-v2/api/MessagingApi
|
|
@@ -16558,7 +16607,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
16558
16607
|
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'],opts['customHeaders']);}}]);}();var MobileDevicesApi=/*#__PURE__*/function(){/**
|
|
16559
16608
|
* MobileDevices service.
|
|
16560
16609
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
16561
|
-
* @version
|
|
16610
|
+
* @version 253.0.0
|
|
16562
16611
|
*//**
|
|
16563
16612
|
* Constructs a new MobileDevicesApi.
|
|
16564
16613
|
* @alias module:purecloud-platform-client-v2/api/MobileDevicesApi
|
|
@@ -16605,7 +16654,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
16605
16654
|
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'],opts['customHeaders']);}}]);}();var NotificationsApi=/*#__PURE__*/function(){/**
|
|
16606
16655
|
* Notifications service.
|
|
16607
16656
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
16608
|
-
* @version
|
|
16657
|
+
* @version 253.0.0
|
|
16609
16658
|
*//**
|
|
16610
16659
|
* Constructs a new NotificationsApi.
|
|
16611
16660
|
* @alias module:purecloud-platform-client-v2/api/NotificationsApi
|
|
@@ -16674,7 +16723,7 @@ if(channelId===undefined||channelId===null||channelId===''){throw'Missing the re
|
|
|
16674
16723
|
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'],opts['customHeaders']);}}]);}();var OAuthApi=/*#__PURE__*/function(){/**
|
|
16675
16724
|
* OAuth service.
|
|
16676
16725
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
16677
|
-
* @version
|
|
16726
|
+
* @version 253.0.0
|
|
16678
16727
|
*//**
|
|
16679
16728
|
* Constructs a new OAuthApi.
|
|
16680
16729
|
* @alias module:purecloud-platform-client-v2/api/OAuthApi
|
|
@@ -16780,7 +16829,7 @@ if(clientId===undefined||clientId===null||clientId===''){throw'Missing the requi
|
|
|
16780
16829
|
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'],opts['customHeaders']);}}]);}();var ObjectsApi=/*#__PURE__*/function(){/**
|
|
16781
16830
|
* Objects service.
|
|
16782
16831
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
16783
|
-
* @version
|
|
16832
|
+
* @version 253.0.0
|
|
16784
16833
|
*//**
|
|
16785
16834
|
* Constructs a new ObjectsApi.
|
|
16786
16835
|
* @alias module:purecloud-platform-client-v2/api/ObjectsApi
|
|
@@ -16883,7 +16932,7 @@ if(divisionId===undefined||divisionId===null||divisionId===''){throw'Missing the
|
|
|
16883
16932
|
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'],opts['customHeaders']);}}]);}();var OperationalEventsApi=/*#__PURE__*/function(){/**
|
|
16884
16933
|
* OperationalEvents service.
|
|
16885
16934
|
* @module purecloud-platform-client-v2/api/OperationalEventsApi
|
|
16886
|
-
* @version
|
|
16935
|
+
* @version 253.0.0
|
|
16887
16936
|
*//**
|
|
16888
16937
|
* Constructs a new OperationalEventsApi.
|
|
16889
16938
|
* @alias module:purecloud-platform-client-v2/api/OperationalEventsApi
|
|
@@ -16920,7 +16969,7 @@ if(eventDefinitionId===undefined||eventDefinitionId===null||eventDefinitionId===
|
|
|
16920
16969
|
*/},{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'],opts['customHeaders']);}}]);}();var OrganizationApi=/*#__PURE__*/function(){/**
|
|
16921
16970
|
* Organization service.
|
|
16922
16971
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
16923
|
-
* @version
|
|
16972
|
+
* @version 253.0.0
|
|
16924
16973
|
*//**
|
|
16925
16974
|
* Constructs a new OrganizationApi.
|
|
16926
16975
|
* @alias module:purecloud-platform-client-v2/api/OrganizationApi
|
|
@@ -17060,7 +17109,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
17060
17109
|
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'],opts['customHeaders']);}}]);}();var OrganizationAuthorizationApi=/*#__PURE__*/function(){/**
|
|
17061
17110
|
* OrganizationAuthorization service.
|
|
17062
17111
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
17063
|
-
* @version
|
|
17112
|
+
* @version 253.0.0
|
|
17064
17113
|
*//**
|
|
17065
17114
|
* Constructs a new OrganizationAuthorizationApi.
|
|
17066
17115
|
* @alias module:purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
@@ -17480,7 +17529,7 @@ if(trustorOrgId===undefined||trustorOrgId===null||trustorOrgId===''){throw'Missi
|
|
|
17480
17529
|
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'],opts['customHeaders']);}}]);}();var OutboundApi=/*#__PURE__*/function(){/**
|
|
17481
17530
|
* Outbound service.
|
|
17482
17531
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
17483
|
-
* @version
|
|
17532
|
+
* @version 253.0.0
|
|
17484
17533
|
*//**
|
|
17485
17534
|
* Constructs a new OutboundApi.
|
|
17486
17535
|
* @alias module:purecloud-platform-client-v2/api/OutboundApi
|
|
@@ -18966,7 +19015,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
18966
19015
|
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'],opts['customHeaders']);}}]);}();var PresenceApi=/*#__PURE__*/function(){/**
|
|
18967
19016
|
* Presence service.
|
|
18968
19017
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
18969
|
-
* @version
|
|
19018
|
+
* @version 253.0.0
|
|
18970
19019
|
*//**
|
|
18971
19020
|
* Constructs a new PresenceApi.
|
|
18972
19021
|
* @alias module:purecloud-platform-client-v2/api/PresenceApi
|
|
@@ -19186,7 +19235,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
19186
19235
|
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'],opts['customHeaders']);}}]);}();var ProcessAutomationApi=/*#__PURE__*/function(){/**
|
|
19187
19236
|
* ProcessAutomation service.
|
|
19188
19237
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
19189
|
-
* @version
|
|
19238
|
+
* @version 253.0.0
|
|
19190
19239
|
*//**
|
|
19191
19240
|
* Constructs a new ProcessAutomationApi.
|
|
19192
19241
|
* @alias module:purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
@@ -19300,7 +19349,7 @@ if(triggerId===undefined||triggerId===null||triggerId===''){throw'Missing the re
|
|
|
19300
19349
|
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'],opts['customHeaders']);}}]);}();var QualityApi=/*#__PURE__*/function(){/**
|
|
19301
19350
|
* Quality service.
|
|
19302
19351
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
19303
|
-
* @version
|
|
19352
|
+
* @version 253.0.0
|
|
19304
19353
|
*//**
|
|
19305
19354
|
* Constructs a new QualityApi.
|
|
19306
19355
|
* @alias module:purecloud-platform-client-v2/api/QualityApi
|
|
@@ -19964,7 +20013,7 @@ if(customerSurveyUrl===undefined||customerSurveyUrl===null){throw'Missing the re
|
|
|
19964
20013
|
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'],opts['customHeaders']);}}]);}();var RecordingApi=/*#__PURE__*/function(){/**
|
|
19965
20014
|
* Recording service.
|
|
19966
20015
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
19967
|
-
* @version
|
|
20016
|
+
* @version 253.0.0
|
|
19968
20017
|
*//**
|
|
19969
20018
|
* Constructs a new RecordingApi.
|
|
19970
20019
|
* @alias module:purecloud-platform-client-v2/api/RecordingApi
|
|
@@ -20463,7 +20512,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
20463
20512
|
*/},{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'],opts['customHeaders']);}}]);}();var ResponseManagementApi=/*#__PURE__*/function(){/**
|
|
20464
20513
|
* ResponseManagement service.
|
|
20465
20514
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
20466
|
-
* @version
|
|
20515
|
+
* @version 253.0.0
|
|
20467
20516
|
*//**
|
|
20468
20517
|
* Constructs a new ResponseManagementApi.
|
|
20469
20518
|
* @alias module:purecloud-platform-client-v2/api/ResponseManagementApi
|
|
@@ -20630,7 +20679,7 @@ if(responseAssetId===undefined||responseAssetId===null||responseAssetId===''){th
|
|
|
20630
20679
|
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'],opts['customHeaders']);}}]);}();var RoutingApi=/*#__PURE__*/function(){/**
|
|
20631
20680
|
* Routing service.
|
|
20632
20681
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
20633
|
-
* @version
|
|
20682
|
+
* @version 253.0.0
|
|
20634
20683
|
*//**
|
|
20635
20684
|
* Constructs a new RoutingApi.
|
|
20636
20685
|
* @alias module:purecloud-platform-client-v2/api/RoutingApi
|
|
@@ -20743,6 +20792,19 @@ if(codeId===undefined||codeId===null||codeId===''){throw'Missing the required pa
|
|
|
20743
20792
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
20744
20793
|
*/},{key:"deleteRoutingSkill",value:function deleteRoutingSkill(skillId,opts){opts=opts||{};// verify the required parameter 'skillId' is set
|
|
20745
20794
|
if(skillId===undefined||skillId===null||skillId===''){throw'Missing the required parameter "skillId" when calling deleteRoutingSkill';}return this.apiClient.callApi('/api/v2/routing/skills/{skillId}','DELETE',{'skillId':skillId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
20795
|
+
* Archive a skill expression to remove it from the set of active expressions
|
|
20796
|
+
*
|
|
20797
|
+
* @param {String} expressionId Expression ID
|
|
20798
|
+
* @param {Object} opts Optional parameters
|
|
20799
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
20800
|
+
*/},{key:"deleteRoutingSkillexpression",value:function deleteRoutingSkillexpression(expressionId,opts){opts=opts||{};// verify the required parameter 'expressionId' is set
|
|
20801
|
+
if(expressionId===undefined||expressionId===null||expressionId===''){throw'Missing the required parameter "expressionId" when calling deleteRoutingSkillexpression';}return this.apiClient.callApi('/api/v2/routing/skillexpressions/{expressionId}','DELETE',{'expressionId':expressionId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
20802
|
+
* Archive a set of skill expressions to remove them from the set of active expressions
|
|
20803
|
+
*
|
|
20804
|
+
* @param {Object} opts Optional parameters
|
|
20805
|
+
* @param {Array.<String>} opts.id Expression ID(s) to filter. Repeat for multiple or use comma-separated list.
|
|
20806
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
20807
|
+
*/},{key:"deleteRoutingSkillexpressions",value:function deleteRoutingSkillexpressions(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/routing/skillexpressions','DELETE',{},{'id':this.apiClient.buildCollectionParam(opts['id'],'multi')},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
20746
20808
|
* Remove skill group definition
|
|
20747
20809
|
*
|
|
20748
20810
|
* @param {String} skillGroupId Skill Group ID
|
|
@@ -20791,15 +20853,6 @@ if(userId===undefined||userId===null||userId===''){throw'Missing the required pa
|
|
|
20791
20853
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
20792
20854
|
*/},{key:"deleteRoutingUtilizationLabel",value:function deleteRoutingUtilizationLabel(labelId,opts){opts=opts||{};// verify the required parameter 'labelId' is set
|
|
20793
20855
|
if(labelId===undefined||labelId===null||labelId===''){throw'Missing the required parameter "labelId" when calling deleteRoutingUtilizationLabel';}return this.apiClient.callApi('/api/v2/routing/utilization/labels/{labelId}','DELETE',{'labelId':labelId},{'forceDelete':opts['forceDelete']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
20794
|
-
* Delete an utilization tag
|
|
20795
|
-
*
|
|
20796
|
-
* @param {String} tagId Utilization Tag ID
|
|
20797
|
-
* @param {Object} opts Optional parameters
|
|
20798
|
-
* @param {Boolean} opts.forceDelete Remove all tag usages (if found) without warning (default to false)
|
|
20799
|
-
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
20800
|
-
* deleteRoutingUtilizationTag is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
20801
|
-
*/},{key:"deleteRoutingUtilizationTag",value:function deleteRoutingUtilizationTag(tagId,opts){opts=opts||{};// verify the required parameter 'tagId' is set
|
|
20802
|
-
if(tagId===undefined||tagId===null||tagId===''){throw'Missing the required parameter "tagId" when calling deleteRoutingUtilizationTag';}return this.apiClient.callApi('/api/v2/routing/utilization/tags/{tagId}','DELETE',{'tagId':tagId},{'forceDelete':opts['forceDelete']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
20803
20856
|
* Delete wrap-up code
|
|
20804
20857
|
*
|
|
20805
20858
|
* @param {String} codeId Wrapup Code ID
|
|
@@ -21226,6 +21279,32 @@ if(queueId===undefined||queueId===null||queueId===''){throw'Missing the required
|
|
|
21226
21279
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
21227
21280
|
*/},{key:"getRoutingSkill",value:function getRoutingSkill(skillId,opts){opts=opts||{};// verify the required parameter 'skillId' is set
|
|
21228
21281
|
if(skillId===undefined||skillId===null||skillId===''){throw'Missing the required parameter "skillId" when calling getRoutingSkill';}return this.apiClient.callApi('/api/v2/routing/skills/{skillId}','GET',{'skillId':skillId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
21282
|
+
* Get a skill expression by ID
|
|
21283
|
+
*
|
|
21284
|
+
* @param {String} expressionId Expression ID
|
|
21285
|
+
* @param {Object} opts Optional parameters
|
|
21286
|
+
* @param {Boolean} opts.includeArchived Include archived (default to false)
|
|
21287
|
+
* @param {Object} opts.format Response format: raw expression or normalized (default to Raw)
|
|
21288
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
21289
|
+
*/},{key:"getRoutingSkillexpression",value:function getRoutingSkillexpression(expressionId,opts){opts=opts||{};// verify the required parameter 'expressionId' is set
|
|
21290
|
+
if(expressionId===undefined||expressionId===null||expressionId===''){throw'Missing the required parameter "expressionId" when calling getRoutingSkillexpression';}return this.apiClient.callApi('/api/v2/routing/skillexpressions/{expressionId}','GET',{'expressionId':expressionId},{'includeArchived':opts['includeArchived'],'format':opts['format']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
21291
|
+
* Get skill expressions
|
|
21292
|
+
*
|
|
21293
|
+
* @param {Object} opts Optional parameters
|
|
21294
|
+
* @param {Object} opts.format Response format: raw expression or normalized (default to Raw)
|
|
21295
|
+
* @param {Boolean} opts.includeArchived Include archived (default to false)
|
|
21296
|
+
* @param {Array.<String>} opts.id Expression ID(s) to filter. Repeat for multiple or use comma-separated list.
|
|
21297
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
21298
|
+
*/},{key:"getRoutingSkillexpressions",value:function getRoutingSkillexpressions(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/routing/skillexpressions','GET',{},{'format':opts['format'],'includeArchived':opts['includeArchived'],'id':this.apiClient.buildCollectionParam(opts['id'],'multi')},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
21299
|
+
* Get skill expressions associated with a queue
|
|
21300
|
+
*
|
|
21301
|
+
* @param {String} queueId Queue ID
|
|
21302
|
+
* @param {Object} opts Optional parameters
|
|
21303
|
+
* @param {Object} opts.format Response format: raw expression or normalized (default to Raw)
|
|
21304
|
+
* @param {Boolean} opts.includeArchived Include archived (default to false)
|
|
21305
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
21306
|
+
*/},{key:"getRoutingSkillexpressionsQueueQueueId",value:function getRoutingSkillexpressionsQueueQueueId(queueId,opts){opts=opts||{};// verify the required parameter 'queueId' is set
|
|
21307
|
+
if(queueId===undefined||queueId===null||queueId===''){throw'Missing the required parameter "queueId" when calling getRoutingSkillexpressionsQueueQueueId';}return this.apiClient.callApi('/api/v2/routing/skillexpressions/queue/{queueId}','GET',{'queueId':queueId},{'format':opts['format'],'includeArchived':opts['includeArchived']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
21229
21308
|
* Get skill group
|
|
21230
21309
|
*
|
|
21231
21310
|
* @param {String} skillGroupId Skill Group ID
|
|
@@ -21372,32 +21451,6 @@ if(labelId===undefined||labelId===null||labelId===''){throw'Missing the required
|
|
|
21372
21451
|
* @param {String} opts.name Utilization label's name (Wildcard is supported, e.g., 'label1*', '*label*'
|
|
21373
21452
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
21374
21453
|
*/},{key:"getRoutingUtilizationLabels",value:function getRoutingUtilizationLabels(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/routing/utilization/labels','GET',{},{'pageSize':opts['pageSize'],'pageNumber':opts['pageNumber'],'sortOrder':opts['sortOrder'],'name':opts['name']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
21375
|
-
* Get details about this utilization tag
|
|
21376
|
-
*
|
|
21377
|
-
* @param {String} tagId Utilization Tag ID
|
|
21378
|
-
* @param {Object} opts Optional parameters
|
|
21379
|
-
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
21380
|
-
* getRoutingUtilizationTag is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
21381
|
-
*/},{key:"getRoutingUtilizationTag",value:function getRoutingUtilizationTag(tagId,opts){opts=opts||{};// verify the required parameter 'tagId' is set
|
|
21382
|
-
if(tagId===undefined||tagId===null||tagId===''){throw'Missing the required parameter "tagId" when calling getRoutingUtilizationTag';}return this.apiClient.callApi('/api/v2/routing/utilization/tags/{tagId}','GET',{'tagId':tagId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
21383
|
-
* Get list of agent ids associated with a utilization tag
|
|
21384
|
-
*
|
|
21385
|
-
* @param {String} tagId Utilization Tag ID
|
|
21386
|
-
* @param {Object} opts Optional parameters
|
|
21387
|
-
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
21388
|
-
* getRoutingUtilizationTagAgents is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
21389
|
-
*/},{key:"getRoutingUtilizationTagAgents",value:function getRoutingUtilizationTagAgents(tagId,opts){opts=opts||{};// verify the required parameter 'tagId' is set
|
|
21390
|
-
if(tagId===undefined||tagId===null||tagId===''){throw'Missing the required parameter "tagId" when calling getRoutingUtilizationTagAgents';}return this.apiClient.callApi('/api/v2/routing/utilization/tags/{tagId}/agents','GET',{'tagId':tagId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
21391
|
-
* Get list of utilization tags
|
|
21392
|
-
*
|
|
21393
|
-
* @param {Object} opts Optional parameters
|
|
21394
|
-
* @param {Number} opts.pageSize Page size (default to 25)
|
|
21395
|
-
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
21396
|
-
* @param {Object} opts.sortOrder Sort order by name (default to ascending)
|
|
21397
|
-
* @param {String} opts.name Utilization tag's name (Wildcard is supported, e.g., 'tag1*')
|
|
21398
|
-
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
21399
|
-
* getRoutingUtilizationTags is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
21400
|
-
*/},{key:"getRoutingUtilizationTags",value:function getRoutingUtilizationTags(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/routing/utilization/tags','GET',{},{'pageSize':opts['pageSize'],'pageNumber':opts['pageNumber'],'sortOrder':opts['sortOrder'],'name':opts['name']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
21401
21454
|
* Get details about this wrap-up code.
|
|
21402
21455
|
*
|
|
21403
21456
|
* @param {String} codeId Wrapup Code ID
|
|
@@ -21817,6 +21870,13 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
21817
21870
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
21818
21871
|
*/},{key:"postRoutingQueues",value:function postRoutingQueues(body,opts){opts=opts||{};// verify the required parameter 'body' is set
|
|
21819
21872
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postRoutingQueues';}return this.apiClient.callApi('/api/v2/routing/queues','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
21873
|
+
* Validate and normalize a skill expression
|
|
21874
|
+
*
|
|
21875
|
+
* @param {Object} body Skill expression data to validate
|
|
21876
|
+
* @param {Object} opts Optional parameters
|
|
21877
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
21878
|
+
*/},{key:"postRoutingSkillexpressionsValidate",value:function postRoutingSkillexpressionsValidate(body,opts){opts=opts||{};// verify the required parameter 'body' is set
|
|
21879
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postRoutingSkillexpressionsValidate';}return this.apiClient.callApi('/api/v2/routing/skillexpressions/validate','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
21820
21880
|
* Add or remove member divisions for this skill group.
|
|
21821
21881
|
*
|
|
21822
21882
|
* @param {String} skillGroupId Skill Group ID
|
|
@@ -21875,14 +21935,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
21875
21935
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
21876
21936
|
*/},{key:"postRoutingUtilizationLabels",value:function postRoutingUtilizationLabels(body,opts){opts=opts||{};// verify the required parameter 'body' is set
|
|
21877
21937
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postRoutingUtilizationLabels';}return this.apiClient.callApi('/api/v2/routing/utilization/labels','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
21878
|
-
* Create an utilization tag
|
|
21879
|
-
*
|
|
21880
|
-
* @param {Object} body UtilizationTag
|
|
21881
|
-
* @param {Object} opts Optional parameters
|
|
21882
|
-
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
21883
|
-
* postRoutingUtilizationTags is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
21884
|
-
*/},{key:"postRoutingUtilizationTags",value:function postRoutingUtilizationTags(body,opts){opts=opts||{};// verify the required parameter 'body' is set
|
|
21885
|
-
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postRoutingUtilizationTags';}return this.apiClient.callApi('/api/v2/routing/utilization/tags','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
21886
21938
|
* Create a wrap-up code
|
|
21887
21939
|
*
|
|
21888
21940
|
* @param {Object} body WrapupCode
|
|
@@ -22059,7 +22111,7 @@ if(userId===undefined||userId===null||userId===''){throw'Missing the required pa
|
|
|
22059
22111
|
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'],opts['customHeaders']);}}]);}();var SCIMApi=/*#__PURE__*/function(){/**
|
|
22060
22112
|
* SCIM service.
|
|
22061
22113
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
22062
|
-
* @version
|
|
22114
|
+
* @version 253.0.0
|
|
22063
22115
|
*//**
|
|
22064
22116
|
* Constructs a new SCIMApi.
|
|
22065
22117
|
* @alias module:purecloud-platform-client-v2/api/SCIMApi
|
|
@@ -22322,7 +22374,7 @@ if(userId===undefined||userId===null||userId===''){throw'Missing the required pa
|
|
|
22322
22374
|
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'],opts['customHeaders']);}}]);}();var ScriptsApi=/*#__PURE__*/function(){/**
|
|
22323
22375
|
* Scripts service.
|
|
22324
22376
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
22325
|
-
* @version
|
|
22377
|
+
* @version 253.0.0
|
|
22326
22378
|
*//**
|
|
22327
22379
|
* Constructs a new ScriptsApi.
|
|
22328
22380
|
* @alias module:purecloud-platform-client-v2/api/ScriptsApi
|
|
@@ -22484,7 +22536,7 @@ if(scriptId===undefined||scriptId===null||scriptId===''){throw'Missing the requi
|
|
|
22484
22536
|
*/},{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'],opts['customHeaders']);}}]);}();var SearchApi=/*#__PURE__*/function(){/**
|
|
22485
22537
|
* Search service.
|
|
22486
22538
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
22487
|
-
* @version
|
|
22539
|
+
* @version 253.0.0
|
|
22488
22540
|
*//**
|
|
22489
22541
|
* Constructs a new SearchApi.
|
|
22490
22542
|
* @alias module:purecloud-platform-client-v2/api/SearchApi
|
|
@@ -22691,7 +22743,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
22691
22743
|
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'],opts['customHeaders']);}}]);}();var SettingsApi=/*#__PURE__*/function(){/**
|
|
22692
22744
|
* Settings service.
|
|
22693
22745
|
* @module purecloud-platform-client-v2/api/SettingsApi
|
|
22694
|
-
* @version
|
|
22746
|
+
* @version 253.0.0
|
|
22695
22747
|
*//**
|
|
22696
22748
|
* Constructs a new SettingsApi.
|
|
22697
22749
|
* @alias module:purecloud-platform-client-v2/api/SettingsApi
|
|
@@ -22788,7 +22840,7 @@ if(agentId===undefined||agentId===null||agentId===''){throw'Missing the required
|
|
|
22788
22840
|
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'],opts['customHeaders']);}}]);}();var SocialMediaApi=/*#__PURE__*/function(){/**
|
|
22789
22841
|
* SocialMedia service.
|
|
22790
22842
|
* @module purecloud-platform-client-v2/api/SocialMediaApi
|
|
22791
|
-
* @version
|
|
22843
|
+
* @version 253.0.0
|
|
22792
22844
|
*//**
|
|
22793
22845
|
* Constructs a new SocialMediaApi.
|
|
22794
22846
|
* @alias module:purecloud-platform-client-v2/api/SocialMediaApi
|
|
@@ -23343,7 +23395,7 @@ if(topicId===undefined||topicId===null||topicId===''){throw'Missing the required
|
|
|
23343
23395
|
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'],opts['customHeaders']);}}]);}();var SpeechTextAnalyticsApi=/*#__PURE__*/function(){/**
|
|
23344
23396
|
* SpeechTextAnalytics service.
|
|
23345
23397
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
23346
|
-
* @version
|
|
23398
|
+
* @version 253.0.0
|
|
23347
23399
|
*//**
|
|
23348
23400
|
* Constructs a new SpeechTextAnalyticsApi.
|
|
23349
23401
|
* @alias module:purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
@@ -23836,7 +23888,7 @@ if(topicId===undefined||topicId===null||topicId===''){throw'Missing the required
|
|
|
23836
23888
|
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'],opts['customHeaders']);}}]);}();var StationsApi=/*#__PURE__*/function(){/**
|
|
23837
23889
|
* Stations service.
|
|
23838
23890
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
23839
|
-
* @version
|
|
23891
|
+
* @version 253.0.0
|
|
23840
23892
|
*//**
|
|
23841
23893
|
* Constructs a new StationsApi.
|
|
23842
23894
|
* @alias module:purecloud-platform-client-v2/api/StationsApi
|
|
@@ -23873,7 +23925,7 @@ if(stationId===undefined||stationId===null||stationId===''){throw'Missing the re
|
|
|
23873
23925
|
*/},{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'],opts['customHeaders']);}}]);}();var SuggestApi=/*#__PURE__*/function(){/**
|
|
23874
23926
|
* Suggest service.
|
|
23875
23927
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
23876
|
-
* @version
|
|
23928
|
+
* @version 253.0.0
|
|
23877
23929
|
*//**
|
|
23878
23930
|
* Constructs a new SuggestApi.
|
|
23879
23931
|
* @alias module:purecloud-platform-client-v2/api/SuggestApi
|
|
@@ -23917,7 +23969,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
23917
23969
|
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'],opts['customHeaders']);}}]);}();var TaskManagementApi=/*#__PURE__*/function(){/**
|
|
23918
23970
|
* TaskManagement service.
|
|
23919
23971
|
* @module purecloud-platform-client-v2/api/TaskManagementApi
|
|
23920
|
-
* @version
|
|
23972
|
+
* @version 253.0.0
|
|
23921
23973
|
*//**
|
|
23922
23974
|
* Constructs a new TaskManagementApi.
|
|
23923
23975
|
* @alias module:purecloud-platform-client-v2/api/TaskManagementApi
|
|
@@ -24561,7 +24613,7 @@ if(schemaId===undefined||schemaId===null||schemaId===''){throw'Missing the requi
|
|
|
24561
24613
|
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'],opts['customHeaders']);}}]);}();var TeamsApi=/*#__PURE__*/function(){/**
|
|
24562
24614
|
* Teams service.
|
|
24563
24615
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
24564
|
-
* @version
|
|
24616
|
+
* @version 253.0.0
|
|
24565
24617
|
*//**
|
|
24566
24618
|
* Constructs a new TeamsApi.
|
|
24567
24619
|
* @alias module:purecloud-platform-client-v2/api/TeamsApi
|
|
@@ -24657,7 +24709,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
24657
24709
|
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'],opts['customHeaders']);}}]);}();var TelephonyApi=/*#__PURE__*/function(){/**
|
|
24658
24710
|
* Telephony service.
|
|
24659
24711
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
24660
|
-
* @version
|
|
24712
|
+
* @version 253.0.0
|
|
24661
24713
|
*//**
|
|
24662
24714
|
* Constructs a new TelephonyApi.
|
|
24663
24715
|
* @alias module:purecloud-platform-client-v2/api/TelephonyApi
|
|
@@ -24760,7 +24812,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
24760
24812
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putTelephonySettings';}return this.apiClient.callApi('/api/v2/telephony/settings','PUT',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}}]);}();var TelephonyProvidersEdgeApi=/*#__PURE__*/function(){/**
|
|
24761
24813
|
* TelephonyProvidersEdge service.
|
|
24762
24814
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
24763
|
-
* @version
|
|
24815
|
+
* @version 253.0.0
|
|
24764
24816
|
*//**
|
|
24765
24817
|
* Constructs a new TelephonyProvidersEdgeApi.
|
|
24766
24818
|
* @alias module:purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
@@ -25614,20 +25666,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
25614
25666
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
25615
25667
|
*/},{key:"postTelephonyProvidersEdgesExtensionpools",value:function postTelephonyProvidersEdgesExtensionpools(body,opts){opts=opts||{};// verify the required parameter 'body' is set
|
|
25616
25668
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postTelephonyProvidersEdgesExtensionpools';}return this.apiClient.callApi('/api/v2/telephony/providers/edges/extensionpools','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
25617
|
-
* Post media endpoint statistics event.
|
|
25618
|
-
*
|
|
25619
|
-
* @param {String} conversationId Identifier of the conversation
|
|
25620
|
-
* @param {String} communicationId Identifier of the media session
|
|
25621
|
-
* @param {String} mediaResourceId Identifier of the media resource of the endpoint
|
|
25622
|
-
* @param {Object} body MediaStatisticsPostRequest
|
|
25623
|
-
* @param {Object} opts Optional parameters
|
|
25624
|
-
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
25625
|
-
* postTelephonyProvidersEdgesMediastatisticsConversationCommunicationMediaresource is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
25626
|
-
*/},{key:"postTelephonyProvidersEdgesMediastatisticsConversationCommunicationMediaresource",value:function postTelephonyProvidersEdgesMediastatisticsConversationCommunicationMediaresource(conversationId,communicationId,mediaResourceId,body,opts){opts=opts||{};// verify the required parameter 'conversationId' is set
|
|
25627
|
-
if(conversationId===undefined||conversationId===null||conversationId===''){throw'Missing the required parameter "conversationId" when calling postTelephonyProvidersEdgesMediastatisticsConversationCommunicationMediaresource';}// verify the required parameter 'communicationId' is set
|
|
25628
|
-
if(communicationId===undefined||communicationId===null||communicationId===''){throw'Missing the required parameter "communicationId" when calling postTelephonyProvidersEdgesMediastatisticsConversationCommunicationMediaresource';}// verify the required parameter 'mediaResourceId' is set
|
|
25629
|
-
if(mediaResourceId===undefined||mediaResourceId===null||mediaResourceId===''){throw'Missing the required parameter "mediaResourceId" when calling postTelephonyProvidersEdgesMediastatisticsConversationCommunicationMediaresource';}// verify the required parameter 'body' is set
|
|
25630
|
-
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postTelephonyProvidersEdgesMediastatisticsConversationCommunicationMediaresource';}return this.apiClient.callApi('/api/v2/telephony/providers/edges/mediastatistics/conversations/{conversationId}/communications/{communicationId}/mediaresources/{mediaResourceId}','POST',{'conversationId':conversationId,'communicationId':communicationId,'mediaResourceId':mediaResourceId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
25631
25669
|
* Reboot a Phone
|
|
25632
25670
|
*
|
|
25633
25671
|
* @param {String} phoneId Phone Id
|
|
@@ -25827,7 +25865,7 @@ if(trunkBaseSettingsId===undefined||trunkBaseSettingsId===null||trunkBaseSetting
|
|
|
25827
25865
|
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'],opts['customHeaders']);}}]);}();var TextbotsApi=/*#__PURE__*/function(){/**
|
|
25828
25866
|
* Textbots service.
|
|
25829
25867
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
25830
|
-
* @version
|
|
25868
|
+
* @version 253.0.0
|
|
25831
25869
|
*//**
|
|
25832
25870
|
* Constructs a new TextbotsApi.
|
|
25833
25871
|
* @alias module:purecloud-platform-client-v2/api/TextbotsApi
|
|
@@ -25870,7 +25908,7 @@ if(launchRequest===undefined||launchRequest===null){throw'Missing the required p
|
|
|
25870
25908
|
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'],opts['customHeaders']);}}]);}();var TokensApi=/*#__PURE__*/function(){/**
|
|
25871
25909
|
* Tokens service.
|
|
25872
25910
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
25873
|
-
* @version
|
|
25911
|
+
* @version 253.0.0
|
|
25874
25912
|
*//**
|
|
25875
25913
|
* Constructs a new TokensApi.
|
|
25876
25914
|
* @alias module:purecloud-platform-client-v2/api/TokensApi
|
|
@@ -25914,7 +25952,7 @@ if(userId===undefined||userId===null||userId===''){throw'Missing the required pa
|
|
|
25914
25952
|
*/},{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'],opts['customHeaders']);}}]);}();var UploadsApi=/*#__PURE__*/function(){/**
|
|
25915
25953
|
* Uploads service.
|
|
25916
25954
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
25917
|
-
* @version
|
|
25955
|
+
* @version 253.0.0
|
|
25918
25956
|
*//**
|
|
25919
25957
|
* Constructs a new UploadsApi.
|
|
25920
25958
|
* @alias module:purecloud-platform-client-v2/api/UploadsApi
|
|
@@ -26009,7 +26047,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
26009
26047
|
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'],opts['customHeaders']);}}]);}();var UsageApi=/*#__PURE__*/function(){/**
|
|
26010
26048
|
* Usage service.
|
|
26011
26049
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
26012
|
-
* @version
|
|
26050
|
+
* @version 253.0.0
|
|
26013
26051
|
*//**
|
|
26014
26052
|
* Constructs a new UsageApi.
|
|
26015
26053
|
* @alias module:purecloud-platform-client-v2/api/UsageApi
|
|
@@ -26111,7 +26149,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
26111
26149
|
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'],opts['customHeaders']);}}]);}();var UserRecordingsApi=/*#__PURE__*/function(){/**
|
|
26112
26150
|
* UserRecordings service.
|
|
26113
26151
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
26114
|
-
* @version
|
|
26152
|
+
* @version 253.0.0
|
|
26115
26153
|
*//**
|
|
26116
26154
|
* Constructs a new UserRecordingsApi.
|
|
26117
26155
|
* @alias module:purecloud-platform-client-v2/api/UserRecordingsApi
|
|
@@ -26167,7 +26205,7 @@ if(recordingId===undefined||recordingId===null||recordingId===''){throw'Missing
|
|
|
26167
26205
|
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'],opts['customHeaders']);}}]);}();var UsersApi=/*#__PURE__*/function(){/**
|
|
26168
26206
|
* Users service.
|
|
26169
26207
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
26170
|
-
* @version
|
|
26208
|
+
* @version 253.0.0
|
|
26171
26209
|
*//**
|
|
26172
26210
|
* Constructs a new UsersApi.
|
|
26173
26211
|
* @alias module:purecloud-platform-client-v2/api/UsersApi
|
|
@@ -27229,7 +27267,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
27229
27267
|
if(stationId===undefined||stationId===null||stationId===''){throw'Missing the required parameter "stationId" when calling putUsersStationsMeAssociatedstationStationId';}return this.apiClient.callApi('/api/v2/users/stations/me/associatedstation/{stationId}','PUT',{'stationId':stationId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}}]);}();var UsersRulesApi=/*#__PURE__*/function(){/**
|
|
27230
27268
|
* UsersRules service.
|
|
27231
27269
|
* @module purecloud-platform-client-v2/api/UsersRulesApi
|
|
27232
|
-
* @version
|
|
27270
|
+
* @version 253.0.0
|
|
27233
27271
|
*//**
|
|
27234
27272
|
* Constructs a new UsersRulesApi.
|
|
27235
27273
|
* @alias module:purecloud-platform-client-v2/api/UsersRulesApi
|
|
@@ -27319,7 +27357,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
27319
27357
|
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'],opts['customHeaders']);}}]);}();var UtilitiesApi=/*#__PURE__*/function(){/**
|
|
27320
27358
|
* Utilities service.
|
|
27321
27359
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
27322
|
-
* @version
|
|
27360
|
+
* @version 253.0.0
|
|
27323
27361
|
*//**
|
|
27324
27362
|
* Constructs a new UtilitiesApi.
|
|
27325
27363
|
* @alias module:purecloud-platform-client-v2/api/UtilitiesApi
|
|
@@ -27353,7 +27391,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
27353
27391
|
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'],opts['customHeaders']);}}]);}();var VoicemailApi=/*#__PURE__*/function(){/**
|
|
27354
27392
|
* Voicemail service.
|
|
27355
27393
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
27356
|
-
* @version
|
|
27394
|
+
* @version 253.0.0
|
|
27357
27395
|
*//**
|
|
27358
27396
|
* Constructs a new VoicemailApi.
|
|
27359
27397
|
* @alias module:purecloud-platform-client-v2/api/VoicemailApi
|
|
@@ -27560,7 +27598,7 @@ if(userId===undefined||userId===null||userId===''){throw'Missing the required pa
|
|
|
27560
27598
|
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'],opts['customHeaders']);}}]);}();var WebChatApi=/*#__PURE__*/function(){/**
|
|
27561
27599
|
* WebChat service.
|
|
27562
27600
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
27563
|
-
* @version
|
|
27601
|
+
* @version 253.0.0
|
|
27564
27602
|
*//**
|
|
27565
27603
|
* Constructs a new WebChatApi.
|
|
27566
27604
|
* @alias module:purecloud-platform-client-v2/api/WebChatApi
|
|
@@ -27743,7 +27781,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
27743
27781
|
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'],opts['customHeaders']);}}]);}();var WebDeploymentsApi=/*#__PURE__*/function(){/**
|
|
27744
27782
|
* WebDeployments service.
|
|
27745
27783
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
27746
|
-
* @version
|
|
27784
|
+
* @version 253.0.0
|
|
27747
27785
|
*//**
|
|
27748
27786
|
* Constructs a new WebDeploymentsApi.
|
|
27749
27787
|
* @alias module:purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
@@ -27921,7 +27959,7 @@ if(deploymentId===undefined||deploymentId===null||deploymentId===''){throw'Missi
|
|
|
27921
27959
|
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'],opts['customHeaders']);}}]);}();var WebMessagingApi=/*#__PURE__*/function(){/**
|
|
27922
27960
|
* WebMessaging service.
|
|
27923
27961
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
27924
|
-
* @version
|
|
27962
|
+
* @version 253.0.0
|
|
27925
27963
|
*//**
|
|
27926
27964
|
* Constructs a new WebMessagingApi.
|
|
27927
27965
|
* @alias module:purecloud-platform-client-v2/api/WebMessagingApi
|
|
@@ -27969,7 +28007,7 @@ if(tokenId===undefined||tokenId===null||tokenId===''){throw'Missing the required
|
|
|
27969
28007
|
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'],opts['customHeaders']);}}]);}();var WidgetsApi=/*#__PURE__*/function(){/**
|
|
27970
28008
|
* Widgets service.
|
|
27971
28009
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
27972
|
-
* @version
|
|
28010
|
+
* @version 253.0.0
|
|
27973
28011
|
*//**
|
|
27974
28012
|
* Constructs a new WidgetsApi.
|
|
27975
28013
|
* @alias module:purecloud-platform-client-v2/api/WidgetsApi
|
|
@@ -28019,7 +28057,7 @@ if(deploymentId===undefined||deploymentId===null||deploymentId===''){throw'Missi
|
|
|
28019
28057
|
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'],opts['customHeaders']);}}]);}();var WorkforceManagementApi=/*#__PURE__*/function(){/**
|
|
28020
28058
|
* WorkforceManagement service.
|
|
28021
28059
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
28022
|
-
* @version
|
|
28060
|
+
* @version 253.0.0
|
|
28023
28061
|
*//**
|
|
28024
28062
|
* Constructs a new WorkforceManagementApi.
|
|
28025
28063
|
* @alias module:purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
@@ -28494,6 +28532,16 @@ if(businessUnitId===undefined||businessUnitId===null||businessUnitId===''){throw
|
|
|
28494
28532
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
28495
28533
|
*/},{key:"getWorkforcemanagementBusinessunitMinimumstaffingSettings",value:function getWorkforcemanagementBusinessunitMinimumstaffingSettings(businessUnitId,opts){opts=opts||{};// verify the required parameter 'businessUnitId' is set
|
|
28496
28534
|
if(businessUnitId===undefined||businessUnitId===null||businessUnitId===''){throw'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitMinimumstaffingSettings';}return this.apiClient.callApi('/api/v2/workforcemanagement/businessunits/{businessUnitId}/minimumstaffing/settings','GET',{'businessUnitId':businessUnitId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
28535
|
+
* Get opportunity details
|
|
28536
|
+
*
|
|
28537
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
28538
|
+
* @param {String} opportunityId The ID of the opportunity
|
|
28539
|
+
* @param {Object} opts Optional parameters
|
|
28540
|
+
* @param {Object} opts.expand List of resources to expand
|
|
28541
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
28542
|
+
*/},{key:"getWorkforcemanagementBusinessunitOpportunity",value:function getWorkforcemanagementBusinessunitOpportunity(businessUnitId,opportunityId,opts){opts=opts||{};// verify the required parameter 'businessUnitId' is set
|
|
28543
|
+
if(businessUnitId===undefined||businessUnitId===null||businessUnitId===''){throw'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitOpportunity';}// verify the required parameter 'opportunityId' is set
|
|
28544
|
+
if(opportunityId===undefined||opportunityId===null||opportunityId===''){throw'Missing the required parameter "opportunityId" when calling getWorkforcemanagementBusinessunitOpportunity';}return this.apiClient.callApi('/api/v2/workforcemanagement/businessunits/{businessUnitId}/opportunities/{opportunityId}','GET',{'businessUnitId':businessUnitId,'opportunityId':opportunityId},{'expand':opts['expand']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
28497
28545
|
* Get a planning group
|
|
28498
28546
|
*
|
|
28499
28547
|
* @param {String} businessUnitId The ID of the business unit.
|
|
@@ -28978,19 +29026,21 @@ if(managementUnitId===undefined||managementUnitId===null||managementUnitId==='')
|
|
|
28978
29026
|
if(managementUnitId===undefined||managementUnitId===null||managementUnitId===''){throw'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitAgent';}// verify the required parameter 'agentId' is set
|
|
28979
29027
|
if(agentId===undefined||agentId===null||agentId===''){throw'Missing the required parameter "agentId" when calling getWorkforcemanagementManagementunitAgent';}return this.apiClient.callApi('/api/v2/workforcemanagement/managementunits/{managementUnitId}/agents/{agentId}','GET',{'managementUnitId':managementUnitId,'agentId':agentId},{'excludeCapabilities':opts['excludeCapabilities'],'expand':this.apiClient.buildCollectionParam(opts['expand'],'multi')},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
28980
29028
|
* Gets all the shift trades for a given agent
|
|
28981
|
-
*
|
|
29029
|
+
* Deprecated. Use new route instead (/businessunits/{businessUnitId}/shifttrading/trades/query/jobs)
|
|
28982
29030
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
28983
29031
|
* @param {String} agentId The agent id
|
|
28984
29032
|
* @param {Object} opts Optional parameters
|
|
28985
29033
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
29034
|
+
* @deprecated
|
|
28986
29035
|
*/},{key:"getWorkforcemanagementManagementunitAgentShifttrades",value:function getWorkforcemanagementManagementunitAgentShifttrades(managementUnitId,agentId,opts){opts=opts||{};// verify the required parameter 'managementUnitId' is set
|
|
28987
29036
|
if(managementUnitId===undefined||managementUnitId===null||managementUnitId===''){throw'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitAgentShifttrades';}// verify the required parameter 'agentId' is set
|
|
28988
29037
|
if(agentId===undefined||agentId===null||agentId===''){throw'Missing the required parameter "agentId" when calling getWorkforcemanagementManagementunitAgentShifttrades';}return this.apiClient.callApi('/api/v2/workforcemanagement/managementunits/{managementUnitId}/agents/{agentId}/shifttrades','GET',{'managementUnitId':managementUnitId,'agentId':agentId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
28989
29038
|
* Gets a summary of all shift trades in the matched state
|
|
28990
|
-
*
|
|
29039
|
+
* Deprecated. Use new route instead (/businessunits/{businessUnitId}/shifttrading/weeks/summary/jobs)
|
|
28991
29040
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
28992
29041
|
* @param {Object} opts Optional parameters
|
|
28993
29042
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
29043
|
+
* @deprecated
|
|
28994
29044
|
*/},{key:"getWorkforcemanagementManagementunitShifttradesMatched",value:function getWorkforcemanagementManagementunitShifttradesMatched(managementUnitId,opts){opts=opts||{};// verify the required parameter 'managementUnitId' is set
|
|
28995
29045
|
if(managementUnitId===undefined||managementUnitId===null||managementUnitId===''){throw'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitShifttradesMatched';}return this.apiClient.callApi('/api/v2/workforcemanagement/managementunits/{managementUnitId}/shifttrades/matched','GET',{'managementUnitId':managementUnitId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
28996
29046
|
* Gets list of users available for whom you can send direct shift trade requests
|
|
@@ -29098,7 +29148,7 @@ if(scheduleId===undefined||scheduleId===null||scheduleId===''){throw'Missing the
|
|
|
29098
29148
|
if(managementUnitId===undefined||managementUnitId===null||managementUnitId===''){throw'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitWeekSchedules';}// verify the required parameter 'weekId' is set
|
|
29099
29149
|
if(weekId===undefined||weekId===null||weekId===''){throw'Missing the required parameter "weekId" when calling getWorkforcemanagementManagementunitWeekSchedules';}return this.apiClient.callApi('/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekId}/schedules','GET',{'managementUnitId':managementUnitId,'weekId':weekId},{'includeOnlyPublished':opts['includeOnlyPublished'],'earliestWeekDate':opts['earliestWeekDate'],'latestWeekDate':opts['latestWeekDate']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
29100
29150
|
* Gets all the shift trades for a given week
|
|
29101
|
-
*
|
|
29151
|
+
* Deprecated. Use new route instead (/businessunits/{businessUnitId}/shifttrading/trades/evaluate/jobs)
|
|
29102
29152
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
29103
29153
|
* @param {String} weekDateId The start week date of the initiating shift in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
29104
29154
|
* @param {Object} opts Optional parameters
|
|
@@ -29106,6 +29156,7 @@ if(weekId===undefined||weekId===null||weekId===''){throw'Missing the required pa
|
|
|
29106
29156
|
* @param {Boolean} opts.includeCrossWeekShifts Whether to include all shift trades with either the initiating shift or the receiving shift in the week (default to false)
|
|
29107
29157
|
* @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
|
|
29108
29158
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
29159
|
+
* @deprecated
|
|
29109
29160
|
*/},{key:"getWorkforcemanagementManagementunitWeekShifttrades",value:function getWorkforcemanagementManagementunitWeekShifttrades(managementUnitId,weekDateId,opts){opts=opts||{};// verify the required parameter 'managementUnitId' is set
|
|
29110
29161
|
if(managementUnitId===undefined||managementUnitId===null||managementUnitId===''){throw'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitWeekShifttrades';}// verify the required parameter 'weekDateId' is set
|
|
29111
29162
|
if(weekDateId===undefined||weekDateId===null){throw'Missing the required parameter "weekDateId" when calling getWorkforcemanagementManagementunitWeekShifttrades';}return this.apiClient.callApi('/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shifttrades','GET',{'managementUnitId':managementUnitId,'weekDateId':weekDateId},{'evaluateMatches':opts['evaluateMatches'],'includeCrossWeekShifts':opts['includeCrossWeekShifts'],'forceDownloadService':opts['forceDownloadService']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
@@ -29174,9 +29225,10 @@ if(managementUnitId===undefined||managementUnitId===null||managementUnitId==='')
|
|
|
29174
29225
|
*/},{key:"getWorkforcemanagementSchedulingjob",value:function getWorkforcemanagementSchedulingjob(jobId,opts){opts=opts||{};// verify the required parameter 'jobId' is set
|
|
29175
29226
|
if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required parameter "jobId" when calling getWorkforcemanagementSchedulingjob';}return this.apiClient.callApi('/api/v2/workforcemanagement/schedulingjobs/{jobId}','GET',{'jobId':jobId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
29176
29227
|
* Gets all of my shift trades
|
|
29177
|
-
*
|
|
29228
|
+
* Deprecated. Use new route instead (/shifttrading/trades/mine/query/jobs)
|
|
29178
29229
|
* @param {Object} opts Optional parameters
|
|
29179
29230
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
29231
|
+
* @deprecated
|
|
29180
29232
|
*/},{key:"getWorkforcemanagementShifttrades",value:function getWorkforcemanagementShifttrades(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/workforcemanagement/shifttrades','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
29181
29233
|
* View result of update trade operation. Only the user who started the operation can query the status
|
|
29182
29234
|
* Job details are only retained if the initial request returned a 202 ACCEPTED response
|
|
@@ -29385,8 +29437,19 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
29385
29437
|
*/},{key:"patchWorkforcemanagementBusinessunitMinimumstaffingSettings",value:function patchWorkforcemanagementBusinessunitMinimumstaffingSettings(businessUnitId,body,opts){opts=opts||{};// verify the required parameter 'businessUnitId' is set
|
|
29386
29438
|
if(businessUnitId===undefined||businessUnitId===null||businessUnitId===''){throw'Missing the required parameter "businessUnitId" when calling patchWorkforcemanagementBusinessunitMinimumstaffingSettings';}// verify the required parameter 'body' is set
|
|
29387
29439
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling patchWorkforcemanagementBusinessunitMinimumstaffingSettings';}return this.apiClient.callApi('/api/v2/workforcemanagement/businessunits/{businessUnitId}/minimumstaffing/settings','PATCH',{'businessUnitId':businessUnitId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
29440
|
+
* Update the opportunity
|
|
29441
|
+
* Only opportunities with Draft status can be updated.
|
|
29442
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
29443
|
+
* @param {String} opportunityId The ID of the opportunity
|
|
29444
|
+
* @param {Object} body body
|
|
29445
|
+
* @param {Object} opts Optional parameters
|
|
29446
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
29447
|
+
*/},{key:"patchWorkforcemanagementBusinessunitOpportunity",value:function patchWorkforcemanagementBusinessunitOpportunity(businessUnitId,opportunityId,body,opts){opts=opts||{};// verify the required parameter 'businessUnitId' is set
|
|
29448
|
+
if(businessUnitId===undefined||businessUnitId===null||businessUnitId===''){throw'Missing the required parameter "businessUnitId" when calling patchWorkforcemanagementBusinessunitOpportunity';}// verify the required parameter 'opportunityId' is set
|
|
29449
|
+
if(opportunityId===undefined||opportunityId===null||opportunityId===''){throw'Missing the required parameter "opportunityId" when calling patchWorkforcemanagementBusinessunitOpportunity';}// verify the required parameter 'body' is set
|
|
29450
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling patchWorkforcemanagementBusinessunitOpportunity';}return this.apiClient.callApi('/api/v2/workforcemanagement/businessunits/{businessUnitId}/opportunities/{opportunityId}','PATCH',{'businessUnitId':businessUnitId,'opportunityId':opportunityId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
29388
29451
|
* Updates the planning group
|
|
29389
|
-
*
|
|
29452
|
+
* If the request body contains queue references in route paths, routing:queue:view is required in each referenced queues division.
|
|
29390
29453
|
* @param {String} businessUnitId The ID of the business unit.
|
|
29391
29454
|
* @param {String} planningGroupId The ID of a planning group to update
|
|
29392
29455
|
* @param {Object} body body
|
|
@@ -29571,13 +29634,14 @@ if(userId===undefined||userId===null||userId===''){throw'Missing the required pa
|
|
|
29571
29634
|
if(timeOffRequestId===undefined||timeOffRequestId===null||timeOffRequestId===''){throw'Missing the required parameter "timeOffRequestId" when calling patchWorkforcemanagementManagementunitUserTimeoffrequest';}// verify the required parameter 'body' is set
|
|
29572
29635
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling patchWorkforcemanagementManagementunitUserTimeoffrequest';}return this.apiClient.callApi('/api/v2/workforcemanagement/managementunits/{managementUnitId}/users/{userId}/timeoffrequests/{timeOffRequestId}','PATCH',{'managementUnitId':managementUnitId,'userId':userId,'timeOffRequestId':timeOffRequestId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
29573
29636
|
* Updates a shift trade. This route can only be called by the initiating agent
|
|
29574
|
-
*
|
|
29637
|
+
* Deprecated. Use new route instead (/shifttrading/trades/{tradeId}/jobs)
|
|
29575
29638
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
29576
29639
|
* @param {String} weekDateId The start week date of the initiating shift in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
29577
29640
|
* @param {String} tradeId The ID of the shift trade to update
|
|
29578
29641
|
* @param {Object} body body
|
|
29579
29642
|
* @param {Object} opts Optional parameters
|
|
29580
29643
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
29644
|
+
* @deprecated
|
|
29581
29645
|
*/},{key:"patchWorkforcemanagementManagementunitWeekShifttrade",value:function patchWorkforcemanagementManagementunitWeekShifttrade(managementUnitId,weekDateId,tradeId,body,opts){opts=opts||{};// verify the required parameter 'managementUnitId' is set
|
|
29582
29646
|
if(managementUnitId===undefined||managementUnitId===null||managementUnitId===''){throw'Missing the required parameter "managementUnitId" when calling patchWorkforcemanagementManagementunitWeekShifttrade';}// verify the required parameter 'weekDateId' is set
|
|
29583
29647
|
if(weekDateId===undefined||weekDateId===null){throw'Missing the required parameter "weekDateId" when calling patchWorkforcemanagementManagementunitWeekShifttrade';}// verify the required parameter 'tradeId' is set
|
|
@@ -29663,13 +29727,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
29663
29727
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
29664
29728
|
*/},{key:"postWorkforcemanagementAdherenceExplanationsQuery",value:function postWorkforcemanagementAdherenceExplanationsQuery(body,opts){opts=opts||{};// verify the required parameter 'body' is set
|
|
29665
29729
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postWorkforcemanagementAdherenceExplanationsQuery';}return this.apiClient.callApi('/api/v2/workforcemanagement/adherence/explanations/query','POST',{},{'forceAsync':opts['forceAsync'],'forceDownloadService':opts['forceDownloadService']},{},{},body,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
29666
|
-
* Deprecated. Use bulk routes instead (/adherence/historical/bulk)
|
|
29667
|
-
*
|
|
29668
|
-
* @param {Object} opts Optional parameters
|
|
29669
|
-
* @param {Object} opts.body body
|
|
29670
|
-
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
29671
|
-
* @deprecated
|
|
29672
|
-
*/},{key:"postWorkforcemanagementAdherenceHistorical",value:function postWorkforcemanagementAdherenceHistorical(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/workforcemanagement/adherence/historical','POST',{},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
29673
29730
|
* Request a historical adherence report in bulk
|
|
29674
29731
|
*
|
|
29675
29732
|
* @param {Object} body body
|
|
@@ -29734,6 +29791,29 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
29734
29791
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
29735
29792
|
*/},{key:"postWorkforcemanagementAgentsMePossibleworkshifts",value:function postWorkforcemanagementAgentsMePossibleworkshifts(body,opts){opts=opts||{};// verify the required parameter 'body' is set
|
|
29736
29793
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postWorkforcemanagementAgentsMePossibleworkshifts';}return this.apiClient.callApi('/api/v2/workforcemanagement/agents/me/possibleworkshifts','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
29794
|
+
* Bulk add enrollments to opportunities for the authenticated agent
|
|
29795
|
+
* Allows an agent to enroll in opportunities. This endpoint can return partial success.
|
|
29796
|
+
* @param {Object} body body
|
|
29797
|
+
* @param {Object} opts Optional parameters
|
|
29798
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
29799
|
+
*/},{key:"postWorkforcemanagementAgentsOpportunitiesEnrollmentsBulkAdd",value:function postWorkforcemanagementAgentsOpportunitiesEnrollmentsBulkAdd(body,opts){opts=opts||{};// verify the required parameter 'body' is set
|
|
29800
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postWorkforcemanagementAgentsOpportunitiesEnrollmentsBulkAdd';}return this.apiClient.callApi('/api/v2/workforcemanagement/agents/opportunities/enrollments/bulk/add','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
29801
|
+
* Bulk update enrollment status for the authenticated agent
|
|
29802
|
+
* Allows an agent to update the status of their enrollments (e.g. withdraw). Returns partial success if some enrollments cannot be updated.
|
|
29803
|
+
* @param {Object} body body
|
|
29804
|
+
* @param {Object} opts Optional parameters
|
|
29805
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
29806
|
+
*/},{key:"postWorkforcemanagementAgentsOpportunitiesEnrollmentsBulkStatusesUpdate",value:function postWorkforcemanagementAgentsOpportunitiesEnrollmentsBulkStatusesUpdate(body,opts){opts=opts||{};// verify the required parameter 'body' is set
|
|
29807
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postWorkforcemanagementAgentsOpportunitiesEnrollmentsBulkStatusesUpdate';}return this.apiClient.callApi('/api/v2/workforcemanagement/agents/opportunities/enrollments/bulk/statuses/update','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
29808
|
+
* Query opportunities for the authenticated agent
|
|
29809
|
+
* Queries within the specified date range. Each opportunity includes the agents enrollment details if they have enrolled.
|
|
29810
|
+
* @param {Object} body body
|
|
29811
|
+
* @param {Object} opts Optional parameters
|
|
29812
|
+
* @param {Object} opts.expand List of resources to expand
|
|
29813
|
+
* @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
|
|
29814
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
29815
|
+
*/},{key:"postWorkforcemanagementAgentsOpportunitiesQuery",value:function postWorkforcemanagementAgentsOpportunitiesQuery(body,opts){opts=opts||{};// verify the required parameter 'body' is set
|
|
29816
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postWorkforcemanagementAgentsOpportunitiesQuery';}return this.apiClient.callApi('/api/v2/workforcemanagement/agents/opportunities/query','POST',{},{'expand':opts['expand'],'forceDownloadService':opts['forceDownloadService']},{},{},body,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
29737
29817
|
* Fetch agent schedules for the logged in user's management unit
|
|
29738
29818
|
*
|
|
29739
29819
|
* @param {Object} body body
|
|
@@ -29911,8 +29991,83 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
29911
29991
|
*/},{key:"postWorkforcemanagementBusinessunitIntraday",value:function postWorkforcemanagementBusinessunitIntraday(businessUnitId,body,opts){opts=opts||{};// verify the required parameter 'businessUnitId' is set
|
|
29912
29992
|
if(businessUnitId===undefined||businessUnitId===null||businessUnitId===''){throw'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitIntraday';}// verify the required parameter 'body' is set
|
|
29913
29993
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitIntraday';}return this.apiClient.callApi('/api/v2/workforcemanagement/businessunits/{businessUnitId}/intraday','POST',{'businessUnitId':businessUnitId},{'forceAsync':opts['forceAsync']},{},{},body,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
29914
|
-
*
|
|
29994
|
+
* Bulk add opportunities
|
|
29995
|
+
*
|
|
29996
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
29997
|
+
* @param {Object} body body
|
|
29998
|
+
* @param {Object} opts Optional parameters
|
|
29999
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
30000
|
+
*/},{key:"postWorkforcemanagementBusinessunitOpportunitiesBulkAdd",value:function postWorkforcemanagementBusinessunitOpportunitiesBulkAdd(businessUnitId,body,opts){opts=opts||{};// verify the required parameter 'businessUnitId' is set
|
|
30001
|
+
if(businessUnitId===undefined||businessUnitId===null||businessUnitId===''){throw'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitOpportunitiesBulkAdd';}// verify the required parameter 'body' is set
|
|
30002
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitOpportunitiesBulkAdd';}return this.apiClient.callApi('/api/v2/workforcemanagement/businessunits/{businessUnitId}/opportunities/bulk/add','POST',{'businessUnitId':businessUnitId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
30003
|
+
* Bulk publish opportunities
|
|
30004
|
+
* Published opportunities become available for agent enrollment when they open. Returns partial success if some opportunities cannot be published.
|
|
30005
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
30006
|
+
* @param {Object} body body
|
|
30007
|
+
* @param {Object} opts Optional parameters
|
|
30008
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
30009
|
+
*/},{key:"postWorkforcemanagementBusinessunitOpportunitiesBulkPublish",value:function postWorkforcemanagementBusinessunitOpportunitiesBulkPublish(businessUnitId,body,opts){opts=opts||{};// verify the required parameter 'businessUnitId' is set
|
|
30010
|
+
if(businessUnitId===undefined||businessUnitId===null||businessUnitId===''){throw'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitOpportunitiesBulkPublish';}// verify the required parameter 'body' is set
|
|
30011
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitOpportunitiesBulkPublish';}return this.apiClient.callApi('/api/v2/workforcemanagement/businessunits/{businessUnitId}/opportunities/bulk/publish','POST',{'businessUnitId':businessUnitId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
30012
|
+
* Bulk remove opportunities
|
|
30013
|
+
* This operation is permanent and cannot be undone. Returns partial success if some opportunities cannot be removed.
|
|
30014
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
30015
|
+
* @param {Object} body body
|
|
30016
|
+
* @param {Object} opts Optional parameters
|
|
30017
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
30018
|
+
*/},{key:"postWorkforcemanagementBusinessunitOpportunitiesBulkRemove",value:function postWorkforcemanagementBusinessunitOpportunitiesBulkRemove(businessUnitId,body,opts){opts=opts||{};// verify the required parameter 'businessUnitId' is set
|
|
30019
|
+
if(businessUnitId===undefined||businessUnitId===null||businessUnitId===''){throw'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitOpportunitiesBulkRemove';}// verify the required parameter 'body' is set
|
|
30020
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitOpportunitiesBulkRemove';}return this.apiClient.callApi('/api/v2/workforcemanagement/businessunits/{businessUnitId}/opportunities/bulk/remove','POST',{'businessUnitId':businessUnitId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
30021
|
+
* Bulk update opportunities status
|
|
30022
|
+
* If status is Closed, pending enrollments are automatically denied; approved enrollments remain in schedules. Returns partial success if some opportunities cannot be updated.
|
|
30023
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
30024
|
+
* @param {Object} body body
|
|
30025
|
+
* @param {Object} opts Optional parameters
|
|
30026
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
30027
|
+
*/},{key:"postWorkforcemanagementBusinessunitOpportunitiesBulkStatusesUpdate",value:function postWorkforcemanagementBusinessunitOpportunitiesBulkStatusesUpdate(businessUnitId,body,opts){opts=opts||{};// verify the required parameter 'businessUnitId' is set
|
|
30028
|
+
if(businessUnitId===undefined||businessUnitId===null||businessUnitId===''){throw'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitOpportunitiesBulkStatusesUpdate';}// verify the required parameter 'body' is set
|
|
30029
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitOpportunitiesBulkStatusesUpdate';}return this.apiClient.callApi('/api/v2/workforcemanagement/businessunits/{businessUnitId}/opportunities/bulk/statuses/update','POST',{'businessUnitId':businessUnitId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
30030
|
+
* Bulk update enrollment status
|
|
30031
|
+
* Updates the status of enrollments (approve/deny). Returns partial success if some enrollments cannot be updated.
|
|
30032
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
30033
|
+
* @param {Object} body body
|
|
30034
|
+
* @param {Object} opts Optional parameters
|
|
30035
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
30036
|
+
*/},{key:"postWorkforcemanagementBusinessunitOpportunitiesEnrollmentsBulkStatusesUpdate",value:function postWorkforcemanagementBusinessunitOpportunitiesEnrollmentsBulkStatusesUpdate(businessUnitId,body,opts){opts=opts||{};// verify the required parameter 'businessUnitId' is set
|
|
30037
|
+
if(businessUnitId===undefined||businessUnitId===null||businessUnitId===''){throw'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitOpportunitiesEnrollmentsBulkStatusesUpdate';}// verify the required parameter 'body' is set
|
|
30038
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitOpportunitiesEnrollmentsBulkStatusesUpdate';}return this.apiClient.callApi('/api/v2/workforcemanagement/businessunits/{businessUnitId}/opportunities/enrollments/bulk/statuses/update','POST',{'businessUnitId':businessUnitId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
30039
|
+
* Query enrollments
|
|
30040
|
+
* For more information about opportunities, use the expand parameter.
|
|
30041
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
30042
|
+
* @param {Object} body body
|
|
30043
|
+
* @param {Object} opts Optional parameters
|
|
30044
|
+
* @param {Object} opts.expand List of resources to expand
|
|
30045
|
+
* @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
|
|
30046
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
30047
|
+
*/},{key:"postWorkforcemanagementBusinessunitOpportunitiesEnrollmentsQuery",value:function postWorkforcemanagementBusinessunitOpportunitiesEnrollmentsQuery(businessUnitId,body,opts){opts=opts||{};// verify the required parameter 'businessUnitId' is set
|
|
30048
|
+
if(businessUnitId===undefined||businessUnitId===null||businessUnitId===''){throw'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitOpportunitiesEnrollmentsQuery';}// verify the required parameter 'body' is set
|
|
30049
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitOpportunitiesEnrollmentsQuery';}return this.apiClient.callApi('/api/v2/workforcemanagement/businessunits/{businessUnitId}/opportunities/enrollments/query','POST',{'businessUnitId':businessUnitId},{'expand':opts['expand'],'forceDownloadService':opts['forceDownloadService']},{},{},body,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
30050
|
+
* Query opportunities by external activity IDs
|
|
29915
30051
|
*
|
|
30052
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
30053
|
+
* @param {Object} body body
|
|
30054
|
+
* @param {Object} opts Optional parameters
|
|
30055
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
30056
|
+
*/},{key:"postWorkforcemanagementBusinessunitOpportunitiesExternalactivitiesQuery",value:function postWorkforcemanagementBusinessunitOpportunitiesExternalactivitiesQuery(businessUnitId,body,opts){opts=opts||{};// verify the required parameter 'businessUnitId' is set
|
|
30057
|
+
if(businessUnitId===undefined||businessUnitId===null||businessUnitId===''){throw'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitOpportunitiesExternalactivitiesQuery';}// verify the required parameter 'body' is set
|
|
30058
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitOpportunitiesExternalactivitiesQuery';}return this.apiClient.callApi('/api/v2/workforcemanagement/businessunits/{businessUnitId}/opportunities/externalactivities/query','POST',{'businessUnitId':businessUnitId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
30059
|
+
* Query opportunities within the specified date range
|
|
30060
|
+
*
|
|
30061
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
30062
|
+
* @param {Object} body body
|
|
30063
|
+
* @param {Object} opts Optional parameters
|
|
30064
|
+
* @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
|
|
30065
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
30066
|
+
*/},{key:"postWorkforcemanagementBusinessunitOpportunitiesQuery",value:function postWorkforcemanagementBusinessunitOpportunitiesQuery(businessUnitId,body,opts){opts=opts||{};// verify the required parameter 'businessUnitId' is set
|
|
30067
|
+
if(businessUnitId===undefined||businessUnitId===null||businessUnitId===''){throw'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitOpportunitiesQuery';}// verify the required parameter 'body' is set
|
|
30068
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitOpportunitiesQuery';}return this.apiClient.callApi('/api/v2/workforcemanagement/businessunits/{businessUnitId}/opportunities/query','POST',{'businessUnitId':businessUnitId},{'forceDownloadService':opts['forceDownloadService']},{},{},body,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
30069
|
+
* Adds a new planning group
|
|
30070
|
+
* If the request body contains queue references in route paths, routing:queue:view is required in each referenced queues division.
|
|
29916
30071
|
* @param {String} businessUnitId The ID of the business unit.
|
|
29917
30072
|
* @param {Object} body body
|
|
29918
30073
|
* @param {Object} opts Optional parameters
|
|
@@ -30463,49 +30618,53 @@ if(managementUnitId===undefined||managementUnitId===null||managementUnitId==='')
|
|
|
30463
30618
|
if(userId===undefined||userId===null||userId===''){throw'Missing the required parameter "userId" when calling postWorkforcemanagementManagementunitUserTimeoffrequestsEstimate';}// verify the required parameter 'body' is set
|
|
30464
30619
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postWorkforcemanagementManagementunitUserTimeoffrequestsEstimate';}return this.apiClient.callApi('/api/v2/workforcemanagement/managementunits/{managementUnitId}/users/{userId}/timeoffrequests/estimate','POST',{'managementUnitId':managementUnitId,'userId':userId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
30465
30620
|
* Matches a shift trade. This route can only be called by the receiving agent
|
|
30466
|
-
*
|
|
30621
|
+
* Deprecated. Use new route instead (/shifttrading/trades/{tradeId}/match/jobs)
|
|
30467
30622
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
30468
30623
|
* @param {String} weekDateId The start week date of the initiating shift in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
30469
30624
|
* @param {String} tradeId The ID of the shift trade to update
|
|
30470
30625
|
* @param {Object} body body
|
|
30471
30626
|
* @param {Object} opts Optional parameters
|
|
30472
30627
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
30628
|
+
* @deprecated
|
|
30473
30629
|
*/},{key:"postWorkforcemanagementManagementunitWeekShifttradeMatch",value:function postWorkforcemanagementManagementunitWeekShifttradeMatch(managementUnitId,weekDateId,tradeId,body,opts){opts=opts||{};// verify the required parameter 'managementUnitId' is set
|
|
30474
30630
|
if(managementUnitId===undefined||managementUnitId===null||managementUnitId===''){throw'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitWeekShifttradeMatch';}// verify the required parameter 'weekDateId' is set
|
|
30475
30631
|
if(weekDateId===undefined||weekDateId===null){throw'Missing the required parameter "weekDateId" when calling postWorkforcemanagementManagementunitWeekShifttradeMatch';}// verify the required parameter 'tradeId' is set
|
|
30476
30632
|
if(tradeId===undefined||tradeId===null||tradeId===''){throw'Missing the required parameter "tradeId" when calling postWorkforcemanagementManagementunitWeekShifttradeMatch';}// verify the required parameter 'body' is set
|
|
30477
30633
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postWorkforcemanagementManagementunitWeekShifttradeMatch';}return this.apiClient.callApi('/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shifttrades/{tradeId}/match','POST',{'managementUnitId':managementUnitId,'weekDateId':weekDateId,'tradeId':tradeId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
30478
30634
|
* Adds a shift trade
|
|
30479
|
-
*
|
|
30635
|
+
* Deprecated. Use new route instead (/shifttrading/trades/jobs)
|
|
30480
30636
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
30481
30637
|
* @param {String} weekDateId The start week date of the initiating shift in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
30482
30638
|
* @param {Object} body body
|
|
30483
30639
|
* @param {Object} opts Optional parameters
|
|
30484
30640
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
30641
|
+
* @deprecated
|
|
30485
30642
|
*/},{key:"postWorkforcemanagementManagementunitWeekShifttrades",value:function postWorkforcemanagementManagementunitWeekShifttrades(managementUnitId,weekDateId,body,opts){opts=opts||{};// verify the required parameter 'managementUnitId' is set
|
|
30486
30643
|
if(managementUnitId===undefined||managementUnitId===null||managementUnitId===''){throw'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitWeekShifttrades';}// verify the required parameter 'weekDateId' is set
|
|
30487
30644
|
if(weekDateId===undefined||weekDateId===null){throw'Missing the required parameter "weekDateId" when calling postWorkforcemanagementManagementunitWeekShifttrades';}// verify the required parameter 'body' is set
|
|
30488
30645
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postWorkforcemanagementManagementunitWeekShifttrades';}return this.apiClient.callApi('/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shifttrades','POST',{'managementUnitId':managementUnitId,'weekDateId':weekDateId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
30489
30646
|
* Searches for potential shift trade matches for the current agent
|
|
30490
|
-
*
|
|
30647
|
+
* Deprecated. Use new route instead (/businessunits/{businessUnitId}/shifttrading/unmatched/search/jobs)
|
|
30491
30648
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
30492
30649
|
* @param {String} weekDateId The start week date of the initiating shift in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
30493
30650
|
* @param {Object} body body
|
|
30494
30651
|
* @param {Object} opts Optional parameters
|
|
30495
30652
|
* @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
|
|
30496
30653
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
30654
|
+
* @deprecated
|
|
30497
30655
|
*/},{key:"postWorkforcemanagementManagementunitWeekShifttradesSearch",value:function postWorkforcemanagementManagementunitWeekShifttradesSearch(managementUnitId,weekDateId,body,opts){opts=opts||{};// verify the required parameter 'managementUnitId' is set
|
|
30498
30656
|
if(managementUnitId===undefined||managementUnitId===null||managementUnitId===''){throw'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitWeekShifttradesSearch';}// verify the required parameter 'weekDateId' is set
|
|
30499
30657
|
if(weekDateId===undefined||weekDateId===null){throw'Missing the required parameter "weekDateId" when calling postWorkforcemanagementManagementunitWeekShifttradesSearch';}// verify the required parameter 'body' is set
|
|
30500
30658
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postWorkforcemanagementManagementunitWeekShifttradesSearch';}return this.apiClient.callApi('/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shifttrades/search','POST',{'managementUnitId':managementUnitId,'weekDateId':weekDateId},{'forceDownloadService':opts['forceDownloadService']},{},{},body,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
30501
30659
|
* Updates the state of a batch of shift trades
|
|
30502
|
-
* Admin functionality is not supported with "mine".
|
|
30660
|
+
* Admin functionality is not supported with "mine". Deprecated. Use new route instead (/businessunits/{buId}/shifttrading/trades/state/bulk/jobs)
|
|
30503
30661
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
30504
30662
|
* @param {String} weekDateId The start week date of the initiating shift in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
30505
30663
|
* @param {Object} body body
|
|
30506
30664
|
* @param {Object} opts Optional parameters
|
|
30507
30665
|
* @param {Boolean} opts.forceAsync Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes
|
|
30508
30666
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
30667
|
+
* @deprecated
|
|
30509
30668
|
*/},{key:"postWorkforcemanagementManagementunitWeekShifttradesStateBulk",value:function postWorkforcemanagementManagementunitWeekShifttradesStateBulk(managementUnitId,weekDateId,body,opts){opts=opts||{};// verify the required parameter 'managementUnitId' is set
|
|
30510
30669
|
if(managementUnitId===undefined||managementUnitId===null||managementUnitId===''){throw'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitWeekShifttradesStateBulk';}// verify the required parameter 'weekDateId' is set
|
|
30511
30670
|
if(weekDateId===undefined||weekDateId===null){throw'Missing the required parameter "weekDateId" when calling postWorkforcemanagementManagementunitWeekShifttradesStateBulk';}// verify the required parameter 'body' is set
|
|
@@ -30757,7 +30916,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
30757
30916
|
* </pre>
|
|
30758
30917
|
* </p>
|
|
30759
30918
|
* @module purecloud-platform-client-v2/index
|
|
30760
|
-
* @version
|
|
30919
|
+
* @version 253.0.0
|
|
30761
30920
|
*/var platformClient=/*#__PURE__*/_createClass(function platformClient(){_classCallCheck(this,platformClient);/**
|
|
30762
30921
|
* The ApiClient constructor.
|
|
30763
30922
|
* @property {module:purecloud-platform-client-v2/ApiClient}
|