purecloud-platform-client-v2 215.0.0 → 216.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +3 -3
- package/dist/node/purecloud-platform-client-v2.js +559 -118
- package/dist/web-amd/purecloud-platform-client-v2.js +559 -118
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +203 -96
- package/dist/web-cjs/purecloud-platform-client-v2.js +204 -97
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +484 -255
- package/package.json +1 -1
- package/src/purecloud-platform-client-v2/ApiClient.js +1 -1
- package/src/purecloud-platform-client-v2/api/AgentAssistantsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AgentCopilotApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AgentUIApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AlertingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +1 -2
- 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 +379 -1
- package/src/purecloud-platform-client-v2/api/BillingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/CarrierServicesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ChatApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/CoachingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ContentManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ConversationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/DataPrivacyApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/DownloadsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EmailsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EmployeeEngagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EventsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +9 -4
- 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 +21 -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 +1 -1
- package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OutboundApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/PresenceApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ProcessAutomationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/QualityApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RecordingApi.js +1 -31
- package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RoutingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ScreenRecordingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ScriptsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SearchApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SettingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SocialMediaApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +3 -3
- 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 +70 -1
- package/src/purecloud-platform-client-v2/index.js +1 -1
|
@@ -1966,7 +1966,7 @@ var $TypeError = require('es-errors/type');
|
|
|
1966
1966
|
var $call = require('./functionCall');
|
|
1967
1967
|
var $actualApply = require('./actualApply');
|
|
1968
1968
|
|
|
1969
|
-
/** @type {import('.')
|
|
1969
|
+
/** @type {(args: [Function, thisArg?: unknown, ...args: unknown[]]) => Function} TODO FIXME, find a way to use import('.') */
|
|
1970
1970
|
module.exports = function callBindBasic(args) {
|
|
1971
1971
|
if (args.length < 1 || typeof args[0] !== 'function') {
|
|
1972
1972
|
throw new $TypeError('a function is required');
|
|
@@ -6455,7 +6455,7 @@ if(env)this.environment=env;else this.environment=this.host?this.host:'mypureclo
|
|
|
6455
6455
|
this.environment=this.environment.replace(/\/+$/,'');// Strip protocol and subdomain
|
|
6456
6456
|
if(this.environment.startsWith('https://'))this.environment=this.environment.substring(8);if(this.environment.startsWith('http://'))this.environment=this.environment.substring(7);if(this.environment.startsWith('api.'))this.environment=this.environment.substring(4);this.basePath="https://api.".concat(this.environment);this.authUrl="https://login.".concat(this.environment);}},{key:"getConfUrl",value:function getConfUrl(pathType,regionUrl){if(!this.gateway)return regionUrl;if(!this.gateway.host)return regionUrl;var url=this.gateway.protocol+'://'+this.gateway.host;if(this.gateway.port>-1)url=url+':'+this.gateway.port.toString();if(pathType==='login'){if(this.gateway.path_params_login){if(this.gateway.path_params_login.startsWith('/'))url=url+this.gateway.path_params_login;else url=url+'/'+this.gateway.path_params_login;}}else{if(this.gateway.path_params_api){if(this.gateway.path_params_api.startsWith('/'))url=url+this.gateway.path_params_api;else url=url+'/'+this.gateway.path_params_api;}}return url;}},{key:"getConfigString",value:function getConfigString(section,key){if(this.config._sections[section])return this.config._sections[section][key];}},{key:"getConfigBoolean",value:function getConfigBoolean(section,key){if(this.config._sections[section]&&this.config._sections[section][key]!==undefined){if(typeof this.config._sections[section][key]==='string'){return this.config._sections[section][key]==='true';}else return this.config._sections[section][key];}}},{key:"getConfigInt",value:function getConfigInt(section,key){if(this.config._sections[section]&&this.config._sections[section][key]){if(typeof this.config._sections[section][key]==='string'){return parseInt(this.config._sections[section][key]);}else return this.config._sections[section][key];}}}]);}();/**
|
|
6457
6457
|
* @module purecloud-platform-client-v2/ApiClient
|
|
6458
|
-
* @version
|
|
6458
|
+
* @version 216.0.0
|
|
6459
6459
|
*/var ApiClient=/*#__PURE__*/function(){/**
|
|
6460
6460
|
* Manages low level client-server communications, parameter marshalling, etc. There should not be any need for an
|
|
6461
6461
|
* application to use this class directly - the *Api and model classes provide the public API for the service. The
|
|
@@ -6798,7 +6798,7 @@ resolve(data);})["catch"](function(error){var data=error;if(error.response&&erro
|
|
|
6798
6798
|
that.config.logger.log('error',error.response.status,httpMethod,url,request.headers,error.response.headers,bodyParam,error.response.data);data=that.returnExtended===true?{status:error.response.status,statusText:error.response.statusText,headers:error.response.headers,body:error.response.data,text:error.response.text,error:error}:error.response.data?error.response.data:error.response.text;}reject(data);});}});}}]);}();var AgentAssistantsApi=/*#__PURE__*/function(){/**
|
|
6799
6799
|
* AgentAssistants service.
|
|
6800
6800
|
* @module purecloud-platform-client-v2/api/AgentAssistantsApi
|
|
6801
|
-
* @version
|
|
6801
|
+
* @version 216.0.0
|
|
6802
6802
|
*//**
|
|
6803
6803
|
* Constructs a new AgentAssistantsApi.
|
|
6804
6804
|
* @alias module:purecloud-platform-client-v2/api/AgentAssistantsApi
|
|
@@ -6899,7 +6899,7 @@ if(queueId===undefined||queueId===null){throw'Missing the required parameter "qu
|
|
|
6899
6899
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putAssistantQueue';}return this.apiClient.callApi('/api/v2/assistants/{assistantId}/queues/{queueId}','PUT',{'assistantId':assistantId,'queueId':queueId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var AgentCopilotApi=/*#__PURE__*/function(){/**
|
|
6900
6900
|
* AgentCopilot service.
|
|
6901
6901
|
* @module purecloud-platform-client-v2/api/AgentCopilotApi
|
|
6902
|
-
* @version
|
|
6902
|
+
* @version 216.0.0
|
|
6903
6903
|
*//**
|
|
6904
6904
|
* Constructs a new AgentCopilotApi.
|
|
6905
6905
|
* @alias module:purecloud-platform-client-v2/api/AgentCopilotApi
|
|
@@ -6921,7 +6921,7 @@ if(assistantId===undefined||assistantId===null){throw'Missing the required param
|
|
|
6921
6921
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putAssistantCopilot';}return this.apiClient.callApi('/api/v2/assistants/{assistantId}/copilot','PUT',{'assistantId':assistantId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var AgentUIApi=/*#__PURE__*/function(){/**
|
|
6922
6922
|
* AgentUI service.
|
|
6923
6923
|
* @module purecloud-platform-client-v2/api/AgentUIApi
|
|
6924
|
-
* @version
|
|
6924
|
+
* @version 216.0.0
|
|
6925
6925
|
*//**
|
|
6926
6926
|
* Constructs a new AgentUIApi.
|
|
6927
6927
|
* @alias module:purecloud-platform-client-v2/api/AgentUIApi
|
|
@@ -6955,7 +6955,7 @@ if(agentId===undefined||agentId===null){throw'Missing the required parameter "ag
|
|
|
6955
6955
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putUsersAgentuiAgentsAutoanswerAgentIdSettings';}return this.apiClient.callApi('/api/v2/users/agentui/agents/autoanswer/{agentId}/settings','PUT',{'agentId':agentId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var AlertingApi=/*#__PURE__*/function(){/**
|
|
6956
6956
|
* Alerting service.
|
|
6957
6957
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
6958
|
-
* @version
|
|
6958
|
+
* @version 216.0.0
|
|
6959
6959
|
*//**
|
|
6960
6960
|
* Constructs a new AlertingApi.
|
|
6961
6961
|
* @alias module:purecloud-platform-client-v2/api/AlertingApi
|
|
@@ -7120,7 +7120,7 @@ if(ruleId===undefined||ruleId===null){throw'Missing the required parameter "rule
|
|
|
7120
7120
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putAlertingRule';}return this.apiClient.callApi('/api/v2/alerting/rules/{ruleId}','PUT',{'ruleId':ruleId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var AnalyticsApi=/*#__PURE__*/function(){/**
|
|
7121
7121
|
* Analytics service.
|
|
7122
7122
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
7123
|
-
* @version
|
|
7123
|
+
* @version 216.0.0
|
|
7124
7124
|
*//**
|
|
7125
7125
|
* Constructs a new AnalyticsApi.
|
|
7126
7126
|
* @alias module:purecloud-platform-client-v2/api/AnalyticsApi
|
|
@@ -7707,7 +7707,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
7707
7707
|
* Query for summary aggregates
|
|
7708
7708
|
*
|
|
7709
7709
|
* @param {Object} body query
|
|
7710
|
-
* postAnalyticsSummariesAggregatesQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
7711
7710
|
*/},{key:"postAnalyticsSummariesAggregatesQuery",value:function postAnalyticsSummariesAggregatesQuery(body){// verify the required parameter 'body' is set
|
|
7712
7711
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postAnalyticsSummariesAggregatesQuery';}return this.apiClient.callApi('/api/v2/analytics/summaries/aggregates/query','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
7713
7712
|
* Query for survey aggregates asynchronously
|
|
@@ -7792,7 +7791,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
7792
7791
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putAnalyticsDataretentionSettings';}return this.apiClient.callApi('/api/v2/analytics/dataretention/settings','PUT',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var ArchitectApi=/*#__PURE__*/function(){/**
|
|
7793
7792
|
* Architect service.
|
|
7794
7793
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
7795
|
-
* @version
|
|
7794
|
+
* @version 216.0.0
|
|
7796
7795
|
*//**
|
|
7797
7796
|
* Constructs a new ArchitectApi.
|
|
7798
7797
|
* @alias module:purecloud-platform-client-v2/api/ArchitectApi
|
|
@@ -8884,7 +8883,7 @@ if(milestoneId===undefined||milestoneId===null){throw'Missing the required param
|
|
|
8884
8883
|
if(flowOutcomeId===undefined||flowOutcomeId===null){throw'Missing the required parameter "flowOutcomeId" when calling putFlowsOutcome';}return this.apiClient.callApi('/api/v2/flows/outcomes/{flowOutcomeId}','PUT',{'flowOutcomeId':flowOutcomeId},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var AuditApi=/*#__PURE__*/function(){/**
|
|
8885
8884
|
* Audit service.
|
|
8886
8885
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
8887
|
-
* @version
|
|
8886
|
+
* @version 216.0.0
|
|
8888
8887
|
*//**
|
|
8889
8888
|
* Constructs a new AuditApi.
|
|
8890
8889
|
* @alias module:purecloud-platform-client-v2/api/AuditApi
|
|
@@ -8934,7 +8933,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
8934
8933
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postAuditsQueryRealtimeRelated';}return this.apiClient.callApi('/api/v2/audits/query/realtime/related','POST',{},{'expand':this.apiClient.buildCollectionParam(opts['expand'],'multi')},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var AuthorizationApi=/*#__PURE__*/function(){/**
|
|
8935
8934
|
* Authorization service.
|
|
8936
8935
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
8937
|
-
* @version
|
|
8936
|
+
* @version 216.0.0
|
|
8938
8937
|
*//**
|
|
8939
8938
|
* Constructs a new AuthorizationApi.
|
|
8940
8939
|
* @alias module:purecloud-platform-client-v2/api/AuthorizationApi
|
|
@@ -8949,6 +8948,14 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
8949
8948
|
* @param {Boolean} opts.force Force delete this division as well as the grants and objects associated with it (default to false)
|
|
8950
8949
|
*/return _createClass(AuthorizationApi,[{key:"deleteAuthorizationDivision",value:function deleteAuthorizationDivision(divisionId,opts){opts=opts||{};// verify the required parameter 'divisionId' is set
|
|
8951
8950
|
if(divisionId===undefined||divisionId===null){throw'Missing the required parameter "divisionId" when calling deleteAuthorizationDivision';}return this.apiClient.callApi('/api/v2/authorization/divisions/{divisionId}','DELETE',{'divisionId':divisionId},{'force':opts['force']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
8951
|
+
* Delete an access control policy
|
|
8952
|
+
*
|
|
8953
|
+
* @param {String} targetName The domain:entity:action target to which the policy is applied
|
|
8954
|
+
* @param {String} subjectId The ID of the subject to which the policy is applied
|
|
8955
|
+
* deleteAuthorizationPoliciesTargetSubjectSubjectId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
8956
|
+
*/},{key:"deleteAuthorizationPoliciesTargetSubjectSubjectId",value:function deleteAuthorizationPoliciesTargetSubjectSubjectId(targetName,subjectId){// verify the required parameter 'targetName' is set
|
|
8957
|
+
if(targetName===undefined||targetName===null){throw'Missing the required parameter "targetName" when calling deleteAuthorizationPoliciesTargetSubjectSubjectId';}// verify the required parameter 'subjectId' is set
|
|
8958
|
+
if(subjectId===undefined||subjectId===null){throw'Missing the required parameter "subjectId" when calling deleteAuthorizationPoliciesTargetSubjectSubjectId';}return this.apiClient.callApi('/api/v2/authorization/policies/targets/{targetName}/subject/{subjectId}','DELETE',{'targetName':targetName,'subjectId':subjectId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
8952
8959
|
* Delete an organization role.
|
|
8953
8960
|
*
|
|
8954
8961
|
* @param {String} roleId Role ID
|
|
@@ -9032,6 +9039,55 @@ if(permission===undefined||permission===null){throw'Missing the required paramet
|
|
|
9032
9039
|
* @param {Object} opts.queryType Query filter type
|
|
9033
9040
|
* @param {String} opts.query Comma-separated list of permissions or domains to query
|
|
9034
9041
|
*/},{key:"getAuthorizationPermissions",value:function getAuthorizationPermissions(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/authorization/permissions','GET',{},{'pageSize':opts['pageSize'],'pageNumber':opts['pageNumber'],'queryType':opts['queryType'],'query':opts['query']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
9042
|
+
* Get a page of access policies for an organization
|
|
9043
|
+
*
|
|
9044
|
+
* @param {Object} opts Optional parameters
|
|
9045
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
9046
|
+
* @param {Number} opts.pageSize Number of entities to return. Maximum of 200. (default to 25)
|
|
9047
|
+
* getAuthorizationPolicies is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
9048
|
+
*/},{key:"getAuthorizationPolicies",value:function getAuthorizationPolicies(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/authorization/policies','GET',{},{'after':opts['after'],'pageSize':opts['pageSize']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
9049
|
+
* Get a page of access policies for a given subject
|
|
9050
|
+
*
|
|
9051
|
+
* @param {String} subjectId The ID of the subject to which policies are applied
|
|
9052
|
+
* @param {Object} opts Optional parameters
|
|
9053
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
9054
|
+
* @param {Number} opts.pageSize Number of entities to return. Maximum of 200. (default to 25)
|
|
9055
|
+
* getAuthorizationPoliciesSubjectSubjectId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
9056
|
+
*/},{key:"getAuthorizationPoliciesSubjectSubjectId",value:function getAuthorizationPoliciesSubjectSubjectId(subjectId,opts){opts=opts||{};// verify the required parameter 'subjectId' is set
|
|
9057
|
+
if(subjectId===undefined||subjectId===null){throw'Missing the required parameter "subjectId" when calling getAuthorizationPoliciesSubjectSubjectId';}return this.apiClient.callApi('/api/v2/authorization/policies/subject/{subjectId}','GET',{'subjectId':subjectId},{'after':opts['after'],'pageSize':opts['pageSize']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
9058
|
+
* Get a page of access policies for a given policy target
|
|
9059
|
+
*
|
|
9060
|
+
* @param {String} targetName The domain:entity:action resource target to which policies are applied
|
|
9061
|
+
* @param {Object} opts Optional parameters
|
|
9062
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
9063
|
+
* @param {Number} opts.pageSize Number of entities to return. Maximum of 200. (default to 25)
|
|
9064
|
+
* getAuthorizationPoliciesTarget is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
9065
|
+
*/},{key:"getAuthorizationPoliciesTarget",value:function getAuthorizationPoliciesTarget(targetName,opts){opts=opts||{};// verify the required parameter 'targetName' is set
|
|
9066
|
+
if(targetName===undefined||targetName===null){throw'Missing the required parameter "targetName" when calling getAuthorizationPoliciesTarget';}return this.apiClient.callApi('/api/v2/authorization/policies/targets/{targetName}','GET',{'targetName':targetName},{'after':opts['after'],'pageSize':opts['pageSize']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
9067
|
+
* Get an access control policy for a specified resource target and subject
|
|
9068
|
+
*
|
|
9069
|
+
* @param {String} targetName The domain:entity:action resource target to which the policy is applied
|
|
9070
|
+
* @param {String} subjectId The ID of the subject to which the policy is applied
|
|
9071
|
+
* getAuthorizationPoliciesTargetSubjectSubjectId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
9072
|
+
*/},{key:"getAuthorizationPoliciesTargetSubjectSubjectId",value:function getAuthorizationPoliciesTargetSubjectSubjectId(targetName,subjectId){// verify the required parameter 'targetName' is set
|
|
9073
|
+
if(targetName===undefined||targetName===null){throw'Missing the required parameter "targetName" when calling getAuthorizationPoliciesTargetSubjectSubjectId';}// verify the required parameter 'subjectId' is set
|
|
9074
|
+
if(subjectId===undefined||subjectId===null){throw'Missing the required parameter "subjectId" when calling getAuthorizationPoliciesTargetSubjectSubjectId';}return this.apiClient.callApi('/api/v2/authorization/policies/targets/{targetName}/subject/{subjectId}','GET',{'targetName':targetName,'subjectId':subjectId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
9075
|
+
* Get a map of policy targets to valid attributes for those targets
|
|
9076
|
+
*
|
|
9077
|
+
* getAuthorizationPoliciesTargets is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
9078
|
+
*/},{key:"getAuthorizationPoliciesTargets",value:function getAuthorizationPoliciesTargets(){return this.apiClient.callApi('/api/v2/authorization/policies/targets','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
9079
|
+
* Get an access control policy with the specified policy ID
|
|
9080
|
+
*
|
|
9081
|
+
* @param {String} policyId The ID of the policy to retrieve
|
|
9082
|
+
* getAuthorizationPolicy is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
9083
|
+
*/},{key:"getAuthorizationPolicy",value:function getAuthorizationPolicy(policyId){// verify the required parameter 'policyId' is set
|
|
9084
|
+
if(policyId===undefined||policyId===null){throw'Missing the required parameter "policyId" when calling getAuthorizationPolicy';}return this.apiClient.callApi('/api/v2/authorization/policies/{policyId}','GET',{'policyId':policyId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
9085
|
+
* Get the list of attributes used to evaluate an access control policy with the specified policy ID
|
|
9086
|
+
*
|
|
9087
|
+
* @param {String} policyId The ID of the policy to retrieve attributes
|
|
9088
|
+
* getAuthorizationPolicyAttributes is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
9089
|
+
*/},{key:"getAuthorizationPolicyAttributes",value:function getAuthorizationPolicyAttributes(policyId){// verify the required parameter 'policyId' is set
|
|
9090
|
+
if(policyId===undefined||policyId===null){throw'Missing the required parameter "policyId" when calling getAuthorizationPolicyAttributes';}return this.apiClient.callApi('/api/v2/authorization/policies/{policyId}/attributes','GET',{'policyId':policyId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
9035
9091
|
* Get the list of enabled products
|
|
9036
9092
|
* Gets the list of enabled products. Some example product names are: collaborateFree, collaboratePro, communicate, and engage.
|
|
9037
9093
|
*/},{key:"getAuthorizationProducts",value:function getAuthorizationProducts(){return this.apiClient.callApi('/api/v2/authorization/products','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
@@ -9146,6 +9202,30 @@ if(divisionId===undefined||divisionId===null){throw'Missing the required paramet
|
|
|
9146
9202
|
* @param {Object} body Division
|
|
9147
9203
|
*/},{key:"postAuthorizationDivisions",value:function postAuthorizationDivisions(body){// verify the required parameter 'body' is set
|
|
9148
9204
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postAuthorizationDivisions';}return this.apiClient.callApi('/api/v2/authorization/divisions','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
9205
|
+
* Add an access control policy for a specified resource target and subject
|
|
9206
|
+
*
|
|
9207
|
+
* @param {String} targetName The domain:entity:action target to which the policy will be applied
|
|
9208
|
+
* @param {Object} body Access control policy
|
|
9209
|
+
* postAuthorizationPoliciesTarget is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
9210
|
+
*/},{key:"postAuthorizationPoliciesTarget",value:function postAuthorizationPoliciesTarget(targetName,body){// verify the required parameter 'targetName' is set
|
|
9211
|
+
if(targetName===undefined||targetName===null){throw'Missing the required parameter "targetName" when calling postAuthorizationPoliciesTarget';}// verify the required parameter 'body' is set
|
|
9212
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postAuthorizationPoliciesTarget';}return this.apiClient.callApi('/api/v2/authorization/policies/targets/{targetName}','POST',{'targetName':targetName},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
9213
|
+
* Validate the conditions and attributes of an access control policy for a specified resource target
|
|
9214
|
+
*
|
|
9215
|
+
* @param {String} targetName The domain:entity:action target to which the policy will be applied
|
|
9216
|
+
* @param {Object} body Access control policy
|
|
9217
|
+
* postAuthorizationPoliciesTargetValidate is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
9218
|
+
*/},{key:"postAuthorizationPoliciesTargetValidate",value:function postAuthorizationPoliciesTargetValidate(targetName,body){// verify the required parameter 'targetName' is set
|
|
9219
|
+
if(targetName===undefined||targetName===null){throw'Missing the required parameter "targetName" when calling postAuthorizationPoliciesTargetValidate';}// verify the required parameter 'body' is set
|
|
9220
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postAuthorizationPoliciesTargetValidate';}return this.apiClient.callApi('/api/v2/authorization/policies/targets/{targetName}/validate','POST',{'targetName':targetName},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
9221
|
+
* Simulate a request and evaluate the specified policy ID against the provided values
|
|
9222
|
+
*
|
|
9223
|
+
* @param {String} policyId The ID of the policy to test the simulated data against
|
|
9224
|
+
* @param {Object} body A map of attribute names to type and simulated data value
|
|
9225
|
+
* postAuthorizationPolicySimulate is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
9226
|
+
*/},{key:"postAuthorizationPolicySimulate",value:function postAuthorizationPolicySimulate(policyId,body){// verify the required parameter 'policyId' is set
|
|
9227
|
+
if(policyId===undefined||policyId===null){throw'Missing the required parameter "policyId" when calling postAuthorizationPolicySimulate';}// verify the required parameter 'body' is set
|
|
9228
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postAuthorizationPolicySimulate';}return this.apiClient.callApi('/api/v2/authorization/policies/{policyId}/simulate','POST',{'policyId':policyId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
9149
9229
|
* Bulk-grant subjects and divisions with an organization role.
|
|
9150
9230
|
*
|
|
9151
9231
|
* @param {String} roleId Role ID
|
|
@@ -9217,6 +9297,22 @@ if(roleId===undefined||roleId===null){throw'Missing the required parameter "role
|
|
|
9217
9297
|
*/},{key:"putAuthorizationDivision",value:function putAuthorizationDivision(divisionId,body){// verify the required parameter 'divisionId' is set
|
|
9218
9298
|
if(divisionId===undefined||divisionId===null){throw'Missing the required parameter "divisionId" when calling putAuthorizationDivision';}// verify the required parameter 'body' is set
|
|
9219
9299
|
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']);}/**
|
|
9300
|
+
* Add an access control policy for a specified resource target and subject, overwriting any existing policy
|
|
9301
|
+
*
|
|
9302
|
+
* @param {String} targetName The domain:entity:action target to which the policy will be applied
|
|
9303
|
+
* @param {Object} body Access control policy
|
|
9304
|
+
* putAuthorizationPoliciesTarget is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
9305
|
+
*/},{key:"putAuthorizationPoliciesTarget",value:function putAuthorizationPoliciesTarget(targetName,body){// verify the required parameter 'targetName' is set
|
|
9306
|
+
if(targetName===undefined||targetName===null){throw'Missing the required parameter "targetName" when calling putAuthorizationPoliciesTarget';}// verify the required parameter 'body' is set
|
|
9307
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putAuthorizationPoliciesTarget';}return this.apiClient.callApi('/api/v2/authorization/policies/targets/{targetName}','PUT',{'targetName':targetName},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
9308
|
+
* Update an access control policy with a given ID
|
|
9309
|
+
*
|
|
9310
|
+
* @param {String} policyId The ID of the policy to update
|
|
9311
|
+
* @param {Object} body Access control policy
|
|
9312
|
+
* putAuthorizationPolicy is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
9313
|
+
*/},{key:"putAuthorizationPolicy",value:function putAuthorizationPolicy(policyId,body){// verify the required parameter 'policyId' is set
|
|
9314
|
+
if(policyId===undefined||policyId===null){throw'Missing the required parameter "policyId" when calling putAuthorizationPolicy';}// verify the required parameter 'body' is set
|
|
9315
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putAuthorizationPolicy';}return this.apiClient.callApi('/api/v2/authorization/policies/{policyId}','PUT',{'policyId':policyId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
9220
9316
|
* Update an organization role.
|
|
9221
9317
|
* Update
|
|
9222
9318
|
* @param {String} roleId Role ID
|
|
@@ -9257,7 +9353,7 @@ if(subjectId===undefined||subjectId===null){throw'Missing the required parameter
|
|
|
9257
9353
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putUserRoles';}return this.apiClient.callApi('/api/v2/users/{subjectId}/roles','PUT',{'subjectId':subjectId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var BillingApi=/*#__PURE__*/function(){/**
|
|
9258
9354
|
* Billing service.
|
|
9259
9355
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
9260
|
-
* @version
|
|
9356
|
+
* @version 216.0.0
|
|
9261
9357
|
*//**
|
|
9262
9358
|
* Constructs a new BillingApi.
|
|
9263
9359
|
* @alias module:purecloud-platform-client-v2/api/BillingApi
|
|
@@ -9281,7 +9377,7 @@ if(endDate===undefined||endDate===null){throw'Missing the required parameter "en
|
|
|
9281
9377
|
if(trustorOrgId===undefined||trustorOrgId===null){throw'Missing the required parameter "trustorOrgId" when calling getBillingTrusteebillingoverviewTrustorOrgId';}return this.apiClient.callApi('/api/v2/billing/trusteebillingoverview/{trustorOrgId}','GET',{'trustorOrgId':trustorOrgId},{'billingPeriodIndex':opts['billingPeriodIndex']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var CarrierServicesApi=/*#__PURE__*/function(){/**
|
|
9282
9378
|
* CarrierServices service.
|
|
9283
9379
|
* @module purecloud-platform-client-v2/api/CarrierServicesApi
|
|
9284
|
-
* @version
|
|
9380
|
+
* @version 216.0.0
|
|
9285
9381
|
*//**
|
|
9286
9382
|
* Constructs a new CarrierServicesApi.
|
|
9287
9383
|
* @alias module:purecloud-platform-client-v2/api/CarrierServicesApi
|
|
@@ -9301,7 +9397,7 @@ if(phoneNumber===undefined||phoneNumber===null){throw'Missing the required param
|
|
|
9301
9397
|
*/},{key:"postCarrierservicesIntegrationsEmergencylocationsMe",value:function postCarrierservicesIntegrationsEmergencylocationsMe(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/carrierservices/integrations/emergencylocations/me','POST',{},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var ChatApi=/*#__PURE__*/function(){/**
|
|
9302
9398
|
* Chat service.
|
|
9303
9399
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
9304
|
-
* @version
|
|
9400
|
+
* @version 216.0.0
|
|
9305
9401
|
*//**
|
|
9306
9402
|
* Constructs a new ChatApi.
|
|
9307
9403
|
* @alias module:purecloud-platform-client-v2/api/ChatApi
|
|
@@ -9526,7 +9622,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
9526
9622
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putChatsSettings';}return this.apiClient.callApi('/api/v2/chats/settings','PUT',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var CoachingApi=/*#__PURE__*/function(){/**
|
|
9527
9623
|
* Coaching service.
|
|
9528
9624
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
9529
|
-
* @version
|
|
9625
|
+
* @version 216.0.0
|
|
9530
9626
|
*//**
|
|
9531
9627
|
* Constructs a new CoachingApi.
|
|
9532
9628
|
* @alias module:purecloud-platform-client-v2/api/CoachingApi
|
|
@@ -9679,7 +9775,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
9679
9775
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postCoachingScheduleslotsQuery';}return this.apiClient.callApi('/api/v2/coaching/scheduleslots/query','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var ContentManagementApi=/*#__PURE__*/function(){/**
|
|
9680
9776
|
* ContentManagement service.
|
|
9681
9777
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
9682
|
-
* @version
|
|
9778
|
+
* @version 216.0.0
|
|
9683
9779
|
*//**
|
|
9684
9780
|
* Constructs a new ContentManagementApi.
|
|
9685
9781
|
* @alias module:purecloud-platform-client-v2/api/ContentManagementApi
|
|
@@ -9961,7 +10057,7 @@ if(tagId===undefined||tagId===null){throw'Missing the required parameter "tagId"
|
|
|
9961
10057
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putContentmanagementWorkspaceTagvalue';}return this.apiClient.callApi('/api/v2/contentmanagement/workspaces/{workspaceId}/tagvalues/{tagId}','PUT',{'workspaceId':workspaceId,'tagId':tagId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var ConversationsApi=/*#__PURE__*/function(){/**
|
|
9962
10058
|
* Conversations service.
|
|
9963
10059
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
9964
|
-
* @version
|
|
10060
|
+
* @version 216.0.0
|
|
9965
10061
|
*//**
|
|
9966
10062
|
* Constructs a new ConversationsApi.
|
|
9967
10063
|
* @alias module:purecloud-platform-client-v2/api/ConversationsApi
|
|
@@ -11708,7 +11804,7 @@ if(conversationId===undefined||conversationId===null){throw'Missing the required
|
|
|
11708
11804
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putConversationsVideoRecordingstate';}return this.apiClient.callApi('/api/v2/conversations/videos/{conversationId}/recordingstate','PUT',{'conversationId':conversationId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var DataExtensionsApi=/*#__PURE__*/function(){/**
|
|
11709
11805
|
* DataExtensions service.
|
|
11710
11806
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
11711
|
-
* @version
|
|
11807
|
+
* @version 216.0.0
|
|
11712
11808
|
*//**
|
|
11713
11809
|
* Constructs a new DataExtensionsApi.
|
|
11714
11810
|
* @alias module:purecloud-platform-client-v2/api/DataExtensionsApi
|
|
@@ -11729,7 +11825,7 @@ if(coretypeName===undefined||coretypeName===null){throw'Missing the required par
|
|
|
11729
11825
|
*/},{key:"getDataextensionsLimits",value:function getDataextensionsLimits(){return this.apiClient.callApi('/api/v2/dataextensions/limits','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var DataPrivacyApi=/*#__PURE__*/function(){/**
|
|
11730
11826
|
* DataPrivacy service.
|
|
11731
11827
|
* @module purecloud-platform-client-v2/api/DataPrivacyApi
|
|
11732
|
-
* @version
|
|
11828
|
+
* @version 216.0.0
|
|
11733
11829
|
*//**
|
|
11734
11830
|
* Constructs a new DataPrivacyApi.
|
|
11735
11831
|
* @alias module:purecloud-platform-client-v2/api/DataPrivacyApi
|
|
@@ -11769,7 +11865,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
11769
11865
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postDataprivacyMaskingrulesValidate';}return this.apiClient.callApi('/api/v2/dataprivacy/maskingrules/validate','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var DownloadsApi=/*#__PURE__*/function(){/**
|
|
11770
11866
|
* Downloads service.
|
|
11771
11867
|
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
11772
|
-
* @version
|
|
11868
|
+
* @version 216.0.0
|
|
11773
11869
|
*//**
|
|
11774
11870
|
* Constructs a new DownloadsApi.
|
|
11775
11871
|
* @alias module:purecloud-platform-client-v2/api/DownloadsApi
|
|
@@ -11788,7 +11884,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
11788
11884
|
if(downloadId===undefined||downloadId===null){throw'Missing the required parameter "downloadId" when calling getDownload';}return this.apiClient.callApi('/api/v2/downloads/{downloadId}','GET',{'downloadId':downloadId},{'contentDisposition':opts['contentDisposition'],'issueRedirect':opts['issueRedirect'],'redirectToAuth':opts['redirectToAuth']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var EmailsApi=/*#__PURE__*/function(){/**
|
|
11789
11885
|
* Emails service.
|
|
11790
11886
|
* @module purecloud-platform-client-v2/api/EmailsApi
|
|
11791
|
-
* @version
|
|
11887
|
+
* @version 216.0.0
|
|
11792
11888
|
*//**
|
|
11793
11889
|
* Constructs a new EmailsApi.
|
|
11794
11890
|
* @alias module:purecloud-platform-client-v2/api/EmailsApi
|
|
@@ -11806,7 +11902,7 @@ if(downloadId===undefined||downloadId===null){throw'Missing the required paramet
|
|
|
11806
11902
|
*/},{key:"patchEmailsSettings",value:function patchEmailsSettings(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/emails/settings','PATCH',{},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var EmployeeEngagementApi=/*#__PURE__*/function(){/**
|
|
11807
11903
|
* EmployeeEngagement service.
|
|
11808
11904
|
* @module purecloud-platform-client-v2/api/EmployeeEngagementApi
|
|
11809
|
-
* @version
|
|
11905
|
+
* @version 216.0.0
|
|
11810
11906
|
*//**
|
|
11811
11907
|
* Constructs a new EmployeeEngagementApi.
|
|
11812
11908
|
* @alias module:purecloud-platform-client-v2/api/EmployeeEngagementApi
|
|
@@ -11844,7 +11940,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
11844
11940
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postEmployeeengagementRecognitions';}return this.apiClient.callApi('/api/v2/employeeengagement/recognitions','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var EventsApi=/*#__PURE__*/function(){/**
|
|
11845
11941
|
* Events service.
|
|
11846
11942
|
* @module purecloud-platform-client-v2/api/EventsApi
|
|
11847
|
-
* @version
|
|
11943
|
+
* @version 216.0.0
|
|
11848
11944
|
*//**
|
|
11849
11945
|
* Constructs a new EventsApi.
|
|
11850
11946
|
* @alias module:purecloud-platform-client-v2/api/EventsApi
|
|
@@ -11869,7 +11965,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
11869
11965
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postEventsUsersRoutingstatus';}return this.apiClient.callApi('/api/v2/events/users/routingstatus','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var ExternalContactsApi=/*#__PURE__*/function(){/**
|
|
11870
11966
|
* ExternalContacts service.
|
|
11871
11967
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
11872
|
-
* @version
|
|
11968
|
+
* @version 216.0.0
|
|
11873
11969
|
*//**
|
|
11874
11970
|
* Constructs a new ExternalContactsApi.
|
|
11875
11971
|
* @alias module:purecloud-platform-client-v2/api/ExternalContactsApi
|
|
@@ -12045,16 +12141,19 @@ if(uploadId===undefined||uploadId===null){throw'Missing the required parameter "
|
|
|
12045
12141
|
* Get job based on id
|
|
12046
12142
|
*
|
|
12047
12143
|
* @param {String} jobId Job id
|
|
12048
|
-
|
|
12049
|
-
|
|
12144
|
+
* @param {Object} opts Optional parameters
|
|
12145
|
+
* @param {Array.<String>} opts.expand which fields, if any, to expand
|
|
12146
|
+
*/},{key:"getExternalcontactsImportJob",value:function getExternalcontactsImportJob(jobId,opts){opts=opts||{};// verify the required parameter 'jobId' is set
|
|
12147
|
+
if(jobId===undefined||jobId===null){throw'Missing the required parameter "jobId" when calling getExternalcontactsImportJob';}return this.apiClient.callApi('/api/v2/externalcontacts/import/jobs/{jobId}','GET',{'jobId':jobId},{'expand':this.apiClient.buildCollectionParam(opts['expand'],'multi')},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
12050
12148
|
* List jobs for organization
|
|
12051
12149
|
*
|
|
12052
12150
|
* @param {Object} opts Optional parameters
|
|
12151
|
+
* @param {Array.<String>} opts.expand which fields, if any, to expand
|
|
12053
12152
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
12054
12153
|
* @param {String} opts.pageSize Number of entities to return. Maximum of 100. (default to 25)
|
|
12055
12154
|
* @param {Object} opts.sortOrder Direction of sorting. (default to Ascending)
|
|
12056
12155
|
* @param {Object} opts.jobStatus Search term to filter by jobStatus
|
|
12057
|
-
*/},{key:"getExternalcontactsImportJobs",value:function getExternalcontactsImportJobs(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/externalcontacts/import/jobs','GET',{},{'after':opts['after'],'pageSize':opts['pageSize'],'sortOrder':opts['sortOrder'],'jobStatus':opts['jobStatus']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
12156
|
+
*/},{key:"getExternalcontactsImportJobs",value:function getExternalcontactsImportJobs(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/externalcontacts/import/jobs','GET',{},{'expand':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'after':opts['after'],'pageSize':opts['pageSize'],'sortOrder':opts['sortOrder'],'jobStatus':opts['jobStatus']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
12058
12157
|
* Get setting based on id
|
|
12059
12158
|
*
|
|
12060
12159
|
* @param {String} settingsId Settings id
|
|
@@ -12461,7 +12560,7 @@ if(relationshipId===undefined||relationshipId===null){throw'Missing the required
|
|
|
12461
12560
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putExternalcontactsRelationship';}return this.apiClient.callApi('/api/v2/externalcontacts/relationships/{relationshipId}','PUT',{'relationshipId':relationshipId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var FaxApi=/*#__PURE__*/function(){/**
|
|
12462
12561
|
* Fax service.
|
|
12463
12562
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
12464
|
-
* @version
|
|
12563
|
+
* @version 216.0.0
|
|
12465
12564
|
*//**
|
|
12466
12565
|
* Constructs a new FaxApi.
|
|
12467
12566
|
* @alias module:purecloud-platform-client-v2/api/FaxApi
|
|
@@ -12510,7 +12609,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
12510
12609
|
*/},{key:"putFaxSettings",value:function putFaxSettings(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/fax/settings','PUT',{},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var FlowsApi=/*#__PURE__*/function(){/**
|
|
12511
12610
|
* Flows service.
|
|
12512
12611
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
12513
|
-
* @version
|
|
12612
|
+
* @version 216.0.0
|
|
12514
12613
|
*//**
|
|
12515
12614
|
* Constructs a new FlowsApi.
|
|
12516
12615
|
* @alias module:purecloud-platform-client-v2/api/FlowsApi
|
|
@@ -12558,7 +12657,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
12558
12657
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postAnalyticsFlowsObservationsQuery';}return this.apiClient.callApi('/api/v2/analytics/flows/observations/query','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var GamificationApi=/*#__PURE__*/function(){/**
|
|
12559
12658
|
* Gamification service.
|
|
12560
12659
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
12561
|
-
* @version
|
|
12660
|
+
* @version 216.0.0
|
|
12562
12661
|
*//**
|
|
12563
12662
|
* Constructs a new GamificationApi.
|
|
12564
12663
|
* @alias module:purecloud-platform-client-v2/api/GamificationApi
|
|
@@ -13117,7 +13216,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
13117
13216
|
if(status===undefined||status===null){throw'Missing the required parameter "status" when calling putGamificationStatus';}return this.apiClient.callApi('/api/v2/gamification/status','PUT',{},{},{},{},status,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var GeneralDataProtectionRegulationApi=/*#__PURE__*/function(){/**
|
|
13118
13217
|
* GeneralDataProtectionRegulation service.
|
|
13119
13218
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
13120
|
-
* @version
|
|
13219
|
+
* @version 216.0.0
|
|
13121
13220
|
*//**
|
|
13122
13221
|
* Constructs a new GeneralDataProtectionRegulationApi.
|
|
13123
13222
|
* @alias module:purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
@@ -13152,7 +13251,7 @@ if(searchValue===undefined||searchValue===null){throw'Missing the required param
|
|
|
13152
13251
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postGdprRequests';}return this.apiClient.callApi('/api/v2/gdpr/requests','POST',{},{'deleteConfirmed':opts['deleteConfirmed']},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var GeolocationApi=/*#__PURE__*/function(){/**
|
|
13153
13252
|
* Geolocation service.
|
|
13154
13253
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
13155
|
-
* @version
|
|
13254
|
+
* @version 216.0.0
|
|
13156
13255
|
*//**
|
|
13157
13256
|
* Constructs a new GeolocationApi.
|
|
13158
13257
|
* @alias module:purecloud-platform-client-v2/api/GeolocationApi
|
|
@@ -13186,7 +13285,7 @@ if(clientId===undefined||clientId===null){throw'Missing the required parameter "
|
|
|
13186
13285
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling patchUserGeolocation';}return this.apiClient.callApi('/api/v2/users/{userId}/geolocations/{clientId}','PATCH',{'userId':userId,'clientId':clientId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var GreetingsApi=/*#__PURE__*/function(){/**
|
|
13187
13286
|
* Greetings service.
|
|
13188
13287
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
13189
|
-
* @version
|
|
13288
|
+
* @version 216.0.0
|
|
13190
13289
|
*//**
|
|
13191
13290
|
* Constructs a new GreetingsApi.
|
|
13192
13291
|
* @alias module:purecloud-platform-client-v2/api/GreetingsApi
|
|
@@ -13293,7 +13392,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
13293
13392
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putUserGreetingsDefaults';}return this.apiClient.callApi('/api/v2/users/{userId}/greetings/defaults','PUT',{'userId':userId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var GroupsApi=/*#__PURE__*/function(){/**
|
|
13294
13393
|
* Groups service.
|
|
13295
13394
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
13296
|
-
* @version
|
|
13395
|
+
* @version 216.0.0
|
|
13297
13396
|
*//**
|
|
13298
13397
|
* Constructs a new GroupsApi.
|
|
13299
13398
|
* @alias module:purecloud-platform-client-v2/api/GroupsApi
|
|
@@ -13426,7 +13525,7 @@ if(groupId===undefined||groupId===null){throw'Missing the required parameter "gr
|
|
|
13426
13525
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putGroupDynamicsettings';}return this.apiClient.callApi('/api/v2/groups/{groupId}/dynamicsettings','PUT',{'groupId':groupId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var IdentityProviderApi=/*#__PURE__*/function(){/**
|
|
13427
13526
|
* IdentityProvider service.
|
|
13428
13527
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
13429
|
-
* @version
|
|
13528
|
+
* @version 216.0.0
|
|
13430
13529
|
*//**
|
|
13431
13530
|
* Constructs a new IdentityProviderApi.
|
|
13432
13531
|
* @alias module:purecloud-platform-client-v2/api/IdentityProviderApi
|
|
@@ -13582,7 +13681,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
13582
13681
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putIdentityprovidersSalesforce';}return this.apiClient.callApi('/api/v2/identityproviders/salesforce','PUT',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var InfrastructureAsCodeApi=/*#__PURE__*/function(){/**
|
|
13583
13682
|
* InfrastructureAsCode service.
|
|
13584
13683
|
* @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
13585
|
-
* @version
|
|
13684
|
+
* @version 216.0.0
|
|
13586
13685
|
*//**
|
|
13587
13686
|
* Constructs a new InfrastructureAsCodeApi.
|
|
13588
13687
|
* @alias module:purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
@@ -13636,7 +13735,7 @@ if(jobId===undefined||jobId===null){throw'Missing the required parameter "jobId"
|
|
|
13636
13735
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postInfrastructureascodeJobs';}return this.apiClient.callApi('/api/v2/infrastructureascode/jobs','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var IntegrationsApi=/*#__PURE__*/function(){/**
|
|
13637
13736
|
* Integrations service.
|
|
13638
13737
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
13639
|
-
* @version
|
|
13738
|
+
* @version 216.0.0
|
|
13640
13739
|
*//**
|
|
13641
13740
|
* Constructs a new IntegrationsApi.
|
|
13642
13741
|
* @alias module:purecloud-platform-client-v2/api/IntegrationsApi
|
|
@@ -14266,7 +14365,7 @@ if(ucIntegrationId===undefined||ucIntegrationId===null){throw'Missing the requir
|
|
|
14266
14365
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putIntegrationsUnifiedcommunicationThirdpartypresences';}return this.apiClient.callApi('/api/v2/integrations/unifiedcommunications/{ucIntegrationId}/thirdpartypresences','PUT',{'ucIntegrationId':ucIntegrationId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var JourneyApi=/*#__PURE__*/function(){/**
|
|
14267
14366
|
* Journey service.
|
|
14268
14367
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
14269
|
-
* @version
|
|
14368
|
+
* @version 216.0.0
|
|
14270
14369
|
*//**
|
|
14271
14370
|
* Constructs a new JourneyApi.
|
|
14272
14371
|
* @alias module:purecloud-platform-client-v2/api/JourneyApi
|
|
@@ -14553,6 +14652,9 @@ if(journeyVersionId===undefined||journeyVersionId===null){throw'Missing the requ
|
|
|
14553
14652
|
* @param {Object} opts.expand Parameter to request additional data to return in Journey payload
|
|
14554
14653
|
* @param {String} opts.id Parameter to request a list of Journey Views by id, separated by commas. Limit of 100 items.
|
|
14555
14654
|
*/},{key:"getJourneyViews",value:function getJourneyViews(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/journey/views','GET',{},{'pageNumber':opts['pageNumber'],'pageSize':opts['pageSize'],'nameOrCreatedBy':opts['nameOrCreatedBy'],'expand':opts['expand'],'id':opts['id']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
14655
|
+
* Get details about the data available for journey queries including oldest and newest event dates
|
|
14656
|
+
*
|
|
14657
|
+
*/},{key:"getJourneyViewsDataDetails",value:function getJourneyViewsDataDetails(){return this.apiClient.callApi('/api/v2/journey/views/data/details','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
14556
14658
|
* Get an Event Definition
|
|
14557
14659
|
*
|
|
14558
14660
|
* @param {String} eventDefinitionId Event Definition ID
|
|
@@ -14743,7 +14845,7 @@ if(versionId===undefined||versionId===null){throw'Missing the required parameter
|
|
|
14743
14845
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putJourneyViewVersion';}return this.apiClient.callApi('/api/v2/journey/views/{viewId}/versions/{versionId}','PUT',{'viewId':viewId,'versionId':versionId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var KnowledgeApi=/*#__PURE__*/function(){/**
|
|
14744
14846
|
* Knowledge service.
|
|
14745
14847
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
14746
|
-
* @version
|
|
14848
|
+
* @version 216.0.0
|
|
14747
14849
|
*//**
|
|
14748
14850
|
* Constructs a new KnowledgeApi.
|
|
14749
14851
|
* @alias module:purecloud-platform-client-v2/api/KnowledgeApi
|
|
@@ -15813,7 +15915,7 @@ if(sourceId===undefined||sourceId===null){throw'Missing the required parameter "
|
|
|
15813
15915
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putKnowledgeKnowledgebaseSourcesServicenowSourceId';}return this.apiClient.callApi('/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/sources/servicenow/{sourceId}','PUT',{'knowledgeBaseId':knowledgeBaseId,'sourceId':sourceId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var LanguageUnderstandingApi=/*#__PURE__*/function(){/**
|
|
15814
15916
|
* LanguageUnderstanding service.
|
|
15815
15917
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
15816
|
-
* @version
|
|
15918
|
+
* @version 216.0.0
|
|
15817
15919
|
*//**
|
|
15818
15920
|
* Constructs a new LanguageUnderstandingApi.
|
|
15819
15921
|
* @alias module:purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
@@ -16072,7 +16174,7 @@ if(domainVersionId===undefined||domainVersionId===null){throw'Missing the requir
|
|
|
16072
16174
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putLanguageunderstandingDomainVersion';}return this.apiClient.callApi('/api/v2/languageunderstanding/domains/{domainId}/versions/{domainVersionId}','PUT',{'domainId':domainId,'domainVersionId':domainVersionId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var LanguagesApi=/*#__PURE__*/function(){/**
|
|
16073
16175
|
* Languages service.
|
|
16074
16176
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
16075
|
-
* @version
|
|
16177
|
+
* @version 216.0.0
|
|
16076
16178
|
*//**
|
|
16077
16179
|
* Constructs a new LanguagesApi.
|
|
16078
16180
|
* @alias module:purecloud-platform-client-v2/api/LanguagesApi
|
|
@@ -16127,7 +16229,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
16127
16229
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postLanguages';}return this.apiClient.callApi('/api/v2/languages','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var LearningApi=/*#__PURE__*/function(){/**
|
|
16128
16230
|
* Learning service.
|
|
16129
16231
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
16130
|
-
* @version
|
|
16232
|
+
* @version 216.0.0
|
|
16131
16233
|
*//**
|
|
16132
16234
|
* Constructs a new LearningApi.
|
|
16133
16235
|
* @alias module:purecloud-platform-client-v2/api/LearningApi
|
|
@@ -16398,7 +16500,7 @@ if(moduleId===undefined||moduleId===null){throw'Missing the required parameter "
|
|
|
16398
16500
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putLearningModuleRule';}return this.apiClient.callApi('/api/v2/learning/modules/{moduleId}/rule','PUT',{'moduleId':moduleId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var LicenseApi=/*#__PURE__*/function(){/**
|
|
16399
16501
|
* License service.
|
|
16400
16502
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
16401
|
-
* @version
|
|
16503
|
+
* @version 216.0.0
|
|
16402
16504
|
*//**
|
|
16403
16505
|
* Constructs a new LicenseApi.
|
|
16404
16506
|
* @alias module:purecloud-platform-client-v2/api/LicenseApi
|
|
@@ -16452,7 +16554,7 @@ if(featureName===undefined||featureName===null){throw'Missing the required param
|
|
|
16452
16554
|
*/},{key:"postLicenseUsers",value:function postLicenseUsers(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/license/users','POST',{},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var LocationsApi=/*#__PURE__*/function(){/**
|
|
16453
16555
|
* Locations service.
|
|
16454
16556
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
16455
|
-
* @version
|
|
16557
|
+
* @version 216.0.0
|
|
16456
16558
|
*//**
|
|
16457
16559
|
* Constructs a new LocationsApi.
|
|
16458
16560
|
* @alias module:purecloud-platform-client-v2/api/LocationsApi
|
|
@@ -16511,7 +16613,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
16511
16613
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postLocationsSearch';}return this.apiClient.callApi('/api/v2/locations/search','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var LogCaptureApi=/*#__PURE__*/function(){/**
|
|
16512
16614
|
* LogCapture service.
|
|
16513
16615
|
* @module purecloud-platform-client-v2/api/LogCaptureApi
|
|
16514
|
-
* @version
|
|
16616
|
+
* @version 216.0.0
|
|
16515
16617
|
*//**
|
|
16516
16618
|
* Constructs a new LogCaptureApi.
|
|
16517
16619
|
* @alias module:purecloud-platform-client-v2/api/LogCaptureApi
|
|
@@ -16561,7 +16663,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
16561
16663
|
if(userId===undefined||userId===null){throw'Missing the required parameter "userId" when calling postDiagnosticsLogcaptureBrowserUser';}return this.apiClient.callApi('/api/v2/diagnostics/logcapture/browser/users/{userId}','POST',{'userId':userId},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var MessagingApi=/*#__PURE__*/function(){/**
|
|
16562
16664
|
* Messaging service.
|
|
16563
16665
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
16564
|
-
* @version
|
|
16666
|
+
* @version 216.0.0
|
|
16565
16667
|
*//**
|
|
16566
16668
|
* Constructs a new MessagingApi.
|
|
16567
16669
|
* @alias module:purecloud-platform-client-v2/api/MessagingApi
|
|
@@ -16651,7 +16753,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
16651
16753
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putMessagingSettingsDefault';}return this.apiClient.callApi('/api/v2/messaging/settings/default','PUT',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var MobileDevicesApi=/*#__PURE__*/function(){/**
|
|
16652
16754
|
* MobileDevices service.
|
|
16653
16755
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
16654
|
-
* @version
|
|
16756
|
+
* @version 216.0.0
|
|
16655
16757
|
*//**
|
|
16656
16758
|
* Constructs a new MobileDevicesApi.
|
|
16657
16759
|
* @alias module:purecloud-platform-client-v2/api/MobileDevicesApi
|
|
@@ -16690,7 +16792,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
16690
16792
|
if(deviceId===undefined||deviceId===null){throw'Missing the required parameter "deviceId" when calling putMobiledevice';}return this.apiClient.callApi('/api/v2/mobiledevices/{deviceId}','PUT',{'deviceId':deviceId},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var NotificationsApi=/*#__PURE__*/function(){/**
|
|
16691
16793
|
* Notifications service.
|
|
16692
16794
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
16693
|
-
* @version
|
|
16795
|
+
* @version 216.0.0
|
|
16694
16796
|
*//**
|
|
16695
16797
|
* Constructs a new NotificationsApi.
|
|
16696
16798
|
* @alias module:purecloud-platform-client-v2/api/NotificationsApi
|
|
@@ -16747,7 +16849,7 @@ if(channelId===undefined||channelId===null){throw'Missing the required parameter
|
|
|
16747
16849
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putNotificationsChannelSubscriptions';}return this.apiClient.callApi('/api/v2/notifications/channels/{channelId}/subscriptions','PUT',{'channelId':channelId},{'ignoreErrors':opts['ignoreErrors']},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var OAuthApi=/*#__PURE__*/function(){/**
|
|
16748
16850
|
* OAuth service.
|
|
16749
16851
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
16750
|
-
* @version
|
|
16852
|
+
* @version 216.0.0
|
|
16751
16853
|
*//**
|
|
16752
16854
|
* Constructs a new OAuthApi.
|
|
16753
16855
|
* @alias module:purecloud-platform-client-v2/api/OAuthApi
|
|
@@ -16832,7 +16934,7 @@ if(clientId===undefined||clientId===null){throw'Missing the required parameter "
|
|
|
16832
16934
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putOauthClient';}return this.apiClient.callApi('/api/v2/oauth/clients/{clientId}','PUT',{'clientId':clientId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var ObjectsApi=/*#__PURE__*/function(){/**
|
|
16833
16935
|
* Objects service.
|
|
16834
16936
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
16835
|
-
* @version
|
|
16937
|
+
* @version 216.0.0
|
|
16836
16938
|
*//**
|
|
16837
16939
|
* Constructs a new ObjectsApi.
|
|
16838
16940
|
* @alias module:purecloud-platform-client-v2/api/ObjectsApi
|
|
@@ -16903,7 +17005,7 @@ if(divisionId===undefined||divisionId===null){throw'Missing the required paramet
|
|
|
16903
17005
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putAuthorizationDivision';}return this.apiClient.callApi('/api/v2/authorization/divisions/{divisionId}','PUT',{'divisionId':divisionId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var OperationalEventsApi=/*#__PURE__*/function(){/**
|
|
16904
17006
|
* OperationalEvents service.
|
|
16905
17007
|
* @module purecloud-platform-client-v2/api/OperationalEventsApi
|
|
16906
|
-
* @version
|
|
17008
|
+
* @version 216.0.0
|
|
16907
17009
|
*//**
|
|
16908
17010
|
* Constructs a new OperationalEventsApi.
|
|
16909
17011
|
* @alias module:purecloud-platform-client-v2/api/OperationalEventsApi
|
|
@@ -16934,7 +17036,7 @@ if(eventDefinitionId===undefined||eventDefinitionId===null){throw'Missing the re
|
|
|
16934
17036
|
*/},{key:"postUsageEventsQuery",value:function postUsageEventsQuery(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/usage/events/query','POST',{},{'before':opts['before'],'after':opts['after'],'pageSize':opts['pageSize']},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var OrganizationApi=/*#__PURE__*/function(){/**
|
|
16935
17037
|
* Organization service.
|
|
16936
17038
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
16937
|
-
* @version
|
|
17039
|
+
* @version 216.0.0
|
|
16938
17040
|
*//**
|
|
16939
17041
|
* Constructs a new OrganizationApi.
|
|
16940
17042
|
* @alias module:purecloud-platform-client-v2/api/OrganizationApi
|
|
@@ -17059,7 +17161,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
17059
17161
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putOrganizationsWhitelist';}return this.apiClient.callApi('/api/v2/organizations/whitelist','PUT',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var OrganizationAuthorizationApi=/*#__PURE__*/function(){/**
|
|
17060
17162
|
* OrganizationAuthorization service.
|
|
17061
17163
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
17062
|
-
* @version
|
|
17164
|
+
* @version 216.0.0
|
|
17063
17165
|
*//**
|
|
17064
17166
|
* Constructs a new OrganizationAuthorizationApi.
|
|
17065
17167
|
* @alias module:purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
@@ -17393,7 +17495,7 @@ if(trustorOrgId===undefined||trustorOrgId===null){throw'Missing the required par
|
|
|
17393
17495
|
if(trusteeUserId===undefined||trusteeUserId===null){throw'Missing the required parameter "trusteeUserId" when calling putOrgauthorizationTrustorUser';}return this.apiClient.callApi('/api/v2/orgauthorization/trustors/{trustorOrgId}/users/{trusteeUserId}','PUT',{'trustorOrgId':trustorOrgId,'trusteeUserId':trusteeUserId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var OutboundApi=/*#__PURE__*/function(){/**
|
|
17394
17496
|
* Outbound service.
|
|
17395
17497
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
17396
|
-
* @version
|
|
17498
|
+
* @version 216.0.0
|
|
17397
17499
|
*//**
|
|
17398
17500
|
* Constructs a new OutboundApi.
|
|
17399
17501
|
* @alias module:purecloud-platform-client-v2/api/OutboundApi
|
|
@@ -18504,7 +18606,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
18504
18606
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putOutboundWrapupcodemappings';}return this.apiClient.callApi('/api/v2/outbound/wrapupcodemappings','PUT',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var PresenceApi=/*#__PURE__*/function(){/**
|
|
18505
18607
|
* Presence service.
|
|
18506
18608
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
18507
|
-
* @version
|
|
18609
|
+
* @version 216.0.0
|
|
18508
18610
|
*//**
|
|
18509
18611
|
* Constructs a new PresenceApi.
|
|
18510
18612
|
* @alias module:purecloud-platform-client-v2/api/PresenceApi
|
|
@@ -18677,7 +18779,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
18677
18779
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putUsersPresencesBulk';}return this.apiClient.callApi('/api/v2/users/presences/bulk','PUT',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var ProcessAutomationApi=/*#__PURE__*/function(){/**
|
|
18678
18780
|
* ProcessAutomation service.
|
|
18679
18781
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
18680
|
-
* @version
|
|
18782
|
+
* @version 216.0.0
|
|
18681
18783
|
*//**
|
|
18682
18784
|
* Constructs a new ProcessAutomationApi.
|
|
18683
18785
|
* @alias module:purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
@@ -18740,7 +18842,7 @@ if(triggerId===undefined||triggerId===null){throw'Missing the required parameter
|
|
|
18740
18842
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putProcessautomationTrigger';}return this.apiClient.callApi('/api/v2/processautomation/triggers/{triggerId}','PUT',{'triggerId':triggerId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var QualityApi=/*#__PURE__*/function(){/**
|
|
18741
18843
|
* Quality service.
|
|
18742
18844
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
18743
|
-
* @version
|
|
18845
|
+
* @version 216.0.0
|
|
18744
18846
|
*//**
|
|
18745
18847
|
* Constructs a new QualityApi.
|
|
18746
18848
|
* @alias module:purecloud-platform-client-v2/api/QualityApi
|
|
@@ -19219,7 +19321,7 @@ if(customerSurveyUrl===undefined||customerSurveyUrl===null){throw'Missing the re
|
|
|
19219
19321
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putQualitySurveysScorable';}return this.apiClient.callApi('/api/v2/quality/surveys/scorable','PUT',{},{'customerSurveyUrl':customerSurveyUrl},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var RecordingApi=/*#__PURE__*/function(){/**
|
|
19220
19322
|
* Recording service.
|
|
19221
19323
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
19222
|
-
* @version
|
|
19324
|
+
* @version 216.0.0
|
|
19223
19325
|
*//**
|
|
19224
19326
|
* Constructs a new RecordingApi.
|
|
19225
19327
|
* @alias module:purecloud-platform-client-v2/api/RecordingApi
|
|
@@ -19481,14 +19583,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
19481
19583
|
*/},{key:"patchRecordingMediaretentionpolicy",value:function patchRecordingMediaretentionpolicy(policyId,body){// verify the required parameter 'policyId' is set
|
|
19482
19584
|
if(policyId===undefined||policyId===null){throw'Missing the required parameter "policyId" when calling patchRecordingMediaretentionpolicy';}// verify the required parameter 'body' is set
|
|
19483
19585
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling patchRecordingMediaretentionpolicy';}return this.apiClient.callApi('/api/v2/recording/mediaretentionpolicies/{policyId}','PATCH',{'policyId':policyId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
19484
|
-
* Update a screen recording session
|
|
19485
|
-
* This API is deprecated and the functionality to stop screen recording will be no longer supported.
|
|
19486
|
-
* @param {String} recordingSessionId Screen recording session ID
|
|
19487
|
-
* @param {Object} opts Optional parameters
|
|
19488
|
-
* @param {Object} opts.body
|
|
19489
|
-
* @deprecated
|
|
19490
|
-
*/},{key:"patchRecordingsScreensession",value:function patchRecordingsScreensession(recordingSessionId,opts){opts=opts||{};// verify the required parameter 'recordingSessionId' is set
|
|
19491
|
-
if(recordingSessionId===undefined||recordingSessionId===null){throw'Missing the required parameter "recordingSessionId" when calling patchRecordingsScreensession';}return this.apiClient.callApi('/api/v2/recordings/screensessions/{recordingSessionId}','PATCH',{'recordingSessionId':recordingSessionId},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
19492
19586
|
* Create annotation
|
|
19493
19587
|
*
|
|
19494
19588
|
* @param {String} conversationId Conversation ID
|
|
@@ -19631,7 +19725,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
19631
19725
|
*/},{key:"putRecordingsDeletionprotection",value:function putRecordingsDeletionprotection(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/recordings/deletionprotection','PUT',{},{'protect':opts['protect']},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var ResponseManagementApi=/*#__PURE__*/function(){/**
|
|
19632
19726
|
* ResponseManagement service.
|
|
19633
19727
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
19634
|
-
* @version
|
|
19728
|
+
* @version 216.0.0
|
|
19635
19729
|
*//**
|
|
19636
19730
|
* Constructs a new ResponseManagementApi.
|
|
19637
19731
|
* @alias module:purecloud-platform-client-v2/api/ResponseManagementApi
|
|
@@ -19752,7 +19846,7 @@ if(responseAssetId===undefined||responseAssetId===null){throw'Missing the requir
|
|
|
19752
19846
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putResponsemanagementResponseasset';}return this.apiClient.callApi('/api/v2/responsemanagement/responseassets/{responseAssetId}','PUT',{'responseAssetId':responseAssetId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var RoutingApi=/*#__PURE__*/function(){/**
|
|
19753
19847
|
* Routing service.
|
|
19754
19848
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
19755
|
-
* @version
|
|
19849
|
+
* @version 216.0.0
|
|
19756
19850
|
*//**
|
|
19757
19851
|
* Constructs a new RoutingApi.
|
|
19758
19852
|
* @alias module:purecloud-platform-client-v2/api/RoutingApi
|
|
@@ -20751,7 +20845,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
20751
20845
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putUserRoutingskillsBulk';}return this.apiClient.callApi('/api/v2/users/{userId}/routingskills/bulk','PUT',{'userId':userId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var SCIMApi=/*#__PURE__*/function(){/**
|
|
20752
20846
|
* SCIM service.
|
|
20753
20847
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
20754
|
-
* @version
|
|
20848
|
+
* @version 216.0.0
|
|
20755
20849
|
*//**
|
|
20756
20850
|
* Constructs a new SCIMApi.
|
|
20757
20851
|
* @alias module:purecloud-platform-client-v2/api/SCIMApi
|
|
@@ -20976,7 +21070,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
20976
21070
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putScimV2User';}return this.apiClient.callApi('/api/v2/scim/v2/users/{userId}','PUT',{'userId':userId},{},{'If-Match':opts['ifMatch']},{},body,['PureCloud OAuth'],['application/scim+json','application/json'],['application/scim+json','application/json']);}}]);}();var ScreenRecordingApi=/*#__PURE__*/function(){/**
|
|
20977
21071
|
* ScreenRecording service.
|
|
20978
21072
|
* @module purecloud-platform-client-v2/api/ScreenRecordingApi
|
|
20979
|
-
* @version
|
|
21073
|
+
* @version 216.0.0
|
|
20980
21074
|
*//**
|
|
20981
21075
|
* Constructs a new ScreenRecordingApi.
|
|
20982
21076
|
* @alias module:purecloud-platform-client-v2/api/ScreenRecordingApi
|
|
@@ -20991,7 +21085,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
20991
21085
|
*/return _createClass(ScreenRecordingApi,[{key:"postScreenrecordingToken",value:function postScreenrecordingToken(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/screenrecording/token','POST',{},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var ScriptsApi=/*#__PURE__*/function(){/**
|
|
20992
21086
|
* Scripts service.
|
|
20993
21087
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
20994
|
-
* @version
|
|
21088
|
+
* @version 216.0.0
|
|
20995
21089
|
*//**
|
|
20996
21090
|
* Constructs a new ScriptsApi.
|
|
20997
21091
|
* @alias module:purecloud-platform-client-v2/api/ScriptsApi
|
|
@@ -21127,7 +21221,7 @@ if(scriptId===undefined||scriptId===null){throw'Missing the required parameter "
|
|
|
21127
21221
|
*/},{key:"postScriptsPublished",value:function postScriptsPublished(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/scripts/published','POST',{},{'scriptDataVersion':opts['scriptDataVersion']},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var SearchApi=/*#__PURE__*/function(){/**
|
|
21128
21222
|
* Search service.
|
|
21129
21223
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
21130
|
-
* @version
|
|
21224
|
+
* @version 216.0.0
|
|
21131
21225
|
*//**
|
|
21132
21226
|
* Constructs a new SearchApi.
|
|
21133
21227
|
* @alias module:purecloud-platform-client-v2/api/SearchApi
|
|
@@ -21299,7 +21393,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
21299
21393
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postVoicemailSearch';}return this.apiClient.callApi('/api/v2/voicemail/search','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var SettingsApi=/*#__PURE__*/function(){/**
|
|
21300
21394
|
* Settings service.
|
|
21301
21395
|
* @module purecloud-platform-client-v2/api/SettingsApi
|
|
21302
|
-
* @version
|
|
21396
|
+
* @version 216.0.0
|
|
21303
21397
|
*//**
|
|
21304
21398
|
* Constructs a new SettingsApi.
|
|
21305
21399
|
* @alias module:purecloud-platform-client-v2/api/SettingsApi
|
|
@@ -21349,7 +21443,7 @@ if(agentId===undefined||agentId===null){throw'Missing the required parameter "ag
|
|
|
21349
21443
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putUsersAgentuiAgentsAutoanswerAgentIdSettings';}return this.apiClient.callApi('/api/v2/users/agentui/agents/autoanswer/{agentId}/settings','PUT',{'agentId':agentId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var SocialMediaApi=/*#__PURE__*/function(){/**
|
|
21350
21444
|
* SocialMedia service.
|
|
21351
21445
|
* @module purecloud-platform-client-v2/api/SocialMediaApi
|
|
21352
|
-
* @version
|
|
21446
|
+
* @version 216.0.0
|
|
21353
21447
|
*//**
|
|
21354
21448
|
* Constructs a new SocialMediaApi.
|
|
21355
21449
|
* @alias module:purecloud-platform-client-v2/api/SocialMediaApi
|
|
@@ -21614,7 +21708,7 @@ if(topicId===undefined||topicId===null){throw'Missing the required parameter "to
|
|
|
21614
21708
|
if(twitterIngestionRuleId===undefined||twitterIngestionRuleId===null){throw'Missing the required parameter "twitterIngestionRuleId" when calling putSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId';}return this.apiClient.callApi('/api/v2/socialmedia/topics/{topicId}/dataingestionrules/twitter/{twitterIngestionRuleId}','PUT',{'topicId':topicId,'twitterIngestionRuleId':twitterIngestionRuleId},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var SpeechTextAnalyticsApi=/*#__PURE__*/function(){/**
|
|
21615
21709
|
* SpeechTextAnalytics service.
|
|
21616
21710
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
21617
|
-
* @version
|
|
21711
|
+
* @version 216.0.0
|
|
21618
21712
|
*//**
|
|
21619
21713
|
* Constructs a new SpeechTextAnalyticsApi.
|
|
21620
21714
|
* @alias module:purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
@@ -21655,12 +21749,12 @@ if(topicId===undefined||topicId===null){throw'Missing the required parameter "to
|
|
|
21655
21749
|
* Get the list of Speech and Text Analytics categories
|
|
21656
21750
|
*
|
|
21657
21751
|
* @param {Object} opts Optional parameters
|
|
21658
|
-
* @param {Number} opts.pageSize The page size for the listing. The max that will be returned is
|
|
21752
|
+
* @param {Number} opts.pageSize The page size for the listing. The max that will be returned is 25. (default to 25)
|
|
21659
21753
|
* @param {Number} opts.pageNumber The page number for the listing (default to 1)
|
|
21660
21754
|
* @param {String} opts.name The category name filter applied to the listing
|
|
21661
21755
|
* @param {Object} opts.sortOrder The sort order for the listing (default to asc)
|
|
21662
21756
|
* @param {Object} opts.sortBy The field to sort by for the listing (default to name)
|
|
21663
|
-
* @param {Array.<String>} opts.ids Comma separated Category IDs to filter by. Cannot be used with other filters. Maximum of
|
|
21757
|
+
* @param {Array.<String>} opts.ids Comma separated Category IDs to filter by. Cannot be used with other filters. Maximum of 25 IDs allowed.
|
|
21664
21758
|
*/},{key:"getSpeechandtextanalyticsCategories",value:function getSpeechandtextanalyticsCategories(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/speechandtextanalytics/categories','GET',{},{'pageSize':opts['pageSize'],'pageNumber':opts['pageNumber'],'name':opts['name'],'sortOrder':opts['sortOrder'],'sortBy':opts['sortBy'],'ids':this.apiClient.buildCollectionParam(opts['ids'],'multi')},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
21665
21759
|
* Get a Speech and Text Analytics Category by ID
|
|
21666
21760
|
*
|
|
@@ -21937,7 +22031,7 @@ if(topicId===undefined||topicId===null){throw'Missing the required parameter "to
|
|
|
21937
22031
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putSpeechandtextanalyticsTopic';}return this.apiClient.callApi('/api/v2/speechandtextanalytics/topics/{topicId}','PUT',{'topicId':topicId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var StationsApi=/*#__PURE__*/function(){/**
|
|
21938
22032
|
* Stations service.
|
|
21939
22033
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
21940
|
-
* @version
|
|
22034
|
+
* @version 216.0.0
|
|
21941
22035
|
*//**
|
|
21942
22036
|
* Constructs a new StationsApi.
|
|
21943
22037
|
* @alias module:purecloud-platform-client-v2/api/StationsApi
|
|
@@ -21969,7 +22063,7 @@ if(stationId===undefined||stationId===null){throw'Missing the required parameter
|
|
|
21969
22063
|
*/},{key:"getStations",value:function getStations(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/stations','GET',{},{'pageSize':opts['pageSize'],'pageNumber':opts['pageNumber'],'sortBy':opts['sortBy'],'name':opts['name'],'userSelectable':opts['userSelectable'],'webRtcUserId':opts['webRtcUserId'],'id':opts['id'],'lineAppearanceId':opts['lineAppearanceId']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var SuggestApi=/*#__PURE__*/function(){/**
|
|
21970
22064
|
* Suggest service.
|
|
21971
22065
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
21972
|
-
* @version
|
|
22066
|
+
* @version 216.0.0
|
|
21973
22067
|
*//**
|
|
21974
22068
|
* Constructs a new SuggestApi.
|
|
21975
22069
|
* @alias module:purecloud-platform-client-v2/api/SuggestApi
|
|
@@ -22009,7 +22103,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
22009
22103
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postSearchSuggest';}return this.apiClient.callApi('/api/v2/search/suggest','POST',{},{'profile':opts['profile']},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var TaskManagementApi=/*#__PURE__*/function(){/**
|
|
22010
22104
|
* TaskManagement service.
|
|
22011
22105
|
* @module purecloud-platform-client-v2/api/TaskManagementApi
|
|
22012
|
-
* @version
|
|
22106
|
+
* @version 216.0.0
|
|
22013
22107
|
*//**
|
|
22014
22108
|
* Constructs a new TaskManagementApi.
|
|
22015
22109
|
* @alias module:purecloud-platform-client-v2/api/TaskManagementApi
|
|
@@ -22515,7 +22609,7 @@ if(schemaId===undefined||schemaId===null){throw'Missing the required parameter "
|
|
|
22515
22609
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putTaskmanagementWorkitemsSchema';}return this.apiClient.callApi('/api/v2/taskmanagement/workitems/schemas/{schemaId}','PUT',{'schemaId':schemaId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var TeamsApi=/*#__PURE__*/function(){/**
|
|
22516
22610
|
* Teams service.
|
|
22517
22611
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
22518
|
-
* @version
|
|
22612
|
+
* @version 216.0.0
|
|
22519
22613
|
*//**
|
|
22520
22614
|
* Constructs a new TeamsApi.
|
|
22521
22615
|
* @alias module:purecloud-platform-client-v2/api/TeamsApi
|
|
@@ -22595,7 +22689,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
22595
22689
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postTeamsSearch';}return this.apiClient.callApi('/api/v2/teams/search','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var TelephonyApi=/*#__PURE__*/function(){/**
|
|
22596
22690
|
* Telephony service.
|
|
22597
22691
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
22598
|
-
* @version
|
|
22692
|
+
* @version 216.0.0
|
|
22599
22693
|
*//**
|
|
22600
22694
|
* Constructs a new TelephonyApi.
|
|
22601
22695
|
* @alias module:purecloud-platform-client-v2/api/TelephonyApi
|
|
@@ -22642,7 +22736,7 @@ if(downloadId===undefined||downloadId===null){throw'Missing the required paramet
|
|
|
22642
22736
|
if(sIPSearchPublicRequest===undefined||sIPSearchPublicRequest===null){throw'Missing the required parameter "sIPSearchPublicRequest" when calling postTelephonySiptracesDownload';}return this.apiClient.callApi('/api/v2/telephony/siptraces/download','POST',{},{},{},{},sIPSearchPublicRequest,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var TelephonyProvidersEdgeApi=/*#__PURE__*/function(){/**
|
|
22643
22737
|
* TelephonyProvidersEdge service.
|
|
22644
22738
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
22645
|
-
* @version
|
|
22739
|
+
* @version 216.0.0
|
|
22646
22740
|
*//**
|
|
22647
22741
|
* Constructs a new TelephonyProvidersEdgeApi.
|
|
22648
22742
|
* @alias module:purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
@@ -23477,7 +23571,7 @@ if(trunkBaseSettingsId===undefined||trunkBaseSettingsId===null){throw'Missing th
|
|
|
23477
23571
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putTelephonyProvidersEdgesTrunkbasesetting';}return this.apiClient.callApi('/api/v2/telephony/providers/edges/trunkbasesettings/{trunkBaseSettingsId}','PUT',{'trunkBaseSettingsId':trunkBaseSettingsId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var TextbotsApi=/*#__PURE__*/function(){/**
|
|
23478
23572
|
* Textbots service.
|
|
23479
23573
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
23480
|
-
* @version
|
|
23574
|
+
* @version 216.0.0
|
|
23481
23575
|
*//**
|
|
23482
23576
|
* Constructs a new TextbotsApi.
|
|
23483
23577
|
* @alias module:purecloud-platform-client-v2/api/TextbotsApi
|
|
@@ -23512,7 +23606,7 @@ if(launchRequest===undefined||launchRequest===null){throw'Missing the required p
|
|
|
23512
23606
|
if(postTextRequest===undefined||postTextRequest===null){throw'Missing the required parameter "postTextRequest" when calling postTextbotsBotsExecute';}return this.apiClient.callApi('/api/v2/textbots/bots/execute','POST',{},{},{},{},postTextRequest,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var TokensApi=/*#__PURE__*/function(){/**
|
|
23513
23607
|
* Tokens service.
|
|
23514
23608
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
23515
|
-
* @version
|
|
23609
|
+
* @version 216.0.0
|
|
23516
23610
|
*//**
|
|
23517
23611
|
* Constructs a new TokensApi.
|
|
23518
23612
|
* @alias module:purecloud-platform-client-v2/api/TokensApi
|
|
@@ -23546,7 +23640,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
23546
23640
|
*/},{key:"putTokensTimeout",value:function putTokensTimeout(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/tokens/timeout','PUT',{},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var UploadsApi=/*#__PURE__*/function(){/**
|
|
23547
23641
|
* Uploads service.
|
|
23548
23642
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
23549
|
-
* @version
|
|
23643
|
+
* @version 216.0.0
|
|
23550
23644
|
*//**
|
|
23551
23645
|
* Constructs a new UploadsApi.
|
|
23552
23646
|
* @alias module:purecloud-platform-client-v2/api/UploadsApi
|
|
@@ -23611,7 +23705,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
23611
23705
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postUploadsWorkforcemanagementHistoricaldataCsv';}return this.apiClient.callApi('/api/v2/uploads/workforcemanagement/historicaldata/csv','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var UsageApi=/*#__PURE__*/function(){/**
|
|
23612
23706
|
* Usage service.
|
|
23613
23707
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
23614
|
-
* @version
|
|
23708
|
+
* @version 216.0.0
|
|
23615
23709
|
*//**
|
|
23616
23710
|
* Constructs a new UsageApi.
|
|
23617
23711
|
* @alias module:purecloud-platform-client-v2/api/UsageApi
|
|
@@ -23665,7 +23759,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
23665
23759
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postUsageSimplesearch';}return this.apiClient.callApi('/api/v2/usage/simplesearch','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var UserRecordingsApi=/*#__PURE__*/function(){/**
|
|
23666
23760
|
* UserRecordings service.
|
|
23667
23761
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
23668
|
-
* @version
|
|
23762
|
+
* @version 216.0.0
|
|
23669
23763
|
*//**
|
|
23670
23764
|
* Constructs a new UserRecordingsApi.
|
|
23671
23765
|
* @alias module:purecloud-platform-client-v2/api/UserRecordingsApi
|
|
@@ -23722,7 +23816,7 @@ if(recordingId===undefined||recordingId===null){throw'Missing the required param
|
|
|
23722
23816
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putUserrecording';}return this.apiClient.callApi('/api/v2/userrecordings/{recordingId}','PUT',{'recordingId':recordingId},{'expand':this.apiClient.buildCollectionParam(opts['expand'],'multi')},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var UsersApi=/*#__PURE__*/function(){/**
|
|
23723
23817
|
* Users service.
|
|
23724
23818
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
23725
|
-
* @version
|
|
23819
|
+
* @version 216.0.0
|
|
23726
23820
|
*//**
|
|
23727
23821
|
* Constructs a new UsersApi.
|
|
23728
23822
|
* @alias module:purecloud-platform-client-v2/api/UsersApi
|
|
@@ -24449,7 +24543,7 @@ if(verifierId===undefined||verifierId===null){throw'Missing the required paramet
|
|
|
24449
24543
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putUserVerifier';}return this.apiClient.callApi('/api/v2/users/{userId}/verifiers/{verifierId}','PUT',{'userId':userId,'verifierId':verifierId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var UtilitiesApi=/*#__PURE__*/function(){/**
|
|
24450
24544
|
* Utilities service.
|
|
24451
24545
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
24452
|
-
* @version
|
|
24546
|
+
* @version 216.0.0
|
|
24453
24547
|
*//**
|
|
24454
24548
|
* Constructs a new UtilitiesApi.
|
|
24455
24549
|
* @alias module:purecloud-platform-client-v2/api/UtilitiesApi
|
|
@@ -24476,7 +24570,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
24476
24570
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postCertificateDetails';}return this.apiClient.callApi('/api/v2/certificate/details','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var VoicemailApi=/*#__PURE__*/function(){/**
|
|
24477
24571
|
* Voicemail service.
|
|
24478
24572
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
24479
|
-
* @version
|
|
24573
|
+
* @version 216.0.0
|
|
24480
24574
|
*//**
|
|
24481
24575
|
* Constructs a new VoicemailApi.
|
|
24482
24576
|
* @alias module:purecloud-platform-client-v2/api/VoicemailApi
|
|
@@ -24638,7 +24732,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
24638
24732
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putVoicemailUserpolicy';}return this.apiClient.callApi('/api/v2/voicemail/userpolicies/{userId}','PUT',{'userId':userId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var WebChatApi=/*#__PURE__*/function(){/**
|
|
24639
24733
|
* WebChat service.
|
|
24640
24734
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
24641
|
-
* @version
|
|
24735
|
+
* @version 216.0.0
|
|
24642
24736
|
*//**
|
|
24643
24737
|
* Constructs a new WebChatApi.
|
|
24644
24738
|
* @alias module:purecloud-platform-client-v2/api/WebChatApi
|
|
@@ -24773,7 +24867,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
24773
24867
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putWebchatSettings';}return this.apiClient.callApi('/api/v2/webchat/settings','PUT',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var WebDeploymentsApi=/*#__PURE__*/function(){/**
|
|
24774
24868
|
* WebDeployments service.
|
|
24775
24869
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
24776
|
-
* @version
|
|
24870
|
+
* @version 216.0.0
|
|
24777
24871
|
*//**
|
|
24778
24872
|
* Constructs a new WebDeploymentsApi.
|
|
24779
24873
|
* @alias module:purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
@@ -24894,7 +24988,7 @@ if(deploymentId===undefined||deploymentId===null){throw'Missing the required par
|
|
|
24894
24988
|
if(deployment===undefined||deployment===null){throw'Missing the required parameter "deployment" when calling putWebdeploymentsDeployment';}return this.apiClient.callApi('/api/v2/webdeployments/deployments/{deploymentId}','PUT',{'deploymentId':deploymentId},{},{},{},deployment,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var WebMessagingApi=/*#__PURE__*/function(){/**
|
|
24895
24989
|
* WebMessaging service.
|
|
24896
24990
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
24897
|
-
* @version
|
|
24991
|
+
* @version 216.0.0
|
|
24898
24992
|
*//**
|
|
24899
24993
|
* Constructs a new WebMessagingApi.
|
|
24900
24994
|
* @alias module:purecloud-platform-client-v2/api/WebMessagingApi
|
|
@@ -24910,7 +25004,7 @@ if(deployment===undefined||deployment===null){throw'Missing the required paramet
|
|
|
24910
25004
|
*/return _createClass(WebMessagingApi,[{key:"getWebmessagingMessages",value:function getWebmessagingMessages(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/webmessaging/messages','GET',{},{'pageSize':opts['pageSize'],'pageNumber':opts['pageNumber']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var WidgetsApi=/*#__PURE__*/function(){/**
|
|
24911
25005
|
* Widgets service.
|
|
24912
25006
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
24913
|
-
* @version
|
|
25007
|
+
* @version 216.0.0
|
|
24914
25008
|
*//**
|
|
24915
25009
|
* Constructs a new WidgetsApi.
|
|
24916
25010
|
* @alias module:purecloud-platform-client-v2/api/WidgetsApi
|
|
@@ -24945,7 +25039,7 @@ if(deploymentId===undefined||deploymentId===null){throw'Missing the required par
|
|
|
24945
25039
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putWidgetsDeployment';}return this.apiClient.callApi('/api/v2/widgets/deployments/{deploymentId}','PUT',{'deploymentId':deploymentId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var WorkforceManagementApi=/*#__PURE__*/function(){/**
|
|
24946
25040
|
* WorkforceManagement service.
|
|
24947
25041
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
24948
|
-
* @version
|
|
25042
|
+
* @version 216.0.0
|
|
24949
25043
|
*//**
|
|
24950
25044
|
* Constructs a new WorkforceManagementApi.
|
|
24951
25045
|
* @alias module:purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
@@ -25549,6 +25643,14 @@ if(calendarId===undefined||calendarId===null){throw'Missing the required paramet
|
|
|
25549
25643
|
* Get existing calendar link for the current user
|
|
25550
25644
|
*
|
|
25551
25645
|
*/},{key:"getWorkforcemanagementCalendarUrlIcs",value:function getWorkforcemanagementCalendarUrlIcs(){return this.apiClient.callApi('/api/v2/workforcemanagement/calendar/url/ics','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
25646
|
+
* Retrieves delete job status for historical data imports associated with the job id
|
|
25647
|
+
*
|
|
25648
|
+
* @param {String} jobId The job ID of the historical data delete request
|
|
25649
|
+
*/},{key:"getWorkforcemanagementHistoricaldataBulkRemoveJob",value:function getWorkforcemanagementHistoricaldataBulkRemoveJob(jobId){// verify the required parameter 'jobId' is set
|
|
25650
|
+
if(jobId===undefined||jobId===null){throw'Missing the required parameter "jobId" when calling getWorkforcemanagementHistoricaldataBulkRemoveJob';}return this.apiClient.callApi('/api/v2/workforcemanagement/historicaldata/bulk/remove/jobs/{jobId}','GET',{'jobId':jobId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
25651
|
+
* Retrieves all delete job status for historical data
|
|
25652
|
+
*
|
|
25653
|
+
*/},{key:"getWorkforcemanagementHistoricaldataBulkRemoveJobs",value:function getWorkforcemanagementHistoricaldataBulkRemoveJobs(){return this.apiClient.callApi('/api/v2/workforcemanagement/historicaldata/bulk/remove/jobs','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
25552
25654
|
* Retrieves delete job status for historical data imports of the organization
|
|
25553
25655
|
*
|
|
25554
25656
|
*/},{key:"getWorkforcemanagementHistoricaldataDeletejob",value:function getWorkforcemanagementHistoricaldataDeletejob(){return this.apiClient.callApi('/api/v2/workforcemanagement/historicaldata/deletejob','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
@@ -26422,6 +26524,11 @@ if(businessUnitId===undefined||businessUnitId===null){throw'Missing the required
|
|
|
26422
26524
|
* @param {Object} opts Optional parameters
|
|
26423
26525
|
* @param {String} opts.language A language tag (which is sometimes referred to as a locale identifier) to use to localize default activity code names in the ics-formatted calendar (default to en-US)
|
|
26424
26526
|
*/},{key:"postWorkforcemanagementCalendarUrlIcs",value:function postWorkforcemanagementCalendarUrlIcs(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/workforcemanagement/calendar/url/ics','POST',{},{'language':opts['language']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
26527
|
+
* Delete the list of the historical data import entries
|
|
26528
|
+
*
|
|
26529
|
+
* @param {Object} opts Optional parameters
|
|
26530
|
+
* @param {Object} opts.body body
|
|
26531
|
+
*/},{key:"postWorkforcemanagementHistoricaldataBulkRemoveJobs",value:function postWorkforcemanagementHistoricaldataBulkRemoveJobs(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/workforcemanagement/historicaldata/bulk/remove/jobs','POST',{},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
26425
26532
|
* Delete the entries of the historical data imports in the organization
|
|
26426
26533
|
*
|
|
26427
26534
|
*/},{key:"postWorkforcemanagementHistoricaldataDeletejob",value:function postWorkforcemanagementHistoricaldataDeletejob(){return this.apiClient.callApi('/api/v2/workforcemanagement/historicaldata/deletejob','POST',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
@@ -26751,7 +26858,7 @@ if(timeOffLimitId===undefined||timeOffLimitId===null){throw'Missing the required
|
|
|
26751
26858
|
* </pre>
|
|
26752
26859
|
* </p>
|
|
26753
26860
|
* @module purecloud-platform-client-v2/index
|
|
26754
|
-
* @version
|
|
26861
|
+
* @version 216.0.0
|
|
26755
26862
|
*/var platformClient=/*#__PURE__*/_createClass(function platformClient(){_classCallCheck(this,platformClient);/**
|
|
26756
26863
|
* The ApiClient constructor.
|
|
26757
26864
|
* @property {module:purecloud-platform-client-v2/ApiClient}
|