purecloud-platform-client-v2 196.0.0 → 198.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 +2 -2
- package/dist/node/purecloud-platform-client-v2.js +972 -148
- package/dist/web-amd/purecloud-platform-client-v2.js +972 -148
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +323 -110
- package/dist/web-cjs/purecloud-platform-client-v2.js +327 -111
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +791 -121
- package/package.json +1 -1
- package/src/purecloud-platform-client-v2/ApiClient.js +1 -1
- package/src/purecloud-platform-client-v2/api/AgentUIApi.js +136 -0
- package/src/purecloud-platform-client-v2/api/AlertingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ArchitectApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AuditApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/BillingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/CarrierServicesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ChatApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/CoachingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ContentManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ConversationsApi.js +165 -1
- package/src/purecloud-platform-client-v2/api/DataExtensionsApi.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 +156 -0
- package/src/purecloud-platform-client-v2/api/EventsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +9 -5
- package/src/purecloud-platform-client-v2/api/FaxApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/FlowsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GamificationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GeolocationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GreetingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GroupsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/IdentityProviderApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/InfrastructureAsCodeApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/JourneyApi.js +32 -3
- package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LanguagesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LearningApi.js +3 -2
- 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 +32 -36
- 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 +32 -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 +3 -2
- package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ScreenRecordingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ScriptsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SearchApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SettingsApi.js +111 -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 +3 -2
- package/src/purecloud-platform-client-v2/api/TeamsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TelephonyApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TextbotsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TokensApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UploadsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsageApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsersApi.js +3 -3
- 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 +222 -27
- package/src/purecloud-platform-client-v2/index.js +13 -1
|
@@ -4171,6 +4171,7 @@ var parseValues = function parseQueryStringValues(str, options) {
|
|
|
4171
4171
|
var obj = { __proto__: null };
|
|
4172
4172
|
|
|
4173
4173
|
var cleanStr = options.ignoreQueryPrefix ? str.replace(/^\?/, '') : str;
|
|
4174
|
+
cleanStr = cleanStr.replace(/%5B/gi, '[').replace(/%5D/gi, ']');
|
|
4174
4175
|
var limit = options.parameterLimit === Infinity ? undefined : options.parameterLimit;
|
|
4175
4176
|
var parts = cleanStr.split(options.delimiter, limit);
|
|
4176
4177
|
var skipIndex = -1; // Keep track of where the utf8 sentinel was found
|
|
@@ -4241,7 +4242,9 @@ var parseObject = function (chain, val, options, valuesParsed) {
|
|
|
4241
4242
|
var root = chain[i];
|
|
4242
4243
|
|
|
4243
4244
|
if (root === '[]' && options.parseArrays) {
|
|
4244
|
-
obj = options.allowEmptyArrays && leaf === ''
|
|
4245
|
+
obj = options.allowEmptyArrays && (leaf === '' || (options.strictNullHandling && leaf === null))
|
|
4246
|
+
? []
|
|
4247
|
+
: [].concat(leaf);
|
|
4245
4248
|
} else {
|
|
4246
4249
|
obj = options.plainObjects ? Object.create(null) : {};
|
|
4247
4250
|
var cleanRoot = root.charAt(0) === '[' && root.charAt(root.length - 1) === ']' ? root.slice(1, -1) : root;
|
|
@@ -6057,7 +6060,7 @@ if(env)this.environment=env;else this.environment=this.host?this.host:'mypureclo
|
|
|
6057
6060
|
this.environment=this.environment.replace(/\/+$/,'');// Strip protocol and subdomain
|
|
6058
6061
|
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:"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];}}}]);}();/**
|
|
6059
6062
|
* @module purecloud-platform-client-v2/ApiClient
|
|
6060
|
-
* @version
|
|
6063
|
+
* @version 198.0.0
|
|
6061
6064
|
*/var ApiClient=/*#__PURE__*/function(){/**
|
|
6062
6065
|
* Manages low level client-server communications, parameter marshalling, etc. There should not be any need for an
|
|
6063
6066
|
* application to use this class directly - the *Api and model classes provide the public API for the service. The
|
|
@@ -6366,10 +6369,44 @@ var formData=new FormData();formData.set(key,_formParams[key]);request.data=form
|
|
|
6366
6369
|
var data=that.returnExtended===true?{status:response.status,statusText:response.statusText,headers:response.headers,body:response.data,text:response.text,error:null}:response.data?response.data:response.text;// Debug logging
|
|
6367
6370
|
that.config.logger.log('trace',response.status,httpMethod,url,request.headers,response.headers,bodyParam,undefined);that.config.logger.log('debug',response.status,httpMethod,url,request.headers,undefined,bodyParam,undefined);// Resolve promise
|
|
6368
6371
|
resolve(data);})["catch"](function(error){var data=error;if(error.response&&error.response.status==401&&that.config.refresh_access_token&&that.authData.refreshToken!==""){that._handleExpiredAccessToken().then(function(){sendRequest(that);})["catch"](function(err){reject(err);});}else if(error.response){// Log error
|
|
6369
|
-
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
|
|
6372
|
+
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 AgentUIApi=/*#__PURE__*/function(){/**
|
|
6373
|
+
* AgentUI service.
|
|
6374
|
+
* @module purecloud-platform-client-v2/api/AgentUIApi
|
|
6375
|
+
* @version 198.0.0
|
|
6376
|
+
*/ /**
|
|
6377
|
+
* Constructs a new AgentUIApi.
|
|
6378
|
+
* @alias module:purecloud-platform-client-v2/api/AgentUIApi
|
|
6379
|
+
* @class
|
|
6380
|
+
* @param {module:purecloud-platform-client-v2/ApiClient} apiClient Optional API client implementation to use,
|
|
6381
|
+
* default to {@link module:purecloud-platform-client-v2/ApiClient#instance} if unspecified.
|
|
6382
|
+
*/function AgentUIApi(apiClient){_classCallCheck(this,AgentUIApi);this.apiClient=apiClient||ApiClient.instance;}/**
|
|
6383
|
+
* Delete agent auto answer settings
|
|
6384
|
+
*
|
|
6385
|
+
* @param {String} agentId The agent to apply the auto answer settings to
|
|
6386
|
+
*/return _createClass(AgentUIApi,[{key:"deleteUsersAgentuiAgentsAutoanswerAgentIdSettings",value:function deleteUsersAgentuiAgentsAutoanswerAgentIdSettings(agentId){// verify the required parameter 'agentId' is set
|
|
6387
|
+
if(agentId===undefined||agentId===null){throw'Missing the required parameter "agentId" when calling deleteUsersAgentuiAgentsAutoanswerAgentIdSettings';}return this.apiClient.callApi('/api/v2/users/agentui/agents/autoanswer/{agentId}/settings','DELETE',{'agentId':agentId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
6388
|
+
* Get agent auto answer settings
|
|
6389
|
+
*
|
|
6390
|
+
* @param {String} agentId The agent to apply the auto answer settings to
|
|
6391
|
+
*/},{key:"getUsersAgentuiAgentsAutoanswerAgentIdSettings",value:function getUsersAgentuiAgentsAutoanswerAgentIdSettings(agentId){// verify the required parameter 'agentId' is set
|
|
6392
|
+
if(agentId===undefined||agentId===null){throw'Missing the required parameter "agentId" when calling getUsersAgentuiAgentsAutoanswerAgentIdSettings';}return this.apiClient.callApi('/api/v2/users/agentui/agents/autoanswer/{agentId}/settings','GET',{'agentId':agentId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
6393
|
+
* Update agent auto answer settings
|
|
6394
|
+
*
|
|
6395
|
+
* @param {String} agentId The agent to apply the auto answer settings to
|
|
6396
|
+
* @param {Object} body AutoAnswerSettings
|
|
6397
|
+
*/},{key:"patchUsersAgentuiAgentsAutoanswerAgentIdSettings",value:function patchUsersAgentuiAgentsAutoanswerAgentIdSettings(agentId,body){// verify the required parameter 'agentId' is set
|
|
6398
|
+
if(agentId===undefined||agentId===null){throw'Missing the required parameter "agentId" when calling patchUsersAgentuiAgentsAutoanswerAgentIdSettings';}// verify the required parameter 'body' is set
|
|
6399
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling patchUsersAgentuiAgentsAutoanswerAgentIdSettings';}return this.apiClient.callApi('/api/v2/users/agentui/agents/autoanswer/{agentId}/settings','PATCH',{'agentId':agentId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
6400
|
+
* Set agent auto answer settings
|
|
6401
|
+
*
|
|
6402
|
+
* @param {String} agentId The agent to apply the auto answer settings to
|
|
6403
|
+
* @param {Object} body AutoAnswerSettings
|
|
6404
|
+
*/},{key:"putUsersAgentuiAgentsAutoanswerAgentIdSettings",value:function putUsersAgentuiAgentsAutoanswerAgentIdSettings(agentId,body){// verify the required parameter 'agentId' is set
|
|
6405
|
+
if(agentId===undefined||agentId===null){throw'Missing the required parameter "agentId" when calling putUsersAgentuiAgentsAutoanswerAgentIdSettings';}// verify the required parameter 'body' is set
|
|
6406
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putUsersAgentuiAgentsAutoanswerAgentIdSettings';}return this.apiClient.callApi('/api/v2/users/agentui/agents/autoanswer/{agentId}/settings','PUT',{'agentId':agentId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var AlertingApi=/*#__PURE__*/function(){/**
|
|
6370
6407
|
* Alerting service.
|
|
6371
6408
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
6372
|
-
* @version
|
|
6409
|
+
* @version 198.0.0
|
|
6373
6410
|
*/ /**
|
|
6374
6411
|
* Constructs a new AlertingApi.
|
|
6375
6412
|
* @alias module:purecloud-platform-client-v2/api/AlertingApi
|
|
@@ -6526,7 +6563,7 @@ if(ruleId===undefined||ruleId===null){throw'Missing the required parameter "rule
|
|
|
6526
6563
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putAlertingRule';}return this.apiClient.callApi('/api/v2/alerting/rules/{ruleId}','PUT',{'ruleId':ruleId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var AnalyticsApi=/*#__PURE__*/function(){/**
|
|
6527
6564
|
* Analytics service.
|
|
6528
6565
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
6529
|
-
* @version
|
|
6566
|
+
* @version 198.0.0
|
|
6530
6567
|
*/ /**
|
|
6531
6568
|
* Constructs a new AnalyticsApi.
|
|
6532
6569
|
* @alias module:purecloud-platform-client-v2/api/AnalyticsApi
|
|
@@ -7147,7 +7184,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
7147
7184
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putAnalyticsDataretentionSettings';}return this.apiClient.callApi('/api/v2/analytics/dataretention/settings','PUT',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var ArchitectApi=/*#__PURE__*/function(){/**
|
|
7148
7185
|
* Architect service.
|
|
7149
7186
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
7150
|
-
* @version
|
|
7187
|
+
* @version 198.0.0
|
|
7151
7188
|
*/ /**
|
|
7152
7189
|
* Constructs a new ArchitectApi.
|
|
7153
7190
|
* @alias module:purecloud-platform-client-v2/api/ArchitectApi
|
|
@@ -8263,7 +8300,7 @@ if(milestoneId===undefined||milestoneId===null){throw'Missing the required param
|
|
|
8263
8300
|
if(flowOutcomeId===undefined||flowOutcomeId===null){throw'Missing the required parameter "flowOutcomeId" when calling putFlowsOutcome';}return this.apiClient.callApi('/api/v2/flows/outcomes/{flowOutcomeId}','PUT',{'flowOutcomeId':flowOutcomeId},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var AuditApi=/*#__PURE__*/function(){/**
|
|
8264
8301
|
* Audit service.
|
|
8265
8302
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
8266
|
-
* @version
|
|
8303
|
+
* @version 198.0.0
|
|
8267
8304
|
*/ /**
|
|
8268
8305
|
* Constructs a new AuditApi.
|
|
8269
8306
|
* @alias module:purecloud-platform-client-v2/api/AuditApi
|
|
@@ -8312,7 +8349,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
8312
8349
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postAuditsQueryRealtimeRelated';}return this.apiClient.callApi('/api/v2/audits/query/realtime/related','POST',{},{'expand':this.apiClient.buildCollectionParam(opts['expand'],'multi')},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var AuthorizationApi=/*#__PURE__*/function(){/**
|
|
8313
8350
|
* Authorization service.
|
|
8314
8351
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
8315
|
-
* @version
|
|
8352
|
+
* @version 198.0.0
|
|
8316
8353
|
*/ /**
|
|
8317
8354
|
* Constructs a new AuthorizationApi.
|
|
8318
8355
|
* @alias module:purecloud-platform-client-v2/api/AuthorizationApi
|
|
@@ -8627,7 +8664,7 @@ if(subjectId===undefined||subjectId===null){throw'Missing the required parameter
|
|
|
8627
8664
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putUserRoles';}return this.apiClient.callApi('/api/v2/users/{subjectId}/roles','PUT',{'subjectId':subjectId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var BillingApi=/*#__PURE__*/function(){/**
|
|
8628
8665
|
* Billing service.
|
|
8629
8666
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
8630
|
-
* @version
|
|
8667
|
+
* @version 198.0.0
|
|
8631
8668
|
*/ /**
|
|
8632
8669
|
* Constructs a new BillingApi.
|
|
8633
8670
|
* @alias module:purecloud-platform-client-v2/api/BillingApi
|
|
@@ -8651,7 +8688,7 @@ if(endDate===undefined||endDate===null){throw'Missing the required parameter "en
|
|
|
8651
8688
|
if(trustorOrgId===undefined||trustorOrgId===null){throw'Missing the required parameter "trustorOrgId" when calling getBillingTrusteebillingoverviewTrustorOrgId';}return this.apiClient.callApi('/api/v2/billing/trusteebillingoverview/{trustorOrgId}','GET',{'trustorOrgId':trustorOrgId},{'billingPeriodIndex':opts['billingPeriodIndex']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var CarrierServicesApi=/*#__PURE__*/function(){/**
|
|
8652
8689
|
* CarrierServices service.
|
|
8653
8690
|
* @module purecloud-platform-client-v2/api/CarrierServicesApi
|
|
8654
|
-
* @version
|
|
8691
|
+
* @version 198.0.0
|
|
8655
8692
|
*/ /**
|
|
8656
8693
|
* Constructs a new CarrierServicesApi.
|
|
8657
8694
|
* @alias module:purecloud-platform-client-v2/api/CarrierServicesApi
|
|
@@ -8671,7 +8708,7 @@ if(phoneNumber===undefined||phoneNumber===null){throw'Missing the required param
|
|
|
8671
8708
|
*/},{key:"postCarrierservicesIntegrationsEmergencylocationsMe",value:function postCarrierservicesIntegrationsEmergencylocationsMe(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/carrierservices/integrations/emergencylocations/me','POST',{},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var ChatApi=/*#__PURE__*/function(){/**
|
|
8672
8709
|
* Chat service.
|
|
8673
8710
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
8674
|
-
* @version
|
|
8711
|
+
* @version 198.0.0
|
|
8675
8712
|
*/ /**
|
|
8676
8713
|
* Constructs a new ChatApi.
|
|
8677
8714
|
* @alias module:purecloud-platform-client-v2/api/ChatApi
|
|
@@ -8896,7 +8933,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
8896
8933
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putChatsSettings';}return this.apiClient.callApi('/api/v2/chats/settings','PUT',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var CoachingApi=/*#__PURE__*/function(){/**
|
|
8897
8934
|
* Coaching service.
|
|
8898
8935
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
8899
|
-
* @version
|
|
8936
|
+
* @version 198.0.0
|
|
8900
8937
|
*/ /**
|
|
8901
8938
|
* Constructs a new CoachingApi.
|
|
8902
8939
|
* @alias module:purecloud-platform-client-v2/api/CoachingApi
|
|
@@ -9049,7 +9086,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
9049
9086
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postCoachingScheduleslotsQuery';}return this.apiClient.callApi('/api/v2/coaching/scheduleslots/query','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var ContentManagementApi=/*#__PURE__*/function(){/**
|
|
9050
9087
|
* ContentManagement service.
|
|
9051
9088
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
9052
|
-
* @version
|
|
9089
|
+
* @version 198.0.0
|
|
9053
9090
|
*/ /**
|
|
9054
9091
|
* Constructs a new ContentManagementApi.
|
|
9055
9092
|
* @alias module:purecloud-platform-client-v2/api/ContentManagementApi
|
|
@@ -9332,7 +9369,7 @@ if(tagId===undefined||tagId===null){throw'Missing the required parameter "tagId"
|
|
|
9332
9369
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putContentmanagementWorkspaceTagvalue';}return this.apiClient.callApi('/api/v2/contentmanagement/workspaces/{workspaceId}/tagvalues/{tagId}','PUT',{'workspaceId':workspaceId,'tagId':tagId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var ConversationsApi=/*#__PURE__*/function(){/**
|
|
9333
9370
|
* Conversations service.
|
|
9334
9371
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
9335
|
-
* @version
|
|
9372
|
+
* @version 198.0.0
|
|
9336
9373
|
*/ /**
|
|
9337
9374
|
* Constructs a new ConversationsApi.
|
|
9338
9375
|
* @alias module:purecloud-platform-client-v2/api/ConversationsApi
|
|
@@ -9495,6 +9532,24 @@ if(participantId===undefined||participantId===null){throw'Missing the required p
|
|
|
9495
9532
|
* @param {String} conversationId conversation ID
|
|
9496
9533
|
*/},{key:"getConversationSecureattributes",value:function getConversationSecureattributes(conversationId){// verify the required parameter 'conversationId' is set
|
|
9497
9534
|
if(conversationId===undefined||conversationId===null){throw'Missing the required parameter "conversationId" when calling getConversationSecureattributes';}return this.apiClient.callApi('/api/v2/conversations/{conversationId}/secureattributes','GET',{'conversationId':conversationId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
9535
|
+
* Get Suggestion.
|
|
9536
|
+
*
|
|
9537
|
+
* @param {String} conversationId Conversation ID
|
|
9538
|
+
* @param {String} suggestionId Suggestion ID
|
|
9539
|
+
*/},{key:"getConversationSuggestion",value:function getConversationSuggestion(conversationId,suggestionId){// verify the required parameter 'conversationId' is set
|
|
9540
|
+
if(conversationId===undefined||conversationId===null){throw'Missing the required parameter "conversationId" when calling getConversationSuggestion';}// verify the required parameter 'suggestionId' is set
|
|
9541
|
+
if(suggestionId===undefined||suggestionId===null){throw'Missing the required parameter "suggestionId" when calling getConversationSuggestion';}return this.apiClient.callApi('/api/v2/conversations/{conversationId}/suggestions/{suggestionId}','GET',{'conversationId':conversationId,'suggestionId':suggestionId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
9542
|
+
* Get all suggestions for a conversation.
|
|
9543
|
+
*
|
|
9544
|
+
* @param {String} conversationId Conversation ID
|
|
9545
|
+
* @param {Object} opts Optional parameters
|
|
9546
|
+
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
9547
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
9548
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
9549
|
+
* @param {Object} opts.type Suggestion type to filter by.
|
|
9550
|
+
* @param {Object} opts.state Suggestion state to filter Copilot suggestions.
|
|
9551
|
+
*/},{key:"getConversationSuggestions",value:function getConversationSuggestions(conversationId,opts){opts=opts||{};// verify the required parameter 'conversationId' is set
|
|
9552
|
+
if(conversationId===undefined||conversationId===null){throw'Missing the required parameter "conversationId" when calling getConversationSuggestions';}return this.apiClient.callApi('/api/v2/conversations/{conversationId}/suggestions','GET',{'conversationId':conversationId},{'before':opts['before'],'after':opts['after'],'pageSize':opts['pageSize'],'type':opts['type'],'state':opts['state']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
9498
9553
|
* Get active conversations for the logged in user
|
|
9499
9554
|
*
|
|
9500
9555
|
* @param {Object} opts Optional parameters
|
|
@@ -10218,6 +10273,16 @@ if(conversationId===undefined||conversationId===null){throw'Missing the required
|
|
|
10218
10273
|
if(participantId===undefined||participantId===null){throw'Missing the required parameter "participantId" when calling patchConversationsEmailParticipantCommunication';}// verify the required parameter 'communicationId' is set
|
|
10219
10274
|
if(communicationId===undefined||communicationId===null){throw'Missing the required parameter "communicationId" when calling patchConversationsEmailParticipantCommunication';}// verify the required parameter 'body' is set
|
|
10220
10275
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling patchConversationsEmailParticipantCommunication';}return this.apiClient.callApi('/api/v2/conversations/emails/{conversationId}/participants/{participantId}/communications/{communicationId}','PATCH',{'conversationId':conversationId,'participantId':participantId,'communicationId':communicationId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
10276
|
+
* Update conversation by setting its parking state
|
|
10277
|
+
*
|
|
10278
|
+
* @param {String} conversationId conversationId
|
|
10279
|
+
* @param {String} participantId participantId
|
|
10280
|
+
* @param {Object} body Parking update request
|
|
10281
|
+
* patchConversationsEmailParticipantParkingstate is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
10282
|
+
*/},{key:"patchConversationsEmailParticipantParkingstate",value:function patchConversationsEmailParticipantParkingstate(conversationId,participantId,body){// verify the required parameter 'conversationId' is set
|
|
10283
|
+
if(conversationId===undefined||conversationId===null){throw'Missing the required parameter "conversationId" when calling patchConversationsEmailParticipantParkingstate';}// verify the required parameter 'participantId' is set
|
|
10284
|
+
if(participantId===undefined||participantId===null){throw'Missing the required parameter "participantId" when calling patchConversationsEmailParticipantParkingstate';}// verify the required parameter 'body' is set
|
|
10285
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling patchConversationsEmailParticipantParkingstate';}return this.apiClient.callApi('/api/v2/conversations/emails/{conversationId}/participants/{participantId}/parkingstate','PATCH',{'conversationId':conversationId,'participantId':participantId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
10221
10286
|
* Update a conversation by disconnecting all of the participants
|
|
10222
10287
|
*
|
|
10223
10288
|
* @param {String} conversationId conversationId
|
|
@@ -10430,6 +10495,22 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
10430
10495
|
*/},{key:"postConversationParticipantSecureivrsessions",value:function postConversationParticipantSecureivrsessions(conversationId,participantId,opts){opts=opts||{};// verify the required parameter 'conversationId' is set
|
|
10431
10496
|
if(conversationId===undefined||conversationId===null){throw'Missing the required parameter "conversationId" when calling postConversationParticipantSecureivrsessions';}// verify the required parameter 'participantId' is set
|
|
10432
10497
|
if(participantId===undefined||participantId===null){throw'Missing the required parameter "participantId" when calling postConversationParticipantSecureivrsessions';}return this.apiClient.callApi('/api/v2/conversations/{conversationId}/participants/{participantId}/secureivrsessions','POST',{'conversationId':conversationId,'participantId':participantId},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
10498
|
+
* Save an engagement on the suggestion.
|
|
10499
|
+
*
|
|
10500
|
+
* @param {String} conversationId Conversation ID
|
|
10501
|
+
* @param {String} suggestionId Suggestion ID
|
|
10502
|
+
* @param {Object} body
|
|
10503
|
+
*/},{key:"postConversationSuggestionEngagement",value:function postConversationSuggestionEngagement(conversationId,suggestionId,body){// verify the required parameter 'conversationId' is set
|
|
10504
|
+
if(conversationId===undefined||conversationId===null){throw'Missing the required parameter "conversationId" when calling postConversationSuggestionEngagement';}// verify the required parameter 'suggestionId' is set
|
|
10505
|
+
if(suggestionId===undefined||suggestionId===null){throw'Missing the required parameter "suggestionId" when calling postConversationSuggestionEngagement';}// verify the required parameter 'body' is set
|
|
10506
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postConversationSuggestionEngagement';}return this.apiClient.callApi('/api/v2/conversations/{conversationId}/suggestions/{suggestionId}/engagement','POST',{'conversationId':conversationId,'suggestionId':suggestionId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
10507
|
+
* Suggestion feedback.
|
|
10508
|
+
*
|
|
10509
|
+
* @param {String} conversationId Conversation ID
|
|
10510
|
+
* @param {Object} body SuggestionFeedback
|
|
10511
|
+
*/},{key:"postConversationSuggestionsFeedback",value:function postConversationSuggestionsFeedback(conversationId,body){// verify the required parameter 'conversationId' is set
|
|
10512
|
+
if(conversationId===undefined||conversationId===null){throw'Missing the required parameter "conversationId" when calling postConversationSuggestionsFeedback';}// verify the required parameter 'body' is set
|
|
10513
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postConversationSuggestionsFeedback';}return this.apiClient.callApi('/api/v2/conversations/{conversationId}/suggestions/feedback','POST',{'conversationId':conversationId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
10433
10514
|
* Submit feedback for the summary.
|
|
10434
10515
|
*
|
|
10435
10516
|
* @param {String} conversationId Conversation ID
|
|
@@ -11012,7 +11093,7 @@ if(conversationId===undefined||conversationId===null){throw'Missing the required
|
|
|
11012
11093
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putConversationsVideoRecordingstate';}return this.apiClient.callApi('/api/v2/conversations/videos/{conversationId}/recordingstate','PUT',{'conversationId':conversationId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var DataExtensionsApi=/*#__PURE__*/function(){/**
|
|
11013
11094
|
* DataExtensions service.
|
|
11014
11095
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
11015
|
-
* @version
|
|
11096
|
+
* @version 198.0.0
|
|
11016
11097
|
*/ /**
|
|
11017
11098
|
* Constructs a new DataExtensionsApi.
|
|
11018
11099
|
* @alias module:purecloud-platform-client-v2/api/DataExtensionsApi
|
|
@@ -11033,7 +11114,7 @@ if(coretypeName===undefined||coretypeName===null){throw'Missing the required par
|
|
|
11033
11114
|
*/},{key:"getDataextensionsLimits",value:function getDataextensionsLimits(){return this.apiClient.callApi('/api/v2/dataextensions/limits','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var DownloadsApi=/*#__PURE__*/function(){/**
|
|
11034
11115
|
* Downloads service.
|
|
11035
11116
|
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
11036
|
-
* @version
|
|
11117
|
+
* @version 198.0.0
|
|
11037
11118
|
*/ /**
|
|
11038
11119
|
* Constructs a new DownloadsApi.
|
|
11039
11120
|
* @alias module:purecloud-platform-client-v2/api/DownloadsApi
|
|
@@ -11052,7 +11133,7 @@ if(coretypeName===undefined||coretypeName===null){throw'Missing the required par
|
|
|
11052
11133
|
if(downloadId===undefined||downloadId===null){throw'Missing the required parameter "downloadId" when calling getDownload';}return this.apiClient.callApi('/api/v2/downloads/{downloadId}','GET',{'downloadId':downloadId},{'contentDisposition':opts['contentDisposition'],'issueRedirect':opts['issueRedirect'],'redirectToAuth':opts['redirectToAuth']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var EmailsApi=/*#__PURE__*/function(){/**
|
|
11053
11134
|
* Emails service.
|
|
11054
11135
|
* @module purecloud-platform-client-v2/api/EmailsApi
|
|
11055
|
-
* @version
|
|
11136
|
+
* @version 198.0.0
|
|
11056
11137
|
*/ /**
|
|
11057
11138
|
* Constructs a new EmailsApi.
|
|
11058
11139
|
* @alias module:purecloud-platform-client-v2/api/EmailsApi
|
|
@@ -11067,10 +11148,48 @@ if(downloadId===undefined||downloadId===null){throw'Missing the required paramet
|
|
|
11067
11148
|
*
|
|
11068
11149
|
* @param {Object} opts Optional parameters
|
|
11069
11150
|
* @param {Object} opts.body
|
|
11070
|
-
*/},{key:"patchEmailsSettings",value:function patchEmailsSettings(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/emails/settings','PATCH',{},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var
|
|
11151
|
+
*/},{key:"patchEmailsSettings",value:function patchEmailsSettings(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/emails/settings','PATCH',{},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var EmployeeEngagementApi=/*#__PURE__*/function(){/**
|
|
11152
|
+
* EmployeeEngagement service.
|
|
11153
|
+
* @module purecloud-platform-client-v2/api/EmployeeEngagementApi
|
|
11154
|
+
* @version 198.0.0
|
|
11155
|
+
*/ /**
|
|
11156
|
+
* Constructs a new EmployeeEngagementApi.
|
|
11157
|
+
* @alias module:purecloud-platform-client-v2/api/EmployeeEngagementApi
|
|
11158
|
+
* @class
|
|
11159
|
+
* @param {module:purecloud-platform-client-v2/ApiClient} apiClient Optional API client implementation to use,
|
|
11160
|
+
* default to {@link module:purecloud-platform-client-v2/ApiClient#instance} if unspecified.
|
|
11161
|
+
*/function EmployeeEngagementApi(apiClient){_classCallCheck(this,EmployeeEngagementApi);this.apiClient=apiClient||ApiClient.instance;}/**
|
|
11162
|
+
* Deletes a celebration
|
|
11163
|
+
*
|
|
11164
|
+
* @param {String} celebrationId The ID of the celebration
|
|
11165
|
+
*/return _createClass(EmployeeEngagementApi,[{key:"deleteEmployeeengagementCelebration",value:function deleteEmployeeengagementCelebration(celebrationId){// verify the required parameter 'celebrationId' is set
|
|
11166
|
+
if(celebrationId===undefined||celebrationId===null){throw'Missing the required parameter "celebrationId" when calling deleteEmployeeengagementCelebration';}return this.apiClient.callApi('/api/v2/employeeengagement/celebrations/{celebrationId}','DELETE',{'celebrationId':celebrationId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
11167
|
+
* Get all celebrations
|
|
11168
|
+
*
|
|
11169
|
+
* @param {Object} opts Optional parameters
|
|
11170
|
+
* @param {Number} opts.pageNumber (default to 1)
|
|
11171
|
+
* @param {Number} opts.pageSize (default to 25)
|
|
11172
|
+
*/},{key:"getEmployeeengagementCelebrations",value:function getEmployeeengagementCelebrations(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/employeeengagement/celebrations','GET',{},{'pageNumber':opts['pageNumber'],'pageSize':opts['pageSize']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
11173
|
+
* Gets a single recognition
|
|
11174
|
+
*
|
|
11175
|
+
* @param {String} recognitionId The Recognition ID
|
|
11176
|
+
*/},{key:"getEmployeeengagementRecognition",value:function getEmployeeengagementRecognition(recognitionId){// verify the required parameter 'recognitionId' is set
|
|
11177
|
+
if(recognitionId===undefined||recognitionId===null){throw'Missing the required parameter "recognitionId" when calling getEmployeeengagementRecognition';}return this.apiClient.callApi('/api/v2/employeeengagement/recognitions/{recognitionId}','GET',{'recognitionId':recognitionId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
11178
|
+
* Set a state for a celebration
|
|
11179
|
+
*
|
|
11180
|
+
* @param {String} celebrationId The ID of the celebration
|
|
11181
|
+
* @param {Object} body Patch Celebration state
|
|
11182
|
+
*/},{key:"patchEmployeeengagementCelebration",value:function patchEmployeeengagementCelebration(celebrationId,body){// verify the required parameter 'celebrationId' is set
|
|
11183
|
+
if(celebrationId===undefined||celebrationId===null){throw'Missing the required parameter "celebrationId" when calling patchEmployeeengagementCelebration';}// verify the required parameter 'body' is set
|
|
11184
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling patchEmployeeengagementCelebration';}return this.apiClient.callApi('/api/v2/employeeengagement/celebrations/{celebrationId}','PATCH',{'celebrationId':celebrationId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
11185
|
+
* Creates a recognition
|
|
11186
|
+
*
|
|
11187
|
+
* @param {Object} body Create Recognition
|
|
11188
|
+
*/},{key:"postEmployeeengagementRecognitions",value:function postEmployeeengagementRecognitions(body){// verify the required parameter 'body' is set
|
|
11189
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postEmployeeengagementRecognitions';}return this.apiClient.callApi('/api/v2/employeeengagement/recognitions','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var EventsApi=/*#__PURE__*/function(){/**
|
|
11071
11190
|
* Events service.
|
|
11072
11191
|
* @module purecloud-platform-client-v2/api/EventsApi
|
|
11073
|
-
* @version
|
|
11192
|
+
* @version 198.0.0
|
|
11074
11193
|
*/ /**
|
|
11075
11194
|
* Constructs a new EventsApi.
|
|
11076
11195
|
* @alias module:purecloud-platform-client-v2/api/EventsApi
|
|
@@ -11095,7 +11214,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
11095
11214
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postEventsUsersRoutingstatus';}return this.apiClient.callApi('/api/v2/events/users/routingstatus','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var ExternalContactsApi=/*#__PURE__*/function(){/**
|
|
11096
11215
|
* ExternalContacts service.
|
|
11097
11216
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
11098
|
-
* @version
|
|
11217
|
+
* @version 198.0.0
|
|
11099
11218
|
*/ /**
|
|
11100
11219
|
* Constructs a new ExternalContactsApi.
|
|
11101
11220
|
* @alias module:purecloud-platform-client-v2/api/ExternalContactsApi
|
|
@@ -11146,7 +11265,7 @@ if(relationshipId===undefined||relationshipId===null){throw'Missing the required
|
|
|
11146
11265
|
*
|
|
11147
11266
|
* @param {String} contactId ExternalContact ID
|
|
11148
11267
|
* @param {Object} opts Optional parameters
|
|
11149
|
-
* @param {Array.<String>} opts.expand which fields, if any, to expand (externalOrganization,externalDataSources)
|
|
11268
|
+
* @param {Array.<String>} opts.expand which fields, if any, to expand (externalOrganization,externalDataSources,identifiers)
|
|
11150
11269
|
*/},{key:"getExternalcontactsContact",value:function getExternalcontactsContact(contactId,opts){opts=opts||{};// verify the required parameter 'contactId' is set
|
|
11151
11270
|
if(contactId===undefined||contactId===null){throw'Missing the required parameter "contactId" when calling getExternalcontactsContact';}return this.apiClient.callApi('/api/v2/externalcontacts/contacts/{contactId}','GET',{'contactId':contactId},{'expand':this.apiClient.buildCollectionParam(opts['expand'],'multi')},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
11152
11271
|
* List the identifiers for a contact
|
|
@@ -11186,7 +11305,7 @@ if(contactId===undefined||contactId===null){throw'Missing the required parameter
|
|
|
11186
11305
|
*
|
|
11187
11306
|
* @param {String} contactId ExternalContact ID
|
|
11188
11307
|
* @param {Object} opts Optional parameters
|
|
11189
|
-
* @param {Array.<String>} opts.expand which fields, if any, to expand (externalOrganization,externalDataSources)
|
|
11308
|
+
* @param {Array.<String>} opts.expand which fields, if any, to expand (externalOrganization,externalDataSources,identifiers)
|
|
11190
11309
|
*/},{key:"getExternalcontactsContactUnresolved",value:function getExternalcontactsContactUnresolved(contactId,opts){opts=opts||{};// verify the required parameter 'contactId' is set
|
|
11191
11310
|
if(contactId===undefined||contactId===null){throw'Missing the required parameter "contactId" when calling getExternalcontactsContactUnresolved';}return this.apiClient.callApi('/api/v2/externalcontacts/contacts/{contactId}/unresolved','GET',{'contactId':contactId},{'expand':this.apiClient.buildCollectionParam(opts['expand'],'multi')},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
11192
11311
|
* Search for external contacts
|
|
@@ -11452,8 +11571,10 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
11452
11571
|
* Fetch a contact using an identifier type and value.
|
|
11453
11572
|
* Phone number identifier values must be provided with the country code and a leading + symbol. Example: "+1 704 298 4733"
|
|
11454
11573
|
* @param {Object} identifier
|
|
11455
|
-
|
|
11456
|
-
|
|
11574
|
+
* @param {Object} opts Optional parameters
|
|
11575
|
+
* @param {Array.<String>} opts.expand which field, if any, to expand
|
|
11576
|
+
*/},{key:"postExternalcontactsIdentifierlookup",value:function postExternalcontactsIdentifierlookup(identifier,opts){opts=opts||{};// verify the required parameter 'identifier' is set
|
|
11577
|
+
if(identifier===undefined||identifier===null){throw'Missing the required parameter "identifier" when calling postExternalcontactsIdentifierlookup';}return this.apiClient.callApi('/api/v2/externalcontacts/identifierlookup','POST',{},{'expand':this.apiClient.buildCollectionParam(opts['expand'],'multi')},{},{},identifier,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
11457
11578
|
* Merge two contacts into a new contact record
|
|
11458
11579
|
* Two curated contacts cannot be merged. Refer to the Contact Merging article on the Developer Center for details
|
|
11459
11580
|
* @param {Object} body MergeRequest
|
|
@@ -11550,7 +11671,7 @@ if(relationshipId===undefined||relationshipId===null){throw'Missing the required
|
|
|
11550
11671
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putExternalcontactsRelationship';}return this.apiClient.callApi('/api/v2/externalcontacts/relationships/{relationshipId}','PUT',{'relationshipId':relationshipId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var FaxApi=/*#__PURE__*/function(){/**
|
|
11551
11672
|
* Fax service.
|
|
11552
11673
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
11553
|
-
* @version
|
|
11674
|
+
* @version 198.0.0
|
|
11554
11675
|
*/ /**
|
|
11555
11676
|
* Constructs a new FaxApi.
|
|
11556
11677
|
* @alias module:purecloud-platform-client-v2/api/FaxApi
|
|
@@ -11599,7 +11720,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
11599
11720
|
*/},{key:"putFaxSettings",value:function putFaxSettings(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/fax/settings','PUT',{},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var FlowsApi=/*#__PURE__*/function(){/**
|
|
11600
11721
|
* Flows service.
|
|
11601
11722
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
11602
|
-
* @version
|
|
11723
|
+
* @version 198.0.0
|
|
11603
11724
|
*/ /**
|
|
11604
11725
|
* Constructs a new FlowsApi.
|
|
11605
11726
|
* @alias module:purecloud-platform-client-v2/api/FlowsApi
|
|
@@ -11647,7 +11768,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
11647
11768
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postAnalyticsFlowsObservationsQuery';}return this.apiClient.callApi('/api/v2/analytics/flows/observations/query','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var GamificationApi=/*#__PURE__*/function(){/**
|
|
11648
11769
|
* Gamification service.
|
|
11649
11770
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
11650
|
-
* @version
|
|
11771
|
+
* @version 198.0.0
|
|
11651
11772
|
*/ /**
|
|
11652
11773
|
* Constructs a new GamificationApi.
|
|
11653
11774
|
* @alias module:purecloud-platform-client-v2/api/GamificationApi
|
|
@@ -12187,7 +12308,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
12187
12308
|
if(status===undefined||status===null){throw'Missing the required parameter "status" when calling putGamificationStatus';}return this.apiClient.callApi('/api/v2/gamification/status','PUT',{},{},{},{},status,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var GeneralDataProtectionRegulationApi=/*#__PURE__*/function(){/**
|
|
12188
12309
|
* GeneralDataProtectionRegulation service.
|
|
12189
12310
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
12190
|
-
* @version
|
|
12311
|
+
* @version 198.0.0
|
|
12191
12312
|
*/ /**
|
|
12192
12313
|
* Constructs a new GeneralDataProtectionRegulationApi.
|
|
12193
12314
|
* @alias module:purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
@@ -12222,7 +12343,7 @@ if(searchValue===undefined||searchValue===null){throw'Missing the required param
|
|
|
12222
12343
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postGdprRequests';}return this.apiClient.callApi('/api/v2/gdpr/requests','POST',{},{'deleteConfirmed':opts['deleteConfirmed']},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var GeolocationApi=/*#__PURE__*/function(){/**
|
|
12223
12344
|
* Geolocation service.
|
|
12224
12345
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
12225
|
-
* @version
|
|
12346
|
+
* @version 198.0.0
|
|
12226
12347
|
*/ /**
|
|
12227
12348
|
* Constructs a new GeolocationApi.
|
|
12228
12349
|
* @alias module:purecloud-platform-client-v2/api/GeolocationApi
|
|
@@ -12256,7 +12377,7 @@ if(clientId===undefined||clientId===null){throw'Missing the required parameter "
|
|
|
12256
12377
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling patchUserGeolocation';}return this.apiClient.callApi('/api/v2/users/{userId}/geolocations/{clientId}','PATCH',{'userId':userId,'clientId':clientId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var GreetingsApi=/*#__PURE__*/function(){/**
|
|
12257
12378
|
* Greetings service.
|
|
12258
12379
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
12259
|
-
* @version
|
|
12380
|
+
* @version 198.0.0
|
|
12260
12381
|
*/ /**
|
|
12261
12382
|
* Constructs a new GreetingsApi.
|
|
12262
12383
|
* @alias module:purecloud-platform-client-v2/api/GreetingsApi
|
|
@@ -12363,7 +12484,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
12363
12484
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putUserGreetingsDefaults';}return this.apiClient.callApi('/api/v2/users/{userId}/greetings/defaults','PUT',{'userId':userId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var GroupsApi=/*#__PURE__*/function(){/**
|
|
12364
12485
|
* Groups service.
|
|
12365
12486
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
12366
|
-
* @version
|
|
12487
|
+
* @version 198.0.0
|
|
12367
12488
|
*/ /**
|
|
12368
12489
|
* Constructs a new GroupsApi.
|
|
12369
12490
|
* @alias module:purecloud-platform-client-v2/api/GroupsApi
|
|
@@ -12496,7 +12617,7 @@ if(groupId===undefined||groupId===null){throw'Missing the required parameter "gr
|
|
|
12496
12617
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putGroupDynamicsettings';}return this.apiClient.callApi('/api/v2/groups/{groupId}/dynamicsettings','PUT',{'groupId':groupId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var IdentityProviderApi=/*#__PURE__*/function(){/**
|
|
12497
12618
|
* IdentityProvider service.
|
|
12498
12619
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
12499
|
-
* @version
|
|
12620
|
+
* @version 198.0.0
|
|
12500
12621
|
*/ /**
|
|
12501
12622
|
* Constructs a new IdentityProviderApi.
|
|
12502
12623
|
* @alias module:purecloud-platform-client-v2/api/IdentityProviderApi
|
|
@@ -12652,7 +12773,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
12652
12773
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putIdentityprovidersSalesforce';}return this.apiClient.callApi('/api/v2/identityproviders/salesforce','PUT',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var InfrastructureAsCodeApi=/*#__PURE__*/function(){/**
|
|
12653
12774
|
* InfrastructureAsCode service.
|
|
12654
12775
|
* @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
12655
|
-
* @version
|
|
12776
|
+
* @version 198.0.0
|
|
12656
12777
|
*/ /**
|
|
12657
12778
|
* Constructs a new InfrastructureAsCodeApi.
|
|
12658
12779
|
* @alias module:purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
@@ -12706,7 +12827,7 @@ if(jobId===undefined||jobId===null){throw'Missing the required parameter "jobId"
|
|
|
12706
12827
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postInfrastructureascodeJobs';}return this.apiClient.callApi('/api/v2/infrastructureascode/jobs','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var IntegrationsApi=/*#__PURE__*/function(){/**
|
|
12707
12828
|
* Integrations service.
|
|
12708
12829
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
12709
|
-
* @version
|
|
12830
|
+
* @version 198.0.0
|
|
12710
12831
|
*/ /**
|
|
12711
12832
|
* Constructs a new IntegrationsApi.
|
|
12712
12833
|
* @alias module:purecloud-platform-client-v2/api/IntegrationsApi
|
|
@@ -13317,7 +13438,7 @@ if(ucIntegrationId===undefined||ucIntegrationId===null){throw'Missing the requir
|
|
|
13317
13438
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putIntegrationsUnifiedcommunicationThirdpartypresences';}return this.apiClient.callApi('/api/v2/integrations/unifiedcommunications/{ucIntegrationId}/thirdpartypresences','PUT',{'ucIntegrationId':ucIntegrationId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var JourneyApi=/*#__PURE__*/function(){/**
|
|
13318
13439
|
* Journey service.
|
|
13319
13440
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
13320
|
-
* @version
|
|
13441
|
+
* @version 198.0.0
|
|
13321
13442
|
*/ /**
|
|
13322
13443
|
* Constructs a new JourneyApi.
|
|
13323
13444
|
* @alias module:purecloud-platform-client-v2/api/JourneyApi
|
|
@@ -13510,9 +13631,9 @@ if(sessionId===undefined||sessionId===null){throw'Missing the required parameter
|
|
|
13510
13631
|
* @param {Object} opts Optional parameters
|
|
13511
13632
|
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
13512
13633
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
13513
|
-
*
|
|
13634
|
+
* @param {Object} opts.eventType A comma separated list of journey event types to include in the results.
|
|
13514
13635
|
*/},{key:"getJourneySessionEvents",value:function getJourneySessionEvents(sessionId,opts){opts=opts||{};// verify the required parameter 'sessionId' is set
|
|
13515
|
-
if(sessionId===undefined||sessionId===null){throw'Missing the required parameter "sessionId" when calling getJourneySessionEvents';}return this.apiClient.callApi('/api/v2/journey/sessions/{sessionId}/events','GET',{'sessionId':sessionId},{'pageSize':opts['pageSize'],'after':opts['after']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
13636
|
+
if(sessionId===undefined||sessionId===null){throw'Missing the required parameter "sessionId" when calling getJourneySessionEvents';}return this.apiClient.callApi('/api/v2/journey/sessions/{sessionId}/events','GET',{'sessionId':sessionId},{'pageSize':opts['pageSize'],'after':opts['after'],'eventType':opts['eventType']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
13516
13637
|
* Retrieve latest outcome score associated with a session for all outcomes.
|
|
13517
13638
|
*
|
|
13518
13639
|
* @param {String} sessionId ID of the session.
|
|
@@ -13658,6 +13779,13 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
13658
13779
|
* @param {Object} opts.body
|
|
13659
13780
|
*/},{key:"postJourneyDeploymentAppevents",value:function postJourneyDeploymentAppevents(deploymentId,opts){opts=opts||{};// verify the required parameter 'deploymentId' is set
|
|
13660
13781
|
if(deploymentId===undefined||deploymentId===null){throw'Missing the required parameter "deploymentId" when calling postJourneyDeploymentAppevents';}return this.apiClient.callApi('/api/v2/journey/deployments/{deploymentId}/appevents','POST',{'deploymentId':deploymentId},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
13782
|
+
* Send a journey web event, used for tracking customer activity on a website.
|
|
13783
|
+
*
|
|
13784
|
+
* @param {String} deploymentId The ID of the deployment sending the web event.
|
|
13785
|
+
* @param {Object} opts Optional parameters
|
|
13786
|
+
* @param {Object} opts.body
|
|
13787
|
+
*/},{key:"postJourneyDeploymentWebevents",value:function postJourneyDeploymentWebevents(deploymentId,opts){opts=opts||{};// verify the required parameter 'deploymentId' is set
|
|
13788
|
+
if(deploymentId===undefined||deploymentId===null){throw'Missing the required parameter "deploymentId" when calling postJourneyDeploymentWebevents';}return this.apiClient.callApi('/api/v2/journey/deployments/{deploymentId}/webevents','POST',{'deploymentId':deploymentId},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
13661
13789
|
* Query for flow paths.
|
|
13662
13790
|
*
|
|
13663
13791
|
* @param {Object} opts Optional parameters
|
|
@@ -13714,7 +13842,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
13714
13842
|
*/},{key:"postJourneyViewsEncodingsValidate",value:function postJourneyViewsEncodingsValidate(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/journey/views/encodings/validate','POST',{},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var KnowledgeApi=/*#__PURE__*/function(){/**
|
|
13715
13843
|
* Knowledge service.
|
|
13716
13844
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
13717
|
-
* @version
|
|
13845
|
+
* @version 198.0.0
|
|
13718
13846
|
*/ /**
|
|
13719
13847
|
* Constructs a new KnowledgeApi.
|
|
13720
13848
|
* @alias module:purecloud-platform-client-v2/api/KnowledgeApi
|
|
@@ -14627,7 +14755,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
14627
14755
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postKnowledgeKnowledgebases';}return this.apiClient.callApi('/api/v2/knowledge/knowledgebases','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var LanguageUnderstandingApi=/*#__PURE__*/function(){/**
|
|
14628
14756
|
* LanguageUnderstanding service.
|
|
14629
14757
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
14630
|
-
* @version
|
|
14758
|
+
* @version 198.0.0
|
|
14631
14759
|
*/ /**
|
|
14632
14760
|
* Constructs a new LanguageUnderstandingApi.
|
|
14633
14761
|
* @alias module:purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
@@ -14887,7 +15015,7 @@ if(domainVersionId===undefined||domainVersionId===null){throw'Missing the requir
|
|
|
14887
15015
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putLanguageunderstandingDomainVersion';}return this.apiClient.callApi('/api/v2/languageunderstanding/domains/{domainId}/versions/{domainVersionId}','PUT',{'domainId':domainId,'domainVersionId':domainVersionId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var LanguagesApi=/*#__PURE__*/function(){/**
|
|
14888
15016
|
* Languages service.
|
|
14889
15017
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
14890
|
-
* @version
|
|
15018
|
+
* @version 198.0.0
|
|
14891
15019
|
*/ /**
|
|
14892
15020
|
* Constructs a new LanguagesApi.
|
|
14893
15021
|
* @alias module:purecloud-platform-client-v2/api/LanguagesApi
|
|
@@ -14942,7 +15070,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
14942
15070
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postLanguages';}return this.apiClient.callApi('/api/v2/languages','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var LearningApi=/*#__PURE__*/function(){/**
|
|
14943
15071
|
* Learning service.
|
|
14944
15072
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
14945
|
-
* @version
|
|
15073
|
+
* @version 198.0.0
|
|
14946
15074
|
*/ /**
|
|
14947
15075
|
* Constructs a new LearningApi.
|
|
14948
15076
|
* @alias module:purecloud-platform-client-v2/api/LearningApi
|
|
@@ -14973,10 +15101,11 @@ if(assignmentId===undefined||assignmentId===null){throw'Missing the required par
|
|
|
14973
15101
|
* @param {String} stepId The ID of Learning Assignment Step
|
|
14974
15102
|
* @param {Object} opts Optional parameters
|
|
14975
15103
|
* @param {String} opts.shareableContentObjectId The ID of SCO to load
|
|
15104
|
+
* @param {Object} opts.defaultShareableContentObject The default SCO to retrieve
|
|
14976
15105
|
* @param {Array.<String>} opts.expand Fields to expand in response
|
|
14977
15106
|
*/},{key:"getLearningAssignmentStep",value:function getLearningAssignmentStep(assignmentId,stepId,opts){opts=opts||{};// verify the required parameter 'assignmentId' is set
|
|
14978
15107
|
if(assignmentId===undefined||assignmentId===null){throw'Missing the required parameter "assignmentId" when calling getLearningAssignmentStep';}// verify the required parameter 'stepId' is set
|
|
14979
|
-
if(stepId===undefined||stepId===null){throw'Missing the required parameter "stepId" when calling getLearningAssignmentStep';}return this.apiClient.callApi('/api/v2/learning/assignments/{assignmentId}/steps/{stepId}','GET',{'assignmentId':assignmentId,'stepId':stepId},{'shareableContentObjectId':opts['shareableContentObjectId'],'expand':this.apiClient.buildCollectionParam(opts['expand'],'multi')},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
15108
|
+
if(stepId===undefined||stepId===null){throw'Missing the required parameter "stepId" when calling getLearningAssignmentStep';}return this.apiClient.callApi('/api/v2/learning/assignments/{assignmentId}/steps/{stepId}','GET',{'assignmentId':assignmentId,'stepId':stepId},{'shareableContentObjectId':opts['shareableContentObjectId'],'defaultShareableContentObject':opts['defaultShareableContentObject'],'expand':this.apiClient.buildCollectionParam(opts['expand'],'multi')},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
14980
15109
|
* List of Learning module Assignments
|
|
14981
15110
|
* Either moduleId or user value is required
|
|
14982
15111
|
* @param {Object} opts Optional parameters
|
|
@@ -15212,7 +15341,7 @@ if(moduleId===undefined||moduleId===null){throw'Missing the required parameter "
|
|
|
15212
15341
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putLearningModuleRule';}return this.apiClient.callApi('/api/v2/learning/modules/{moduleId}/rule','PUT',{'moduleId':moduleId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var LicenseApi=/*#__PURE__*/function(){/**
|
|
15213
15342
|
* License service.
|
|
15214
15343
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
15215
|
-
* @version
|
|
15344
|
+
* @version 198.0.0
|
|
15216
15345
|
*/ /**
|
|
15217
15346
|
* Constructs a new LicenseApi.
|
|
15218
15347
|
* @alias module:purecloud-platform-client-v2/api/LicenseApi
|
|
@@ -15266,7 +15395,7 @@ if(featureName===undefined||featureName===null){throw'Missing the required param
|
|
|
15266
15395
|
*/},{key:"postLicenseUsers",value:function postLicenseUsers(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/license/users','POST',{},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var LocationsApi=/*#__PURE__*/function(){/**
|
|
15267
15396
|
* Locations service.
|
|
15268
15397
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
15269
|
-
* @version
|
|
15398
|
+
* @version 198.0.0
|
|
15270
15399
|
*/ /**
|
|
15271
15400
|
* Constructs a new LocationsApi.
|
|
15272
15401
|
* @alias module:purecloud-platform-client-v2/api/LocationsApi
|
|
@@ -15325,7 +15454,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
15325
15454
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postLocationsSearch';}return this.apiClient.callApi('/api/v2/locations/search','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var LogCaptureApi=/*#__PURE__*/function(){/**
|
|
15326
15455
|
* LogCapture service.
|
|
15327
15456
|
* @module purecloud-platform-client-v2/api/LogCaptureApi
|
|
15328
|
-
* @version
|
|
15457
|
+
* @version 198.0.0
|
|
15329
15458
|
*/ /**
|
|
15330
15459
|
* Constructs a new LogCaptureApi.
|
|
15331
15460
|
* @alias module:purecloud-platform-client-v2/api/LogCaptureApi
|
|
@@ -15375,7 +15504,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
15375
15504
|
if(userId===undefined||userId===null){throw'Missing the required parameter "userId" when calling postDiagnosticsLogcaptureBrowserUser';}return this.apiClient.callApi('/api/v2/diagnostics/logcapture/browser/users/{userId}','POST',{'userId':userId},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var MessagingApi=/*#__PURE__*/function(){/**
|
|
15376
15505
|
* Messaging service.
|
|
15377
15506
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
15378
|
-
* @version
|
|
15507
|
+
* @version 198.0.0
|
|
15379
15508
|
*/ /**
|
|
15380
15509
|
* Constructs a new MessagingApi.
|
|
15381
15510
|
* @alias module:purecloud-platform-client-v2/api/MessagingApi
|
|
@@ -15465,7 +15594,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
15465
15594
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putMessagingSettingsDefault';}return this.apiClient.callApi('/api/v2/messaging/settings/default','PUT',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var MobileDevicesApi=/*#__PURE__*/function(){/**
|
|
15466
15595
|
* MobileDevices service.
|
|
15467
15596
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
15468
|
-
* @version
|
|
15597
|
+
* @version 198.0.0
|
|
15469
15598
|
*/ /**
|
|
15470
15599
|
* Constructs a new MobileDevicesApi.
|
|
15471
15600
|
* @alias module:purecloud-platform-client-v2/api/MobileDevicesApi
|
|
@@ -15504,7 +15633,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
15504
15633
|
if(deviceId===undefined||deviceId===null){throw'Missing the required parameter "deviceId" when calling putMobiledevice';}return this.apiClient.callApi('/api/v2/mobiledevices/{deviceId}','PUT',{'deviceId':deviceId},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var NotificationsApi=/*#__PURE__*/function(){/**
|
|
15505
15634
|
* Notifications service.
|
|
15506
15635
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
15507
|
-
* @version
|
|
15636
|
+
* @version 198.0.0
|
|
15508
15637
|
*/ /**
|
|
15509
15638
|
* Constructs a new NotificationsApi.
|
|
15510
15639
|
* @alias module:purecloud-platform-client-v2/api/NotificationsApi
|
|
@@ -15561,7 +15690,7 @@ if(channelId===undefined||channelId===null){throw'Missing the required parameter
|
|
|
15561
15690
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putNotificationsChannelSubscriptions';}return this.apiClient.callApi('/api/v2/notifications/channels/{channelId}/subscriptions','PUT',{'channelId':channelId},{'ignoreErrors':opts['ignoreErrors']},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var OAuthApi=/*#__PURE__*/function(){/**
|
|
15562
15691
|
* OAuth service.
|
|
15563
15692
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
15564
|
-
* @version
|
|
15693
|
+
* @version 198.0.0
|
|
15565
15694
|
*/ /**
|
|
15566
15695
|
* Constructs a new OAuthApi.
|
|
15567
15696
|
* @alias module:purecloud-platform-client-v2/api/OAuthApi
|
|
@@ -15646,7 +15775,7 @@ if(clientId===undefined||clientId===null){throw'Missing the required parameter "
|
|
|
15646
15775
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putOauthClient';}return this.apiClient.callApi('/api/v2/oauth/clients/{clientId}','PUT',{'clientId':clientId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var ObjectsApi=/*#__PURE__*/function(){/**
|
|
15647
15776
|
* Objects service.
|
|
15648
15777
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
15649
|
-
* @version
|
|
15778
|
+
* @version 198.0.0
|
|
15650
15779
|
*/ /**
|
|
15651
15780
|
* Constructs a new ObjectsApi.
|
|
15652
15781
|
* @alias module:purecloud-platform-client-v2/api/ObjectsApi
|
|
@@ -15717,7 +15846,7 @@ if(divisionId===undefined||divisionId===null){throw'Missing the required paramet
|
|
|
15717
15846
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putAuthorizationDivision';}return this.apiClient.callApi('/api/v2/authorization/divisions/{divisionId}','PUT',{'divisionId':divisionId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var OperationalEventsApi=/*#__PURE__*/function(){/**
|
|
15718
15847
|
* OperationalEvents service.
|
|
15719
15848
|
* @module purecloud-platform-client-v2/api/OperationalEventsApi
|
|
15720
|
-
* @version
|
|
15849
|
+
* @version 198.0.0
|
|
15721
15850
|
*/ /**
|
|
15722
15851
|
* Constructs a new OperationalEventsApi.
|
|
15723
15852
|
* @alias module:purecloud-platform-client-v2/api/OperationalEventsApi
|
|
@@ -15735,7 +15864,7 @@ if(eventDefinitionId===undefined||eventDefinitionId===null){throw'Missing the re
|
|
|
15735
15864
|
*/},{key:"getUsageEventsDefinitions",value:function getUsageEventsDefinitions(){return this.apiClient.callApi('/api/v2/usage/events/definitions','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var OrganizationApi=/*#__PURE__*/function(){/**
|
|
15736
15865
|
* Organization service.
|
|
15737
15866
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
15738
|
-
* @version
|
|
15867
|
+
* @version 198.0.0
|
|
15739
15868
|
*/ /**
|
|
15740
15869
|
* Constructs a new OrganizationApi.
|
|
15741
15870
|
* @alias module:purecloud-platform-client-v2/api/OrganizationApi
|
|
@@ -15840,7 +15969,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
15840
15969
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putOrganizationsWhitelist';}return this.apiClient.callApi('/api/v2/organizations/whitelist','PUT',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var OrganizationAuthorizationApi=/*#__PURE__*/function(){/**
|
|
15841
15970
|
* OrganizationAuthorization service.
|
|
15842
15971
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
15843
|
-
* @version
|
|
15972
|
+
* @version 198.0.0
|
|
15844
15973
|
*/ /**
|
|
15845
15974
|
* Constructs a new OrganizationAuthorizationApi.
|
|
15846
15975
|
* @alias module:purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
@@ -16163,7 +16292,7 @@ if(trustorOrgId===undefined||trustorOrgId===null){throw'Missing the required par
|
|
|
16163
16292
|
if(trusteeUserId===undefined||trusteeUserId===null){throw'Missing the required parameter "trusteeUserId" when calling putOrgauthorizationTrustorUser';}return this.apiClient.callApi('/api/v2/orgauthorization/trustors/{trustorOrgId}/users/{trusteeUserId}','PUT',{'trustorOrgId':trustorOrgId,'trusteeUserId':trusteeUserId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var OutboundApi=/*#__PURE__*/function(){/**
|
|
16164
16293
|
* Outbound service.
|
|
16165
16294
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
16166
|
-
* @version
|
|
16295
|
+
* @version 198.0.0
|
|
16167
16296
|
*/ /**
|
|
16168
16297
|
* Constructs a new OutboundApi.
|
|
16169
16298
|
* @alias module:purecloud-platform-client-v2/api/OutboundApi
|
|
@@ -16297,7 +16426,7 @@ if(id===undefined||id===null){throw'Missing the required parameter "id" when cal
|
|
|
16297
16426
|
*/},{key:"deleteOutboundMessagingcampaign",value:function deleteOutboundMessagingcampaign(messagingCampaignId){// verify the required parameter 'messagingCampaignId' is set
|
|
16298
16427
|
if(messagingCampaignId===undefined||messagingCampaignId===null){throw'Missing the required parameter "messagingCampaignId" when calling deleteOutboundMessagingcampaign';}return this.apiClient.callApi('/api/v2/outbound/messagingcampaigns/{messagingCampaignId}','DELETE',{'messagingCampaignId':messagingCampaignId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
16299
16428
|
* Reset messaging campaign progress and recycle the messaging campaign
|
|
16300
|
-
*
|
|
16429
|
+
* Documented permissions are applicable based on campaign type.
|
|
16301
16430
|
* @param {String} messagingCampaignId The Messaging Campaign ID
|
|
16302
16431
|
*/},{key:"deleteOutboundMessagingcampaignProgress",value:function deleteOutboundMessagingcampaignProgress(messagingCampaignId){// verify the required parameter 'messagingCampaignId' is set
|
|
16303
16432
|
if(messagingCampaignId===undefined||messagingCampaignId===null){throw'Missing the required parameter "messagingCampaignId" when calling deleteOutboundMessagingcampaignProgress';}return this.apiClient.callApi('/api/v2/outbound/messagingcampaigns/{messagingCampaignId}/progress','DELETE',{'messagingCampaignId':messagingCampaignId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
@@ -16839,6 +16968,13 @@ if(sequenceId===undefined||sequenceId===null){throw'Missing the required paramet
|
|
|
16839
16968
|
* Get the Dialer wrap up code mapping.
|
|
16840
16969
|
*
|
|
16841
16970
|
*/},{key:"getOutboundWrapupcodemappings",value:function getOutboundWrapupcodemappings(){return this.apiClient.callApi('/api/v2/outbound/wrapupcodemappings','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
16971
|
+
* Update a campaign.
|
|
16972
|
+
*
|
|
16973
|
+
* @param {String} campaignId Campaign ID
|
|
16974
|
+
* @param {Object} body CampaignPatchRequest
|
|
16975
|
+
*/},{key:"patchOutboundCampaign",value:function patchOutboundCampaign(campaignId,body){// verify the required parameter 'campaignId' is set
|
|
16976
|
+
if(campaignId===undefined||campaignId===null){throw'Missing the required parameter "campaignId" when calling patchOutboundCampaign';}// verify the required parameter 'body' is set
|
|
16977
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling patchOutboundCampaign';}return this.apiClient.callApi('/api/v2/outbound/campaigns/{campaignId}','PATCH',{'campaignId':campaignId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
16842
16978
|
* Add entries to or delete entries from a DNC list.
|
|
16843
16979
|
* Only Internal DNC lists may be deleted from
|
|
16844
16980
|
* @param {String} dncListId DncList ID
|
|
@@ -16870,18 +17006,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
16870
17006
|
* @param {Object} body AttemptLimits
|
|
16871
17007
|
*/},{key:"postOutboundAttemptlimits",value:function postOutboundAttemptlimits(body){// verify the required parameter 'body' is set
|
|
16872
17008
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postOutboundAttemptlimits';}return this.apiClient.callApi('/api/v2/outbound/attemptlimits','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
16873
|
-
* Retrieves audits for dialer. (Deprecated)
|
|
16874
|
-
* This endpoint is deprecated as a result of this functionality being moved to the Audit Service. Please use "/api/v2/audits/query" instead.
|
|
16875
|
-
* @param {Object} body AuditSearch
|
|
16876
|
-
* @param {Object} opts Optional parameters
|
|
16877
|
-
* @param {Number} opts.pageSize Page size (default to 25)
|
|
16878
|
-
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
16879
|
-
* @param {String} opts.sortBy Sort by (default to entity.name)
|
|
16880
|
-
* @param {String} opts.sortOrder Sort order (default to ascending)
|
|
16881
|
-
* @param {Boolean} opts.facetsOnly Facets only (default to false)
|
|
16882
|
-
* @deprecated
|
|
16883
|
-
*/},{key:"postOutboundAudits",value:function postOutboundAudits(body,opts){opts=opts||{};// verify the required parameter 'body' is set
|
|
16884
|
-
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postOutboundAudits';}return this.apiClient.callApi('/api/v2/outbound/audits','POST',{},{'pageSize':opts['pageSize'],'pageNumber':opts['pageNumber'],'sortBy':opts['sortBy'],'sortOrder':opts['sortOrder'],'facetsOnly':opts['facetsOnly']},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
16885
17009
|
* Create callable time set
|
|
16886
17010
|
*
|
|
16887
17011
|
* @param {Object} body DialerCallableTimeSet
|
|
@@ -17235,7 +17359,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
17235
17359
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putOutboundWrapupcodemappings';}return this.apiClient.callApi('/api/v2/outbound/wrapupcodemappings','PUT',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var PresenceApi=/*#__PURE__*/function(){/**
|
|
17236
17360
|
* Presence service.
|
|
17237
17361
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
17238
|
-
* @version
|
|
17362
|
+
* @version 198.0.0
|
|
17239
17363
|
*/ /**
|
|
17240
17364
|
* Constructs a new PresenceApi.
|
|
17241
17365
|
* @alias module:purecloud-platform-client-v2/api/PresenceApi
|
|
@@ -17408,7 +17532,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
17408
17532
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putUsersPresencesBulk';}return this.apiClient.callApi('/api/v2/users/presences/bulk','PUT',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var ProcessAutomationApi=/*#__PURE__*/function(){/**
|
|
17409
17533
|
* ProcessAutomation service.
|
|
17410
17534
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
17411
|
-
* @version
|
|
17535
|
+
* @version 198.0.0
|
|
17412
17536
|
*/ /**
|
|
17413
17537
|
* Constructs a new ProcessAutomationApi.
|
|
17414
17538
|
* @alias module:purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
@@ -17471,7 +17595,7 @@ if(triggerId===undefined||triggerId===null){throw'Missing the required parameter
|
|
|
17471
17595
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putProcessautomationTrigger';}return this.apiClient.callApi('/api/v2/processautomation/triggers/{triggerId}','PUT',{'triggerId':triggerId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var QualityApi=/*#__PURE__*/function(){/**
|
|
17472
17596
|
* Quality service.
|
|
17473
17597
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
17474
|
-
* @version
|
|
17598
|
+
* @version 198.0.0
|
|
17475
17599
|
*/ /**
|
|
17476
17600
|
* Constructs a new QualityApi.
|
|
17477
17601
|
* @alias module:purecloud-platform-client-v2/api/QualityApi
|
|
@@ -17924,6 +18048,14 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
17924
18048
|
*/},{key:"putQualityFormsEvaluation",value:function putQualityFormsEvaluation(formId,body){// verify the required parameter 'formId' is set
|
|
17925
18049
|
if(formId===undefined||formId===null){throw'Missing the required parameter "formId" when calling putQualityFormsEvaluation';}// verify the required parameter 'body' is set
|
|
17926
18050
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putQualityFormsEvaluation';}return this.apiClient.callApi('/api/v2/quality/forms/evaluations/{formId}','PUT',{'formId':formId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
18051
|
+
* Update the Predictive Scoring settings of an evaluation form.
|
|
18052
|
+
*
|
|
18053
|
+
* @param {String} formId Form ID
|
|
18054
|
+
* @param {Object} body Predictive Scoring Settings
|
|
18055
|
+
* putQualityFormsEvaluationPredictivescoringSettings is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
18056
|
+
*/},{key:"putQualityFormsEvaluationPredictivescoringSettings",value:function putQualityFormsEvaluationPredictivescoringSettings(formId,body){// verify the required parameter 'formId' is set
|
|
18057
|
+
if(formId===undefined||formId===null){throw'Missing the required parameter "formId" when calling putQualityFormsEvaluationPredictivescoringSettings';}// verify the required parameter 'body' is set
|
|
18058
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putQualityFormsEvaluationPredictivescoringSettings';}return this.apiClient.callApi('/api/v2/quality/forms/evaluations/{formId}/predictivescoring/settings','PUT',{'formId':formId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
17927
18059
|
* Update a survey form.
|
|
17928
18060
|
*
|
|
17929
18061
|
* @param {String} formId Form ID
|
|
@@ -17940,7 +18072,7 @@ if(customerSurveyUrl===undefined||customerSurveyUrl===null){throw'Missing the re
|
|
|
17940
18072
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putQualitySurveysScorable';}return this.apiClient.callApi('/api/v2/quality/surveys/scorable','PUT',{},{'customerSurveyUrl':customerSurveyUrl},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var RecordingApi=/*#__PURE__*/function(){/**
|
|
17941
18073
|
* Recording service.
|
|
17942
18074
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
17943
|
-
* @version
|
|
18075
|
+
* @version 198.0.0
|
|
17944
18076
|
*/ /**
|
|
17945
18077
|
* Constructs a new RecordingApi.
|
|
17946
18078
|
* @alias module:purecloud-platform-client-v2/api/RecordingApi
|
|
@@ -18351,7 +18483,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
18351
18483
|
*/},{key:"putRecordingsDeletionprotection",value:function putRecordingsDeletionprotection(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/recordings/deletionprotection','PUT',{},{'protect':opts['protect']},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var ResponseManagementApi=/*#__PURE__*/function(){/**
|
|
18352
18484
|
* ResponseManagement service.
|
|
18353
18485
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
18354
|
-
* @version
|
|
18486
|
+
* @version 198.0.0
|
|
18355
18487
|
*/ /**
|
|
18356
18488
|
* Constructs a new ResponseManagementApi.
|
|
18357
18489
|
* @alias module:purecloud-platform-client-v2/api/ResponseManagementApi
|
|
@@ -18472,7 +18604,7 @@ if(responseAssetId===undefined||responseAssetId===null){throw'Missing the requir
|
|
|
18472
18604
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putResponsemanagementResponseasset';}return this.apiClient.callApi('/api/v2/responsemanagement/responseassets/{responseAssetId}','PUT',{'responseAssetId':responseAssetId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var RoutingApi=/*#__PURE__*/function(){/**
|
|
18473
18605
|
* Routing service.
|
|
18474
18606
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
18475
|
-
* @version
|
|
18607
|
+
* @version 198.0.0
|
|
18476
18608
|
*/ /**
|
|
18477
18609
|
* Constructs a new RoutingApi.
|
|
18478
18610
|
* @alias module:purecloud-platform-client-v2/api/RoutingApi
|
|
@@ -18954,7 +19086,8 @@ if(addressId===undefined||addressId===null){throw'Missing the required parameter
|
|
|
18954
19086
|
* @param {Object} opts.sortOrder Sort order
|
|
18955
19087
|
* @param {String} opts.language A language tag (which is sometimes referred to as a locale identifier) to use to localize country field and sort operations (default to en-US)
|
|
18956
19088
|
* @param {String} opts.integrationId Filter on the Genesys Cloud integration id to which the phone number belongs to
|
|
18957
|
-
|
|
19089
|
+
* @param {String} opts.supportedContentId Filter based on the supported content ID
|
|
19090
|
+
*/},{key:"getRoutingSmsPhonenumbers",value:function getRoutingSmsPhonenumbers(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/routing/sms/phonenumbers','GET',{},{'phoneNumber':opts['phoneNumber'],'phoneNumberType':this.apiClient.buildCollectionParam(opts['phoneNumberType'],'multi'),'phoneNumberStatus':this.apiClient.buildCollectionParam(opts['phoneNumberStatus'],'multi'),'countryCode':this.apiClient.buildCollectionParam(opts['countryCode'],'multi'),'pageSize':opts['pageSize'],'pageNumber':opts['pageNumber'],'sortBy':opts['sortBy'],'sortOrder':opts['sortOrder'],'language':opts['language'],'integration.id':opts['integrationId'],'supportedContent.id':opts['supportedContentId']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
18958
19091
|
* Get the user's max utilization settings. If not configured, the organization-wide default is returned.
|
|
18959
19092
|
*
|
|
18960
19093
|
* @param {String} userId User ID
|
|
@@ -19440,7 +19573,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
19440
19573
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putUserRoutingskillsBulk';}return this.apiClient.callApi('/api/v2/users/{userId}/routingskills/bulk','PUT',{'userId':userId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var SCIMApi=/*#__PURE__*/function(){/**
|
|
19441
19574
|
* SCIM service.
|
|
19442
19575
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
19443
|
-
* @version
|
|
19576
|
+
* @version 198.0.0
|
|
19444
19577
|
*/ /**
|
|
19445
19578
|
* Constructs a new SCIMApi.
|
|
19446
19579
|
* @alias module:purecloud-platform-client-v2/api/SCIMApi
|
|
@@ -19665,7 +19798,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
19665
19798
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putScimV2User';}return this.apiClient.callApi('/api/v2/scim/v2/users/{userId}','PUT',{'userId':userId},{},{'If-Match':opts['ifMatch']},{},body,['PureCloud OAuth'],['application/scim+json','application/json'],['application/scim+json','application/json']);}}]);}();var ScreenRecordingApi=/*#__PURE__*/function(){/**
|
|
19666
19799
|
* ScreenRecording service.
|
|
19667
19800
|
* @module purecloud-platform-client-v2/api/ScreenRecordingApi
|
|
19668
|
-
* @version
|
|
19801
|
+
* @version 198.0.0
|
|
19669
19802
|
*/ /**
|
|
19670
19803
|
* Constructs a new ScreenRecordingApi.
|
|
19671
19804
|
* @alias module:purecloud-platform-client-v2/api/ScreenRecordingApi
|
|
@@ -19680,7 +19813,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
19680
19813
|
*/return _createClass(ScreenRecordingApi,[{key:"postScreenrecordingToken",value:function postScreenrecordingToken(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/screenrecording/token','POST',{},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var ScriptsApi=/*#__PURE__*/function(){/**
|
|
19681
19814
|
* Scripts service.
|
|
19682
19815
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
19683
|
-
* @version
|
|
19816
|
+
* @version 198.0.0
|
|
19684
19817
|
*/ /**
|
|
19685
19818
|
* Constructs a new ScriptsApi.
|
|
19686
19819
|
* @alias module:purecloud-platform-client-v2/api/ScriptsApi
|
|
@@ -19816,7 +19949,7 @@ if(scriptId===undefined||scriptId===null){throw'Missing the required parameter "
|
|
|
19816
19949
|
*/},{key:"postScriptsPublished",value:function postScriptsPublished(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/scripts/published','POST',{},{'scriptDataVersion':opts['scriptDataVersion']},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var SearchApi=/*#__PURE__*/function(){/**
|
|
19817
19950
|
* Search service.
|
|
19818
19951
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
19819
|
-
* @version
|
|
19952
|
+
* @version 198.0.0
|
|
19820
19953
|
*/ /**
|
|
19821
19954
|
* Constructs a new SearchApi.
|
|
19822
19955
|
* @alias module:purecloud-platform-client-v2/api/SearchApi
|
|
@@ -19976,7 +20109,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
19976
20109
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postVoicemailSearch';}return this.apiClient.callApi('/api/v2/voicemail/search','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var SettingsApi=/*#__PURE__*/function(){/**
|
|
19977
20110
|
* Settings service.
|
|
19978
20111
|
* @module purecloud-platform-client-v2/api/SettingsApi
|
|
19979
|
-
* @version
|
|
20112
|
+
* @version 198.0.0
|
|
19980
20113
|
*/ /**
|
|
19981
20114
|
* Constructs a new SettingsApi.
|
|
19982
20115
|
* @alias module:purecloud-platform-client-v2/api/SettingsApi
|
|
@@ -19984,13 +20117,23 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
19984
20117
|
* @param {module:purecloud-platform-client-v2/ApiClient} apiClient Optional API client implementation to use,
|
|
19985
20118
|
* default to {@link module:purecloud-platform-client-v2/ApiClient#instance} if unspecified.
|
|
19986
20119
|
*/function SettingsApi(apiClient){_classCallCheck(this,SettingsApi);this.apiClient=apiClient||ApiClient.instance;}/**
|
|
20120
|
+
* Delete agent auto answer settings
|
|
20121
|
+
*
|
|
20122
|
+
* @param {String} agentId The agent to apply the auto answer settings to
|
|
20123
|
+
*/return _createClass(SettingsApi,[{key:"deleteUsersAgentuiAgentsAutoanswerAgentIdSettings",value:function deleteUsersAgentuiAgentsAutoanswerAgentIdSettings(agentId){// verify the required parameter 'agentId' is set
|
|
20124
|
+
if(agentId===undefined||agentId===null){throw'Missing the required parameter "agentId" when calling deleteUsersAgentuiAgentsAutoanswerAgentIdSettings';}return this.apiClient.callApi('/api/v2/users/agentui/agents/autoanswer/{agentId}/settings','DELETE',{'agentId':agentId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
19987
20125
|
* Get email Contact Center settings
|
|
19988
20126
|
*
|
|
19989
|
-
*/
|
|
20127
|
+
*/},{key:"getEmailsSettings",value:function getEmailsSettings(){return this.apiClient.callApi('/api/v2/emails/settings','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
19990
20128
|
* Get the execution history enabled setting.
|
|
19991
20129
|
* Get the execution history enabled setting.
|
|
19992
20130
|
* getSettingsExecutiondata is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
19993
20131
|
*/},{key:"getSettingsExecutiondata",value:function getSettingsExecutiondata(){return this.apiClient.callApi('/api/v2/settings/executiondata','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
20132
|
+
* Get agent auto answer settings
|
|
20133
|
+
*
|
|
20134
|
+
* @param {String} agentId The agent to apply the auto answer settings to
|
|
20135
|
+
*/},{key:"getUsersAgentuiAgentsAutoanswerAgentIdSettings",value:function getUsersAgentuiAgentsAutoanswerAgentIdSettings(agentId){// verify the required parameter 'agentId' is set
|
|
20136
|
+
if(agentId===undefined||agentId===null){throw'Missing the required parameter "agentId" when calling getUsersAgentuiAgentsAutoanswerAgentIdSettings';}return this.apiClient.callApi('/api/v2/users/agentui/agents/autoanswer/{agentId}/settings','GET',{'agentId':agentId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
19994
20137
|
* Patch email Contact Center settings
|
|
19995
20138
|
*
|
|
19996
20139
|
* @param {Object} opts Optional parameters
|
|
@@ -20001,10 +20144,24 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
20001
20144
|
* @param {Object} body New Execution Data Setting
|
|
20002
20145
|
* patchSettingsExecutiondata is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
20003
20146
|
*/},{key:"patchSettingsExecutiondata",value:function patchSettingsExecutiondata(body){// verify the required parameter 'body' is set
|
|
20004
|
-
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling patchSettingsExecutiondata';}return this.apiClient.callApi('/api/v2/settings/executiondata','PATCH',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}
|
|
20147
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling patchSettingsExecutiondata';}return this.apiClient.callApi('/api/v2/settings/executiondata','PATCH',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
20148
|
+
* Update agent auto answer settings
|
|
20149
|
+
*
|
|
20150
|
+
* @param {String} agentId The agent to apply the auto answer settings to
|
|
20151
|
+
* @param {Object} body AutoAnswerSettings
|
|
20152
|
+
*/},{key:"patchUsersAgentuiAgentsAutoanswerAgentIdSettings",value:function patchUsersAgentuiAgentsAutoanswerAgentIdSettings(agentId,body){// verify the required parameter 'agentId' is set
|
|
20153
|
+
if(agentId===undefined||agentId===null){throw'Missing the required parameter "agentId" when calling patchUsersAgentuiAgentsAutoanswerAgentIdSettings';}// verify the required parameter 'body' is set
|
|
20154
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling patchUsersAgentuiAgentsAutoanswerAgentIdSettings';}return this.apiClient.callApi('/api/v2/users/agentui/agents/autoanswer/{agentId}/settings','PATCH',{'agentId':agentId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
20155
|
+
* Set agent auto answer settings
|
|
20156
|
+
*
|
|
20157
|
+
* @param {String} agentId The agent to apply the auto answer settings to
|
|
20158
|
+
* @param {Object} body AutoAnswerSettings
|
|
20159
|
+
*/},{key:"putUsersAgentuiAgentsAutoanswerAgentIdSettings",value:function putUsersAgentuiAgentsAutoanswerAgentIdSettings(agentId,body){// verify the required parameter 'agentId' is set
|
|
20160
|
+
if(agentId===undefined||agentId===null){throw'Missing the required parameter "agentId" when calling putUsersAgentuiAgentsAutoanswerAgentIdSettings';}// verify the required parameter 'body' is set
|
|
20161
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putUsersAgentuiAgentsAutoanswerAgentIdSettings';}return this.apiClient.callApi('/api/v2/users/agentui/agents/autoanswer/{agentId}/settings','PUT',{'agentId':agentId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var SpeechTextAnalyticsApi=/*#__PURE__*/function(){/**
|
|
20005
20162
|
* SpeechTextAnalytics service.
|
|
20006
20163
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
20007
|
-
* @version
|
|
20164
|
+
* @version 198.0.0
|
|
20008
20165
|
*/ /**
|
|
20009
20166
|
* Constructs a new SpeechTextAnalyticsApi.
|
|
20010
20167
|
* @alias module:purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
@@ -20288,7 +20445,7 @@ if(topicId===undefined||topicId===null){throw'Missing the required parameter "to
|
|
|
20288
20445
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putSpeechandtextanalyticsTopic';}return this.apiClient.callApi('/api/v2/speechandtextanalytics/topics/{topicId}','PUT',{'topicId':topicId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var StationsApi=/*#__PURE__*/function(){/**
|
|
20289
20446
|
* Stations service.
|
|
20290
20447
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
20291
|
-
* @version
|
|
20448
|
+
* @version 198.0.0
|
|
20292
20449
|
*/ /**
|
|
20293
20450
|
* Constructs a new StationsApi.
|
|
20294
20451
|
* @alias module:purecloud-platform-client-v2/api/StationsApi
|
|
@@ -20320,7 +20477,7 @@ if(stationId===undefined||stationId===null){throw'Missing the required parameter
|
|
|
20320
20477
|
*/},{key:"getStations",value:function getStations(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/stations','GET',{},{'pageSize':opts['pageSize'],'pageNumber':opts['pageNumber'],'sortBy':opts['sortBy'],'name':opts['name'],'userSelectable':opts['userSelectable'],'webRtcUserId':opts['webRtcUserId'],'id':opts['id'],'lineAppearanceId':opts['lineAppearanceId']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var SuggestApi=/*#__PURE__*/function(){/**
|
|
20321
20478
|
* Suggest service.
|
|
20322
20479
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
20323
|
-
* @version
|
|
20480
|
+
* @version 198.0.0
|
|
20324
20481
|
*/ /**
|
|
20325
20482
|
* Constructs a new SuggestApi.
|
|
20326
20483
|
* @alias module:purecloud-platform-client-v2/api/SuggestApi
|
|
@@ -20360,7 +20517,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
20360
20517
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postSearchSuggest';}return this.apiClient.callApi('/api/v2/search/suggest','POST',{},{'profile':opts['profile']},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var TaskManagementApi=/*#__PURE__*/function(){/**
|
|
20361
20518
|
* TaskManagement service.
|
|
20362
20519
|
* @module purecloud-platform-client-v2/api/TaskManagementApi
|
|
20363
|
-
* @version
|
|
20520
|
+
* @version 198.0.0
|
|
20364
20521
|
*/ /**
|
|
20365
20522
|
* Constructs a new TaskManagementApi.
|
|
20366
20523
|
* @alias module:purecloud-platform-client-v2/api/TaskManagementApi
|
|
@@ -20529,9 +20686,10 @@ if(worktypeId===undefined||worktypeId===null){throw'Missing the required paramet
|
|
|
20529
20686
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
20530
20687
|
* @param {Number} opts.pageSize Limit the number of entities to return. It is not guaranteed that the requested number of entities will be filled in a single request. If an `after` key is returned as part of the response it is possible that more entities that match the filter criteria exist. Maximum of 200. (default to 25)
|
|
20531
20688
|
* @param {Object} opts.sortOrder Ascending or descending sort order (default to descending)
|
|
20689
|
+
* @param {Array.<String>} opts.fields Comma-separated list of fields. The response will contain only versions created as a result of changes to these fields.
|
|
20532
20690
|
* getTaskmanagementWorktypeHistory is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
20533
20691
|
*/},{key:"getTaskmanagementWorktypeHistory",value:function getTaskmanagementWorktypeHistory(worktypeId,opts){opts=opts||{};// verify the required parameter 'worktypeId' is set
|
|
20534
|
-
if(worktypeId===undefined||worktypeId===null){throw'Missing the required parameter "worktypeId" when calling getTaskmanagementWorktypeHistory';}return this.apiClient.callApi('/api/v2/taskmanagement/worktypes/{worktypeId}/history','GET',{'worktypeId':worktypeId},{'after':opts['after'],'pageSize':opts['pageSize'],'sortOrder':opts['sortOrder']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
20692
|
+
if(worktypeId===undefined||worktypeId===null){throw'Missing the required parameter "worktypeId" when calling getTaskmanagementWorktypeHistory';}return this.apiClient.callApi('/api/v2/taskmanagement/worktypes/{worktypeId}/history','GET',{'worktypeId':worktypeId},{'after':opts['after'],'pageSize':opts['pageSize'],'sortOrder':opts['sortOrder'],'fields':this.apiClient.buildCollectionParam(opts['fields'],'multi')},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
20535
20693
|
* Get a status
|
|
20536
20694
|
*
|
|
20537
20695
|
* @param {String} worktypeId Worktype id
|
|
@@ -20689,7 +20847,7 @@ if(schemaId===undefined||schemaId===null){throw'Missing the required parameter "
|
|
|
20689
20847
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putTaskmanagementWorkitemsSchema';}return this.apiClient.callApi('/api/v2/taskmanagement/workitems/schemas/{schemaId}','PUT',{'schemaId':schemaId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var TeamsApi=/*#__PURE__*/function(){/**
|
|
20690
20848
|
* Teams service.
|
|
20691
20849
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
20692
|
-
* @version
|
|
20850
|
+
* @version 198.0.0
|
|
20693
20851
|
*/ /**
|
|
20694
20852
|
* Constructs a new TeamsApi.
|
|
20695
20853
|
* @alias module:purecloud-platform-client-v2/api/TeamsApi
|
|
@@ -20767,7 +20925,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
20767
20925
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postTeamsSearch';}return this.apiClient.callApi('/api/v2/teams/search','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var TelephonyApi=/*#__PURE__*/function(){/**
|
|
20768
20926
|
* Telephony service.
|
|
20769
20927
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
20770
|
-
* @version
|
|
20928
|
+
* @version 198.0.0
|
|
20771
20929
|
*/ /**
|
|
20772
20930
|
* Constructs a new TelephonyApi.
|
|
20773
20931
|
* @alias module:purecloud-platform-client-v2/api/TelephonyApi
|
|
@@ -20814,7 +20972,7 @@ if(downloadId===undefined||downloadId===null){throw'Missing the required paramet
|
|
|
20814
20972
|
if(sIPSearchPublicRequest===undefined||sIPSearchPublicRequest===null){throw'Missing the required parameter "sIPSearchPublicRequest" when calling postTelephonySiptracesDownload';}return this.apiClient.callApi('/api/v2/telephony/siptraces/download','POST',{},{},{},{},sIPSearchPublicRequest,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var TelephonyProvidersEdgeApi=/*#__PURE__*/function(){/**
|
|
20815
20973
|
* TelephonyProvidersEdge service.
|
|
20816
20974
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
20817
|
-
* @version
|
|
20975
|
+
* @version 198.0.0
|
|
20818
20976
|
*/ /**
|
|
20819
20977
|
* Constructs a new TelephonyProvidersEdgeApi.
|
|
20820
20978
|
* @alias module:purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
@@ -21624,7 +21782,7 @@ if(trunkBaseSettingsId===undefined||trunkBaseSettingsId===null){throw'Missing th
|
|
|
21624
21782
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putTelephonyProvidersEdgesTrunkbasesetting';}return this.apiClient.callApi('/api/v2/telephony/providers/edges/trunkbasesettings/{trunkBaseSettingsId}','PUT',{'trunkBaseSettingsId':trunkBaseSettingsId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var TextbotsApi=/*#__PURE__*/function(){/**
|
|
21625
21783
|
* Textbots service.
|
|
21626
21784
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
21627
|
-
* @version
|
|
21785
|
+
* @version 198.0.0
|
|
21628
21786
|
*/ /**
|
|
21629
21787
|
* Constructs a new TextbotsApi.
|
|
21630
21788
|
* @alias module:purecloud-platform-client-v2/api/TextbotsApi
|
|
@@ -21659,7 +21817,7 @@ if(launchRequest===undefined||launchRequest===null){throw'Missing the required p
|
|
|
21659
21817
|
if(postTextRequest===undefined||postTextRequest===null){throw'Missing the required parameter "postTextRequest" when calling postTextbotsBotsExecute';}return this.apiClient.callApi('/api/v2/textbots/bots/execute','POST',{},{},{},{},postTextRequest,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var TokensApi=/*#__PURE__*/function(){/**
|
|
21660
21818
|
* Tokens service.
|
|
21661
21819
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
21662
|
-
* @version
|
|
21820
|
+
* @version 198.0.0
|
|
21663
21821
|
*/ /**
|
|
21664
21822
|
* Constructs a new TokensApi.
|
|
21665
21823
|
* @alias module:purecloud-platform-client-v2/api/TokensApi
|
|
@@ -21693,7 +21851,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
21693
21851
|
*/},{key:"putTokensTimeout",value:function putTokensTimeout(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/tokens/timeout','PUT',{},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var UploadsApi=/*#__PURE__*/function(){/**
|
|
21694
21852
|
* Uploads service.
|
|
21695
21853
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
21696
|
-
* @version
|
|
21854
|
+
* @version 198.0.0
|
|
21697
21855
|
*/ /**
|
|
21698
21856
|
* Constructs a new UploadsApi.
|
|
21699
21857
|
* @alias module:purecloud-platform-client-v2/api/UploadsApi
|
|
@@ -21759,7 +21917,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
21759
21917
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postUploadsWorkforcemanagementHistoricaldataCsv';}return this.apiClient.callApi('/api/v2/uploads/workforcemanagement/historicaldata/csv','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var UsageApi=/*#__PURE__*/function(){/**
|
|
21760
21918
|
* Usage service.
|
|
21761
21919
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
21762
|
-
* @version
|
|
21920
|
+
* @version 198.0.0
|
|
21763
21921
|
*/ /**
|
|
21764
21922
|
* Constructs a new UsageApi.
|
|
21765
21923
|
* @alias module:purecloud-platform-client-v2/api/UsageApi
|
|
@@ -21813,7 +21971,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
21813
21971
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postUsageSimplesearch';}return this.apiClient.callApi('/api/v2/usage/simplesearch','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var UserRecordingsApi=/*#__PURE__*/function(){/**
|
|
21814
21972
|
* UserRecordings service.
|
|
21815
21973
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
21816
|
-
* @version
|
|
21974
|
+
* @version 198.0.0
|
|
21817
21975
|
*/ /**
|
|
21818
21976
|
* Constructs a new UserRecordingsApi.
|
|
21819
21977
|
* @alias module:purecloud-platform-client-v2/api/UserRecordingsApi
|
|
@@ -21862,7 +22020,7 @@ if(recordingId===undefined||recordingId===null){throw'Missing the required param
|
|
|
21862
22020
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putUserrecording';}return this.apiClient.callApi('/api/v2/userrecordings/{recordingId}','PUT',{'recordingId':recordingId},{'expand':this.apiClient.buildCollectionParam(opts['expand'],'multi')},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var UsersApi=/*#__PURE__*/function(){/**
|
|
21863
22021
|
* Users service.
|
|
21864
22022
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
21865
|
-
* @version
|
|
22023
|
+
* @version 198.0.0
|
|
21866
22024
|
*/ /**
|
|
21867
22025
|
* Constructs a new UsersApi.
|
|
21868
22026
|
* @alias module:purecloud-platform-client-v2/api/UsersApi
|
|
@@ -22021,7 +22179,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
22021
22179
|
*
|
|
22022
22180
|
* @param {String} userId User ID
|
|
22023
22181
|
* @param {Object} opts Optional parameters
|
|
22024
|
-
* @param {Array.<String>} opts.expand Which fields, if any, to expand
|
|
22182
|
+
* @param {Array.<String>} opts.expand Which fields, if any, to expand. Note, expand parameters are resolved with a best effort approach and not guaranteed to be returned. If requested expand information is absolutely required, it's recommended to use specific API requests instead.
|
|
22025
22183
|
* @param {Object} opts.integrationPresenceSource Gets an integration presence for a user instead of their default.
|
|
22026
22184
|
* @param {Object} opts.state Search for a user with this state (default to active)
|
|
22027
22185
|
*/},{key:"getUser",value:function getUser(userId,opts){opts=opts||{};// verify the required parameter 'userId' is set
|
|
@@ -22167,7 +22325,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
22167
22325
|
* @param {Array.<String>} opts.id A list of user IDs to fetch by bulk
|
|
22168
22326
|
* @param {Array.<String>} opts.jabberId A list of jabberIds to fetch by bulk (cannot be used with the id parameter)
|
|
22169
22327
|
* @param {Object} opts.sortOrder Ascending or descending sort order (default to ASC)
|
|
22170
|
-
* @param {Array.<String>} opts.expand Which fields, if any, to expand
|
|
22328
|
+
* @param {Array.<String>} opts.expand Which fields, if any, to expand. Note, expand parameters are resolved with a best effort approach and not guaranteed to be returned. If requested expand information is absolutely required, it's recommended to use specific API requests instead.
|
|
22171
22329
|
* @param {Object} opts.integrationPresenceSource Gets an integration presence for users instead of their defaults. This parameter will only be used when presence is provided as an expand. When using this parameter the maximum number of users that can be returned is 100.
|
|
22172
22330
|
* @param {Object} opts.state Only list users of this state (default to active)
|
|
22173
22331
|
*/},{key:"getUsers",value:function getUsers(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/users','GET',{},{'pageSize':opts['pageSize'],'pageNumber':opts['pageNumber'],'id':this.apiClient.buildCollectionParam(opts['id'],'multi'),'jabberId':this.apiClient.buildCollectionParam(opts['jabberId'],'multi'),'sortOrder':opts['sortOrder'],'expand':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'integrationPresenceSource':opts['integrationPresenceSource'],'state':opts['state']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
@@ -22524,7 +22682,7 @@ if(verifierId===undefined||verifierId===null){throw'Missing the required paramet
|
|
|
22524
22682
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putUserVerifier';}return this.apiClient.callApi('/api/v2/users/{userId}/verifiers/{verifierId}','PUT',{'userId':userId,'verifierId':verifierId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var UtilitiesApi=/*#__PURE__*/function(){/**
|
|
22525
22683
|
* Utilities service.
|
|
22526
22684
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
22527
|
-
* @version
|
|
22685
|
+
* @version 198.0.0
|
|
22528
22686
|
*/ /**
|
|
22529
22687
|
* Constructs a new UtilitiesApi.
|
|
22530
22688
|
* @alias module:purecloud-platform-client-v2/api/UtilitiesApi
|
|
@@ -22551,7 +22709,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
22551
22709
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postCertificateDetails';}return this.apiClient.callApi('/api/v2/certificate/details','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var VoicemailApi=/*#__PURE__*/function(){/**
|
|
22552
22710
|
* Voicemail service.
|
|
22553
22711
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
22554
|
-
* @version
|
|
22712
|
+
* @version 198.0.0
|
|
22555
22713
|
*/ /**
|
|
22556
22714
|
* Constructs a new VoicemailApi.
|
|
22557
22715
|
* @alias module:purecloud-platform-client-v2/api/VoicemailApi
|
|
@@ -22700,7 +22858,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
22700
22858
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putVoicemailUserpolicy';}return this.apiClient.callApi('/api/v2/voicemail/userpolicies/{userId}','PUT',{'userId':userId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var WebChatApi=/*#__PURE__*/function(){/**
|
|
22701
22859
|
* WebChat service.
|
|
22702
22860
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
22703
|
-
* @version
|
|
22861
|
+
* @version 198.0.0
|
|
22704
22862
|
*/ /**
|
|
22705
22863
|
* Constructs a new WebChatApi.
|
|
22706
22864
|
* @alias module:purecloud-platform-client-v2/api/WebChatApi
|
|
@@ -22835,7 +22993,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
22835
22993
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putWebchatSettings';}return this.apiClient.callApi('/api/v2/webchat/settings','PUT',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var WebDeploymentsApi=/*#__PURE__*/function(){/**
|
|
22836
22994
|
* WebDeployments service.
|
|
22837
22995
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
22838
|
-
* @version
|
|
22996
|
+
* @version 198.0.0
|
|
22839
22997
|
*/ /**
|
|
22840
22998
|
* Constructs a new WebDeploymentsApi.
|
|
22841
22999
|
* @alias module:purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
@@ -22956,7 +23114,7 @@ if(deploymentId===undefined||deploymentId===null){throw'Missing the required par
|
|
|
22956
23114
|
if(deployment===undefined||deployment===null){throw'Missing the required parameter "deployment" when calling putWebdeploymentsDeployment';}return this.apiClient.callApi('/api/v2/webdeployments/deployments/{deploymentId}','PUT',{'deploymentId':deploymentId},{},{},{},deployment,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var WebMessagingApi=/*#__PURE__*/function(){/**
|
|
22957
23115
|
* WebMessaging service.
|
|
22958
23116
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
22959
|
-
* @version
|
|
23117
|
+
* @version 198.0.0
|
|
22960
23118
|
*/ /**
|
|
22961
23119
|
* Constructs a new WebMessagingApi.
|
|
22962
23120
|
* @alias module:purecloud-platform-client-v2/api/WebMessagingApi
|
|
@@ -22972,7 +23130,7 @@ if(deployment===undefined||deployment===null){throw'Missing the required paramet
|
|
|
22972
23130
|
*/return _createClass(WebMessagingApi,[{key:"getWebmessagingMessages",value:function getWebmessagingMessages(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/webmessaging/messages','GET',{},{'pageSize':opts['pageSize'],'pageNumber':opts['pageNumber']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var WidgetsApi=/*#__PURE__*/function(){/**
|
|
22973
23131
|
* Widgets service.
|
|
22974
23132
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
22975
|
-
* @version
|
|
23133
|
+
* @version 198.0.0
|
|
22976
23134
|
*/ /**
|
|
22977
23135
|
* Constructs a new WidgetsApi.
|
|
22978
23136
|
* @alias module:purecloud-platform-client-v2/api/WidgetsApi
|
|
@@ -23007,7 +23165,7 @@ if(deploymentId===undefined||deploymentId===null){throw'Missing the required par
|
|
|
23007
23165
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putWidgetsDeployment';}return this.apiClient.callApi('/api/v2/widgets/deployments/{deploymentId}','PUT',{'deploymentId':deploymentId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var WorkforceManagementApi=/*#__PURE__*/function(){/**
|
|
23008
23166
|
* WorkforceManagement service.
|
|
23009
23167
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
23010
|
-
* @version
|
|
23168
|
+
* @version 198.0.0
|
|
23011
23169
|
*/ /**
|
|
23012
23170
|
* Constructs a new WorkforceManagementApi.
|
|
23013
23171
|
* @alias module:purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
@@ -23148,12 +23306,6 @@ if(jobId===undefined||jobId===null){throw'Missing the required parameter "jobId"
|
|
|
23148
23306
|
* @param {String} jobId jobId
|
|
23149
23307
|
*/},{key:"getWorkforcemanagementAdherenceHistoricalJob",value:function getWorkforcemanagementAdherenceHistoricalJob(jobId){// verify the required parameter 'jobId' is set
|
|
23150
23308
|
if(jobId===undefined||jobId===null){throw'Missing the required parameter "jobId" when calling getWorkforcemanagementAdherenceHistoricalJob';}return this.apiClient.callApi('/api/v2/workforcemanagement/adherence/historical/jobs/{jobId}','GET',{'jobId':jobId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
23151
|
-
* To get status of the modeling job.
|
|
23152
|
-
* This Endpoint is Deprecated, and not recommended to be used.
|
|
23153
|
-
* @param {String} jobId The id of the modeling job
|
|
23154
|
-
* @deprecated
|
|
23155
|
-
*/},{key:"getWorkforcemanagementAdhocmodelingjob",value:function getWorkforcemanagementAdhocmodelingjob(jobId){// verify the required parameter 'jobId' is set
|
|
23156
|
-
if(jobId===undefined||jobId===null){throw'Missing the required parameter "jobId" when calling getWorkforcemanagementAdhocmodelingjob';}return this.apiClient.callApi('/api/v2/workforcemanagement/adhocmodelingjobs/{jobId}','GET',{'jobId':jobId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
23157
23309
|
* Get an adherence explanation
|
|
23158
23310
|
*
|
|
23159
23311
|
* @param {String} agentId The ID of the agent to query
|
|
@@ -23190,6 +23342,38 @@ if(activityCodeId===undefined||activityCodeId===null){throw'Missing the required
|
|
|
23190
23342
|
* @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
|
|
23191
23343
|
*/},{key:"getWorkforcemanagementBusinessunitActivitycodes",value:function getWorkforcemanagementBusinessunitActivitycodes(businessUnitId,opts){opts=opts||{};// verify the required parameter 'businessUnitId' is set
|
|
23192
23344
|
if(businessUnitId===undefined||businessUnitId===null){throw'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitActivitycodes';}return this.apiClient.callApi('/api/v2/workforcemanagement/businessunits/{businessUnitId}/activitycodes','GET',{'businessUnitId':businessUnitId},{'forceDownloadService':opts['forceDownloadService']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
23345
|
+
* Get an activity plan
|
|
23346
|
+
*
|
|
23347
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
23348
|
+
* @param {String} activityPlanId The ID of the activity plan to fetch
|
|
23349
|
+
* getWorkforcemanagementBusinessunitActivityplan is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
23350
|
+
*/},{key:"getWorkforcemanagementBusinessunitActivityplan",value:function getWorkforcemanagementBusinessunitActivityplan(businessUnitId,activityPlanId){// verify the required parameter 'businessUnitId' is set
|
|
23351
|
+
if(businessUnitId===undefined||businessUnitId===null){throw'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitActivityplan';}// verify the required parameter 'activityPlanId' is set
|
|
23352
|
+
if(activityPlanId===undefined||activityPlanId===null){throw'Missing the required parameter "activityPlanId" when calling getWorkforcemanagementBusinessunitActivityplan';}return this.apiClient.callApi('/api/v2/workforcemanagement/businessunits/{businessUnitId}/activityplans/{activityPlanId}','GET',{'businessUnitId':businessUnitId,'activityPlanId':activityPlanId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
23353
|
+
* Gets an activity plan run job
|
|
23354
|
+
*
|
|
23355
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
23356
|
+
* @param {String} activityPlanId The ID of the activity plan associated with the run job
|
|
23357
|
+
* @param {String} jobId The ID of the activity plan run job
|
|
23358
|
+
* getWorkforcemanagementBusinessunitActivityplanRunsJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
23359
|
+
*/},{key:"getWorkforcemanagementBusinessunitActivityplanRunsJob",value:function getWorkforcemanagementBusinessunitActivityplanRunsJob(businessUnitId,activityPlanId,jobId){// verify the required parameter 'businessUnitId' is set
|
|
23360
|
+
if(businessUnitId===undefined||businessUnitId===null){throw'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitActivityplanRunsJob';}// verify the required parameter 'activityPlanId' is set
|
|
23361
|
+
if(activityPlanId===undefined||activityPlanId===null){throw'Missing the required parameter "activityPlanId" when calling getWorkforcemanagementBusinessunitActivityplanRunsJob';}// verify the required parameter 'jobId' is set
|
|
23362
|
+
if(jobId===undefined||jobId===null){throw'Missing the required parameter "jobId" when calling getWorkforcemanagementBusinessunitActivityplanRunsJob';}return this.apiClient.callApi('/api/v2/workforcemanagement/businessunits/{businessUnitId}/activityplans/{activityPlanId}/runs/jobs/{jobId}','GET',{'businessUnitId':businessUnitId,'activityPlanId':activityPlanId,'jobId':jobId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
23363
|
+
* Get activity plans
|
|
23364
|
+
*
|
|
23365
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
23366
|
+
* @param {Object} opts Optional parameters
|
|
23367
|
+
* @param {Object} opts.state Optionally filter by activity plan state
|
|
23368
|
+
* getWorkforcemanagementBusinessunitActivityplans is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
23369
|
+
*/},{key:"getWorkforcemanagementBusinessunitActivityplans",value:function getWorkforcemanagementBusinessunitActivityplans(businessUnitId,opts){opts=opts||{};// verify the required parameter 'businessUnitId' is set
|
|
23370
|
+
if(businessUnitId===undefined||businessUnitId===null){throw'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitActivityplans';}return this.apiClient.callApi('/api/v2/workforcemanagement/businessunits/{businessUnitId}/activityplans','GET',{'businessUnitId':businessUnitId},{'state':opts['state']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
23371
|
+
* Gets the latest job for all activity plans in the business unit
|
|
23372
|
+
*
|
|
23373
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
23374
|
+
* getWorkforcemanagementBusinessunitActivityplansJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
23375
|
+
*/},{key:"getWorkforcemanagementBusinessunitActivityplansJobs",value:function getWorkforcemanagementBusinessunitActivityplansJobs(businessUnitId){// verify the required parameter 'businessUnitId' is set
|
|
23376
|
+
if(businessUnitId===undefined||businessUnitId===null){throw'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitActivityplansJobs';}return this.apiClient.callApi('/api/v2/workforcemanagement/businessunits/{businessUnitId}/activityplans/jobs','GET',{'businessUnitId':businessUnitId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
23193
23377
|
* Get intraday planning groups for the given date
|
|
23194
23378
|
*
|
|
23195
23379
|
* @param {String} businessUnitId The ID of the business unit
|
|
@@ -23718,6 +23902,16 @@ if(businessUnitId===undefined||businessUnitId===null){throw'Missing the required
|
|
|
23718
23902
|
*/},{key:"patchWorkforcemanagementBusinessunitActivitycode",value:function patchWorkforcemanagementBusinessunitActivitycode(businessUnitId,activityCodeId,opts){opts=opts||{};// verify the required parameter 'businessUnitId' is set
|
|
23719
23903
|
if(businessUnitId===undefined||businessUnitId===null){throw'Missing the required parameter "businessUnitId" when calling patchWorkforcemanagementBusinessunitActivitycode';}// verify the required parameter 'activityCodeId' is set
|
|
23720
23904
|
if(activityCodeId===undefined||activityCodeId===null){throw'Missing the required parameter "activityCodeId" when calling patchWorkforcemanagementBusinessunitActivitycode';}return this.apiClient.callApi('/api/v2/workforcemanagement/businessunits/{businessUnitId}/activitycodes/{activityCodeId}','PATCH',{'businessUnitId':businessUnitId,'activityCodeId':activityCodeId},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
23905
|
+
* Update an activity plan
|
|
23906
|
+
* If a job associated with the activity plan is in Processing state the activity plan cannot be updated
|
|
23907
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
23908
|
+
* @param {String} activityPlanId The ID of the activity plan to update
|
|
23909
|
+
* @param {Object} body body
|
|
23910
|
+
* patchWorkforcemanagementBusinessunitActivityplan is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
23911
|
+
*/},{key:"patchWorkforcemanagementBusinessunitActivityplan",value:function patchWorkforcemanagementBusinessunitActivityplan(businessUnitId,activityPlanId,body){// verify the required parameter 'businessUnitId' is set
|
|
23912
|
+
if(businessUnitId===undefined||businessUnitId===null){throw'Missing the required parameter "businessUnitId" when calling patchWorkforcemanagementBusinessunitActivityplan';}// verify the required parameter 'activityPlanId' is set
|
|
23913
|
+
if(activityPlanId===undefined||activityPlanId===null){throw'Missing the required parameter "activityPlanId" when calling patchWorkforcemanagementBusinessunitActivityplan';}// verify the required parameter 'body' is set
|
|
23914
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling patchWorkforcemanagementBusinessunitActivityplan';}return this.apiClient.callApi('/api/v2/workforcemanagement/businessunits/{businessUnitId}/activityplans/{activityPlanId}','PATCH',{'businessUnitId':businessUnitId,'activityPlanId':activityPlanId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
23721
23915
|
* Updates the planning group
|
|
23722
23916
|
*
|
|
23723
23917
|
* @param {String} businessUnitId The ID of the business unit.
|
|
@@ -23922,6 +24116,22 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
23922
24116
|
* @param {Object} opts.body body
|
|
23923
24117
|
*/},{key:"postWorkforcemanagementBusinessunitActivitycodes",value:function postWorkforcemanagementBusinessunitActivitycodes(businessUnitId,opts){opts=opts||{};// verify the required parameter 'businessUnitId' is set
|
|
23924
24118
|
if(businessUnitId===undefined||businessUnitId===null){throw'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitActivitycodes';}return this.apiClient.callApi('/api/v2/workforcemanagement/businessunits/{businessUnitId}/activitycodes','POST',{'businessUnitId':businessUnitId},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
24119
|
+
* Run an activity plan manually
|
|
24120
|
+
* Triggers a job running the activity plan. The activity plan cannot be updated until the job completes
|
|
24121
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
24122
|
+
* @param {String} activityPlanId The ID of the activity plan to run
|
|
24123
|
+
* postWorkforcemanagementBusinessunitActivityplanRunsJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
24124
|
+
*/},{key:"postWorkforcemanagementBusinessunitActivityplanRunsJobs",value:function postWorkforcemanagementBusinessunitActivityplanRunsJobs(businessUnitId,activityPlanId){// verify the required parameter 'businessUnitId' is set
|
|
24125
|
+
if(businessUnitId===undefined||businessUnitId===null){throw'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitActivityplanRunsJobs';}// verify the required parameter 'activityPlanId' is set
|
|
24126
|
+
if(activityPlanId===undefined||activityPlanId===null){throw'Missing the required parameter "activityPlanId" when calling postWorkforcemanagementBusinessunitActivityplanRunsJobs';}return this.apiClient.callApi('/api/v2/workforcemanagement/businessunits/{businessUnitId}/activityplans/{activityPlanId}/runs/jobs','POST',{'businessUnitId':businessUnitId,'activityPlanId':activityPlanId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
24127
|
+
* Create an activity plan
|
|
24128
|
+
*
|
|
24129
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
24130
|
+
* @param {Object} body body
|
|
24131
|
+
* postWorkforcemanagementBusinessunitActivityplans is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
24132
|
+
*/},{key:"postWorkforcemanagementBusinessunitActivityplans",value:function postWorkforcemanagementBusinessunitActivityplans(businessUnitId,body){// verify the required parameter 'businessUnitId' is set
|
|
24133
|
+
if(businessUnitId===undefined||businessUnitId===null){throw'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitActivityplans';}// verify the required parameter 'body' is set
|
|
24134
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitActivityplans';}return this.apiClient.callApi('/api/v2/workforcemanagement/businessunits/{businessUnitId}/activityplans','POST',{'businessUnitId':businessUnitId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
23925
24135
|
* Query adherence explanations across an entire business unit for the requested period
|
|
23926
24136
|
*
|
|
23927
24137
|
* @param {String} businessUnitId The ID of the business unit
|
|
@@ -24487,7 +24697,7 @@ if(timeOffLimitId===undefined||timeOffLimitId===null){throw'Missing the required
|
|
|
24487
24697
|
* </pre>
|
|
24488
24698
|
* </p>
|
|
24489
24699
|
* @module purecloud-platform-client-v2/index
|
|
24490
|
-
* @version
|
|
24700
|
+
* @version 198.0.0
|
|
24491
24701
|
*/var platformClient=/*#__PURE__*/_createClass(function platformClient(){_classCallCheck(this,platformClient);/**
|
|
24492
24702
|
* The ApiClient constructor.
|
|
24493
24703
|
* @property {module:purecloud-platform-client-v2/ApiClient}
|
|
@@ -24495,6 +24705,9 @@ if(timeOffLimitId===undefined||timeOffLimitId===null){throw'Missing the required
|
|
|
24495
24705
|
* The ApiClient class.
|
|
24496
24706
|
* @property {module:purecloud-platform-client-v2/ApiClient}
|
|
24497
24707
|
*/this.ApiClientClass=ApiClient;/**
|
|
24708
|
+
* The AgentUIApi service constructor.
|
|
24709
|
+
* @property {module:purecloud-platform-client-v2/api/AgentUIApi}
|
|
24710
|
+
*/this.AgentUIApi=AgentUIApi;/**
|
|
24498
24711
|
* The AlertingApi service constructor.
|
|
24499
24712
|
* @property {module:purecloud-platform-client-v2/api/AlertingApi}
|
|
24500
24713
|
*/this.AlertingApi=AlertingApi;/**
|
|
@@ -24537,6 +24750,9 @@ if(timeOffLimitId===undefined||timeOffLimitId===null){throw'Missing the required
|
|
|
24537
24750
|
* The EmailsApi service constructor.
|
|
24538
24751
|
* @property {module:purecloud-platform-client-v2/api/EmailsApi}
|
|
24539
24752
|
*/this.EmailsApi=EmailsApi;/**
|
|
24753
|
+
* The EmployeeEngagementApi service constructor.
|
|
24754
|
+
* @property {module:purecloud-platform-client-v2/api/EmployeeEngagementApi}
|
|
24755
|
+
*/this.EmployeeEngagementApi=EmployeeEngagementApi;/**
|
|
24540
24756
|
* The EventsApi service constructor.
|
|
24541
24757
|
* @property {module:purecloud-platform-client-v2/api/EventsApi}
|
|
24542
24758
|
*/this.EventsApi=EventsApi;/**
|