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
package/dist/web-cjs/bundle.js
CHANGED
|
@@ -891,7 +891,7 @@ if(env)this.environment=env;else this.environment=this.host?this.host:'mypureclo
|
|
|
891
891
|
this.environment=this.environment.replace(/\/+$/,'');// Strip protocol and subdomain
|
|
892
892
|
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];}}}]);}();/**
|
|
893
893
|
* @module purecloud-platform-client-v2/ApiClient
|
|
894
|
-
* @version
|
|
894
|
+
* @version 216.0.0
|
|
895
895
|
*/var ApiClient=/*#__PURE__*/function(){/**
|
|
896
896
|
* Manages low level client-server communications, parameter marshalling, etc. There should not be any need for an
|
|
897
897
|
* application to use this class directly - the *Api and model classes provide the public API for the service. The
|
|
@@ -1234,7 +1234,7 @@ resolve(data);})["catch"](function(error){var data=error;if(error.response&&erro
|
|
|
1234
1234
|
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(){/**
|
|
1235
1235
|
* AgentAssistants service.
|
|
1236
1236
|
* @module purecloud-platform-client-v2/api/AgentAssistantsApi
|
|
1237
|
-
* @version
|
|
1237
|
+
* @version 216.0.0
|
|
1238
1238
|
*//**
|
|
1239
1239
|
* Constructs a new AgentAssistantsApi.
|
|
1240
1240
|
* @alias module:purecloud-platform-client-v2/api/AgentAssistantsApi
|
|
@@ -1335,7 +1335,7 @@ if(queueId===undefined||queueId===null){throw'Missing the required parameter "qu
|
|
|
1335
1335
|
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(){/**
|
|
1336
1336
|
* AgentCopilot service.
|
|
1337
1337
|
* @module purecloud-platform-client-v2/api/AgentCopilotApi
|
|
1338
|
-
* @version
|
|
1338
|
+
* @version 216.0.0
|
|
1339
1339
|
*//**
|
|
1340
1340
|
* Constructs a new AgentCopilotApi.
|
|
1341
1341
|
* @alias module:purecloud-platform-client-v2/api/AgentCopilotApi
|
|
@@ -1357,7 +1357,7 @@ if(assistantId===undefined||assistantId===null){throw'Missing the required param
|
|
|
1357
1357
|
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(){/**
|
|
1358
1358
|
* AgentUI service.
|
|
1359
1359
|
* @module purecloud-platform-client-v2/api/AgentUIApi
|
|
1360
|
-
* @version
|
|
1360
|
+
* @version 216.0.0
|
|
1361
1361
|
*//**
|
|
1362
1362
|
* Constructs a new AgentUIApi.
|
|
1363
1363
|
* @alias module:purecloud-platform-client-v2/api/AgentUIApi
|
|
@@ -1391,7 +1391,7 @@ if(agentId===undefined||agentId===null){throw'Missing the required parameter "ag
|
|
|
1391
1391
|
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(){/**
|
|
1392
1392
|
* Alerting service.
|
|
1393
1393
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
1394
|
-
* @version
|
|
1394
|
+
* @version 216.0.0
|
|
1395
1395
|
*//**
|
|
1396
1396
|
* Constructs a new AlertingApi.
|
|
1397
1397
|
* @alias module:purecloud-platform-client-v2/api/AlertingApi
|
|
@@ -1556,7 +1556,7 @@ if(ruleId===undefined||ruleId===null){throw'Missing the required parameter "rule
|
|
|
1556
1556
|
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(){/**
|
|
1557
1557
|
* Analytics service.
|
|
1558
1558
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
1559
|
-
* @version
|
|
1559
|
+
* @version 216.0.0
|
|
1560
1560
|
*//**
|
|
1561
1561
|
* Constructs a new AnalyticsApi.
|
|
1562
1562
|
* @alias module:purecloud-platform-client-v2/api/AnalyticsApi
|
|
@@ -2143,7 +2143,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
2143
2143
|
* Query for summary aggregates
|
|
2144
2144
|
*
|
|
2145
2145
|
* @param {Object} body query
|
|
2146
|
-
* postAnalyticsSummariesAggregatesQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2147
2146
|
*/},{key:"postAnalyticsSummariesAggregatesQuery",value:function postAnalyticsSummariesAggregatesQuery(body){// verify the required parameter 'body' is set
|
|
2148
2147
|
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']);}/**
|
|
2149
2148
|
* Query for survey aggregates asynchronously
|
|
@@ -2228,7 +2227,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
2228
2227
|
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(){/**
|
|
2229
2228
|
* Architect service.
|
|
2230
2229
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
2231
|
-
* @version
|
|
2230
|
+
* @version 216.0.0
|
|
2232
2231
|
*//**
|
|
2233
2232
|
* Constructs a new ArchitectApi.
|
|
2234
2233
|
* @alias module:purecloud-platform-client-v2/api/ArchitectApi
|
|
@@ -3320,7 +3319,7 @@ if(milestoneId===undefined||milestoneId===null){throw'Missing the required param
|
|
|
3320
3319
|
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(){/**
|
|
3321
3320
|
* Audit service.
|
|
3322
3321
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
3323
|
-
* @version
|
|
3322
|
+
* @version 216.0.0
|
|
3324
3323
|
*//**
|
|
3325
3324
|
* Constructs a new AuditApi.
|
|
3326
3325
|
* @alias module:purecloud-platform-client-v2/api/AuditApi
|
|
@@ -3370,7 +3369,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
3370
3369
|
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(){/**
|
|
3371
3370
|
* Authorization service.
|
|
3372
3371
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
3373
|
-
* @version
|
|
3372
|
+
* @version 216.0.0
|
|
3374
3373
|
*//**
|
|
3375
3374
|
* Constructs a new AuthorizationApi.
|
|
3376
3375
|
* @alias module:purecloud-platform-client-v2/api/AuthorizationApi
|
|
@@ -3385,6 +3384,14 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
3385
3384
|
* @param {Boolean} opts.force Force delete this division as well as the grants and objects associated with it (default to false)
|
|
3386
3385
|
*/return _createClass(AuthorizationApi,[{key:"deleteAuthorizationDivision",value:function deleteAuthorizationDivision(divisionId,opts){opts=opts||{};// verify the required parameter 'divisionId' is set
|
|
3387
3386
|
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']);}/**
|
|
3387
|
+
* Delete an access control policy
|
|
3388
|
+
*
|
|
3389
|
+
* @param {String} targetName The domain:entity:action target to which the policy is applied
|
|
3390
|
+
* @param {String} subjectId The ID of the subject to which the policy is applied
|
|
3391
|
+
* deleteAuthorizationPoliciesTargetSubjectSubjectId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
3392
|
+
*/},{key:"deleteAuthorizationPoliciesTargetSubjectSubjectId",value:function deleteAuthorizationPoliciesTargetSubjectSubjectId(targetName,subjectId){// verify the required parameter 'targetName' is set
|
|
3393
|
+
if(targetName===undefined||targetName===null){throw'Missing the required parameter "targetName" when calling deleteAuthorizationPoliciesTargetSubjectSubjectId';}// verify the required parameter 'subjectId' is set
|
|
3394
|
+
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']);}/**
|
|
3388
3395
|
* Delete an organization role.
|
|
3389
3396
|
*
|
|
3390
3397
|
* @param {String} roleId Role ID
|
|
@@ -3468,6 +3475,55 @@ if(permission===undefined||permission===null){throw'Missing the required paramet
|
|
|
3468
3475
|
* @param {Object} opts.queryType Query filter type
|
|
3469
3476
|
* @param {String} opts.query Comma-separated list of permissions or domains to query
|
|
3470
3477
|
*/},{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']);}/**
|
|
3478
|
+
* Get a page of access policies for an organization
|
|
3479
|
+
*
|
|
3480
|
+
* @param {Object} opts Optional parameters
|
|
3481
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
3482
|
+
* @param {Number} opts.pageSize Number of entities to return. Maximum of 200. (default to 25)
|
|
3483
|
+
* getAuthorizationPolicies is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
3484
|
+
*/},{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']);}/**
|
|
3485
|
+
* Get a page of access policies for a given subject
|
|
3486
|
+
*
|
|
3487
|
+
* @param {String} subjectId The ID of the subject to which policies are applied
|
|
3488
|
+
* @param {Object} opts Optional parameters
|
|
3489
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
3490
|
+
* @param {Number} opts.pageSize Number of entities to return. Maximum of 200. (default to 25)
|
|
3491
|
+
* getAuthorizationPoliciesSubjectSubjectId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
3492
|
+
*/},{key:"getAuthorizationPoliciesSubjectSubjectId",value:function getAuthorizationPoliciesSubjectSubjectId(subjectId,opts){opts=opts||{};// verify the required parameter 'subjectId' is set
|
|
3493
|
+
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']);}/**
|
|
3494
|
+
* Get a page of access policies for a given policy target
|
|
3495
|
+
*
|
|
3496
|
+
* @param {String} targetName The domain:entity:action resource target to which policies are applied
|
|
3497
|
+
* @param {Object} opts Optional parameters
|
|
3498
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
3499
|
+
* @param {Number} opts.pageSize Number of entities to return. Maximum of 200. (default to 25)
|
|
3500
|
+
* getAuthorizationPoliciesTarget is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
3501
|
+
*/},{key:"getAuthorizationPoliciesTarget",value:function getAuthorizationPoliciesTarget(targetName,opts){opts=opts||{};// verify the required parameter 'targetName' is set
|
|
3502
|
+
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']);}/**
|
|
3503
|
+
* Get an access control policy for a specified resource target and subject
|
|
3504
|
+
*
|
|
3505
|
+
* @param {String} targetName The domain:entity:action resource target to which the policy is applied
|
|
3506
|
+
* @param {String} subjectId The ID of the subject to which the policy is applied
|
|
3507
|
+
* getAuthorizationPoliciesTargetSubjectSubjectId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
3508
|
+
*/},{key:"getAuthorizationPoliciesTargetSubjectSubjectId",value:function getAuthorizationPoliciesTargetSubjectSubjectId(targetName,subjectId){// verify the required parameter 'targetName' is set
|
|
3509
|
+
if(targetName===undefined||targetName===null){throw'Missing the required parameter "targetName" when calling getAuthorizationPoliciesTargetSubjectSubjectId';}// verify the required parameter 'subjectId' is set
|
|
3510
|
+
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']);}/**
|
|
3511
|
+
* Get a map of policy targets to valid attributes for those targets
|
|
3512
|
+
*
|
|
3513
|
+
* getAuthorizationPoliciesTargets is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
3514
|
+
*/},{key:"getAuthorizationPoliciesTargets",value:function getAuthorizationPoliciesTargets(){return this.apiClient.callApi('/api/v2/authorization/policies/targets','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
3515
|
+
* Get an access control policy with the specified policy ID
|
|
3516
|
+
*
|
|
3517
|
+
* @param {String} policyId The ID of the policy to retrieve
|
|
3518
|
+
* getAuthorizationPolicy is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
3519
|
+
*/},{key:"getAuthorizationPolicy",value:function getAuthorizationPolicy(policyId){// verify the required parameter 'policyId' is set
|
|
3520
|
+
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']);}/**
|
|
3521
|
+
* Get the list of attributes used to evaluate an access control policy with the specified policy ID
|
|
3522
|
+
*
|
|
3523
|
+
* @param {String} policyId The ID of the policy to retrieve attributes
|
|
3524
|
+
* getAuthorizationPolicyAttributes is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
3525
|
+
*/},{key:"getAuthorizationPolicyAttributes",value:function getAuthorizationPolicyAttributes(policyId){// verify the required parameter 'policyId' is set
|
|
3526
|
+
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']);}/**
|
|
3471
3527
|
* Get the list of enabled products
|
|
3472
3528
|
* Gets the list of enabled products. Some example product names are: collaborateFree, collaboratePro, communicate, and engage.
|
|
3473
3529
|
*/},{key:"getAuthorizationProducts",value:function getAuthorizationProducts(){return this.apiClient.callApi('/api/v2/authorization/products','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
@@ -3582,6 +3638,30 @@ if(divisionId===undefined||divisionId===null){throw'Missing the required paramet
|
|
|
3582
3638
|
* @param {Object} body Division
|
|
3583
3639
|
*/},{key:"postAuthorizationDivisions",value:function postAuthorizationDivisions(body){// verify the required parameter 'body' is set
|
|
3584
3640
|
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']);}/**
|
|
3641
|
+
* Add an access control policy for a specified resource target and subject
|
|
3642
|
+
*
|
|
3643
|
+
* @param {String} targetName The domain:entity:action target to which the policy will be applied
|
|
3644
|
+
* @param {Object} body Access control policy
|
|
3645
|
+
* postAuthorizationPoliciesTarget is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
3646
|
+
*/},{key:"postAuthorizationPoliciesTarget",value:function postAuthorizationPoliciesTarget(targetName,body){// verify the required parameter 'targetName' is set
|
|
3647
|
+
if(targetName===undefined||targetName===null){throw'Missing the required parameter "targetName" when calling postAuthorizationPoliciesTarget';}// verify the required parameter 'body' is set
|
|
3648
|
+
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']);}/**
|
|
3649
|
+
* Validate the conditions and attributes of an access control policy for a specified resource target
|
|
3650
|
+
*
|
|
3651
|
+
* @param {String} targetName The domain:entity:action target to which the policy will be applied
|
|
3652
|
+
* @param {Object} body Access control policy
|
|
3653
|
+
* postAuthorizationPoliciesTargetValidate is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
3654
|
+
*/},{key:"postAuthorizationPoliciesTargetValidate",value:function postAuthorizationPoliciesTargetValidate(targetName,body){// verify the required parameter 'targetName' is set
|
|
3655
|
+
if(targetName===undefined||targetName===null){throw'Missing the required parameter "targetName" when calling postAuthorizationPoliciesTargetValidate';}// verify the required parameter 'body' is set
|
|
3656
|
+
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']);}/**
|
|
3657
|
+
* Simulate a request and evaluate the specified policy ID against the provided values
|
|
3658
|
+
*
|
|
3659
|
+
* @param {String} policyId The ID of the policy to test the simulated data against
|
|
3660
|
+
* @param {Object} body A map of attribute names to type and simulated data value
|
|
3661
|
+
* postAuthorizationPolicySimulate is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
3662
|
+
*/},{key:"postAuthorizationPolicySimulate",value:function postAuthorizationPolicySimulate(policyId,body){// verify the required parameter 'policyId' is set
|
|
3663
|
+
if(policyId===undefined||policyId===null){throw'Missing the required parameter "policyId" when calling postAuthorizationPolicySimulate';}// verify the required parameter 'body' is set
|
|
3664
|
+
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']);}/**
|
|
3585
3665
|
* Bulk-grant subjects and divisions with an organization role.
|
|
3586
3666
|
*
|
|
3587
3667
|
* @param {String} roleId Role ID
|
|
@@ -3653,6 +3733,22 @@ if(roleId===undefined||roleId===null){throw'Missing the required parameter "role
|
|
|
3653
3733
|
*/},{key:"putAuthorizationDivision",value:function putAuthorizationDivision(divisionId,body){// verify the required parameter 'divisionId' is set
|
|
3654
3734
|
if(divisionId===undefined||divisionId===null){throw'Missing the required parameter "divisionId" when calling putAuthorizationDivision';}// verify the required parameter 'body' is set
|
|
3655
3735
|
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']);}/**
|
|
3736
|
+
* Add an access control policy for a specified resource target and subject, overwriting any existing policy
|
|
3737
|
+
*
|
|
3738
|
+
* @param {String} targetName The domain:entity:action target to which the policy will be applied
|
|
3739
|
+
* @param {Object} body Access control policy
|
|
3740
|
+
* putAuthorizationPoliciesTarget is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
3741
|
+
*/},{key:"putAuthorizationPoliciesTarget",value:function putAuthorizationPoliciesTarget(targetName,body){// verify the required parameter 'targetName' is set
|
|
3742
|
+
if(targetName===undefined||targetName===null){throw'Missing the required parameter "targetName" when calling putAuthorizationPoliciesTarget';}// verify the required parameter 'body' is set
|
|
3743
|
+
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']);}/**
|
|
3744
|
+
* Update an access control policy with a given ID
|
|
3745
|
+
*
|
|
3746
|
+
* @param {String} policyId The ID of the policy to update
|
|
3747
|
+
* @param {Object} body Access control policy
|
|
3748
|
+
* putAuthorizationPolicy is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
3749
|
+
*/},{key:"putAuthorizationPolicy",value:function putAuthorizationPolicy(policyId,body){// verify the required parameter 'policyId' is set
|
|
3750
|
+
if(policyId===undefined||policyId===null){throw'Missing the required parameter "policyId" when calling putAuthorizationPolicy';}// verify the required parameter 'body' is set
|
|
3751
|
+
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']);}/**
|
|
3656
3752
|
* Update an organization role.
|
|
3657
3753
|
* Update
|
|
3658
3754
|
* @param {String} roleId Role ID
|
|
@@ -3693,7 +3789,7 @@ if(subjectId===undefined||subjectId===null){throw'Missing the required parameter
|
|
|
3693
3789
|
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(){/**
|
|
3694
3790
|
* Billing service.
|
|
3695
3791
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
3696
|
-
* @version
|
|
3792
|
+
* @version 216.0.0
|
|
3697
3793
|
*//**
|
|
3698
3794
|
* Constructs a new BillingApi.
|
|
3699
3795
|
* @alias module:purecloud-platform-client-v2/api/BillingApi
|
|
@@ -3717,7 +3813,7 @@ if(endDate===undefined||endDate===null){throw'Missing the required parameter "en
|
|
|
3717
3813
|
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(){/**
|
|
3718
3814
|
* CarrierServices service.
|
|
3719
3815
|
* @module purecloud-platform-client-v2/api/CarrierServicesApi
|
|
3720
|
-
* @version
|
|
3816
|
+
* @version 216.0.0
|
|
3721
3817
|
*//**
|
|
3722
3818
|
* Constructs a new CarrierServicesApi.
|
|
3723
3819
|
* @alias module:purecloud-platform-client-v2/api/CarrierServicesApi
|
|
@@ -3737,7 +3833,7 @@ if(phoneNumber===undefined||phoneNumber===null){throw'Missing the required param
|
|
|
3737
3833
|
*/},{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(){/**
|
|
3738
3834
|
* Chat service.
|
|
3739
3835
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
3740
|
-
* @version
|
|
3836
|
+
* @version 216.0.0
|
|
3741
3837
|
*//**
|
|
3742
3838
|
* Constructs a new ChatApi.
|
|
3743
3839
|
* @alias module:purecloud-platform-client-v2/api/ChatApi
|
|
@@ -3962,7 +4058,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
3962
4058
|
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(){/**
|
|
3963
4059
|
* Coaching service.
|
|
3964
4060
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
3965
|
-
* @version
|
|
4061
|
+
* @version 216.0.0
|
|
3966
4062
|
*//**
|
|
3967
4063
|
* Constructs a new CoachingApi.
|
|
3968
4064
|
* @alias module:purecloud-platform-client-v2/api/CoachingApi
|
|
@@ -4115,7 +4211,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
4115
4211
|
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(){/**
|
|
4116
4212
|
* ContentManagement service.
|
|
4117
4213
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
4118
|
-
* @version
|
|
4214
|
+
* @version 216.0.0
|
|
4119
4215
|
*//**
|
|
4120
4216
|
* Constructs a new ContentManagementApi.
|
|
4121
4217
|
* @alias module:purecloud-platform-client-v2/api/ContentManagementApi
|
|
@@ -4397,7 +4493,7 @@ if(tagId===undefined||tagId===null){throw'Missing the required parameter "tagId"
|
|
|
4397
4493
|
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(){/**
|
|
4398
4494
|
* Conversations service.
|
|
4399
4495
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
4400
|
-
* @version
|
|
4496
|
+
* @version 216.0.0
|
|
4401
4497
|
*//**
|
|
4402
4498
|
* Constructs a new ConversationsApi.
|
|
4403
4499
|
* @alias module:purecloud-platform-client-v2/api/ConversationsApi
|
|
@@ -6144,7 +6240,7 @@ if(conversationId===undefined||conversationId===null){throw'Missing the required
|
|
|
6144
6240
|
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(){/**
|
|
6145
6241
|
* DataExtensions service.
|
|
6146
6242
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
6147
|
-
* @version
|
|
6243
|
+
* @version 216.0.0
|
|
6148
6244
|
*//**
|
|
6149
6245
|
* Constructs a new DataExtensionsApi.
|
|
6150
6246
|
* @alias module:purecloud-platform-client-v2/api/DataExtensionsApi
|
|
@@ -6165,7 +6261,7 @@ if(coretypeName===undefined||coretypeName===null){throw'Missing the required par
|
|
|
6165
6261
|
*/},{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(){/**
|
|
6166
6262
|
* DataPrivacy service.
|
|
6167
6263
|
* @module purecloud-platform-client-v2/api/DataPrivacyApi
|
|
6168
|
-
* @version
|
|
6264
|
+
* @version 216.0.0
|
|
6169
6265
|
*//**
|
|
6170
6266
|
* Constructs a new DataPrivacyApi.
|
|
6171
6267
|
* @alias module:purecloud-platform-client-v2/api/DataPrivacyApi
|
|
@@ -6205,7 +6301,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
6205
6301
|
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(){/**
|
|
6206
6302
|
* Downloads service.
|
|
6207
6303
|
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
6208
|
-
* @version
|
|
6304
|
+
* @version 216.0.0
|
|
6209
6305
|
*//**
|
|
6210
6306
|
* Constructs a new DownloadsApi.
|
|
6211
6307
|
* @alias module:purecloud-platform-client-v2/api/DownloadsApi
|
|
@@ -6224,7 +6320,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
6224
6320
|
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(){/**
|
|
6225
6321
|
* Emails service.
|
|
6226
6322
|
* @module purecloud-platform-client-v2/api/EmailsApi
|
|
6227
|
-
* @version
|
|
6323
|
+
* @version 216.0.0
|
|
6228
6324
|
*//**
|
|
6229
6325
|
* Constructs a new EmailsApi.
|
|
6230
6326
|
* @alias module:purecloud-platform-client-v2/api/EmailsApi
|
|
@@ -6242,7 +6338,7 @@ if(downloadId===undefined||downloadId===null){throw'Missing the required paramet
|
|
|
6242
6338
|
*/},{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(){/**
|
|
6243
6339
|
* EmployeeEngagement service.
|
|
6244
6340
|
* @module purecloud-platform-client-v2/api/EmployeeEngagementApi
|
|
6245
|
-
* @version
|
|
6341
|
+
* @version 216.0.0
|
|
6246
6342
|
*//**
|
|
6247
6343
|
* Constructs a new EmployeeEngagementApi.
|
|
6248
6344
|
* @alias module:purecloud-platform-client-v2/api/EmployeeEngagementApi
|
|
@@ -6280,7 +6376,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
6280
6376
|
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(){/**
|
|
6281
6377
|
* Events service.
|
|
6282
6378
|
* @module purecloud-platform-client-v2/api/EventsApi
|
|
6283
|
-
* @version
|
|
6379
|
+
* @version 216.0.0
|
|
6284
6380
|
*//**
|
|
6285
6381
|
* Constructs a new EventsApi.
|
|
6286
6382
|
* @alias module:purecloud-platform-client-v2/api/EventsApi
|
|
@@ -6305,7 +6401,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
6305
6401
|
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(){/**
|
|
6306
6402
|
* ExternalContacts service.
|
|
6307
6403
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
6308
|
-
* @version
|
|
6404
|
+
* @version 216.0.0
|
|
6309
6405
|
*//**
|
|
6310
6406
|
* Constructs a new ExternalContactsApi.
|
|
6311
6407
|
* @alias module:purecloud-platform-client-v2/api/ExternalContactsApi
|
|
@@ -6481,16 +6577,19 @@ if(uploadId===undefined||uploadId===null){throw'Missing the required parameter "
|
|
|
6481
6577
|
* Get job based on id
|
|
6482
6578
|
*
|
|
6483
6579
|
* @param {String} jobId Job id
|
|
6484
|
-
|
|
6485
|
-
|
|
6580
|
+
* @param {Object} opts Optional parameters
|
|
6581
|
+
* @param {Array.<String>} opts.expand which fields, if any, to expand
|
|
6582
|
+
*/},{key:"getExternalcontactsImportJob",value:function getExternalcontactsImportJob(jobId,opts){opts=opts||{};// verify the required parameter 'jobId' is set
|
|
6583
|
+
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']);}/**
|
|
6486
6584
|
* List jobs for organization
|
|
6487
6585
|
*
|
|
6488
6586
|
* @param {Object} opts Optional parameters
|
|
6587
|
+
* @param {Array.<String>} opts.expand which fields, if any, to expand
|
|
6489
6588
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
6490
6589
|
* @param {String} opts.pageSize Number of entities to return. Maximum of 100. (default to 25)
|
|
6491
6590
|
* @param {Object} opts.sortOrder Direction of sorting. (default to Ascending)
|
|
6492
6591
|
* @param {Object} opts.jobStatus Search term to filter by jobStatus
|
|
6493
|
-
*/},{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']);}/**
|
|
6592
|
+
*/},{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']);}/**
|
|
6494
6593
|
* Get setting based on id
|
|
6495
6594
|
*
|
|
6496
6595
|
* @param {String} settingsId Settings id
|
|
@@ -6897,7 +6996,7 @@ if(relationshipId===undefined||relationshipId===null){throw'Missing the required
|
|
|
6897
6996
|
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(){/**
|
|
6898
6997
|
* Fax service.
|
|
6899
6998
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
6900
|
-
* @version
|
|
6999
|
+
* @version 216.0.0
|
|
6901
7000
|
*//**
|
|
6902
7001
|
* Constructs a new FaxApi.
|
|
6903
7002
|
* @alias module:purecloud-platform-client-v2/api/FaxApi
|
|
@@ -6946,7 +7045,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
6946
7045
|
*/},{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(){/**
|
|
6947
7046
|
* Flows service.
|
|
6948
7047
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
6949
|
-
* @version
|
|
7048
|
+
* @version 216.0.0
|
|
6950
7049
|
*//**
|
|
6951
7050
|
* Constructs a new FlowsApi.
|
|
6952
7051
|
* @alias module:purecloud-platform-client-v2/api/FlowsApi
|
|
@@ -6994,7 +7093,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
6994
7093
|
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(){/**
|
|
6995
7094
|
* Gamification service.
|
|
6996
7095
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
6997
|
-
* @version
|
|
7096
|
+
* @version 216.0.0
|
|
6998
7097
|
*//**
|
|
6999
7098
|
* Constructs a new GamificationApi.
|
|
7000
7099
|
* @alias module:purecloud-platform-client-v2/api/GamificationApi
|
|
@@ -7553,7 +7652,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
7553
7652
|
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(){/**
|
|
7554
7653
|
* GeneralDataProtectionRegulation service.
|
|
7555
7654
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
7556
|
-
* @version
|
|
7655
|
+
* @version 216.0.0
|
|
7557
7656
|
*//**
|
|
7558
7657
|
* Constructs a new GeneralDataProtectionRegulationApi.
|
|
7559
7658
|
* @alias module:purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
@@ -7588,7 +7687,7 @@ if(searchValue===undefined||searchValue===null){throw'Missing the required param
|
|
|
7588
7687
|
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(){/**
|
|
7589
7688
|
* Geolocation service.
|
|
7590
7689
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
7591
|
-
* @version
|
|
7690
|
+
* @version 216.0.0
|
|
7592
7691
|
*//**
|
|
7593
7692
|
* Constructs a new GeolocationApi.
|
|
7594
7693
|
* @alias module:purecloud-platform-client-v2/api/GeolocationApi
|
|
@@ -7622,7 +7721,7 @@ if(clientId===undefined||clientId===null){throw'Missing the required parameter "
|
|
|
7622
7721
|
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(){/**
|
|
7623
7722
|
* Greetings service.
|
|
7624
7723
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
7625
|
-
* @version
|
|
7724
|
+
* @version 216.0.0
|
|
7626
7725
|
*//**
|
|
7627
7726
|
* Constructs a new GreetingsApi.
|
|
7628
7727
|
* @alias module:purecloud-platform-client-v2/api/GreetingsApi
|
|
@@ -7729,7 +7828,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
7729
7828
|
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(){/**
|
|
7730
7829
|
* Groups service.
|
|
7731
7830
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
7732
|
-
* @version
|
|
7831
|
+
* @version 216.0.0
|
|
7733
7832
|
*//**
|
|
7734
7833
|
* Constructs a new GroupsApi.
|
|
7735
7834
|
* @alias module:purecloud-platform-client-v2/api/GroupsApi
|
|
@@ -7862,7 +7961,7 @@ if(groupId===undefined||groupId===null){throw'Missing the required parameter "gr
|
|
|
7862
7961
|
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(){/**
|
|
7863
7962
|
* IdentityProvider service.
|
|
7864
7963
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
7865
|
-
* @version
|
|
7964
|
+
* @version 216.0.0
|
|
7866
7965
|
*//**
|
|
7867
7966
|
* Constructs a new IdentityProviderApi.
|
|
7868
7967
|
* @alias module:purecloud-platform-client-v2/api/IdentityProviderApi
|
|
@@ -8018,7 +8117,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
8018
8117
|
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(){/**
|
|
8019
8118
|
* InfrastructureAsCode service.
|
|
8020
8119
|
* @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
8021
|
-
* @version
|
|
8120
|
+
* @version 216.0.0
|
|
8022
8121
|
*//**
|
|
8023
8122
|
* Constructs a new InfrastructureAsCodeApi.
|
|
8024
8123
|
* @alias module:purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
@@ -8072,7 +8171,7 @@ if(jobId===undefined||jobId===null){throw'Missing the required parameter "jobId"
|
|
|
8072
8171
|
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(){/**
|
|
8073
8172
|
* Integrations service.
|
|
8074
8173
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
8075
|
-
* @version
|
|
8174
|
+
* @version 216.0.0
|
|
8076
8175
|
*//**
|
|
8077
8176
|
* Constructs a new IntegrationsApi.
|
|
8078
8177
|
* @alias module:purecloud-platform-client-v2/api/IntegrationsApi
|
|
@@ -8702,7 +8801,7 @@ if(ucIntegrationId===undefined||ucIntegrationId===null){throw'Missing the requir
|
|
|
8702
8801
|
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(){/**
|
|
8703
8802
|
* Journey service.
|
|
8704
8803
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
8705
|
-
* @version
|
|
8804
|
+
* @version 216.0.0
|
|
8706
8805
|
*//**
|
|
8707
8806
|
* Constructs a new JourneyApi.
|
|
8708
8807
|
* @alias module:purecloud-platform-client-v2/api/JourneyApi
|
|
@@ -8989,6 +9088,9 @@ if(journeyVersionId===undefined||journeyVersionId===null){throw'Missing the requ
|
|
|
8989
9088
|
* @param {Object} opts.expand Parameter to request additional data to return in Journey payload
|
|
8990
9089
|
* @param {String} opts.id Parameter to request a list of Journey Views by id, separated by commas. Limit of 100 items.
|
|
8991
9090
|
*/},{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']);}/**
|
|
9091
|
+
* Get details about the data available for journey queries including oldest and newest event dates
|
|
9092
|
+
*
|
|
9093
|
+
*/},{key:"getJourneyViewsDataDetails",value:function getJourneyViewsDataDetails(){return this.apiClient.callApi('/api/v2/journey/views/data/details','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
8992
9094
|
* Get an Event Definition
|
|
8993
9095
|
*
|
|
8994
9096
|
* @param {String} eventDefinitionId Event Definition ID
|
|
@@ -9179,7 +9281,7 @@ if(versionId===undefined||versionId===null){throw'Missing the required parameter
|
|
|
9179
9281
|
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(){/**
|
|
9180
9282
|
* Knowledge service.
|
|
9181
9283
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
9182
|
-
* @version
|
|
9284
|
+
* @version 216.0.0
|
|
9183
9285
|
*//**
|
|
9184
9286
|
* Constructs a new KnowledgeApi.
|
|
9185
9287
|
* @alias module:purecloud-platform-client-v2/api/KnowledgeApi
|
|
@@ -10249,7 +10351,7 @@ if(sourceId===undefined||sourceId===null){throw'Missing the required parameter "
|
|
|
10249
10351
|
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(){/**
|
|
10250
10352
|
* LanguageUnderstanding service.
|
|
10251
10353
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
10252
|
-
* @version
|
|
10354
|
+
* @version 216.0.0
|
|
10253
10355
|
*//**
|
|
10254
10356
|
* Constructs a new LanguageUnderstandingApi.
|
|
10255
10357
|
* @alias module:purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
@@ -10508,7 +10610,7 @@ if(domainVersionId===undefined||domainVersionId===null){throw'Missing the requir
|
|
|
10508
10610
|
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(){/**
|
|
10509
10611
|
* Languages service.
|
|
10510
10612
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
10511
|
-
* @version
|
|
10613
|
+
* @version 216.0.0
|
|
10512
10614
|
*//**
|
|
10513
10615
|
* Constructs a new LanguagesApi.
|
|
10514
10616
|
* @alias module:purecloud-platform-client-v2/api/LanguagesApi
|
|
@@ -10563,7 +10665,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
10563
10665
|
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(){/**
|
|
10564
10666
|
* Learning service.
|
|
10565
10667
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
10566
|
-
* @version
|
|
10668
|
+
* @version 216.0.0
|
|
10567
10669
|
*//**
|
|
10568
10670
|
* Constructs a new LearningApi.
|
|
10569
10671
|
* @alias module:purecloud-platform-client-v2/api/LearningApi
|
|
@@ -10834,7 +10936,7 @@ if(moduleId===undefined||moduleId===null){throw'Missing the required parameter "
|
|
|
10834
10936
|
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(){/**
|
|
10835
10937
|
* License service.
|
|
10836
10938
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
10837
|
-
* @version
|
|
10939
|
+
* @version 216.0.0
|
|
10838
10940
|
*//**
|
|
10839
10941
|
* Constructs a new LicenseApi.
|
|
10840
10942
|
* @alias module:purecloud-platform-client-v2/api/LicenseApi
|
|
@@ -10888,7 +10990,7 @@ if(featureName===undefined||featureName===null){throw'Missing the required param
|
|
|
10888
10990
|
*/},{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(){/**
|
|
10889
10991
|
* Locations service.
|
|
10890
10992
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
10891
|
-
* @version
|
|
10993
|
+
* @version 216.0.0
|
|
10892
10994
|
*//**
|
|
10893
10995
|
* Constructs a new LocationsApi.
|
|
10894
10996
|
* @alias module:purecloud-platform-client-v2/api/LocationsApi
|
|
@@ -10947,7 +11049,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
10947
11049
|
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(){/**
|
|
10948
11050
|
* LogCapture service.
|
|
10949
11051
|
* @module purecloud-platform-client-v2/api/LogCaptureApi
|
|
10950
|
-
* @version
|
|
11052
|
+
* @version 216.0.0
|
|
10951
11053
|
*//**
|
|
10952
11054
|
* Constructs a new LogCaptureApi.
|
|
10953
11055
|
* @alias module:purecloud-platform-client-v2/api/LogCaptureApi
|
|
@@ -10997,7 +11099,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
10997
11099
|
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(){/**
|
|
10998
11100
|
* Messaging service.
|
|
10999
11101
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
11000
|
-
* @version
|
|
11102
|
+
* @version 216.0.0
|
|
11001
11103
|
*//**
|
|
11002
11104
|
* Constructs a new MessagingApi.
|
|
11003
11105
|
* @alias module:purecloud-platform-client-v2/api/MessagingApi
|
|
@@ -11087,7 +11189,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
11087
11189
|
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(){/**
|
|
11088
11190
|
* MobileDevices service.
|
|
11089
11191
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
11090
|
-
* @version
|
|
11192
|
+
* @version 216.0.0
|
|
11091
11193
|
*//**
|
|
11092
11194
|
* Constructs a new MobileDevicesApi.
|
|
11093
11195
|
* @alias module:purecloud-platform-client-v2/api/MobileDevicesApi
|
|
@@ -11126,7 +11228,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
11126
11228
|
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(){/**
|
|
11127
11229
|
* Notifications service.
|
|
11128
11230
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
11129
|
-
* @version
|
|
11231
|
+
* @version 216.0.0
|
|
11130
11232
|
*//**
|
|
11131
11233
|
* Constructs a new NotificationsApi.
|
|
11132
11234
|
* @alias module:purecloud-platform-client-v2/api/NotificationsApi
|
|
@@ -11183,7 +11285,7 @@ if(channelId===undefined||channelId===null){throw'Missing the required parameter
|
|
|
11183
11285
|
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(){/**
|
|
11184
11286
|
* OAuth service.
|
|
11185
11287
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
11186
|
-
* @version
|
|
11288
|
+
* @version 216.0.0
|
|
11187
11289
|
*//**
|
|
11188
11290
|
* Constructs a new OAuthApi.
|
|
11189
11291
|
* @alias module:purecloud-platform-client-v2/api/OAuthApi
|
|
@@ -11268,7 +11370,7 @@ if(clientId===undefined||clientId===null){throw'Missing the required parameter "
|
|
|
11268
11370
|
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(){/**
|
|
11269
11371
|
* Objects service.
|
|
11270
11372
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
11271
|
-
* @version
|
|
11373
|
+
* @version 216.0.0
|
|
11272
11374
|
*//**
|
|
11273
11375
|
* Constructs a new ObjectsApi.
|
|
11274
11376
|
* @alias module:purecloud-platform-client-v2/api/ObjectsApi
|
|
@@ -11339,7 +11441,7 @@ if(divisionId===undefined||divisionId===null){throw'Missing the required paramet
|
|
|
11339
11441
|
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(){/**
|
|
11340
11442
|
* OperationalEvents service.
|
|
11341
11443
|
* @module purecloud-platform-client-v2/api/OperationalEventsApi
|
|
11342
|
-
* @version
|
|
11444
|
+
* @version 216.0.0
|
|
11343
11445
|
*//**
|
|
11344
11446
|
* Constructs a new OperationalEventsApi.
|
|
11345
11447
|
* @alias module:purecloud-platform-client-v2/api/OperationalEventsApi
|
|
@@ -11370,7 +11472,7 @@ if(eventDefinitionId===undefined||eventDefinitionId===null){throw'Missing the re
|
|
|
11370
11472
|
*/},{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(){/**
|
|
11371
11473
|
* Organization service.
|
|
11372
11474
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
11373
|
-
* @version
|
|
11475
|
+
* @version 216.0.0
|
|
11374
11476
|
*//**
|
|
11375
11477
|
* Constructs a new OrganizationApi.
|
|
11376
11478
|
* @alias module:purecloud-platform-client-v2/api/OrganizationApi
|
|
@@ -11495,7 +11597,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
11495
11597
|
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(){/**
|
|
11496
11598
|
* OrganizationAuthorization service.
|
|
11497
11599
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
11498
|
-
* @version
|
|
11600
|
+
* @version 216.0.0
|
|
11499
11601
|
*//**
|
|
11500
11602
|
* Constructs a new OrganizationAuthorizationApi.
|
|
11501
11603
|
* @alias module:purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
@@ -11829,7 +11931,7 @@ if(trustorOrgId===undefined||trustorOrgId===null){throw'Missing the required par
|
|
|
11829
11931
|
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(){/**
|
|
11830
11932
|
* Outbound service.
|
|
11831
11933
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
11832
|
-
* @version
|
|
11934
|
+
* @version 216.0.0
|
|
11833
11935
|
*//**
|
|
11834
11936
|
* Constructs a new OutboundApi.
|
|
11835
11937
|
* @alias module:purecloud-platform-client-v2/api/OutboundApi
|
|
@@ -12940,7 +13042,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
12940
13042
|
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(){/**
|
|
12941
13043
|
* Presence service.
|
|
12942
13044
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
12943
|
-
* @version
|
|
13045
|
+
* @version 216.0.0
|
|
12944
13046
|
*//**
|
|
12945
13047
|
* Constructs a new PresenceApi.
|
|
12946
13048
|
* @alias module:purecloud-platform-client-v2/api/PresenceApi
|
|
@@ -13113,7 +13215,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
13113
13215
|
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(){/**
|
|
13114
13216
|
* ProcessAutomation service.
|
|
13115
13217
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
13116
|
-
* @version
|
|
13218
|
+
* @version 216.0.0
|
|
13117
13219
|
*//**
|
|
13118
13220
|
* Constructs a new ProcessAutomationApi.
|
|
13119
13221
|
* @alias module:purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
@@ -13176,7 +13278,7 @@ if(triggerId===undefined||triggerId===null){throw'Missing the required parameter
|
|
|
13176
13278
|
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(){/**
|
|
13177
13279
|
* Quality service.
|
|
13178
13280
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
13179
|
-
* @version
|
|
13281
|
+
* @version 216.0.0
|
|
13180
13282
|
*//**
|
|
13181
13283
|
* Constructs a new QualityApi.
|
|
13182
13284
|
* @alias module:purecloud-platform-client-v2/api/QualityApi
|
|
@@ -13655,7 +13757,7 @@ if(customerSurveyUrl===undefined||customerSurveyUrl===null){throw'Missing the re
|
|
|
13655
13757
|
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(){/**
|
|
13656
13758
|
* Recording service.
|
|
13657
13759
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
13658
|
-
* @version
|
|
13760
|
+
* @version 216.0.0
|
|
13659
13761
|
*//**
|
|
13660
13762
|
* Constructs a new RecordingApi.
|
|
13661
13763
|
* @alias module:purecloud-platform-client-v2/api/RecordingApi
|
|
@@ -13917,14 +14019,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
13917
14019
|
*/},{key:"patchRecordingMediaretentionpolicy",value:function patchRecordingMediaretentionpolicy(policyId,body){// verify the required parameter 'policyId' is set
|
|
13918
14020
|
if(policyId===undefined||policyId===null){throw'Missing the required parameter "policyId" when calling patchRecordingMediaretentionpolicy';}// verify the required parameter 'body' is set
|
|
13919
14021
|
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']);}/**
|
|
13920
|
-
* Update a screen recording session
|
|
13921
|
-
* This API is deprecated and the functionality to stop screen recording will be no longer supported.
|
|
13922
|
-
* @param {String} recordingSessionId Screen recording session ID
|
|
13923
|
-
* @param {Object} opts Optional parameters
|
|
13924
|
-
* @param {Object} opts.body
|
|
13925
|
-
* @deprecated
|
|
13926
|
-
*/},{key:"patchRecordingsScreensession",value:function patchRecordingsScreensession(recordingSessionId,opts){opts=opts||{};// verify the required parameter 'recordingSessionId' is set
|
|
13927
|
-
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']);}/**
|
|
13928
14022
|
* Create annotation
|
|
13929
14023
|
*
|
|
13930
14024
|
* @param {String} conversationId Conversation ID
|
|
@@ -14067,7 +14161,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
14067
14161
|
*/},{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(){/**
|
|
14068
14162
|
* ResponseManagement service.
|
|
14069
14163
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
14070
|
-
* @version
|
|
14164
|
+
* @version 216.0.0
|
|
14071
14165
|
*//**
|
|
14072
14166
|
* Constructs a new ResponseManagementApi.
|
|
14073
14167
|
* @alias module:purecloud-platform-client-v2/api/ResponseManagementApi
|
|
@@ -14188,7 +14282,7 @@ if(responseAssetId===undefined||responseAssetId===null){throw'Missing the requir
|
|
|
14188
14282
|
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(){/**
|
|
14189
14283
|
* Routing service.
|
|
14190
14284
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
14191
|
-
* @version
|
|
14285
|
+
* @version 216.0.0
|
|
14192
14286
|
*//**
|
|
14193
14287
|
* Constructs a new RoutingApi.
|
|
14194
14288
|
* @alias module:purecloud-platform-client-v2/api/RoutingApi
|
|
@@ -15187,7 +15281,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
15187
15281
|
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(){/**
|
|
15188
15282
|
* SCIM service.
|
|
15189
15283
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
15190
|
-
* @version
|
|
15284
|
+
* @version 216.0.0
|
|
15191
15285
|
*//**
|
|
15192
15286
|
* Constructs a new SCIMApi.
|
|
15193
15287
|
* @alias module:purecloud-platform-client-v2/api/SCIMApi
|
|
@@ -15412,7 +15506,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
15412
15506
|
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(){/**
|
|
15413
15507
|
* ScreenRecording service.
|
|
15414
15508
|
* @module purecloud-platform-client-v2/api/ScreenRecordingApi
|
|
15415
|
-
* @version
|
|
15509
|
+
* @version 216.0.0
|
|
15416
15510
|
*//**
|
|
15417
15511
|
* Constructs a new ScreenRecordingApi.
|
|
15418
15512
|
* @alias module:purecloud-platform-client-v2/api/ScreenRecordingApi
|
|
@@ -15427,7 +15521,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
15427
15521
|
*/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(){/**
|
|
15428
15522
|
* Scripts service.
|
|
15429
15523
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
15430
|
-
* @version
|
|
15524
|
+
* @version 216.0.0
|
|
15431
15525
|
*//**
|
|
15432
15526
|
* Constructs a new ScriptsApi.
|
|
15433
15527
|
* @alias module:purecloud-platform-client-v2/api/ScriptsApi
|
|
@@ -15563,7 +15657,7 @@ if(scriptId===undefined||scriptId===null){throw'Missing the required parameter "
|
|
|
15563
15657
|
*/},{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(){/**
|
|
15564
15658
|
* Search service.
|
|
15565
15659
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
15566
|
-
* @version
|
|
15660
|
+
* @version 216.0.0
|
|
15567
15661
|
*//**
|
|
15568
15662
|
* Constructs a new SearchApi.
|
|
15569
15663
|
* @alias module:purecloud-platform-client-v2/api/SearchApi
|
|
@@ -15735,7 +15829,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
15735
15829
|
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(){/**
|
|
15736
15830
|
* Settings service.
|
|
15737
15831
|
* @module purecloud-platform-client-v2/api/SettingsApi
|
|
15738
|
-
* @version
|
|
15832
|
+
* @version 216.0.0
|
|
15739
15833
|
*//**
|
|
15740
15834
|
* Constructs a new SettingsApi.
|
|
15741
15835
|
* @alias module:purecloud-platform-client-v2/api/SettingsApi
|
|
@@ -15785,7 +15879,7 @@ if(agentId===undefined||agentId===null){throw'Missing the required parameter "ag
|
|
|
15785
15879
|
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(){/**
|
|
15786
15880
|
* SocialMedia service.
|
|
15787
15881
|
* @module purecloud-platform-client-v2/api/SocialMediaApi
|
|
15788
|
-
* @version
|
|
15882
|
+
* @version 216.0.0
|
|
15789
15883
|
*//**
|
|
15790
15884
|
* Constructs a new SocialMediaApi.
|
|
15791
15885
|
* @alias module:purecloud-platform-client-v2/api/SocialMediaApi
|
|
@@ -16050,7 +16144,7 @@ if(topicId===undefined||topicId===null){throw'Missing the required parameter "to
|
|
|
16050
16144
|
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(){/**
|
|
16051
16145
|
* SpeechTextAnalytics service.
|
|
16052
16146
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
16053
|
-
* @version
|
|
16147
|
+
* @version 216.0.0
|
|
16054
16148
|
*//**
|
|
16055
16149
|
* Constructs a new SpeechTextAnalyticsApi.
|
|
16056
16150
|
* @alias module:purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
@@ -16091,12 +16185,12 @@ if(topicId===undefined||topicId===null){throw'Missing the required parameter "to
|
|
|
16091
16185
|
* Get the list of Speech and Text Analytics categories
|
|
16092
16186
|
*
|
|
16093
16187
|
* @param {Object} opts Optional parameters
|
|
16094
|
-
* @param {Number} opts.pageSize The page size for the listing. The max that will be returned is
|
|
16188
|
+
* @param {Number} opts.pageSize The page size for the listing. The max that will be returned is 25. (default to 25)
|
|
16095
16189
|
* @param {Number} opts.pageNumber The page number for the listing (default to 1)
|
|
16096
16190
|
* @param {String} opts.name The category name filter applied to the listing
|
|
16097
16191
|
* @param {Object} opts.sortOrder The sort order for the listing (default to asc)
|
|
16098
16192
|
* @param {Object} opts.sortBy The field to sort by for the listing (default to name)
|
|
16099
|
-
* @param {Array.<String>} opts.ids Comma separated Category IDs to filter by. Cannot be used with other filters. Maximum of
|
|
16193
|
+
* @param {Array.<String>} opts.ids Comma separated Category IDs to filter by. Cannot be used with other filters. Maximum of 25 IDs allowed.
|
|
16100
16194
|
*/},{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']);}/**
|
|
16101
16195
|
* Get a Speech and Text Analytics Category by ID
|
|
16102
16196
|
*
|
|
@@ -16373,7 +16467,7 @@ if(topicId===undefined||topicId===null){throw'Missing the required parameter "to
|
|
|
16373
16467
|
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(){/**
|
|
16374
16468
|
* Stations service.
|
|
16375
16469
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
16376
|
-
* @version
|
|
16470
|
+
* @version 216.0.0
|
|
16377
16471
|
*//**
|
|
16378
16472
|
* Constructs a new StationsApi.
|
|
16379
16473
|
* @alias module:purecloud-platform-client-v2/api/StationsApi
|
|
@@ -16405,7 +16499,7 @@ if(stationId===undefined||stationId===null){throw'Missing the required parameter
|
|
|
16405
16499
|
*/},{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(){/**
|
|
16406
16500
|
* Suggest service.
|
|
16407
16501
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
16408
|
-
* @version
|
|
16502
|
+
* @version 216.0.0
|
|
16409
16503
|
*//**
|
|
16410
16504
|
* Constructs a new SuggestApi.
|
|
16411
16505
|
* @alias module:purecloud-platform-client-v2/api/SuggestApi
|
|
@@ -16445,7 +16539,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
16445
16539
|
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(){/**
|
|
16446
16540
|
* TaskManagement service.
|
|
16447
16541
|
* @module purecloud-platform-client-v2/api/TaskManagementApi
|
|
16448
|
-
* @version
|
|
16542
|
+
* @version 216.0.0
|
|
16449
16543
|
*//**
|
|
16450
16544
|
* Constructs a new TaskManagementApi.
|
|
16451
16545
|
* @alias module:purecloud-platform-client-v2/api/TaskManagementApi
|
|
@@ -16951,7 +17045,7 @@ if(schemaId===undefined||schemaId===null){throw'Missing the required parameter "
|
|
|
16951
17045
|
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(){/**
|
|
16952
17046
|
* Teams service.
|
|
16953
17047
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
16954
|
-
* @version
|
|
17048
|
+
* @version 216.0.0
|
|
16955
17049
|
*//**
|
|
16956
17050
|
* Constructs a new TeamsApi.
|
|
16957
17051
|
* @alias module:purecloud-platform-client-v2/api/TeamsApi
|
|
@@ -17031,7 +17125,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
17031
17125
|
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(){/**
|
|
17032
17126
|
* Telephony service.
|
|
17033
17127
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
17034
|
-
* @version
|
|
17128
|
+
* @version 216.0.0
|
|
17035
17129
|
*//**
|
|
17036
17130
|
* Constructs a new TelephonyApi.
|
|
17037
17131
|
* @alias module:purecloud-platform-client-v2/api/TelephonyApi
|
|
@@ -17078,7 +17172,7 @@ if(downloadId===undefined||downloadId===null){throw'Missing the required paramet
|
|
|
17078
17172
|
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(){/**
|
|
17079
17173
|
* TelephonyProvidersEdge service.
|
|
17080
17174
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
17081
|
-
* @version
|
|
17175
|
+
* @version 216.0.0
|
|
17082
17176
|
*//**
|
|
17083
17177
|
* Constructs a new TelephonyProvidersEdgeApi.
|
|
17084
17178
|
* @alias module:purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
@@ -17913,7 +18007,7 @@ if(trunkBaseSettingsId===undefined||trunkBaseSettingsId===null){throw'Missing th
|
|
|
17913
18007
|
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(){/**
|
|
17914
18008
|
* Textbots service.
|
|
17915
18009
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
17916
|
-
* @version
|
|
18010
|
+
* @version 216.0.0
|
|
17917
18011
|
*//**
|
|
17918
18012
|
* Constructs a new TextbotsApi.
|
|
17919
18013
|
* @alias module:purecloud-platform-client-v2/api/TextbotsApi
|
|
@@ -17948,7 +18042,7 @@ if(launchRequest===undefined||launchRequest===null){throw'Missing the required p
|
|
|
17948
18042
|
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(){/**
|
|
17949
18043
|
* Tokens service.
|
|
17950
18044
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
17951
|
-
* @version
|
|
18045
|
+
* @version 216.0.0
|
|
17952
18046
|
*//**
|
|
17953
18047
|
* Constructs a new TokensApi.
|
|
17954
18048
|
* @alias module:purecloud-platform-client-v2/api/TokensApi
|
|
@@ -17982,7 +18076,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
17982
18076
|
*/},{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(){/**
|
|
17983
18077
|
* Uploads service.
|
|
17984
18078
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
17985
|
-
* @version
|
|
18079
|
+
* @version 216.0.0
|
|
17986
18080
|
*//**
|
|
17987
18081
|
* Constructs a new UploadsApi.
|
|
17988
18082
|
* @alias module:purecloud-platform-client-v2/api/UploadsApi
|
|
@@ -18047,7 +18141,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
18047
18141
|
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(){/**
|
|
18048
18142
|
* Usage service.
|
|
18049
18143
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
18050
|
-
* @version
|
|
18144
|
+
* @version 216.0.0
|
|
18051
18145
|
*//**
|
|
18052
18146
|
* Constructs a new UsageApi.
|
|
18053
18147
|
* @alias module:purecloud-platform-client-v2/api/UsageApi
|
|
@@ -18101,7 +18195,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
18101
18195
|
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(){/**
|
|
18102
18196
|
* UserRecordings service.
|
|
18103
18197
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
18104
|
-
* @version
|
|
18198
|
+
* @version 216.0.0
|
|
18105
18199
|
*//**
|
|
18106
18200
|
* Constructs a new UserRecordingsApi.
|
|
18107
18201
|
* @alias module:purecloud-platform-client-v2/api/UserRecordingsApi
|
|
@@ -18158,7 +18252,7 @@ if(recordingId===undefined||recordingId===null){throw'Missing the required param
|
|
|
18158
18252
|
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(){/**
|
|
18159
18253
|
* Users service.
|
|
18160
18254
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
18161
|
-
* @version
|
|
18255
|
+
* @version 216.0.0
|
|
18162
18256
|
*//**
|
|
18163
18257
|
* Constructs a new UsersApi.
|
|
18164
18258
|
* @alias module:purecloud-platform-client-v2/api/UsersApi
|
|
@@ -18885,7 +18979,7 @@ if(verifierId===undefined||verifierId===null){throw'Missing the required paramet
|
|
|
18885
18979
|
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(){/**
|
|
18886
18980
|
* Utilities service.
|
|
18887
18981
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
18888
|
-
* @version
|
|
18982
|
+
* @version 216.0.0
|
|
18889
18983
|
*//**
|
|
18890
18984
|
* Constructs a new UtilitiesApi.
|
|
18891
18985
|
* @alias module:purecloud-platform-client-v2/api/UtilitiesApi
|
|
@@ -18912,7 +19006,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
18912
19006
|
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(){/**
|
|
18913
19007
|
* Voicemail service.
|
|
18914
19008
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
18915
|
-
* @version
|
|
19009
|
+
* @version 216.0.0
|
|
18916
19010
|
*//**
|
|
18917
19011
|
* Constructs a new VoicemailApi.
|
|
18918
19012
|
* @alias module:purecloud-platform-client-v2/api/VoicemailApi
|
|
@@ -19074,7 +19168,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
19074
19168
|
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(){/**
|
|
19075
19169
|
* WebChat service.
|
|
19076
19170
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
19077
|
-
* @version
|
|
19171
|
+
* @version 216.0.0
|
|
19078
19172
|
*//**
|
|
19079
19173
|
* Constructs a new WebChatApi.
|
|
19080
19174
|
* @alias module:purecloud-platform-client-v2/api/WebChatApi
|
|
@@ -19209,7 +19303,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
19209
19303
|
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(){/**
|
|
19210
19304
|
* WebDeployments service.
|
|
19211
19305
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
19212
|
-
* @version
|
|
19306
|
+
* @version 216.0.0
|
|
19213
19307
|
*//**
|
|
19214
19308
|
* Constructs a new WebDeploymentsApi.
|
|
19215
19309
|
* @alias module:purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
@@ -19330,7 +19424,7 @@ if(deploymentId===undefined||deploymentId===null){throw'Missing the required par
|
|
|
19330
19424
|
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(){/**
|
|
19331
19425
|
* WebMessaging service.
|
|
19332
19426
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
19333
|
-
* @version
|
|
19427
|
+
* @version 216.0.0
|
|
19334
19428
|
*//**
|
|
19335
19429
|
* Constructs a new WebMessagingApi.
|
|
19336
19430
|
* @alias module:purecloud-platform-client-v2/api/WebMessagingApi
|
|
@@ -19346,7 +19440,7 @@ if(deployment===undefined||deployment===null){throw'Missing the required paramet
|
|
|
19346
19440
|
*/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(){/**
|
|
19347
19441
|
* Widgets service.
|
|
19348
19442
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
19349
|
-
* @version
|
|
19443
|
+
* @version 216.0.0
|
|
19350
19444
|
*//**
|
|
19351
19445
|
* Constructs a new WidgetsApi.
|
|
19352
19446
|
* @alias module:purecloud-platform-client-v2/api/WidgetsApi
|
|
@@ -19381,7 +19475,7 @@ if(deploymentId===undefined||deploymentId===null){throw'Missing the required par
|
|
|
19381
19475
|
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(){/**
|
|
19382
19476
|
* WorkforceManagement service.
|
|
19383
19477
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
19384
|
-
* @version
|
|
19478
|
+
* @version 216.0.0
|
|
19385
19479
|
*//**
|
|
19386
19480
|
* Constructs a new WorkforceManagementApi.
|
|
19387
19481
|
* @alias module:purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
@@ -19985,6 +20079,14 @@ if(calendarId===undefined||calendarId===null){throw'Missing the required paramet
|
|
|
19985
20079
|
* Get existing calendar link for the current user
|
|
19986
20080
|
*
|
|
19987
20081
|
*/},{key:"getWorkforcemanagementCalendarUrlIcs",value:function getWorkforcemanagementCalendarUrlIcs(){return this.apiClient.callApi('/api/v2/workforcemanagement/calendar/url/ics','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
20082
|
+
* Retrieves delete job status for historical data imports associated with the job id
|
|
20083
|
+
*
|
|
20084
|
+
* @param {String} jobId The job ID of the historical data delete request
|
|
20085
|
+
*/},{key:"getWorkforcemanagementHistoricaldataBulkRemoveJob",value:function getWorkforcemanagementHistoricaldataBulkRemoveJob(jobId){// verify the required parameter 'jobId' is set
|
|
20086
|
+
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']);}/**
|
|
20087
|
+
* Retrieves all delete job status for historical data
|
|
20088
|
+
*
|
|
20089
|
+
*/},{key:"getWorkforcemanagementHistoricaldataBulkRemoveJobs",value:function getWorkforcemanagementHistoricaldataBulkRemoveJobs(){return this.apiClient.callApi('/api/v2/workforcemanagement/historicaldata/bulk/remove/jobs','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
19988
20090
|
* Retrieves delete job status for historical data imports of the organization
|
|
19989
20091
|
*
|
|
19990
20092
|
*/},{key:"getWorkforcemanagementHistoricaldataDeletejob",value:function getWorkforcemanagementHistoricaldataDeletejob(){return this.apiClient.callApi('/api/v2/workforcemanagement/historicaldata/deletejob','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
@@ -20858,6 +20960,11 @@ if(businessUnitId===undefined||businessUnitId===null){throw'Missing the required
|
|
|
20858
20960
|
* @param {Object} opts Optional parameters
|
|
20859
20961
|
* @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)
|
|
20860
20962
|
*/},{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']);}/**
|
|
20963
|
+
* Delete the list of the historical data import entries
|
|
20964
|
+
*
|
|
20965
|
+
* @param {Object} opts Optional parameters
|
|
20966
|
+
* @param {Object} opts.body body
|
|
20967
|
+
*/},{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']);}/**
|
|
20861
20968
|
* Delete the entries of the historical data imports in the organization
|
|
20862
20969
|
*
|
|
20863
20970
|
*/},{key:"postWorkforcemanagementHistoricaldataDeletejob",value:function postWorkforcemanagementHistoricaldataDeletejob(){return this.apiClient.callApi('/api/v2/workforcemanagement/historicaldata/deletejob','POST',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
@@ -21187,7 +21294,7 @@ if(timeOffLimitId===undefined||timeOffLimitId===null){throw'Missing the required
|
|
|
21187
21294
|
* </pre>
|
|
21188
21295
|
* </p>
|
|
21189
21296
|
* @module purecloud-platform-client-v2/index
|
|
21190
|
-
* @version
|
|
21297
|
+
* @version 216.0.0
|
|
21191
21298
|
*/var platformClient=/*#__PURE__*/_createClass(function platformClient(){_classCallCheck(this,platformClient);/**
|
|
21192
21299
|
* The ApiClient constructor.
|
|
21193
21300
|
* @property {module:purecloud-platform-client-v2/ApiClient}
|