purecloud-platform-client-v2 189.0.0 → 190.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 +923 -109
- package/dist/web-amd/purecloud-platform-client-v2.js +923 -109
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +300 -112
- package/dist/web-cjs/purecloud-platform-client-v2.js +385 -144
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +824 -453
- package/package.json +1 -1
- package/src/purecloud-platform-client-v2/ApiClient.js +1 -1
- package/src/purecloud-platform-client-v2/api/AlertingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ArchitectApi.js +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 +86 -20
- 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 +13 -8
- 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/EventsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/FaxApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/FlowsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GamificationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GeolocationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GreetingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GroupsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/IdentityProviderApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/InfrastructureAsCodeApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/JourneyApi.js +207 -1
- package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LanguagesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LearningApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LicenseApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LocationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LogCaptureApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/MessagingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/MobileDevicesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/NotificationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OAuthApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ObjectsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OperationalEventsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OrganizationApi.js +2 -2
- package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OutboundApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/PresenceApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ProcessAutomationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/QualityApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RecordingApi.js +22 -1
- package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RoutingApi.js +8 -7
- package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ScreenRecordingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ScriptsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SearchApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SettingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/StationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SuggestApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TaskManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TeamsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TelephonyApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TextbotsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TokensApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UploadsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsageApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsersApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/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 +516 -1
- package/src/purecloud-platform-client-v2/index.js +1 -1
package/dist/web-cjs/bundle.js
CHANGED
|
@@ -721,7 +721,7 @@ request.send(requestData||null);});};var knownAdapters={http:httpAdapter,xhr:xhr
|
|
|
721
721
|
*/function dispatchRequest(config){throwIfCancellationRequested(config);config.headers=AxiosHeaders$1.from(config.headers);// Transform request data
|
|
722
722
|
config.data=transformData.call(config,config.transformRequest);if(['post','put','patch'].indexOf(config.method)!==-1){config.headers.setContentType('application/x-www-form-urlencoded',false);}var adapter=adapters.getAdapter(config.adapter||defaults$1.adapter);return adapter(config).then(function onAdapterResolution(response){throwIfCancellationRequested(config);// Transform response data
|
|
723
723
|
response.data=transformData.call(config,config.transformResponse,response);response.headers=AxiosHeaders$1.from(response.headers);return response;},function onAdapterRejection(reason){if(!isCancel(reason)){throwIfCancellationRequested(config);// Transform response data
|
|
724
|
-
if(reason&&reason.response){reason.response.data=transformData.call(config,config.transformResponse,reason.response);reason.response.headers=AxiosHeaders$1.from(reason.response.headers);}}return Promise.reject(reason);});}var headersToObject=function headersToObject(thing){return thing instanceof AxiosHeaders$1?thing
|
|
724
|
+
if(reason&&reason.response){reason.response.data=transformData.call(config,config.transformResponse,reason.response);reason.response.headers=AxiosHeaders$1.from(reason.response.headers);}}return Promise.reject(reason);});}var headersToObject=function headersToObject(thing){return thing instanceof AxiosHeaders$1?_objectSpread({},thing):thing;};/**
|
|
725
725
|
* Config-specific merge-function which creates a new config-object
|
|
726
726
|
* by merging two configuration objects together.
|
|
727
727
|
*
|
|
@@ -734,7 +734,7 @@ config2=config2||{};var config={};function getMergedValue(target,source,caseless
|
|
|
734
734
|
function mergeDeepProperties(a,b,caseless){if(!utils$1.isUndefined(b)){return getMergedValue(a,b,caseless);}else if(!utils$1.isUndefined(a)){return getMergedValue(undefined,a,caseless);}}// eslint-disable-next-line consistent-return
|
|
735
735
|
function valueFromConfig2(a,b){if(!utils$1.isUndefined(b)){return getMergedValue(undefined,b);}}// eslint-disable-next-line consistent-return
|
|
736
736
|
function defaultToConfig2(a,b){if(!utils$1.isUndefined(b)){return getMergedValue(undefined,b);}else if(!utils$1.isUndefined(a)){return getMergedValue(undefined,a);}}// eslint-disable-next-line consistent-return
|
|
737
|
-
function mergeDirectKeys(a,b,prop){if(prop in config2){return getMergedValue(a,b);}else if(prop in config1){return getMergedValue(undefined,a);}}var mergeMap={url:valueFromConfig2,method:valueFromConfig2,data:valueFromConfig2,baseURL:defaultToConfig2,transformRequest:defaultToConfig2,transformResponse:defaultToConfig2,paramsSerializer:defaultToConfig2,timeout:defaultToConfig2,timeoutMessage:defaultToConfig2,withCredentials:defaultToConfig2,withXSRFToken:defaultToConfig2,adapter:defaultToConfig2,responseType:defaultToConfig2,xsrfCookieName:defaultToConfig2,xsrfHeaderName:defaultToConfig2,onUploadProgress:defaultToConfig2,onDownloadProgress:defaultToConfig2,decompress:defaultToConfig2,maxContentLength:defaultToConfig2,maxBodyLength:defaultToConfig2,beforeRedirect:defaultToConfig2,transport:defaultToConfig2,httpAgent:defaultToConfig2,httpsAgent:defaultToConfig2,cancelToken:defaultToConfig2,socketPath:defaultToConfig2,responseEncoding:defaultToConfig2,validateStatus:mergeDirectKeys,headers:function headers(a,b){return mergeDeepProperties(headersToObject(a),headersToObject(b),true);}};utils$1.forEach(Object.keys(Object.assign({},config1,config2)),function computeConfigValue(prop){var merge=mergeMap[prop]||mergeDeepProperties;var configValue=merge(config1[prop],config2[prop],prop);utils$1.isUndefined(configValue)&&merge!==mergeDirectKeys||(config[prop]=configValue);});return config;}var VERSION="1.6.
|
|
737
|
+
function mergeDirectKeys(a,b,prop){if(prop in config2){return getMergedValue(a,b);}else if(prop in config1){return getMergedValue(undefined,a);}}var mergeMap={url:valueFromConfig2,method:valueFromConfig2,data:valueFromConfig2,baseURL:defaultToConfig2,transformRequest:defaultToConfig2,transformResponse:defaultToConfig2,paramsSerializer:defaultToConfig2,timeout:defaultToConfig2,timeoutMessage:defaultToConfig2,withCredentials:defaultToConfig2,withXSRFToken:defaultToConfig2,adapter:defaultToConfig2,responseType:defaultToConfig2,xsrfCookieName:defaultToConfig2,xsrfHeaderName:defaultToConfig2,onUploadProgress:defaultToConfig2,onDownloadProgress:defaultToConfig2,decompress:defaultToConfig2,maxContentLength:defaultToConfig2,maxBodyLength:defaultToConfig2,beforeRedirect:defaultToConfig2,transport:defaultToConfig2,httpAgent:defaultToConfig2,httpsAgent:defaultToConfig2,cancelToken:defaultToConfig2,socketPath:defaultToConfig2,responseEncoding:defaultToConfig2,validateStatus:mergeDirectKeys,headers:function headers(a,b){return mergeDeepProperties(headersToObject(a),headersToObject(b),true);}};utils$1.forEach(Object.keys(Object.assign({},config1,config2)),function computeConfigValue(prop){var merge=mergeMap[prop]||mergeDeepProperties;var configValue=merge(config1[prop],config2[prop],prop);utils$1.isUndefined(configValue)&&merge!==mergeDirectKeys||(config[prop]=configValue);});return config;}var VERSION="1.6.8";var validators$1={};// eslint-disable-next-line func-names
|
|
738
738
|
['object','boolean','number','function','string','symbol'].forEach(function(type,i){validators$1[type]=function validator(thing){return _typeof(thing)===type||'a'+(i<1?'n ':' ')+type;};});var deprecatedWarnings={};/**
|
|
739
739
|
* Transitional option validator
|
|
740
740
|
*
|
|
@@ -847,7 +847,7 @@ if(env)this.environment=env;else this.environment=this.host?this.host:'mypureclo
|
|
|
847
847
|
this.environment=this.environment.replace(/\/+$/,'');// Strip protocol and subdomain
|
|
848
848
|
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];}}}]);return Configuration;}();/**
|
|
849
849
|
* @module purecloud-platform-client-v2/ApiClient
|
|
850
|
-
* @version
|
|
850
|
+
* @version 190.0.0
|
|
851
851
|
*/var ApiClient=/*#__PURE__*/function(){/**
|
|
852
852
|
* Manages low level client-server communications, parameter marshalling, etc. There should not be any need for an
|
|
853
853
|
* application to use this class directly - the *Api and model classes provide the public API for the service. The
|
|
@@ -1159,7 +1159,7 @@ resolve(data);})["catch"](function(error){var data=error;if(error.response&&erro
|
|
|
1159
1159
|
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);});}});}}]);return ApiClient;}();var AlertingApi=/*#__PURE__*/function(){/**
|
|
1160
1160
|
* Alerting service.
|
|
1161
1161
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
1162
|
-
* @version
|
|
1162
|
+
* @version 190.0.0
|
|
1163
1163
|
*/ /**
|
|
1164
1164
|
* Constructs a new AlertingApi.
|
|
1165
1165
|
* @alias module:purecloud-platform-client-v2/api/AlertingApi
|
|
@@ -1316,7 +1316,7 @@ if(ruleId===undefined||ruleId===null){throw'Missing the required parameter "rule
|
|
|
1316
1316
|
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']);}}]);return AlertingApi;}();var AnalyticsApi=/*#__PURE__*/function(){/**
|
|
1317
1317
|
* Analytics service.
|
|
1318
1318
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
1319
|
-
* @version
|
|
1319
|
+
* @version 190.0.0
|
|
1320
1320
|
*/ /**
|
|
1321
1321
|
* Constructs a new AnalyticsApi.
|
|
1322
1322
|
* @alias module:purecloud-platform-client-v2/api/AnalyticsApi
|
|
@@ -1926,7 +1926,7 @@ if(scheduleId===undefined||scheduleId===null){throw'Missing the required paramet
|
|
|
1926
1926
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putAnalyticsReportingSchedule';}return this.apiClient.callApi('/api/v2/analytics/reporting/schedules/{scheduleId}','PUT',{'scheduleId':scheduleId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return AnalyticsApi;}();var ArchitectApi=/*#__PURE__*/function(){/**
|
|
1927
1927
|
* Architect service.
|
|
1928
1928
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
1929
|
-
* @version
|
|
1929
|
+
* @version 190.0.0
|
|
1930
1930
|
*/ /**
|
|
1931
1931
|
* Constructs a new ArchitectApi.
|
|
1932
1932
|
* @alias module:purecloud-platform-client-v2/api/ArchitectApi
|
|
@@ -3042,7 +3042,7 @@ if(milestoneId===undefined||milestoneId===null){throw'Missing the required param
|
|
|
3042
3042
|
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']);}}]);return ArchitectApi;}();var AuditApi=/*#__PURE__*/function(){/**
|
|
3043
3043
|
* Audit service.
|
|
3044
3044
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
3045
|
-
* @version
|
|
3045
|
+
* @version 190.0.0
|
|
3046
3046
|
*/ /**
|
|
3047
3047
|
* Constructs a new AuditApi.
|
|
3048
3048
|
* @alias module:purecloud-platform-client-v2/api/AuditApi
|
|
@@ -3084,7 +3084,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
3084
3084
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postAuditsQueryRealtime';}return this.apiClient.callApi('/api/v2/audits/query/realtime','POST',{},{'expand':this.apiClient.buildCollectionParam(opts['expand'],'multi')},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return AuditApi;}();var AuthorizationApi=/*#__PURE__*/function(){/**
|
|
3085
3085
|
* Authorization service.
|
|
3086
3086
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
3087
|
-
* @version
|
|
3087
|
+
* @version 190.0.0
|
|
3088
3088
|
*/ /**
|
|
3089
3089
|
* Constructs a new AuthorizationApi.
|
|
3090
3090
|
* @alias module:purecloud-platform-client-v2/api/AuthorizationApi
|
|
@@ -3395,7 +3395,7 @@ if(subjectId===undefined||subjectId===null){throw'Missing the required parameter
|
|
|
3395
3395
|
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']);}}]);return AuthorizationApi;}();var BillingApi=/*#__PURE__*/function(){/**
|
|
3396
3396
|
* Billing service.
|
|
3397
3397
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
3398
|
-
* @version
|
|
3398
|
+
* @version 190.0.0
|
|
3399
3399
|
*/ /**
|
|
3400
3400
|
* Constructs a new BillingApi.
|
|
3401
3401
|
* @alias module:purecloud-platform-client-v2/api/BillingApi
|
|
@@ -3419,7 +3419,7 @@ if(endDate===undefined||endDate===null){throw'Missing the required parameter "en
|
|
|
3419
3419
|
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']);}}]);return BillingApi;}();var CarrierServicesApi=/*#__PURE__*/function(){/**
|
|
3420
3420
|
* CarrierServices service.
|
|
3421
3421
|
* @module purecloud-platform-client-v2/api/CarrierServicesApi
|
|
3422
|
-
* @version
|
|
3422
|
+
* @version 190.0.0
|
|
3423
3423
|
*/ /**
|
|
3424
3424
|
* Constructs a new CarrierServicesApi.
|
|
3425
3425
|
* @alias module:purecloud-platform-client-v2/api/CarrierServicesApi
|
|
@@ -3439,7 +3439,7 @@ if(phoneNumber===undefined||phoneNumber===null){throw'Missing the required param
|
|
|
3439
3439
|
*/},{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']);}}]);return CarrierServicesApi;}();var ChatApi=/*#__PURE__*/function(){/**
|
|
3440
3440
|
* Chat service.
|
|
3441
3441
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
3442
|
-
* @version
|
|
3442
|
+
* @version 190.0.0
|
|
3443
3443
|
*/ /**
|
|
3444
3444
|
* Constructs a new ChatApi.
|
|
3445
3445
|
* @alias module:purecloud-platform-client-v2/api/ChatApi
|
|
@@ -3451,7 +3451,6 @@ if(phoneNumber===undefined||phoneNumber===null){throw'Missing the required param
|
|
|
3451
3451
|
*
|
|
3452
3452
|
* @param {String} roomJid roomId
|
|
3453
3453
|
* @param {String} messageId messageId
|
|
3454
|
-
* deleteChatsRoomMessage is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
3455
3454
|
*/_createClass(ChatApi,[{key:"deleteChatsRoomMessage",value:function deleteChatsRoomMessage(roomJid,messageId){// verify the required parameter 'roomJid' is set
|
|
3456
3455
|
if(roomJid===undefined||roomJid===null){throw'Missing the required parameter "roomJid" when calling deleteChatsRoomMessage';}// verify the required parameter 'messageId' is set
|
|
3457
3456
|
if(messageId===undefined||messageId===null){throw'Missing the required parameter "messageId" when calling deleteChatsRoomMessage';}return this.apiClient.callApi('/api/v2/chats/rooms/{roomJid}/messages/{messageId}','DELETE',{'roomJid':roomJid,'messageId':messageId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
@@ -3459,7 +3458,6 @@ if(messageId===undefined||messageId===null){throw'Missing the required parameter
|
|
|
3459
3458
|
*
|
|
3460
3459
|
* @param {String} roomJid roomJid
|
|
3461
3460
|
* @param {String} userId userId
|
|
3462
|
-
* deleteChatsRoomParticipant is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
3463
3461
|
*/},{key:"deleteChatsRoomParticipant",value:function deleteChatsRoomParticipant(roomJid,userId){// verify the required parameter 'roomJid' is set
|
|
3464
3462
|
if(roomJid===undefined||roomJid===null){throw'Missing the required parameter "roomJid" when calling deleteChatsRoomParticipant';}// verify the required parameter 'userId' is set
|
|
3465
3463
|
if(userId===undefined||userId===null){throw'Missing the required parameter "userId" when calling deleteChatsRoomParticipant';}return this.apiClient.callApi('/api/v2/chats/rooms/{roomJid}/participants/{userId}','DELETE',{'roomJid':roomJid,'userId':userId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
@@ -3467,7 +3465,6 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
3467
3465
|
*
|
|
3468
3466
|
* @param {String} roomJid roomJid
|
|
3469
3467
|
* @param {String} pinnedMessageId pinnedMessageId
|
|
3470
|
-
* deleteChatsRoomPinnedmessage is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
3471
3468
|
*/},{key:"deleteChatsRoomPinnedmessage",value:function deleteChatsRoomPinnedmessage(roomJid,pinnedMessageId){// verify the required parameter 'roomJid' is set
|
|
3472
3469
|
if(roomJid===undefined||roomJid===null){throw'Missing the required parameter "roomJid" when calling deleteChatsRoomPinnedmessage';}// verify the required parameter 'pinnedMessageId' is set
|
|
3473
3470
|
if(pinnedMessageId===undefined||pinnedMessageId===null){throw'Missing the required parameter "pinnedMessageId" when calling deleteChatsRoomPinnedmessage';}return this.apiClient.callApi('/api/v2/chats/rooms/{roomJid}/pinnedmessages/{pinnedMessageId}','DELETE',{'roomJid':roomJid,'pinnedMessageId':pinnedMessageId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
@@ -3475,27 +3472,23 @@ if(pinnedMessageId===undefined||pinnedMessageId===null){throw'Missing the requir
|
|
|
3475
3472
|
*
|
|
3476
3473
|
* @param {String} userId userId
|
|
3477
3474
|
* @param {String} messageId messageId
|
|
3478
|
-
* deleteChatsUserMessage is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
3479
3475
|
*/},{key:"deleteChatsUserMessage",value:function deleteChatsUserMessage(userId,messageId){// verify the required parameter 'userId' is set
|
|
3480
3476
|
if(userId===undefined||userId===null){throw'Missing the required parameter "userId" when calling deleteChatsUserMessage';}// verify the required parameter 'messageId' is set
|
|
3481
3477
|
if(messageId===undefined||messageId===null){throw'Missing the required parameter "messageId" when calling deleteChatsUserMessage';}return this.apiClient.callApi('/api/v2/chats/users/{userId}/messages/{messageId}','DELETE',{'userId':userId,'messageId':messageId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
3482
3478
|
* Get a message
|
|
3483
3479
|
*
|
|
3484
3480
|
* @param {String} messageId messageId
|
|
3485
|
-
* getChatsMessage is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
3486
3481
|
*/},{key:"getChatsMessage",value:function getChatsMessage(messageId){// verify the required parameter 'messageId' is set
|
|
3487
3482
|
if(messageId===undefined||messageId===null){throw'Missing the required parameter "messageId" when calling getChatsMessage';}return this.apiClient.callApi('/api/v2/chats/messages/{messageId}','GET',{'messageId':messageId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
3488
3483
|
* Get a room
|
|
3489
3484
|
*
|
|
3490
3485
|
* @param {String} roomJid roomJid
|
|
3491
|
-
* getChatsRoom is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
3492
3486
|
*/},{key:"getChatsRoom",value:function getChatsRoom(roomJid){// verify the required parameter 'roomJid' is set
|
|
3493
3487
|
if(roomJid===undefined||roomJid===null){throw'Missing the required parameter "roomJid" when calling getChatsRoom';}return this.apiClient.callApi('/api/v2/chats/rooms/{roomJid}','GET',{'roomJid':roomJid},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
3494
3488
|
* Get messages by id(s) from a room
|
|
3495
3489
|
*
|
|
3496
3490
|
* @param {String} roomJid roomJid
|
|
3497
3491
|
* @param {String} messageIds messageIds, comma separated
|
|
3498
|
-
* getChatsRoomMessage is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
3499
3492
|
*/},{key:"getChatsRoomMessage",value:function getChatsRoomMessage(roomJid,messageIds){// verify the required parameter 'roomJid' is set
|
|
3500
3493
|
if(roomJid===undefined||roomJid===null){throw'Missing the required parameter "roomJid" when calling getChatsRoomMessage';}// verify the required parameter 'messageIds' is set
|
|
3501
3494
|
if(messageIds===undefined||messageIds===null){throw'Missing the required parameter "messageIds" when calling getChatsRoomMessage';}return this.apiClient.callApi('/api/v2/chats/rooms/{roomJid}/messages/{messageIds}','GET',{'roomJid':roomJid,'messageIds':messageIds},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
@@ -3506,9 +3499,20 @@ if(messageIds===undefined||messageIds===null){throw'Missing the required paramet
|
|
|
3506
3499
|
* @param {String} opts.limit The maximum number of messages to retrieve
|
|
3507
3500
|
* @param {String} opts.before The cutoff date for messages to retrieve
|
|
3508
3501
|
* @param {String} opts.after The beginning date for messages to retrieve
|
|
3509
|
-
* getChatsRoomMessages is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
3510
3502
|
*/},{key:"getChatsRoomMessages",value:function getChatsRoomMessages(roomJid,opts){opts=opts||{};// verify the required parameter 'roomJid' is set
|
|
3511
3503
|
if(roomJid===undefined||roomJid===null){throw'Missing the required parameter "roomJid" when calling getChatsRoomMessages';}return this.apiClient.callApi('/api/v2/chats/rooms/{roomJid}/messages','GET',{'roomJid':roomJid},{'limit':opts['limit'],'before':opts['before'],'after':opts['after']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
3504
|
+
* Get a room participant
|
|
3505
|
+
*
|
|
3506
|
+
* @param {String} roomJid roomJid
|
|
3507
|
+
* @param {String} participantJid participantJid
|
|
3508
|
+
*/},{key:"getChatsRoomParticipant",value:function getChatsRoomParticipant(roomJid,participantJid){// verify the required parameter 'roomJid' is set
|
|
3509
|
+
if(roomJid===undefined||roomJid===null){throw'Missing the required parameter "roomJid" when calling getChatsRoomParticipant';}// verify the required parameter 'participantJid' is set
|
|
3510
|
+
if(participantJid===undefined||participantJid===null){throw'Missing the required parameter "participantJid" when calling getChatsRoomParticipant';}return this.apiClient.callApi('/api/v2/chats/rooms/{roomJid}/participants/{participantJid}','GET',{'roomJid':roomJid,'participantJid':participantJid},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
3511
|
+
* Get room participants in a room
|
|
3512
|
+
*
|
|
3513
|
+
* @param {String} roomJid roomJid
|
|
3514
|
+
*/},{key:"getChatsRoomParticipants",value:function getChatsRoomParticipants(roomJid){// verify the required parameter 'roomJid' is set
|
|
3515
|
+
if(roomJid===undefined||roomJid===null){throw'Missing the required parameter "roomJid" when calling getChatsRoomParticipants';}return this.apiClient.callApi('/api/v2/chats/rooms/{roomJid}/participants','GET',{'roomJid':roomJid},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
3512
3516
|
* Get Chat Settings.
|
|
3513
3517
|
*
|
|
3514
3518
|
*/},{key:"getChatsSettings",value:function getChatsSettings(){return this.apiClient.callApi('/api/v2/chats/settings','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
@@ -3519,14 +3523,12 @@ if(roomJid===undefined||roomJid===null){throw'Missing the required parameter "ro
|
|
|
3519
3523
|
* @param {String} opts.limit The maximum number of messages to retrieve
|
|
3520
3524
|
* @param {String} opts.before The cutoff date for messages to retrieve
|
|
3521
3525
|
* @param {String} opts.after The beginning date for messages to retrieve
|
|
3522
|
-
* getChatsThreadMessages is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
3523
3526
|
*/},{key:"getChatsThreadMessages",value:function getChatsThreadMessages(threadId,opts){opts=opts||{};// verify the required parameter 'threadId' is set
|
|
3524
3527
|
if(threadId===undefined||threadId===null){throw'Missing the required parameter "threadId" when calling getChatsThreadMessages';}return this.apiClient.callApi('/api/v2/chats/threads/{threadId}/messages','GET',{'threadId':threadId},{'limit':opts['limit'],'before':opts['before'],'after':opts['after']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
3525
3528
|
* Get messages by id(s) from a 1on1
|
|
3526
3529
|
*
|
|
3527
3530
|
* @param {String} userId userId
|
|
3528
3531
|
* @param {String} messageIds messageIds, comma separated
|
|
3529
|
-
* getChatsUserMessage is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
3530
3532
|
*/},{key:"getChatsUserMessage",value:function getChatsUserMessage(userId,messageIds){// verify the required parameter 'userId' is set
|
|
3531
3533
|
if(userId===undefined||userId===null){throw'Missing the required parameter "userId" when calling getChatsUserMessage';}// verify the required parameter 'messageIds' is set
|
|
3532
3534
|
if(messageIds===undefined||messageIds===null){throw'Missing the required parameter "messageIds" when calling getChatsUserMessage';}return this.apiClient.callApi('/api/v2/chats/users/{userId}/messages/{messageIds}','GET',{'userId':userId,'messageIds':messageIds},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
@@ -3537,7 +3539,6 @@ if(messageIds===undefined||messageIds===null){throw'Missing the required paramet
|
|
|
3537
3539
|
* @param {String} opts.limit The maximum number of messages to retrieve
|
|
3538
3540
|
* @param {String} opts.before The cutoff date for messages to retrieve
|
|
3539
3541
|
* @param {String} opts.after The beginning date for messages to retrieve
|
|
3540
|
-
* getChatsUserMessages is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
3541
3542
|
*/},{key:"getChatsUserMessages",value:function getChatsUserMessages(userId,opts){opts=opts||{};// verify the required parameter 'userId' is set
|
|
3542
3543
|
if(userId===undefined||userId===null){throw'Missing the required parameter "userId" when calling getChatsUserMessages';}return this.apiClient.callApi('/api/v2/chats/users/{userId}/messages','GET',{'userId':userId},{'limit':opts['limit'],'before':opts['before'],'after':opts['after']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
3543
3544
|
* Get a user's chat settings
|
|
@@ -3550,7 +3551,6 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
3550
3551
|
*
|
|
3551
3552
|
* @param {String} roomJid roomJid
|
|
3552
3553
|
* @param {Object} body Room properties
|
|
3553
|
-
* patchChatsRoom is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
3554
3554
|
*/},{key:"patchChatsRoom",value:function patchChatsRoom(roomJid,body){// verify the required parameter 'roomJid' is set
|
|
3555
3555
|
if(roomJid===undefined||roomJid===null){throw'Missing the required parameter "roomJid" when calling patchChatsRoom';}// verify the required parameter 'body' is set
|
|
3556
3556
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling patchChatsRoom';}return this.apiClient.callApi('/api/v2/chats/rooms/{roomJid}','PATCH',{'roomJid':roomJid},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
@@ -3559,7 +3559,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
3559
3559
|
* @param {String} roomJid roomId
|
|
3560
3560
|
* @param {String} messageId messageId
|
|
3561
3561
|
* @param {Object} body messageBody
|
|
3562
|
-
* patchChatsRoomMessage is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
3563
3562
|
*/},{key:"patchChatsRoomMessage",value:function patchChatsRoomMessage(roomJid,messageId,body){// verify the required parameter 'roomJid' is set
|
|
3564
3563
|
if(roomJid===undefined||roomJid===null){throw'Missing the required parameter "roomJid" when calling patchChatsRoomMessage';}// verify the required parameter 'messageId' is set
|
|
3565
3564
|
if(messageId===undefined||messageId===null){throw'Missing the required parameter "messageId" when calling patchChatsRoomMessage';}// verify the required parameter 'body' is set
|
|
@@ -3574,7 +3573,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
3574
3573
|
* @param {String} userId userId
|
|
3575
3574
|
* @param {String} messageId messageId
|
|
3576
3575
|
* @param {Object} body message body
|
|
3577
|
-
* patchChatsUserMessage is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
3578
3576
|
*/},{key:"patchChatsUserMessage",value:function patchChatsUserMessage(userId,messageId,body){// verify the required parameter 'userId' is set
|
|
3579
3577
|
if(userId===undefined||userId===null){throw'Missing the required parameter "userId" when calling patchChatsUserMessage';}// verify the required parameter 'messageId' is set
|
|
3580
3578
|
if(messageId===undefined||messageId===null){throw'Missing the required parameter "messageId" when calling patchChatsUserMessage';}// verify the required parameter 'body' is set
|
|
@@ -3591,7 +3589,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
3591
3589
|
*
|
|
3592
3590
|
* @param {String} roomJid roomId
|
|
3593
3591
|
* @param {Object} body messageBody
|
|
3594
|
-
* postChatsRoomMessages is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
3595
3592
|
*/},{key:"postChatsRoomMessages",value:function postChatsRoomMessages(roomJid,body){// verify the required parameter 'roomJid' is set
|
|
3596
3593
|
if(roomJid===undefined||roomJid===null){throw'Missing the required parameter "roomJid" when calling postChatsRoomMessages';}// verify the required parameter 'body' is set
|
|
3597
3594
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postChatsRoomMessages';}return this.apiClient.callApi('/api/v2/chats/rooms/{roomJid}/messages','POST',{'roomJid':roomJid},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
@@ -3599,7 +3596,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
3599
3596
|
*
|
|
3600
3597
|
* @param {String} roomJid roomJid
|
|
3601
3598
|
* @param {String} userId userId
|
|
3602
|
-
* postChatsRoomParticipant is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
3603
3599
|
*/},{key:"postChatsRoomParticipant",value:function postChatsRoomParticipant(roomJid,userId){// verify the required parameter 'roomJid' is set
|
|
3604
3600
|
if(roomJid===undefined||roomJid===null){throw'Missing the required parameter "roomJid" when calling postChatsRoomParticipant';}// verify the required parameter 'userId' is set
|
|
3605
3601
|
if(userId===undefined||userId===null){throw'Missing the required parameter "userId" when calling postChatsRoomParticipant';}return this.apiClient.callApi('/api/v2/chats/rooms/{roomJid}/participants/{userId}','POST',{'roomJid':roomJid,'userId':userId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
@@ -3607,24 +3603,28 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
3607
3603
|
*
|
|
3608
3604
|
* @param {String} roomJid roomJid
|
|
3609
3605
|
* @param {Object} body Pinned Message Ids
|
|
3610
|
-
* postChatsRoomPinnedmessages is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
3611
3606
|
*/},{key:"postChatsRoomPinnedmessages",value:function postChatsRoomPinnedmessages(roomJid,body){// verify the required parameter 'roomJid' is set
|
|
3612
3607
|
if(roomJid===undefined||roomJid===null){throw'Missing the required parameter "roomJid" when calling postChatsRoomPinnedmessages';}// verify the required parameter 'body' is set
|
|
3613
3608
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postChatsRoomPinnedmessages';}return this.apiClient.callApi('/api/v2/chats/rooms/{roomJid}/pinnedmessages','POST',{'roomJid':roomJid},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
3614
3609
|
* Create an adhoc room
|
|
3615
3610
|
*
|
|
3616
3611
|
* @param {Object} body Room properties
|
|
3617
|
-
* postChatsRooms is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
3618
3612
|
*/},{key:"postChatsRooms",value:function postChatsRooms(body){// verify the required parameter 'body' is set
|
|
3619
3613
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postChatsRooms';}return this.apiClient.callApi('/api/v2/chats/rooms','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
3620
3614
|
* Send a message to a user
|
|
3621
3615
|
*
|
|
3622
3616
|
* @param {String} userId userId
|
|
3623
3617
|
* @param {Object} body message body
|
|
3624
|
-
* postChatsUserMessages is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
3625
3618
|
*/},{key:"postChatsUserMessages",value:function postChatsUserMessages(userId,body){// verify the required parameter 'userId' is set
|
|
3626
3619
|
if(userId===undefined||userId===null){throw'Missing the required parameter "userId" when calling postChatsUserMessages';}// verify the required parameter 'body' is set
|
|
3627
3620
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postChatsUserMessages';}return this.apiClient.callApi('/api/v2/chats/users/{userId}/messages','POST',{'userId':userId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
3621
|
+
* Update reactions to a message
|
|
3622
|
+
*
|
|
3623
|
+
* @param {String} messageId messageId
|
|
3624
|
+
* @param {Object} body reactionUpdate
|
|
3625
|
+
*/},{key:"putChatsMessageReactions",value:function putChatsMessageReactions(messageId,body){// verify the required parameter 'messageId' is set
|
|
3626
|
+
if(messageId===undefined||messageId===null){throw'Missing the required parameter "messageId" when calling putChatsMessageReactions';}// verify the required parameter 'body' is set
|
|
3627
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putChatsMessageReactions';}return this.apiClient.callApi('/api/v2/chats/messages/{messageId}/reactions','PUT',{'messageId':messageId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
3628
3628
|
* Update Chat Settings.
|
|
3629
3629
|
*
|
|
3630
3630
|
* @param {Object} body Chat
|
|
@@ -3632,7 +3632,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
3632
3632
|
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']);}}]);return ChatApi;}();var CoachingApi=/*#__PURE__*/function(){/**
|
|
3633
3633
|
* Coaching service.
|
|
3634
3634
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
3635
|
-
* @version
|
|
3635
|
+
* @version 190.0.0
|
|
3636
3636
|
*/ /**
|
|
3637
3637
|
* Constructs a new CoachingApi.
|
|
3638
3638
|
* @alias module:purecloud-platform-client-v2/api/CoachingApi
|
|
@@ -3785,7 +3785,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
3785
3785
|
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']);}}]);return CoachingApi;}();var ContentManagementApi=/*#__PURE__*/function(){/**
|
|
3786
3786
|
* ContentManagement service.
|
|
3787
3787
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
3788
|
-
* @version
|
|
3788
|
+
* @version 190.0.0
|
|
3789
3789
|
*/ /**
|
|
3790
3790
|
* Constructs a new ContentManagementApi.
|
|
3791
3791
|
* @alias module:purecloud-platform-client-v2/api/ContentManagementApi
|
|
@@ -4068,7 +4068,7 @@ if(tagId===undefined||tagId===null){throw'Missing the required parameter "tagId"
|
|
|
4068
4068
|
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']);}}]);return ContentManagementApi;}();var ConversationsApi=/*#__PURE__*/function(){/**
|
|
4069
4069
|
* Conversations service.
|
|
4070
4070
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
4071
|
-
* @version
|
|
4071
|
+
* @version 190.0.0
|
|
4072
4072
|
*/ /**
|
|
4073
4073
|
* Constructs a new ConversationsApi.
|
|
4074
4074
|
* @alias module:purecloud-platform-client-v2/api/ConversationsApi
|
|
@@ -4138,8 +4138,9 @@ if(integrationId===undefined||integrationId===null){throw'Missing the required p
|
|
|
4138
4138
|
*/},{key:"deleteConversationsMessagingIntegrationsOpenIntegrationId",value:function deleteConversationsMessagingIntegrationsOpenIntegrationId(integrationId){// verify the required parameter 'integrationId' is set
|
|
4139
4139
|
if(integrationId===undefined||integrationId===null){throw'Missing the required parameter "integrationId" when calling deleteConversationsMessagingIntegrationsOpenIntegrationId';}return this.apiClient.callApi('/api/v2/conversations/messaging/integrations/open/{integrationId}','DELETE',{'integrationId':integrationId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
4140
4140
|
* Delete a Twitter messaging integration
|
|
4141
|
-
*
|
|
4141
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-native-x-formerly-twitter-third-party-messaging-channel/
|
|
4142
4142
|
* @param {String} integrationId Integration ID
|
|
4143
|
+
* @deprecated
|
|
4143
4144
|
*/},{key:"deleteConversationsMessagingIntegrationsTwitterIntegrationId",value:function deleteConversationsMessagingIntegrationsTwitterIntegrationId(integrationId){// verify the required parameter 'integrationId' is set
|
|
4144
4145
|
if(integrationId===undefined||integrationId===null){throw'Missing the required parameter "integrationId" when calling deleteConversationsMessagingIntegrationsTwitterIntegrationId';}return this.apiClient.callApi('/api/v2/conversations/messaging/integrations/twitter/{integrationId}','DELETE',{'integrationId':integrationId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
4145
4146
|
* Delete a WhatsApp messaging integration
|
|
@@ -4630,20 +4631,22 @@ if(integrationId===undefined||integrationId===null){throw'Missing the required p
|
|
|
4630
4631
|
* @param {Object} opts.expand Expand instructions for the return value.
|
|
4631
4632
|
*/},{key:"getConversationsMessagingIntegrationsOpenIntegrationId",value:function getConversationsMessagingIntegrationsOpenIntegrationId(integrationId,opts){opts=opts||{};// verify the required parameter 'integrationId' is set
|
|
4632
4633
|
if(integrationId===undefined||integrationId===null){throw'Missing the required parameter "integrationId" when calling getConversationsMessagingIntegrationsOpenIntegrationId';}return this.apiClient.callApi('/api/v2/conversations/messaging/integrations/open/{integrationId}','GET',{'integrationId':integrationId},{'expand':opts['expand']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
4633
|
-
* Get a list of Twitter Integrations
|
|
4634
|
-
*
|
|
4634
|
+
* Get a list of Twitter Integrations (Deprecated)
|
|
4635
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-native-x-formerly-twitter-third-party-messaging-channel/
|
|
4635
4636
|
* @param {Object} opts Optional parameters
|
|
4636
4637
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
4637
4638
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
4638
4639
|
* @param {Object} opts.expand Expand instructions for the return value.
|
|
4639
4640
|
* @param {String} opts.supportedContentId Filter integrations returned based on the supported content ID
|
|
4640
4641
|
* @param {String} opts.messagingSettingId Filter integrations returned based on the setting ID
|
|
4642
|
+
* @deprecated
|
|
4641
4643
|
*/},{key:"getConversationsMessagingIntegrationsTwitter",value:function getConversationsMessagingIntegrationsTwitter(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/conversations/messaging/integrations/twitter','GET',{},{'pageSize':opts['pageSize'],'pageNumber':opts['pageNumber'],'expand':opts['expand'],'supportedContent.id':opts['supportedContentId'],'messagingSetting.id':opts['messagingSettingId']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
4642
|
-
* Get a Twitter messaging integration
|
|
4643
|
-
*
|
|
4644
|
+
* Get a Twitter messaging integration (Deprecated)
|
|
4645
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-native-x-formerly-twitter-third-party-messaging-channel/
|
|
4644
4646
|
* @param {String} integrationId Integration ID
|
|
4645
4647
|
* @param {Object} opts Optional parameters
|
|
4646
4648
|
* @param {Object} opts.expand Expand instructions for the return value.
|
|
4649
|
+
* @deprecated
|
|
4647
4650
|
*/},{key:"getConversationsMessagingIntegrationsTwitterIntegrationId",value:function getConversationsMessagingIntegrationsTwitterIntegrationId(integrationId,opts){opts=opts||{};// verify the required parameter 'integrationId' is set
|
|
4648
4651
|
if(integrationId===undefined||integrationId===null){throw'Missing the required parameter "integrationId" when calling getConversationsMessagingIntegrationsTwitterIntegrationId';}return this.apiClient.callApi('/api/v2/conversations/messaging/integrations/twitter/{integrationId}','GET',{'integrationId':integrationId},{'expand':opts['expand']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
4649
4652
|
* Get a list of WhatsApp Integrations
|
|
@@ -5046,9 +5049,10 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
5046
5049
|
if(integrationId===undefined||integrationId===null){throw'Missing the required parameter "integrationId" when calling patchConversationsMessagingIntegrationsOpenIntegrationId';}// verify the required parameter 'body' is set
|
|
5047
5050
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling patchConversationsMessagingIntegrationsOpenIntegrationId';}return this.apiClient.callApi('/api/v2/conversations/messaging/integrations/open/{integrationId}','PATCH',{'integrationId':integrationId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
5048
5051
|
* Update Twitter messaging integration
|
|
5049
|
-
*
|
|
5052
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-native-x-formerly-twitter-third-party-messaging-channel/
|
|
5050
5053
|
* @param {String} integrationId Integration ID
|
|
5051
5054
|
* @param {Object} body TwitterIntegrationRequest
|
|
5055
|
+
* @deprecated
|
|
5052
5056
|
*/},{key:"patchConversationsMessagingIntegrationsTwitterIntegrationId",value:function patchConversationsMessagingIntegrationsTwitterIntegrationId(integrationId,body){// verify the required parameter 'integrationId' is set
|
|
5053
5057
|
if(integrationId===undefined||integrationId===null){throw'Missing the required parameter "integrationId" when calling patchConversationsMessagingIntegrationsTwitterIntegrationId';}// verify the required parameter 'body' is set
|
|
5054
5058
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling patchConversationsMessagingIntegrationsTwitterIntegrationId';}return this.apiClient.callApi('/api/v2/conversations/messaging/integrations/twitter/{integrationId}','PATCH',{'integrationId':integrationId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
@@ -5596,8 +5600,9 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
5596
5600
|
*/},{key:"postConversationsMessagingIntegrationsOpen",value:function postConversationsMessagingIntegrationsOpen(body){// verify the required parameter 'body' is set
|
|
5597
5601
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postConversationsMessagingIntegrationsOpen';}return this.apiClient.callApi('/api/v2/conversations/messaging/integrations/open','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
5598
5602
|
* Create a Twitter Integration
|
|
5599
|
-
*
|
|
5603
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-native-x-formerly-twitter-third-party-messaging-channel/
|
|
5600
5604
|
* @param {Object} body TwitterIntegrationRequest
|
|
5605
|
+
* @deprecated
|
|
5601
5606
|
*/},{key:"postConversationsMessagingIntegrationsTwitter",value:function postConversationsMessagingIntegrationsTwitter(body){// verify the required parameter 'body' is set
|
|
5602
5607
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postConversationsMessagingIntegrationsTwitter';}return this.apiClient.callApi('/api/v2/conversations/messaging/integrations/twitter','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
5603
5608
|
* [This API is deprecated. Use POST /api/v2/conversations/messaging/integrations/whatsapp/embeddedsignup instead] Create a WhatsApp Integration
|
|
@@ -5799,7 +5804,7 @@ if(conversationId===undefined||conversationId===null){throw'Missing the required
|
|
|
5799
5804
|
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']);}}]);return ConversationsApi;}();var DataExtensionsApi=/*#__PURE__*/function(){/**
|
|
5800
5805
|
* DataExtensions service.
|
|
5801
5806
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
5802
|
-
* @version
|
|
5807
|
+
* @version 190.0.0
|
|
5803
5808
|
*/ /**
|
|
5804
5809
|
* Constructs a new DataExtensionsApi.
|
|
5805
5810
|
* @alias module:purecloud-platform-client-v2/api/DataExtensionsApi
|
|
@@ -5820,7 +5825,7 @@ if(coretypeName===undefined||coretypeName===null){throw'Missing the required par
|
|
|
5820
5825
|
*/},{key:"getDataextensionsLimits",value:function getDataextensionsLimits(){return this.apiClient.callApi('/api/v2/dataextensions/limits','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return DataExtensionsApi;}();var DownloadsApi=/*#__PURE__*/function(){/**
|
|
5821
5826
|
* Downloads service.
|
|
5822
5827
|
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
5823
|
-
* @version
|
|
5828
|
+
* @version 190.0.0
|
|
5824
5829
|
*/ /**
|
|
5825
5830
|
* Constructs a new DownloadsApi.
|
|
5826
5831
|
* @alias module:purecloud-platform-client-v2/api/DownloadsApi
|
|
@@ -5839,7 +5844,7 @@ if(coretypeName===undefined||coretypeName===null){throw'Missing the required par
|
|
|
5839
5844
|
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']);}}]);return DownloadsApi;}();var EmailsApi=/*#__PURE__*/function(){/**
|
|
5840
5845
|
* Emails service.
|
|
5841
5846
|
* @module purecloud-platform-client-v2/api/EmailsApi
|
|
5842
|
-
* @version
|
|
5847
|
+
* @version 190.0.0
|
|
5843
5848
|
*/ /**
|
|
5844
5849
|
* Constructs a new EmailsApi.
|
|
5845
5850
|
* @alias module:purecloud-platform-client-v2/api/EmailsApi
|
|
@@ -5857,7 +5862,7 @@ if(downloadId===undefined||downloadId===null){throw'Missing the required paramet
|
|
|
5857
5862
|
*/},{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']);}}]);return EmailsApi;}();var EventsApi=/*#__PURE__*/function(){/**
|
|
5858
5863
|
* Events service.
|
|
5859
5864
|
* @module purecloud-platform-client-v2/api/EventsApi
|
|
5860
|
-
* @version
|
|
5865
|
+
* @version 190.0.0
|
|
5861
5866
|
*/ /**
|
|
5862
5867
|
* Constructs a new EventsApi.
|
|
5863
5868
|
* @alias module:purecloud-platform-client-v2/api/EventsApi
|
|
@@ -5882,7 +5887,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
5882
5887
|
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']);}}]);return EventsApi;}();var ExternalContactsApi=/*#__PURE__*/function(){/**
|
|
5883
5888
|
* ExternalContacts service.
|
|
5884
5889
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
5885
|
-
* @version
|
|
5890
|
+
* @version 190.0.0
|
|
5886
5891
|
*/ /**
|
|
5887
5892
|
* Constructs a new ExternalContactsApi.
|
|
5888
5893
|
* @alias module:purecloud-platform-client-v2/api/ExternalContactsApi
|
|
@@ -6337,7 +6342,7 @@ if(relationshipId===undefined||relationshipId===null){throw'Missing the required
|
|
|
6337
6342
|
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']);}}]);return ExternalContactsApi;}();var FaxApi=/*#__PURE__*/function(){/**
|
|
6338
6343
|
* Fax service.
|
|
6339
6344
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
6340
|
-
* @version
|
|
6345
|
+
* @version 190.0.0
|
|
6341
6346
|
*/ /**
|
|
6342
6347
|
* Constructs a new FaxApi.
|
|
6343
6348
|
* @alias module:purecloud-platform-client-v2/api/FaxApi
|
|
@@ -6378,7 +6383,7 @@ if(documentId===undefined||documentId===null){throw'Missing the required paramet
|
|
|
6378
6383
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putFaxDocument';}return this.apiClient.callApi('/api/v2/fax/documents/{documentId}','PUT',{'documentId':documentId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return FaxApi;}();var FlowsApi=/*#__PURE__*/function(){/**
|
|
6379
6384
|
* Flows service.
|
|
6380
6385
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
6381
|
-
* @version
|
|
6386
|
+
* @version 190.0.0
|
|
6382
6387
|
*/ /**
|
|
6383
6388
|
* Constructs a new FlowsApi.
|
|
6384
6389
|
* @alias module:purecloud-platform-client-v2/api/FlowsApi
|
|
@@ -6427,7 +6432,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
6427
6432
|
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']);}}]);return FlowsApi;}();var GamificationApi=/*#__PURE__*/function(){/**
|
|
6428
6433
|
* Gamification service.
|
|
6429
6434
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
6430
|
-
* @version
|
|
6435
|
+
* @version 190.0.0
|
|
6431
6436
|
*/ /**
|
|
6432
6437
|
* Constructs a new GamificationApi.
|
|
6433
6438
|
* @alias module:purecloud-platform-client-v2/api/GamificationApi
|
|
@@ -6967,7 +6972,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
6967
6972
|
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']);}}]);return GamificationApi;}();var GeneralDataProtectionRegulationApi=/*#__PURE__*/function(){/**
|
|
6968
6973
|
* GeneralDataProtectionRegulation service.
|
|
6969
6974
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
6970
|
-
* @version
|
|
6975
|
+
* @version 190.0.0
|
|
6971
6976
|
*/ /**
|
|
6972
6977
|
* Constructs a new GeneralDataProtectionRegulationApi.
|
|
6973
6978
|
* @alias module:purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
@@ -7002,7 +7007,7 @@ if(searchValue===undefined||searchValue===null){throw'Missing the required param
|
|
|
7002
7007
|
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']);}}]);return GeneralDataProtectionRegulationApi;}();var GeolocationApi=/*#__PURE__*/function(){/**
|
|
7003
7008
|
* Geolocation service.
|
|
7004
7009
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
7005
|
-
* @version
|
|
7010
|
+
* @version 190.0.0
|
|
7006
7011
|
*/ /**
|
|
7007
7012
|
* Constructs a new GeolocationApi.
|
|
7008
7013
|
* @alias module:purecloud-platform-client-v2/api/GeolocationApi
|
|
@@ -7036,7 +7041,7 @@ if(clientId===undefined||clientId===null){throw'Missing the required parameter "
|
|
|
7036
7041
|
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']);}}]);return GeolocationApi;}();var GreetingsApi=/*#__PURE__*/function(){/**
|
|
7037
7042
|
* Greetings service.
|
|
7038
7043
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
7039
|
-
* @version
|
|
7044
|
+
* @version 190.0.0
|
|
7040
7045
|
*/ /**
|
|
7041
7046
|
* Constructs a new GreetingsApi.
|
|
7042
7047
|
* @alias module:purecloud-platform-client-v2/api/GreetingsApi
|
|
@@ -7143,7 +7148,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
7143
7148
|
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']);}}]);return GreetingsApi;}();var GroupsApi=/*#__PURE__*/function(){/**
|
|
7144
7149
|
* Groups service.
|
|
7145
7150
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
7146
|
-
* @version
|
|
7151
|
+
* @version 190.0.0
|
|
7147
7152
|
*/ /**
|
|
7148
7153
|
* Constructs a new GroupsApi.
|
|
7149
7154
|
* @alias module:purecloud-platform-client-v2/api/GroupsApi
|
|
@@ -7276,7 +7281,7 @@ if(groupId===undefined||groupId===null){throw'Missing the required parameter "gr
|
|
|
7276
7281
|
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']);}}]);return GroupsApi;}();var IdentityProviderApi=/*#__PURE__*/function(){/**
|
|
7277
7282
|
* IdentityProvider service.
|
|
7278
7283
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
7279
|
-
* @version
|
|
7284
|
+
* @version 190.0.0
|
|
7280
7285
|
*/ /**
|
|
7281
7286
|
* Constructs a new IdentityProviderApi.
|
|
7282
7287
|
* @alias module:purecloud-platform-client-v2/api/IdentityProviderApi
|
|
@@ -7432,7 +7437,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
7432
7437
|
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']);}}]);return IdentityProviderApi;}();var InfrastructureAsCodeApi=/*#__PURE__*/function(){/**
|
|
7433
7438
|
* InfrastructureAsCode service.
|
|
7434
7439
|
* @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
7435
|
-
* @version
|
|
7440
|
+
* @version 190.0.0
|
|
7436
7441
|
*/ /**
|
|
7437
7442
|
* Constructs a new InfrastructureAsCodeApi.
|
|
7438
7443
|
* @alias module:purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
@@ -7486,7 +7491,7 @@ if(jobId===undefined||jobId===null){throw'Missing the required parameter "jobId"
|
|
|
7486
7491
|
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']);}}]);return InfrastructureAsCodeApi;}();var IntegrationsApi=/*#__PURE__*/function(){/**
|
|
7487
7492
|
* Integrations service.
|
|
7488
7493
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
7489
|
-
* @version
|
|
7494
|
+
* @version 190.0.0
|
|
7490
7495
|
*/ /**
|
|
7491
7496
|
* Constructs a new IntegrationsApi.
|
|
7492
7497
|
* @alias module:purecloud-platform-client-v2/api/IntegrationsApi
|
|
@@ -8096,7 +8101,7 @@ if(ucIntegrationId===undefined||ucIntegrationId===null){throw'Missing the requir
|
|
|
8096
8101
|
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']);}}]);return IntegrationsApi;}();var JourneyApi=/*#__PURE__*/function(){/**
|
|
8097
8102
|
* Journey service.
|
|
8098
8103
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
8099
|
-
* @version
|
|
8104
|
+
* @version 190.0.0
|
|
8100
8105
|
*/ /**
|
|
8101
8106
|
* Constructs a new JourneyApi.
|
|
8102
8107
|
* @alias module:purecloud-platform-client-v2/api/JourneyApi
|
|
@@ -8311,10 +8316,48 @@ if(viewId===undefined||viewId===null){throw'Missing the required parameter "view
|
|
|
8311
8316
|
*/},{key:"getJourneyViewVersion",value:function getJourneyViewVersion(viewId,versionId){// verify the required parameter 'viewId' is set
|
|
8312
8317
|
if(viewId===undefined||viewId===null){throw'Missing the required parameter "viewId" when calling getJourneyViewVersion';}// verify the required parameter 'versionId' is set
|
|
8313
8318
|
if(versionId===undefined||versionId===null){throw'Missing the required parameter "versionId" when calling getJourneyViewVersion';}return this.apiClient.callApi('/api/v2/journey/views/{viewId}/versions/{versionId}','GET',{'viewId':viewId,'versionId':versionId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
8319
|
+
* Get the job for a journey view version.
|
|
8320
|
+
* used for long descriptions
|
|
8321
|
+
* @param {String} viewId Journey View Id
|
|
8322
|
+
* @param {String} journeyVersionId Journey View Version
|
|
8323
|
+
* @param {String} jobId JobId
|
|
8324
|
+
* getJourneyViewVersionJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
8325
|
+
*/},{key:"getJourneyViewVersionJob",value:function getJourneyViewVersionJob(viewId,journeyVersionId,jobId){// verify the required parameter 'viewId' is set
|
|
8326
|
+
if(viewId===undefined||viewId===null){throw'Missing the required parameter "viewId" when calling getJourneyViewVersionJob';}// verify the required parameter 'journeyVersionId' is set
|
|
8327
|
+
if(journeyVersionId===undefined||journeyVersionId===null){throw'Missing the required parameter "journeyVersionId" when calling getJourneyViewVersionJob';}// verify the required parameter 'jobId' is set
|
|
8328
|
+
if(jobId===undefined||jobId===null){throw'Missing the required parameter "jobId" when calling getJourneyViewVersionJob';}return this.apiClient.callApi('/api/v2/journey/views/{viewId}/versions/{journeyVersionId}/jobs/{jobId}','GET',{'viewId':viewId,'journeyVersionId':journeyVersionId,'jobId':jobId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
8329
|
+
* Get the result of a job for a journey view version.
|
|
8330
|
+
* used for long descriptions
|
|
8331
|
+
* @param {String} viewId JourneyViewResult id
|
|
8332
|
+
* @param {String} journeyViewVersion Journey View Version
|
|
8333
|
+
* @param {String} jobId Id of the executing job
|
|
8334
|
+
* getJourneyViewVersionJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
8335
|
+
*/},{key:"getJourneyViewVersionJobResults",value:function getJourneyViewVersionJobResults(viewId,journeyViewVersion,jobId){// verify the required parameter 'viewId' is set
|
|
8336
|
+
if(viewId===undefined||viewId===null){throw'Missing the required parameter "viewId" when calling getJourneyViewVersionJobResults';}// verify the required parameter 'journeyViewVersion' is set
|
|
8337
|
+
if(journeyViewVersion===undefined||journeyViewVersion===null){throw'Missing the required parameter "journeyViewVersion" when calling getJourneyViewVersionJobResults';}// verify the required parameter 'jobId' is set
|
|
8338
|
+
if(jobId===undefined||jobId===null){throw'Missing the required parameter "jobId" when calling getJourneyViewVersionJobResults';}return this.apiClient.callApi('/api/v2/journey/views/{viewId}/versions/{journeyViewVersion}/jobs/{jobId}/results','GET',{'viewId':viewId,'journeyViewVersion':journeyViewVersion,'jobId':jobId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
8339
|
+
* Get the latest job of a journey view version.
|
|
8340
|
+
* used for long descriptions
|
|
8341
|
+
* @param {String} viewId Journey View Id
|
|
8342
|
+
* @param {String} journeyVersionId Journey View Version
|
|
8343
|
+
* getJourneyViewVersionJobsLatest is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
8344
|
+
*/},{key:"getJourneyViewVersionJobsLatest",value:function getJourneyViewVersionJobsLatest(viewId,journeyVersionId){// verify the required parameter 'viewId' is set
|
|
8345
|
+
if(viewId===undefined||viewId===null){throw'Missing the required parameter "viewId" when calling getJourneyViewVersionJobsLatest';}// verify the required parameter 'journeyVersionId' is set
|
|
8346
|
+
if(journeyVersionId===undefined||journeyVersionId===null){throw'Missing the required parameter "journeyVersionId" when calling getJourneyViewVersionJobsLatest';}return this.apiClient.callApi('/api/v2/journey/views/{viewId}/versions/{journeyVersionId}/jobs/latest','GET',{'viewId':viewId,'journeyVersionId':journeyVersionId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
8314
8347
|
* Get a list of Journey Views
|
|
8315
8348
|
*
|
|
8316
8349
|
* getJourneyViews is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
8317
8350
|
*/},{key:"getJourneyViews",value:function getJourneyViews(){return this.apiClient.callApi('/api/v2/journey/views','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
8351
|
+
* Get an Event Definition
|
|
8352
|
+
*
|
|
8353
|
+
* @param {String} eventDefinitionId Event Definition ID
|
|
8354
|
+
* getJourneyViewsEventdefinition is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
8355
|
+
*/},{key:"getJourneyViewsEventdefinition",value:function getJourneyViewsEventdefinition(eventDefinitionId){// verify the required parameter 'eventDefinitionId' is set
|
|
8356
|
+
if(eventDefinitionId===undefined||eventDefinitionId===null){throw'Missing the required parameter "eventDefinitionId" when calling getJourneyViewsEventdefinition';}return this.apiClient.callApi('/api/v2/journey/views/eventdefinitions/{eventDefinitionId}','GET',{'eventDefinitionId':eventDefinitionId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
8357
|
+
* Get a list of Event Definitions
|
|
8358
|
+
*
|
|
8359
|
+
* getJourneyViewsEventdefinitions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
8360
|
+
*/},{key:"getJourneyViewsEventdefinitions",value:function getJourneyViewsEventdefinitions(){return this.apiClient.callApi('/api/v2/journey/views/eventdefinitions','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
8318
8361
|
* Update single action map.
|
|
8319
8362
|
*
|
|
8320
8363
|
* @param {String} actionMapId ID of the action map.
|
|
@@ -8417,6 +8460,14 @@ if(deploymentId===undefined||deploymentId===null){throw'Missing the required par
|
|
|
8417
8460
|
* @param {Object} opts Optional parameters
|
|
8418
8461
|
* @param {Object} opts.body
|
|
8419
8462
|
*/},{key:"postJourneySegments",value:function postJourneySegments(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/journey/segments','POST',{},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
8463
|
+
* Submit a job request for a journey view version.
|
|
8464
|
+
* used for long descriptions
|
|
8465
|
+
* @param {String} viewId Journey View Id
|
|
8466
|
+
* @param {String} journeyVersionId Journey View Version
|
|
8467
|
+
* postJourneyViewVersionJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
8468
|
+
*/},{key:"postJourneyViewVersionJobs",value:function postJourneyViewVersionJobs(viewId,journeyVersionId){// verify the required parameter 'viewId' is set
|
|
8469
|
+
if(viewId===undefined||viewId===null){throw'Missing the required parameter "viewId" when calling postJourneyViewVersionJobs';}// verify the required parameter 'journeyVersionId' is set
|
|
8470
|
+
if(journeyVersionId===undefined||journeyVersionId===null){throw'Missing the required parameter "journeyVersionId" when calling postJourneyViewVersionJobs';}return this.apiClient.callApi('/api/v2/journey/views/{viewId}/versions/{journeyVersionId}/jobs','POST',{'viewId':viewId,'journeyVersionId':journeyVersionId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
8420
8471
|
* Update a Journey View by ID
|
|
8421
8472
|
* creates a new version
|
|
8422
8473
|
* @param {String} viewId viewId
|
|
@@ -8430,10 +8481,16 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
8430
8481
|
* @param {Object} body JourneyView
|
|
8431
8482
|
* postJourneyViews is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
8432
8483
|
*/},{key:"postJourneyViews",value:function postJourneyViews(body){// verify the required parameter 'body' is set
|
|
8433
|
-
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postJourneyViews';}return this.apiClient.callApi('/api/v2/journey/views','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}
|
|
8484
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postJourneyViews';}return this.apiClient.callApi('/api/v2/journey/views','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
8485
|
+
* Validate whether an encoding exist for a label/value combination.
|
|
8486
|
+
* True indicates a valid encoding
|
|
8487
|
+
* @param {Object} opts Optional parameters
|
|
8488
|
+
* @param {Array.<Object>} opts.body
|
|
8489
|
+
* postJourneyViewsEncodingsValidate is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
8490
|
+
*/},{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']);}}]);return JourneyApi;}();var KnowledgeApi=/*#__PURE__*/function(){/**
|
|
8434
8491
|
* Knowledge service.
|
|
8435
8492
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
8436
|
-
* @version
|
|
8493
|
+
* @version 190.0.0
|
|
8437
8494
|
*/ /**
|
|
8438
8495
|
* Constructs a new KnowledgeApi.
|
|
8439
8496
|
* @alias module:purecloud-platform-client-v2/api/KnowledgeApi
|
|
@@ -9345,7 +9402,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
9345
9402
|
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']);}}]);return KnowledgeApi;}();var LanguageUnderstandingApi=/*#__PURE__*/function(){/**
|
|
9346
9403
|
* LanguageUnderstanding service.
|
|
9347
9404
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
9348
|
-
* @version
|
|
9405
|
+
* @version 190.0.0
|
|
9349
9406
|
*/ /**
|
|
9350
9407
|
* Constructs a new LanguageUnderstandingApi.
|
|
9351
9408
|
* @alias module:purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
@@ -9601,7 +9658,7 @@ if(domainVersionId===undefined||domainVersionId===null){throw'Missing the requir
|
|
|
9601
9658
|
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']);}}]);return LanguageUnderstandingApi;}();var LanguagesApi=/*#__PURE__*/function(){/**
|
|
9602
9659
|
* Languages service.
|
|
9603
9660
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
9604
|
-
* @version
|
|
9661
|
+
* @version 190.0.0
|
|
9605
9662
|
*/ /**
|
|
9606
9663
|
* Constructs a new LanguagesApi.
|
|
9607
9664
|
* @alias module:purecloud-platform-client-v2/api/LanguagesApi
|
|
@@ -9656,7 +9713,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
9656
9713
|
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']);}}]);return LanguagesApi;}();var LearningApi=/*#__PURE__*/function(){/**
|
|
9657
9714
|
* Learning service.
|
|
9658
9715
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
9659
|
-
* @version
|
|
9716
|
+
* @version 190.0.0
|
|
9660
9717
|
*/ /**
|
|
9661
9718
|
* Constructs a new LearningApi.
|
|
9662
9719
|
* @alias module:purecloud-platform-client-v2/api/LearningApi
|
|
@@ -9886,7 +9943,7 @@ if(moduleId===undefined||moduleId===null){throw'Missing the required parameter "
|
|
|
9886
9943
|
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']);}}]);return LearningApi;}();var LicenseApi=/*#__PURE__*/function(){/**
|
|
9887
9944
|
* License service.
|
|
9888
9945
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
9889
|
-
* @version
|
|
9946
|
+
* @version 190.0.0
|
|
9890
9947
|
*/ /**
|
|
9891
9948
|
* Constructs a new LicenseApi.
|
|
9892
9949
|
* @alias module:purecloud-platform-client-v2/api/LicenseApi
|
|
@@ -9940,7 +9997,7 @@ if(featureName===undefined||featureName===null){throw'Missing the required param
|
|
|
9940
9997
|
*/},{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']);}}]);return LicenseApi;}();var LocationsApi=/*#__PURE__*/function(){/**
|
|
9941
9998
|
* Locations service.
|
|
9942
9999
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
9943
|
-
* @version
|
|
10000
|
+
* @version 190.0.0
|
|
9944
10001
|
*/ /**
|
|
9945
10002
|
* Constructs a new LocationsApi.
|
|
9946
10003
|
* @alias module:purecloud-platform-client-v2/api/LocationsApi
|
|
@@ -9999,7 +10056,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
9999
10056
|
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']);}}]);return LocationsApi;}();var LogCaptureApi=/*#__PURE__*/function(){/**
|
|
10000
10057
|
* LogCapture service.
|
|
10001
10058
|
* @module purecloud-platform-client-v2/api/LogCaptureApi
|
|
10002
|
-
* @version
|
|
10059
|
+
* @version 190.0.0
|
|
10003
10060
|
*/ /**
|
|
10004
10061
|
* Constructs a new LogCaptureApi.
|
|
10005
10062
|
* @alias module:purecloud-platform-client-v2/api/LogCaptureApi
|
|
@@ -10049,7 +10106,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
10049
10106
|
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']);}}]);return LogCaptureApi;}();var MessagingApi=/*#__PURE__*/function(){/**
|
|
10050
10107
|
* Messaging service.
|
|
10051
10108
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
10052
|
-
* @version
|
|
10109
|
+
* @version 190.0.0
|
|
10053
10110
|
*/ /**
|
|
10054
10111
|
* Constructs a new MessagingApi.
|
|
10055
10112
|
* @alias module:purecloud-platform-client-v2/api/MessagingApi
|
|
@@ -10139,7 +10196,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
10139
10196
|
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']);}}]);return MessagingApi;}();var MobileDevicesApi=/*#__PURE__*/function(){/**
|
|
10140
10197
|
* MobileDevices service.
|
|
10141
10198
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
10142
|
-
* @version
|
|
10199
|
+
* @version 190.0.0
|
|
10143
10200
|
*/ /**
|
|
10144
10201
|
* Constructs a new MobileDevicesApi.
|
|
10145
10202
|
* @alias module:purecloud-platform-client-v2/api/MobileDevicesApi
|
|
@@ -10178,7 +10235,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
10178
10235
|
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']);}}]);return MobileDevicesApi;}();var NotificationsApi=/*#__PURE__*/function(){/**
|
|
10179
10236
|
* Notifications service.
|
|
10180
10237
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
10181
|
-
* @version
|
|
10238
|
+
* @version 190.0.0
|
|
10182
10239
|
*/ /**
|
|
10183
10240
|
* Constructs a new NotificationsApi.
|
|
10184
10241
|
* @alias module:purecloud-platform-client-v2/api/NotificationsApi
|
|
@@ -10235,7 +10292,7 @@ if(channelId===undefined||channelId===null){throw'Missing the required parameter
|
|
|
10235
10292
|
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']);}}]);return NotificationsApi;}();var OAuthApi=/*#__PURE__*/function(){/**
|
|
10236
10293
|
* OAuth service.
|
|
10237
10294
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
10238
|
-
* @version
|
|
10295
|
+
* @version 190.0.0
|
|
10239
10296
|
*/ /**
|
|
10240
10297
|
* Constructs a new OAuthApi.
|
|
10241
10298
|
* @alias module:purecloud-platform-client-v2/api/OAuthApi
|
|
@@ -10320,7 +10377,7 @@ if(clientId===undefined||clientId===null){throw'Missing the required parameter "
|
|
|
10320
10377
|
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']);}}]);return OAuthApi;}();var ObjectsApi=/*#__PURE__*/function(){/**
|
|
10321
10378
|
* Objects service.
|
|
10322
10379
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
10323
|
-
* @version
|
|
10380
|
+
* @version 190.0.0
|
|
10324
10381
|
*/ /**
|
|
10325
10382
|
* Constructs a new ObjectsApi.
|
|
10326
10383
|
* @alias module:purecloud-platform-client-v2/api/ObjectsApi
|
|
@@ -10391,7 +10448,7 @@ if(divisionId===undefined||divisionId===null){throw'Missing the required paramet
|
|
|
10391
10448
|
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']);}}]);return ObjectsApi;}();var OperationalEventsApi=/*#__PURE__*/function(){/**
|
|
10392
10449
|
* OperationalEvents service.
|
|
10393
10450
|
* @module purecloud-platform-client-v2/api/OperationalEventsApi
|
|
10394
|
-
* @version
|
|
10451
|
+
* @version 190.0.0
|
|
10395
10452
|
*/ /**
|
|
10396
10453
|
* Constructs a new OperationalEventsApi.
|
|
10397
10454
|
* @alias module:purecloud-platform-client-v2/api/OperationalEventsApi
|
|
@@ -10409,7 +10466,7 @@ if(eventDefinitionId===undefined||eventDefinitionId===null){throw'Missing the re
|
|
|
10409
10466
|
*/},{key:"getUsageEventsDefinitions",value:function getUsageEventsDefinitions(){return this.apiClient.callApi('/api/v2/usage/events/definitions','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return OperationalEventsApi;}();var OrganizationApi=/*#__PURE__*/function(){/**
|
|
10410
10467
|
* Organization service.
|
|
10411
10468
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
10412
|
-
* @version
|
|
10469
|
+
* @version 190.0.0
|
|
10413
10470
|
*/ /**
|
|
10414
10471
|
* Constructs a new OrganizationApi.
|
|
10415
10472
|
* @alias module:purecloud-platform-client-v2/api/OrganizationApi
|
|
@@ -10448,7 +10505,7 @@ if(requestId===undefined||requestId===null){throw'Missing the required parameter
|
|
|
10448
10505
|
* @param {Number} opts.pageSize Page Size (default to 25)
|
|
10449
10506
|
* @param {Array.<String>} opts.expand Which fields, if any, to expand.
|
|
10450
10507
|
*/},{key:"getOrganizationsLimitsChangerequests",value:function getOrganizationsLimitsChangerequests(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/organizations/limits/changerequests','GET',{},{'after':opts['after'],'before':opts['before'],'status':opts['status'],'pageSize':opts['pageSize'],'expand':this.apiClient.buildCollectionParam(opts['expand'],'multi')},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
10451
|
-
* Get
|
|
10508
|
+
* Get limit documentation
|
|
10452
10509
|
*
|
|
10453
10510
|
*/},{key:"getOrganizationsLimitsDocs",value:function getOrganizationsLimitsDocs(){return this.apiClient.callApi('/api/v2/organizations/limits/docs','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
10454
10511
|
* Get the effective limits in a namespace for an organization
|
|
@@ -10511,7 +10568,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
10511
10568
|
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']);}}]);return OrganizationApi;}();var OrganizationAuthorizationApi=/*#__PURE__*/function(){/**
|
|
10512
10569
|
* OrganizationAuthorization service.
|
|
10513
10570
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
10514
|
-
* @version
|
|
10571
|
+
* @version 190.0.0
|
|
10515
10572
|
*/ /**
|
|
10516
10573
|
* Constructs a new OrganizationAuthorizationApi.
|
|
10517
10574
|
* @alias module:purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
@@ -10834,7 +10891,7 @@ if(trustorOrgId===undefined||trustorOrgId===null){throw'Missing the required par
|
|
|
10834
10891
|
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']);}}]);return OrganizationAuthorizationApi;}();var OutboundApi=/*#__PURE__*/function(){/**
|
|
10835
10892
|
* Outbound service.
|
|
10836
10893
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
10837
|
-
* @version
|
|
10894
|
+
* @version 190.0.0
|
|
10838
10895
|
*/ /**
|
|
10839
10896
|
* Constructs a new OutboundApi.
|
|
10840
10897
|
* @alias module:purecloud-platform-client-v2/api/OutboundApi
|
|
@@ -11872,7 +11929,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
11872
11929
|
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']);}}]);return OutboundApi;}();var PresenceApi=/*#__PURE__*/function(){/**
|
|
11873
11930
|
* Presence service.
|
|
11874
11931
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
11875
|
-
* @version
|
|
11932
|
+
* @version 190.0.0
|
|
11876
11933
|
*/ /**
|
|
11877
11934
|
* Constructs a new PresenceApi.
|
|
11878
11935
|
* @alias module:purecloud-platform-client-v2/api/PresenceApi
|
|
@@ -12045,7 +12102,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
12045
12102
|
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']);}}]);return PresenceApi;}();var ProcessAutomationApi=/*#__PURE__*/function(){/**
|
|
12046
12103
|
* ProcessAutomation service.
|
|
12047
12104
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
12048
|
-
* @version
|
|
12105
|
+
* @version 190.0.0
|
|
12049
12106
|
*/ /**
|
|
12050
12107
|
* Constructs a new ProcessAutomationApi.
|
|
12051
12108
|
* @alias module:purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
@@ -12108,7 +12165,7 @@ if(triggerId===undefined||triggerId===null){throw'Missing the required parameter
|
|
|
12108
12165
|
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']);}}]);return ProcessAutomationApi;}();var QualityApi=/*#__PURE__*/function(){/**
|
|
12109
12166
|
* Quality service.
|
|
12110
12167
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
12111
|
-
* @version
|
|
12168
|
+
* @version 190.0.0
|
|
12112
12169
|
*/ /**
|
|
12113
12170
|
* Constructs a new QualityApi.
|
|
12114
12171
|
* @alias module:purecloud-platform-client-v2/api/QualityApi
|
|
@@ -12579,7 +12636,7 @@ if(customerSurveyUrl===undefined||customerSurveyUrl===null){throw'Missing the re
|
|
|
12579
12636
|
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']);}}]);return QualityApi;}();var RecordingApi=/*#__PURE__*/function(){/**
|
|
12580
12637
|
* Recording service.
|
|
12581
12638
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
12582
|
-
* @version
|
|
12639
|
+
* @version 190.0.0
|
|
12583
12640
|
*/ /**
|
|
12584
12641
|
* Constructs a new RecordingApi.
|
|
12585
12642
|
* @alias module:purecloud-platform-client-v2/api/RecordingApi
|
|
@@ -12823,6 +12880,10 @@ if(retentionThresholdDays===undefined||retentionThresholdDays===null){throw'Miss
|
|
|
12823
12880
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
12824
12881
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
12825
12882
|
*/},{key:"getRecordingsScreensessions",value:function getRecordingsScreensessions(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/recordings/screensessions','GET',{},{'pageSize':opts['pageSize'],'pageNumber':opts['pageNumber']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
12883
|
+
* Retrieves an object containing the total number of concurrent active screen recordings
|
|
12884
|
+
*
|
|
12885
|
+
* getRecordingsScreensessionsDetails is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
12886
|
+
*/},{key:"getRecordingsScreensessionsDetails",value:function getRecordingsScreensessionsDetails(){return this.apiClient.callApi('/api/v2/recordings/screensessions/details','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
12826
12887
|
* Patch a media retention policy
|
|
12827
12888
|
*
|
|
12828
12889
|
* @param {String} policyId Policy ID
|
|
@@ -12986,7 +13047,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
12986
13047
|
*/},{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']);}}]);return RecordingApi;}();var ResponseManagementApi=/*#__PURE__*/function(){/**
|
|
12987
13048
|
* ResponseManagement service.
|
|
12988
13049
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
12989
|
-
* @version
|
|
13050
|
+
* @version 190.0.0
|
|
12990
13051
|
*/ /**
|
|
12991
13052
|
* Constructs a new ResponseManagementApi.
|
|
12992
13053
|
* @alias module:purecloud-platform-client-v2/api/ResponseManagementApi
|
|
@@ -13102,7 +13163,7 @@ if(responseAssetId===undefined||responseAssetId===null){throw'Missing the requir
|
|
|
13102
13163
|
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']);}}]);return ResponseManagementApi;}();var RoutingApi=/*#__PURE__*/function(){/**
|
|
13103
13164
|
* Routing service.
|
|
13104
13165
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
13105
|
-
* @version
|
|
13166
|
+
* @version 190.0.0
|
|
13106
13167
|
*/ /**
|
|
13107
13168
|
* Constructs a new RoutingApi.
|
|
13108
13169
|
* @alias module:purecloud-platform-client-v2/api/RoutingApi
|
|
@@ -13456,12 +13517,13 @@ if(queueId===undefined||queueId===null){throw'Missing the required parameter "qu
|
|
|
13456
13517
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
13457
13518
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
13458
13519
|
* @param {Object} opts.sortOrder Note: results are sorted by name. (default to asc)
|
|
13459
|
-
* @param {String} opts.name
|
|
13460
|
-
* @param {Array.<String>} opts.id
|
|
13461
|
-
* @param {Array.<String>} opts.divisionId
|
|
13462
|
-
* @param {Array.<String>} opts.peerId
|
|
13463
|
-
* @param {
|
|
13464
|
-
|
|
13520
|
+
* @param {String} opts.name Include only queues with the given name (leading and trailing asterisks allowed)
|
|
13521
|
+
* @param {Array.<String>} opts.id Include only queues with the specified ID(s)
|
|
13522
|
+
* @param {Array.<String>} opts.divisionId Include only queues in the specified division ID(s)
|
|
13523
|
+
* @param {Array.<String>} opts.peerId Include only queues with the specified peer ID(s)
|
|
13524
|
+
* @param {String} opts.cannedResponseLibraryId Include only queues explicitly associated with the specified canned response library ID
|
|
13525
|
+
* @param {Boolean} opts.hasPeer Include only queues with a peer ID
|
|
13526
|
+
*/},{key:"getRoutingQueues",value:function getRoutingQueues(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/routing/queues','GET',{},{'pageNumber':opts['pageNumber'],'pageSize':opts['pageSize'],'sortOrder':opts['sortOrder'],'name':opts['name'],'id':this.apiClient.buildCollectionParam(opts['id'],'multi'),'divisionId':this.apiClient.buildCollectionParam(opts['divisionId'],'multi'),'peerId':this.apiClient.buildCollectionParam(opts['peerId'],'multi'),'cannedResponseLibraryId':opts['cannedResponseLibraryId'],'hasPeer':opts['hasPeer']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
13465
13527
|
* Get a paged listing of simplified queue objects, filterable by name, queue ID(s), or division ID(s).
|
|
13466
13528
|
*
|
|
13467
13529
|
* @param {Object} opts Optional parameters
|
|
@@ -14070,7 +14132,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
14070
14132
|
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']);}}]);return RoutingApi;}();var SCIMApi=/*#__PURE__*/function(){/**
|
|
14071
14133
|
* SCIM service.
|
|
14072
14134
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
14073
|
-
* @version
|
|
14135
|
+
* @version 190.0.0
|
|
14074
14136
|
*/ /**
|
|
14075
14137
|
* Constructs a new SCIMApi.
|
|
14076
14138
|
* @alias module:purecloud-platform-client-v2/api/SCIMApi
|
|
@@ -14295,7 +14357,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
14295
14357
|
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']);}}]);return SCIMApi;}();var ScreenRecordingApi=/*#__PURE__*/function(){/**
|
|
14296
14358
|
* ScreenRecording service.
|
|
14297
14359
|
* @module purecloud-platform-client-v2/api/ScreenRecordingApi
|
|
14298
|
-
* @version
|
|
14360
|
+
* @version 190.0.0
|
|
14299
14361
|
*/ /**
|
|
14300
14362
|
* Constructs a new ScreenRecordingApi.
|
|
14301
14363
|
* @alias module:purecloud-platform-client-v2/api/ScreenRecordingApi
|
|
@@ -14310,7 +14372,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
14310
14372
|
*/_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']);}}]);return ScreenRecordingApi;}();var ScriptsApi=/*#__PURE__*/function(){/**
|
|
14311
14373
|
* Scripts service.
|
|
14312
14374
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
14313
|
-
* @version
|
|
14375
|
+
* @version 190.0.0
|
|
14314
14376
|
*/ /**
|
|
14315
14377
|
* Constructs a new ScriptsApi.
|
|
14316
14378
|
* @alias module:purecloud-platform-client-v2/api/ScriptsApi
|
|
@@ -14446,7 +14508,7 @@ if(scriptId===undefined||scriptId===null){throw'Missing the required parameter "
|
|
|
14446
14508
|
*/},{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']);}}]);return ScriptsApi;}();var SearchApi=/*#__PURE__*/function(){/**
|
|
14447
14509
|
* Search service.
|
|
14448
14510
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
14449
|
-
* @version
|
|
14511
|
+
* @version 190.0.0
|
|
14450
14512
|
*/ /**
|
|
14451
14513
|
* Constructs a new SearchApi.
|
|
14452
14514
|
* @alias module:purecloud-platform-client-v2/api/SearchApi
|
|
@@ -14606,7 +14668,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
14606
14668
|
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']);}}]);return SearchApi;}();var SettingsApi=/*#__PURE__*/function(){/**
|
|
14607
14669
|
* Settings service.
|
|
14608
14670
|
* @module purecloud-platform-client-v2/api/SettingsApi
|
|
14609
|
-
* @version
|
|
14671
|
+
* @version 190.0.0
|
|
14610
14672
|
*/ /**
|
|
14611
14673
|
* Constructs a new SettingsApi.
|
|
14612
14674
|
* @alias module:purecloud-platform-client-v2/api/SettingsApi
|
|
@@ -14634,7 +14696,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
14634
14696
|
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']);}}]);return SettingsApi;}();var SpeechTextAnalyticsApi=/*#__PURE__*/function(){/**
|
|
14635
14697
|
* SpeechTextAnalytics service.
|
|
14636
14698
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
14637
|
-
* @version
|
|
14699
|
+
* @version 190.0.0
|
|
14638
14700
|
*/ /**
|
|
14639
14701
|
* Constructs a new SpeechTextAnalyticsApi.
|
|
14640
14702
|
* @alias module:purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
@@ -14878,7 +14940,7 @@ if(topicId===undefined||topicId===null){throw'Missing the required parameter "to
|
|
|
14878
14940
|
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']);}}]);return SpeechTextAnalyticsApi;}();var StationsApi=/*#__PURE__*/function(){/**
|
|
14879
14941
|
* Stations service.
|
|
14880
14942
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
14881
|
-
* @version
|
|
14943
|
+
* @version 190.0.0
|
|
14882
14944
|
*/ /**
|
|
14883
14945
|
* Constructs a new StationsApi.
|
|
14884
14946
|
* @alias module:purecloud-platform-client-v2/api/StationsApi
|
|
@@ -14910,7 +14972,7 @@ if(stationId===undefined||stationId===null){throw'Missing the required parameter
|
|
|
14910
14972
|
*/},{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']);}}]);return StationsApi;}();var SuggestApi=/*#__PURE__*/function(){/**
|
|
14911
14973
|
* Suggest service.
|
|
14912
14974
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
14913
|
-
* @version
|
|
14975
|
+
* @version 190.0.0
|
|
14914
14976
|
*/ /**
|
|
14915
14977
|
* Constructs a new SuggestApi.
|
|
14916
14978
|
* @alias module:purecloud-platform-client-v2/api/SuggestApi
|
|
@@ -14950,7 +15012,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
14950
15012
|
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']);}}]);return SuggestApi;}();var TaskManagementApi=/*#__PURE__*/function(){/**
|
|
14951
15013
|
* TaskManagement service.
|
|
14952
15014
|
* @module purecloud-platform-client-v2/api/TaskManagementApi
|
|
14953
|
-
* @version
|
|
15015
|
+
* @version 190.0.0
|
|
14954
15016
|
*/ /**
|
|
14955
15017
|
* Constructs a new TaskManagementApi.
|
|
14956
15018
|
* @alias module:purecloud-platform-client-v2/api/TaskManagementApi
|
|
@@ -15298,7 +15360,7 @@ if(schemaId===undefined||schemaId===null){throw'Missing the required parameter "
|
|
|
15298
15360
|
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']);}}]);return TaskManagementApi;}();var TeamsApi=/*#__PURE__*/function(){/**
|
|
15299
15361
|
* Teams service.
|
|
15300
15362
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
15301
|
-
* @version
|
|
15363
|
+
* @version 190.0.0
|
|
15302
15364
|
*/ /**
|
|
15303
15365
|
* Constructs a new TeamsApi.
|
|
15304
15366
|
* @alias module:purecloud-platform-client-v2/api/TeamsApi
|
|
@@ -15377,7 +15439,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
15377
15439
|
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']);}}]);return TeamsApi;}();var TelephonyApi=/*#__PURE__*/function(){/**
|
|
15378
15440
|
* Telephony service.
|
|
15379
15441
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
15380
|
-
* @version
|
|
15442
|
+
* @version 190.0.0
|
|
15381
15443
|
*/ /**
|
|
15382
15444
|
* Constructs a new TelephonyApi.
|
|
15383
15445
|
* @alias module:purecloud-platform-client-v2/api/TelephonyApi
|
|
@@ -15424,7 +15486,7 @@ if(downloadId===undefined||downloadId===null){throw'Missing the required paramet
|
|
|
15424
15486
|
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']);}}]);return TelephonyApi;}();var TelephonyProvidersEdgeApi=/*#__PURE__*/function(){/**
|
|
15425
15487
|
* TelephonyProvidersEdge service.
|
|
15426
15488
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
15427
|
-
* @version
|
|
15489
|
+
* @version 190.0.0
|
|
15428
15490
|
*/ /**
|
|
15429
15491
|
* Constructs a new TelephonyProvidersEdgeApi.
|
|
15430
15492
|
* @alias module:purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
@@ -16238,7 +16300,7 @@ if(trunkBaseSettingsId===undefined||trunkBaseSettingsId===null){throw'Missing th
|
|
|
16238
16300
|
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']);}}]);return TelephonyProvidersEdgeApi;}();var TextbotsApi=/*#__PURE__*/function(){/**
|
|
16239
16301
|
* Textbots service.
|
|
16240
16302
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
16241
|
-
* @version
|
|
16303
|
+
* @version 190.0.0
|
|
16242
16304
|
*/ /**
|
|
16243
16305
|
* Constructs a new TextbotsApi.
|
|
16244
16306
|
* @alias module:purecloud-platform-client-v2/api/TextbotsApi
|
|
@@ -16273,7 +16335,7 @@ if(launchRequest===undefined||launchRequest===null){throw'Missing the required p
|
|
|
16273
16335
|
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']);}}]);return TextbotsApi;}();var TokensApi=/*#__PURE__*/function(){/**
|
|
16274
16336
|
* Tokens service.
|
|
16275
16337
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
16276
|
-
* @version
|
|
16338
|
+
* @version 190.0.0
|
|
16277
16339
|
*/ /**
|
|
16278
16340
|
* Constructs a new TokensApi.
|
|
16279
16341
|
* @alias module:purecloud-platform-client-v2/api/TokensApi
|
|
@@ -16307,7 +16369,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
16307
16369
|
*/},{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']);}}]);return TokensApi;}();var UploadsApi=/*#__PURE__*/function(){/**
|
|
16308
16370
|
* Uploads service.
|
|
16309
16371
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
16310
|
-
* @version
|
|
16372
|
+
* @version 190.0.0
|
|
16311
16373
|
*/ /**
|
|
16312
16374
|
* Constructs a new UploadsApi.
|
|
16313
16375
|
* @alias module:purecloud-platform-client-v2/api/UploadsApi
|
|
@@ -16373,7 +16435,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
16373
16435
|
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']);}}]);return UploadsApi;}();var UsageApi=/*#__PURE__*/function(){/**
|
|
16374
16436
|
* Usage service.
|
|
16375
16437
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
16376
|
-
* @version
|
|
16438
|
+
* @version 190.0.0
|
|
16377
16439
|
*/ /**
|
|
16378
16440
|
* Constructs a new UsageApi.
|
|
16379
16441
|
* @alias module:purecloud-platform-client-v2/api/UsageApi
|
|
@@ -16424,7 +16486,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
16424
16486
|
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']);}}]);return UsageApi;}();var UserRecordingsApi=/*#__PURE__*/function(){/**
|
|
16425
16487
|
* UserRecordings service.
|
|
16426
16488
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
16427
|
-
* @version
|
|
16489
|
+
* @version 190.0.0
|
|
16428
16490
|
*/ /**
|
|
16429
16491
|
* Constructs a new UserRecordingsApi.
|
|
16430
16492
|
* @alias module:purecloud-platform-client-v2/api/UserRecordingsApi
|
|
@@ -16473,7 +16535,7 @@ if(recordingId===undefined||recordingId===null){throw'Missing the required param
|
|
|
16473
16535
|
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']);}}]);return UserRecordingsApi;}();var UsersApi=/*#__PURE__*/function(){/**
|
|
16474
16536
|
* Users service.
|
|
16475
16537
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
16476
|
-
* @version
|
|
16538
|
+
* @version 190.0.0
|
|
16477
16539
|
*/ /**
|
|
16478
16540
|
* Constructs a new UsersApi.
|
|
16479
16541
|
* @alias module:purecloud-platform-client-v2/api/UsersApi
|
|
@@ -17132,7 +17194,7 @@ if(verifierId===undefined||verifierId===null){throw'Missing the required paramet
|
|
|
17132
17194
|
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']);}}]);return UsersApi;}();var UtilitiesApi=/*#__PURE__*/function(){/**
|
|
17133
17195
|
* Utilities service.
|
|
17134
17196
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
17135
|
-
* @version
|
|
17197
|
+
* @version 190.0.0
|
|
17136
17198
|
*/ /**
|
|
17137
17199
|
* Constructs a new UtilitiesApi.
|
|
17138
17200
|
* @alias module:purecloud-platform-client-v2/api/UtilitiesApi
|
|
@@ -17159,7 +17221,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
17159
17221
|
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']);}}]);return UtilitiesApi;}();var VoicemailApi=/*#__PURE__*/function(){/**
|
|
17160
17222
|
* Voicemail service.
|
|
17161
17223
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
17162
|
-
* @version
|
|
17224
|
+
* @version 190.0.0
|
|
17163
17225
|
*/ /**
|
|
17164
17226
|
* Constructs a new VoicemailApi.
|
|
17165
17227
|
* @alias module:purecloud-platform-client-v2/api/VoicemailApi
|
|
@@ -17308,7 +17370,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
17308
17370
|
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']);}}]);return VoicemailApi;}();var WebChatApi=/*#__PURE__*/function(){/**
|
|
17309
17371
|
* WebChat service.
|
|
17310
17372
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
17311
|
-
* @version
|
|
17373
|
+
* @version 190.0.0
|
|
17312
17374
|
*/ /**
|
|
17313
17375
|
* Constructs a new WebChatApi.
|
|
17314
17376
|
* @alias module:purecloud-platform-client-v2/api/WebChatApi
|
|
@@ -17441,7 +17503,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
17441
17503
|
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']);}}]);return WebChatApi;}();var WebDeploymentsApi=/*#__PURE__*/function(){/**
|
|
17442
17504
|
* WebDeployments service.
|
|
17443
17505
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
17444
|
-
* @version
|
|
17506
|
+
* @version 190.0.0
|
|
17445
17507
|
*/ /**
|
|
17446
17508
|
* Constructs a new WebDeploymentsApi.
|
|
17447
17509
|
* @alias module:purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
@@ -17562,7 +17624,7 @@ if(deploymentId===undefined||deploymentId===null){throw'Missing the required par
|
|
|
17562
17624
|
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']);}}]);return WebDeploymentsApi;}();var WebMessagingApi=/*#__PURE__*/function(){/**
|
|
17563
17625
|
* WebMessaging service.
|
|
17564
17626
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
17565
|
-
* @version
|
|
17627
|
+
* @version 190.0.0
|
|
17566
17628
|
*/ /**
|
|
17567
17629
|
* Constructs a new WebMessagingApi.
|
|
17568
17630
|
* @alias module:purecloud-platform-client-v2/api/WebMessagingApi
|
|
@@ -17578,7 +17640,7 @@ if(deployment===undefined||deployment===null){throw'Missing the required paramet
|
|
|
17578
17640
|
*/_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']);}}]);return WebMessagingApi;}();var WidgetsApi=/*#__PURE__*/function(){/**
|
|
17579
17641
|
* Widgets service.
|
|
17580
17642
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
17581
|
-
* @version
|
|
17643
|
+
* @version 190.0.0
|
|
17582
17644
|
*/ /**
|
|
17583
17645
|
* Constructs a new WidgetsApi.
|
|
17584
17646
|
* @alias module:purecloud-platform-client-v2/api/WidgetsApi
|
|
@@ -17613,7 +17675,7 @@ if(deploymentId===undefined||deploymentId===null){throw'Missing the required par
|
|
|
17613
17675
|
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']);}}]);return WidgetsApi;}();var WorkforceManagementApi=/*#__PURE__*/function(){/**
|
|
17614
17676
|
* WorkforceManagement service.
|
|
17615
17677
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
17616
|
-
* @version
|
|
17678
|
+
* @version 190.0.0
|
|
17617
17679
|
*/ /**
|
|
17618
17680
|
* Constructs a new WorkforceManagementApi.
|
|
17619
17681
|
* @alias module:purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
@@ -17654,6 +17716,27 @@ if(runId===undefined||runId===null){throw'Missing the required parameter "runId"
|
|
|
17654
17716
|
*/},{key:"deleteWorkforcemanagementBusinessunitServicegoaltemplate",value:function deleteWorkforcemanagementBusinessunitServicegoaltemplate(businessUnitId,serviceGoalTemplateId){// verify the required parameter 'businessUnitId' is set
|
|
17655
17717
|
if(businessUnitId===undefined||businessUnitId===null){throw'Missing the required parameter "businessUnitId" when calling deleteWorkforcemanagementBusinessunitServicegoaltemplate';}// verify the required parameter 'serviceGoalTemplateId' is set
|
|
17656
17718
|
if(serviceGoalTemplateId===undefined||serviceGoalTemplateId===null){throw'Missing the required parameter "serviceGoalTemplateId" when calling deleteWorkforcemanagementBusinessunitServicegoaltemplate';}return this.apiClient.callApi('/api/v2/workforcemanagement/businessunits/{businessUnitId}/servicegoaltemplates/{serviceGoalTemplateId}','DELETE',{'businessUnitId':businessUnitId,'serviceGoalTemplateId':serviceGoalTemplateId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
17719
|
+
* Deletes a staffing group
|
|
17720
|
+
*
|
|
17721
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
17722
|
+
* @param {String} staffingGroupId The ID of the staffing group to delete
|
|
17723
|
+
*/},{key:"deleteWorkforcemanagementBusinessunitStaffinggroup",value:function deleteWorkforcemanagementBusinessunitStaffinggroup(businessUnitId,staffingGroupId){// verify the required parameter 'businessUnitId' is set
|
|
17724
|
+
if(businessUnitId===undefined||businessUnitId===null){throw'Missing the required parameter "businessUnitId" when calling deleteWorkforcemanagementBusinessunitStaffinggroup';}// verify the required parameter 'staffingGroupId' is set
|
|
17725
|
+
if(staffingGroupId===undefined||staffingGroupId===null){throw'Missing the required parameter "staffingGroupId" when calling deleteWorkforcemanagementBusinessunitStaffinggroup';}return this.apiClient.callApi('/api/v2/workforcemanagement/businessunits/{businessUnitId}/staffinggroups/{staffingGroupId}','DELETE',{'businessUnitId':businessUnitId,'staffingGroupId':staffingGroupId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
17726
|
+
* Deletes a time-off limit object
|
|
17727
|
+
*
|
|
17728
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
17729
|
+
* @param {String} timeOffLimitId The ID of the time-off limit object to delete
|
|
17730
|
+
*/},{key:"deleteWorkforcemanagementBusinessunitTimeofflimit",value:function deleteWorkforcemanagementBusinessunitTimeofflimit(businessUnitId,timeOffLimitId){// verify the required parameter 'businessUnitId' is set
|
|
17731
|
+
if(businessUnitId===undefined||businessUnitId===null){throw'Missing the required parameter "businessUnitId" when calling deleteWorkforcemanagementBusinessunitTimeofflimit';}// verify the required parameter 'timeOffLimitId' is set
|
|
17732
|
+
if(timeOffLimitId===undefined||timeOffLimitId===null){throw'Missing the required parameter "timeOffLimitId" when calling deleteWorkforcemanagementBusinessunitTimeofflimit';}return this.apiClient.callApi('/api/v2/workforcemanagement/businessunits/{businessUnitId}/timeofflimits/{timeOffLimitId}','DELETE',{'businessUnitId':businessUnitId,'timeOffLimitId':timeOffLimitId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
17733
|
+
* Deletes a time-off plan
|
|
17734
|
+
*
|
|
17735
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
17736
|
+
* @param {String} timeOffPlanId The ID of the time-off plan to delete
|
|
17737
|
+
*/},{key:"deleteWorkforcemanagementBusinessunitTimeoffplan",value:function deleteWorkforcemanagementBusinessunitTimeoffplan(businessUnitId,timeOffPlanId){// verify the required parameter 'businessUnitId' is set
|
|
17738
|
+
if(businessUnitId===undefined||businessUnitId===null){throw'Missing the required parameter "businessUnitId" when calling deleteWorkforcemanagementBusinessunitTimeoffplan';}// verify the required parameter 'timeOffPlanId' is set
|
|
17739
|
+
if(timeOffPlanId===undefined||timeOffPlanId===null){throw'Missing the required parameter "timeOffPlanId" when calling deleteWorkforcemanagementBusinessunitTimeoffplan';}return this.apiClient.callApi('/api/v2/workforcemanagement/businessunits/{businessUnitId}/timeoffplans/{timeOffPlanId}','DELETE',{'businessUnitId':businessUnitId,'timeOffPlanId':timeOffPlanId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
17657
17740
|
* Delete a schedule
|
|
17658
17741
|
*
|
|
17659
17742
|
* @param {String} businessUnitId The ID of the business unit
|
|
@@ -17841,6 +17924,49 @@ if(serviceGoalTemplateId===undefined||serviceGoalTemplateId===null){throw'Missin
|
|
|
17841
17924
|
* @param {Array.<String>} opts.expand Include to access additional data on the service goal template
|
|
17842
17925
|
*/},{key:"getWorkforcemanagementBusinessunitServicegoaltemplates",value:function getWorkforcemanagementBusinessunitServicegoaltemplates(businessUnitId,opts){opts=opts||{};// verify the required parameter 'businessUnitId' is set
|
|
17843
17926
|
if(businessUnitId===undefined||businessUnitId===null){throw'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitServicegoaltemplates';}return this.apiClient.callApi('/api/v2/workforcemanagement/businessunits/{businessUnitId}/servicegoaltemplates','GET',{'businessUnitId':businessUnitId},{'expand':this.apiClient.buildCollectionParam(opts['expand'],'multi')},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
17927
|
+
* Gets a staffing group
|
|
17928
|
+
*
|
|
17929
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
17930
|
+
* @param {String} staffingGroupId The ID of the staffing group to fetch
|
|
17931
|
+
*/},{key:"getWorkforcemanagementBusinessunitStaffinggroup",value:function getWorkforcemanagementBusinessunitStaffinggroup(businessUnitId,staffingGroupId){// verify the required parameter 'businessUnitId' is set
|
|
17932
|
+
if(businessUnitId===undefined||businessUnitId===null){throw'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitStaffinggroup';}// verify the required parameter 'staffingGroupId' is set
|
|
17933
|
+
if(staffingGroupId===undefined||staffingGroupId===null){throw'Missing the required parameter "staffingGroupId" when calling getWorkforcemanagementBusinessunitStaffinggroup';}return this.apiClient.callApi('/api/v2/workforcemanagement/businessunits/{businessUnitId}/staffinggroups/{staffingGroupId}','GET',{'businessUnitId':businessUnitId,'staffingGroupId':staffingGroupId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
17934
|
+
* Gets a list of staffing groups
|
|
17935
|
+
*
|
|
17936
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
17937
|
+
* @param {Object} opts Optional parameters
|
|
17938
|
+
* @param {String} opts.managementUnitId The ID of the management unit to get management unit specific staffing groups
|
|
17939
|
+
*/},{key:"getWorkforcemanagementBusinessunitStaffinggroups",value:function getWorkforcemanagementBusinessunitStaffinggroups(businessUnitId,opts){opts=opts||{};// verify the required parameter 'businessUnitId' is set
|
|
17940
|
+
if(businessUnitId===undefined||businessUnitId===null){throw'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitStaffinggroups';}return this.apiClient.callApi('/api/v2/workforcemanagement/businessunits/{businessUnitId}/staffinggroups','GET',{'businessUnitId':businessUnitId},{'managementUnitId':opts['managementUnitId']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
17941
|
+
* Gets a time-off limit object
|
|
17942
|
+
* Returns properties of time-off limit object, but not daily values
|
|
17943
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
17944
|
+
* @param {String} timeOffLimitId The ID of the time-off limit to fetch
|
|
17945
|
+
*/},{key:"getWorkforcemanagementBusinessunitTimeofflimit",value:function getWorkforcemanagementBusinessunitTimeofflimit(businessUnitId,timeOffLimitId){// verify the required parameter 'businessUnitId' is set
|
|
17946
|
+
if(businessUnitId===undefined||businessUnitId===null){throw'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitTimeofflimit';}// verify the required parameter 'timeOffLimitId' is set
|
|
17947
|
+
if(timeOffLimitId===undefined||timeOffLimitId===null){throw'Missing the required parameter "timeOffLimitId" when calling getWorkforcemanagementBusinessunitTimeofflimit';}return this.apiClient.callApi('/api/v2/workforcemanagement/businessunits/{businessUnitId}/timeofflimits/{timeOffLimitId}','GET',{'businessUnitId':businessUnitId,'timeOffLimitId':timeOffLimitId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
17948
|
+
* Gets a list of time-off limit objects
|
|
17949
|
+
*
|
|
17950
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
17951
|
+
* @param {Object} opts Optional parameters
|
|
17952
|
+
* @param {String} opts.managementUnitId The ID of the management unit to get management unit specific time-off limit objects
|
|
17953
|
+
*/},{key:"getWorkforcemanagementBusinessunitTimeofflimits",value:function getWorkforcemanagementBusinessunitTimeofflimits(businessUnitId,opts){opts=opts||{};// verify the required parameter 'businessUnitId' is set
|
|
17954
|
+
if(businessUnitId===undefined||businessUnitId===null){throw'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitTimeofflimits';}return this.apiClient.callApi('/api/v2/workforcemanagement/businessunits/{businessUnitId}/timeofflimits','GET',{'businessUnitId':businessUnitId},{'managementUnitId':opts['managementUnitId']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
17955
|
+
* Gets a time-off plan
|
|
17956
|
+
*
|
|
17957
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
17958
|
+
* @param {String} timeOffPlanId The ID of the time-off plan to fetch
|
|
17959
|
+
*/},{key:"getWorkforcemanagementBusinessunitTimeoffplan",value:function getWorkforcemanagementBusinessunitTimeoffplan(businessUnitId,timeOffPlanId){// verify the required parameter 'businessUnitId' is set
|
|
17960
|
+
if(businessUnitId===undefined||businessUnitId===null){throw'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitTimeoffplan';}// verify the required parameter 'timeOffPlanId' is set
|
|
17961
|
+
if(timeOffPlanId===undefined||timeOffPlanId===null){throw'Missing the required parameter "timeOffPlanId" when calling getWorkforcemanagementBusinessunitTimeoffplan';}return this.apiClient.callApi('/api/v2/workforcemanagement/businessunits/{businessUnitId}/timeoffplans/{timeOffPlanId}','GET',{'businessUnitId':businessUnitId,'timeOffPlanId':timeOffPlanId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
17962
|
+
* Gets a list of time-off plans
|
|
17963
|
+
*
|
|
17964
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
17965
|
+
* @param {Object} opts Optional parameters
|
|
17966
|
+
* @param {String} opts.managementUnitId The ID of the management unit to get management unit specific staffing groups
|
|
17967
|
+
* @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
|
|
17968
|
+
*/},{key:"getWorkforcemanagementBusinessunitTimeoffplans",value:function getWorkforcemanagementBusinessunitTimeoffplans(businessUnitId,opts){opts=opts||{};// verify the required parameter 'businessUnitId' is set
|
|
17969
|
+
if(businessUnitId===undefined||businessUnitId===null){throw'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitTimeoffplans';}return this.apiClient.callApi('/api/v2/workforcemanagement/businessunits/{businessUnitId}/timeoffplans','GET',{'businessUnitId':businessUnitId},{'managementUnitId':opts['managementUnitId'],'forceDownloadService':opts['forceDownloadService']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
17844
17970
|
* Get the metadata for the schedule, describing which management units and agents are in the scheduleSchedule data can then be loaded with the query route
|
|
17845
17971
|
*
|
|
17846
17972
|
* @param {String} businessUnitId The ID of the business unit
|
|
@@ -18285,6 +18411,24 @@ if(runId===undefined||runId===null){throw'Missing the required parameter "runId"
|
|
|
18285
18411
|
*/},{key:"patchWorkforcemanagementBusinessunitServicegoaltemplate",value:function patchWorkforcemanagementBusinessunitServicegoaltemplate(businessUnitId,serviceGoalTemplateId,opts){opts=opts||{};// verify the required parameter 'businessUnitId' is set
|
|
18286
18412
|
if(businessUnitId===undefined||businessUnitId===null){throw'Missing the required parameter "businessUnitId" when calling patchWorkforcemanagementBusinessunitServicegoaltemplate';}// verify the required parameter 'serviceGoalTemplateId' is set
|
|
18287
18413
|
if(serviceGoalTemplateId===undefined||serviceGoalTemplateId===null){throw'Missing the required parameter "serviceGoalTemplateId" when calling patchWorkforcemanagementBusinessunitServicegoaltemplate';}return this.apiClient.callApi('/api/v2/workforcemanagement/businessunits/{businessUnitId}/servicegoaltemplates/{serviceGoalTemplateId}','PATCH',{'businessUnitId':businessUnitId,'serviceGoalTemplateId':serviceGoalTemplateId},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
18414
|
+
* Updates a staffing group
|
|
18415
|
+
*
|
|
18416
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
18417
|
+
* @param {String} staffingGroupId The ID of the staffing group to update
|
|
18418
|
+
* @param {Object} opts Optional parameters
|
|
18419
|
+
* @param {Object} opts.body body
|
|
18420
|
+
*/},{key:"patchWorkforcemanagementBusinessunitStaffinggroup",value:function patchWorkforcemanagementBusinessunitStaffinggroup(businessUnitId,staffingGroupId,opts){opts=opts||{};// verify the required parameter 'businessUnitId' is set
|
|
18421
|
+
if(businessUnitId===undefined||businessUnitId===null){throw'Missing the required parameter "businessUnitId" when calling patchWorkforcemanagementBusinessunitStaffinggroup';}// verify the required parameter 'staffingGroupId' is set
|
|
18422
|
+
if(staffingGroupId===undefined||staffingGroupId===null){throw'Missing the required parameter "staffingGroupId" when calling patchWorkforcemanagementBusinessunitStaffinggroup';}return this.apiClient.callApi('/api/v2/workforcemanagement/businessunits/{businessUnitId}/staffinggroups/{staffingGroupId}','PATCH',{'businessUnitId':businessUnitId,'staffingGroupId':staffingGroupId},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
18423
|
+
* Updates a time-off plan
|
|
18424
|
+
*
|
|
18425
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
18426
|
+
* @param {String} timeOffPlanId The ID of the time-off plan to update
|
|
18427
|
+
* @param {Object} opts Optional parameters
|
|
18428
|
+
* @param {Object} opts.body body
|
|
18429
|
+
*/},{key:"patchWorkforcemanagementBusinessunitTimeoffplan",value:function patchWorkforcemanagementBusinessunitTimeoffplan(businessUnitId,timeOffPlanId,opts){opts=opts||{};// verify the required parameter 'businessUnitId' is set
|
|
18430
|
+
if(businessUnitId===undefined||businessUnitId===null){throw'Missing the required parameter "businessUnitId" when calling patchWorkforcemanagementBusinessunitTimeoffplan';}// verify the required parameter 'timeOffPlanId' is set
|
|
18431
|
+
if(timeOffPlanId===undefined||timeOffPlanId===null){throw'Missing the required parameter "timeOffPlanId" when calling patchWorkforcemanagementBusinessunitTimeoffplan';}return this.apiClient.callApi('/api/v2/workforcemanagement/businessunits/{businessUnitId}/timeoffplans/{timeOffPlanId}','PATCH',{'businessUnitId':businessUnitId,'timeOffPlanId':timeOffPlanId},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
18288
18432
|
* Update the requested management unit
|
|
18289
18433
|
*
|
|
18290
18434
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
@@ -18485,6 +18629,41 @@ if(businessUnitId===undefined||businessUnitId===null){throw'Missing the required
|
|
|
18485
18629
|
* @param {Object} opts.body body
|
|
18486
18630
|
*/},{key:"postWorkforcemanagementBusinessunitServicegoaltemplates",value:function postWorkforcemanagementBusinessunitServicegoaltemplates(businessUnitId,opts){opts=opts||{};// verify the required parameter 'businessUnitId' is set
|
|
18487
18631
|
if(businessUnitId===undefined||businessUnitId===null){throw'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitServicegoaltemplates';}return this.apiClient.callApi('/api/v2/workforcemanagement/businessunits/{businessUnitId}/servicegoaltemplates','POST',{'businessUnitId':businessUnitId},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
18632
|
+
* Creates a new staffing group
|
|
18633
|
+
*
|
|
18634
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
18635
|
+
* @param {Object} opts Optional parameters
|
|
18636
|
+
* @param {Object} opts.body body
|
|
18637
|
+
*/},{key:"postWorkforcemanagementBusinessunitStaffinggroups",value:function postWorkforcemanagementBusinessunitStaffinggroups(businessUnitId,opts){opts=opts||{};// verify the required parameter 'businessUnitId' is set
|
|
18638
|
+
if(businessUnitId===undefined||businessUnitId===null){throw'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitStaffinggroups';}return this.apiClient.callApi('/api/v2/workforcemanagement/businessunits/{businessUnitId}/staffinggroups','POST',{'businessUnitId':businessUnitId},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
18639
|
+
* Gets staffing group associations for a list of user IDs
|
|
18640
|
+
*
|
|
18641
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
18642
|
+
* @param {Object} opts Optional parameters
|
|
18643
|
+
* @param {Object} opts.body body
|
|
18644
|
+
*/},{key:"postWorkforcemanagementBusinessunitStaffinggroupsQuery",value:function postWorkforcemanagementBusinessunitStaffinggroupsQuery(businessUnitId,opts){opts=opts||{};// verify the required parameter 'businessUnitId' is set
|
|
18645
|
+
if(businessUnitId===undefined||businessUnitId===null){throw'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitStaffinggroupsQuery';}return this.apiClient.callApi('/api/v2/workforcemanagement/businessunits/{businessUnitId}/staffinggroups/query','POST',{'businessUnitId':businessUnitId},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
18646
|
+
* Creates a new time-off limit object
|
|
18647
|
+
*
|
|
18648
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
18649
|
+
* @param {Object} opts Optional parameters
|
|
18650
|
+
* @param {Object} opts.body body
|
|
18651
|
+
*/},{key:"postWorkforcemanagementBusinessunitTimeofflimits",value:function postWorkforcemanagementBusinessunitTimeofflimits(businessUnitId,opts){opts=opts||{};// verify the required parameter 'businessUnitId' is set
|
|
18652
|
+
if(businessUnitId===undefined||businessUnitId===null){throw'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitTimeofflimits';}return this.apiClient.callApi('/api/v2/workforcemanagement/businessunits/{businessUnitId}/timeofflimits','POST',{'businessUnitId':businessUnitId},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
18653
|
+
* Retrieves time-off limit related values based on a given set of filters.
|
|
18654
|
+
*
|
|
18655
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
18656
|
+
* @param {Object} opts Optional parameters
|
|
18657
|
+
* @param {Object} opts.body body
|
|
18658
|
+
*/},{key:"postWorkforcemanagementBusinessunitTimeofflimitsValuesQuery",value:function postWorkforcemanagementBusinessunitTimeofflimitsValuesQuery(businessUnitId,opts){opts=opts||{};// verify the required parameter 'businessUnitId' is set
|
|
18659
|
+
if(businessUnitId===undefined||businessUnitId===null){throw'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitTimeofflimitsValuesQuery';}return this.apiClient.callApi('/api/v2/workforcemanagement/businessunits/{businessUnitId}/timeofflimits/values/query','POST',{'businessUnitId':businessUnitId},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
18660
|
+
* Creates a new time-off plan
|
|
18661
|
+
*
|
|
18662
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
18663
|
+
* @param {Object} opts Optional parameters
|
|
18664
|
+
* @param {Object} opts.body body
|
|
18665
|
+
*/},{key:"postWorkforcemanagementBusinessunitTimeoffplans",value:function postWorkforcemanagementBusinessunitTimeoffplans(businessUnitId,opts){opts=opts||{};// verify the required parameter 'businessUnitId' is set
|
|
18666
|
+
if(businessUnitId===undefined||businessUnitId===null){throw'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitTimeoffplans';}return this.apiClient.callApi('/api/v2/workforcemanagement/businessunits/{businessUnitId}/timeoffplans','POST',{'businessUnitId':businessUnitId},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
18488
18667
|
* Loads agent schedule data from the schedule. Used in combination with the metadata route
|
|
18489
18668
|
*
|
|
18490
18669
|
* @param {String} businessUnitId The ID of the business unit
|
|
@@ -18928,6 +19107,15 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
18928
19107
|
*/},{key:"putWorkforcemanagementAgentIntegrationsHris",value:function putWorkforcemanagementAgentIntegrationsHris(agentId,body){// verify the required parameter 'agentId' is set
|
|
18929
19108
|
if(agentId===undefined||agentId===null){throw'Missing the required parameter "agentId" when calling putWorkforcemanagementAgentIntegrationsHris';}// verify the required parameter 'body' is set
|
|
18930
19109
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putWorkforcemanagementAgentIntegrationsHris';}return this.apiClient.callApi('/api/v2/workforcemanagement/agents/{agentId}/integrations/hris','PUT',{'agentId':agentId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
19110
|
+
* Sets daily values for a date range of time-off limit object
|
|
19111
|
+
* Note that only limit daily values can be set through API, allocated and waitlisted values are read-only for time-off limit API
|
|
19112
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
19113
|
+
* @param {String} timeOffLimitId The ID of the time-off limit object to set values for
|
|
19114
|
+
* @param {Object} opts Optional parameters
|
|
19115
|
+
* @param {Object} opts.body body
|
|
19116
|
+
*/},{key:"putWorkforcemanagementBusinessunitTimeofflimitValues",value:function putWorkforcemanagementBusinessunitTimeofflimitValues(businessUnitId,timeOffLimitId,opts){opts=opts||{};// verify the required parameter 'businessUnitId' is set
|
|
19117
|
+
if(businessUnitId===undefined||businessUnitId===null){throw'Missing the required parameter "businessUnitId" when calling putWorkforcemanagementBusinessunitTimeofflimitValues';}// verify the required parameter 'timeOffLimitId' is set
|
|
19118
|
+
if(timeOffLimitId===undefined||timeOffLimitId===null){throw'Missing the required parameter "timeOffLimitId" when calling putWorkforcemanagementBusinessunitTimeofflimitValues';}return this.apiClient.callApi('/api/v2/workforcemanagement/businessunits/{businessUnitId}/timeofflimits/{timeOffLimitId}/values','PUT',{'businessUnitId':businessUnitId,'timeOffLimitId':timeOffLimitId},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
18931
19119
|
* Sets daily values for a date range of time off limit object
|
|
18932
19120
|
* Note that only limit daily values can be set through API, allocated and waitlisted values are read-only for time off limit API
|
|
18933
19121
|
* @param {String} managementUnitId The ID of the management unit.
|
|
@@ -18965,7 +19153,7 @@ if(timeOffLimitId===undefined||timeOffLimitId===null){throw'Missing the required
|
|
|
18965
19153
|
* </pre>
|
|
18966
19154
|
* </p>
|
|
18967
19155
|
* @module purecloud-platform-client-v2/index
|
|
18968
|
-
* @version
|
|
19156
|
+
* @version 190.0.0
|
|
18969
19157
|
*/var platformClient=/*#__PURE__*/_createClass(function platformClient(){_classCallCheck(this,platformClient);/**
|
|
18970
19158
|
* The ApiClient constructor.
|
|
18971
19159
|
* @property {module:purecloud-platform-client-v2/ApiClient}
|