purecloud-platform-client-v2 218.1.0 → 219.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 +1118 -100
- package/dist/web-amd/purecloud-platform-client-v2.js +1118 -100
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +349 -100
- package/dist/web-cjs/purecloud-platform-client-v2.js +349 -100
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +499 -8
- 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 -1
- package/src/purecloud-platform-client-v2/api/ArchitectApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AuditApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +54 -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 +396 -2
- 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 +366 -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 +1 -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 +54 -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 +60 -1
- package/src/purecloud-platform-client-v2/api/PresenceApi.js +11 -11
- package/src/purecloud-platform-client-v2/api/ProcessAutomationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/QualityApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RecordingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RoutingApi.js +6 -4
- 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 +1 -1
- package/src/purecloud-platform-client-v2/api/StationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SuggestApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TaskManagementApi.js +66 -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 +26 -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 +7 -5
- package/src/purecloud-platform-client-v2/index.js +1 -1
package/dist/web-cjs/bundle.js
CHANGED
|
@@ -892,7 +892,7 @@ if(env)this.environment=env;else this.environment=this.host?this.host:'mypureclo
|
|
|
892
892
|
this.environment=this.environment.replace(/\/+$/,'');// Strip protocol and subdomain
|
|
893
893
|
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];}}}]);}();/**
|
|
894
894
|
* @module purecloud-platform-client-v2/ApiClient
|
|
895
|
-
* @version
|
|
895
|
+
* @version 219.0.0
|
|
896
896
|
*/var ApiClient=/*#__PURE__*/function(){/**
|
|
897
897
|
* Manages low level client-server communications, parameter marshalling, etc. There should not be any need for an
|
|
898
898
|
* application to use this class directly - the *Api and model classes provide the public API for the service. The
|
|
@@ -1235,7 +1235,7 @@ resolve(data);})["catch"](function(error){var data=error;if(error.response&&erro
|
|
|
1235
1235
|
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(){/**
|
|
1236
1236
|
* AgentAssistants service.
|
|
1237
1237
|
* @module purecloud-platform-client-v2/api/AgentAssistantsApi
|
|
1238
|
-
* @version
|
|
1238
|
+
* @version 219.0.0
|
|
1239
1239
|
*//**
|
|
1240
1240
|
* Constructs a new AgentAssistantsApi.
|
|
1241
1241
|
* @alias module:purecloud-platform-client-v2/api/AgentAssistantsApi
|
|
@@ -1336,7 +1336,7 @@ if(queueId===undefined||queueId===null){throw'Missing the required parameter "qu
|
|
|
1336
1336
|
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(){/**
|
|
1337
1337
|
* AgentCopilot service.
|
|
1338
1338
|
* @module purecloud-platform-client-v2/api/AgentCopilotApi
|
|
1339
|
-
* @version
|
|
1339
|
+
* @version 219.0.0
|
|
1340
1340
|
*//**
|
|
1341
1341
|
* Constructs a new AgentCopilotApi.
|
|
1342
1342
|
* @alias module:purecloud-platform-client-v2/api/AgentCopilotApi
|
|
@@ -1358,7 +1358,7 @@ if(assistantId===undefined||assistantId===null){throw'Missing the required param
|
|
|
1358
1358
|
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(){/**
|
|
1359
1359
|
* AgentUI service.
|
|
1360
1360
|
* @module purecloud-platform-client-v2/api/AgentUIApi
|
|
1361
|
-
* @version
|
|
1361
|
+
* @version 219.0.0
|
|
1362
1362
|
*//**
|
|
1363
1363
|
* Constructs a new AgentUIApi.
|
|
1364
1364
|
* @alias module:purecloud-platform-client-v2/api/AgentUIApi
|
|
@@ -1392,7 +1392,7 @@ if(agentId===undefined||agentId===null){throw'Missing the required parameter "ag
|
|
|
1392
1392
|
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(){/**
|
|
1393
1393
|
* Alerting service.
|
|
1394
1394
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
1395
|
-
* @version
|
|
1395
|
+
* @version 219.0.0
|
|
1396
1396
|
*//**
|
|
1397
1397
|
* Constructs a new AlertingApi.
|
|
1398
1398
|
* @alias module:purecloud-platform-client-v2/api/AlertingApi
|
|
@@ -1481,7 +1481,7 @@ if(ruleId===undefined||ruleId===null){throw'Missing the required parameter "rule
|
|
|
1481
1481
|
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(){/**
|
|
1482
1482
|
* Analytics service.
|
|
1483
1483
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
1484
|
-
* @version
|
|
1484
|
+
* @version 219.0.0
|
|
1485
1485
|
*//**
|
|
1486
1486
|
* Constructs a new AnalyticsApi.
|
|
1487
1487
|
* @alias module:purecloud-platform-client-v2/api/AnalyticsApi
|
|
@@ -2149,7 +2149,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
2149
2149
|
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(){/**
|
|
2150
2150
|
* Architect service.
|
|
2151
2151
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
2152
|
-
* @version
|
|
2152
|
+
* @version 219.0.0
|
|
2153
2153
|
*//**
|
|
2154
2154
|
* Constructs a new ArchitectApi.
|
|
2155
2155
|
* @alias module:purecloud-platform-client-v2/api/ArchitectApi
|
|
@@ -3281,7 +3281,7 @@ if(milestoneId===undefined||milestoneId===null){throw'Missing the required param
|
|
|
3281
3281
|
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(){/**
|
|
3282
3282
|
* Audit service.
|
|
3283
3283
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
3284
|
-
* @version
|
|
3284
|
+
* @version 219.0.0
|
|
3285
3285
|
*//**
|
|
3286
3286
|
* Constructs a new AuditApi.
|
|
3287
3287
|
* @alias module:purecloud-platform-client-v2/api/AuditApi
|
|
@@ -3331,7 +3331,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
3331
3331
|
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(){/**
|
|
3332
3332
|
* Authorization service.
|
|
3333
3333
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
3334
|
-
* @version
|
|
3334
|
+
* @version 219.0.0
|
|
3335
3335
|
*//**
|
|
3336
3336
|
* Constructs a new AuthorizationApi.
|
|
3337
3337
|
* @alias module:purecloud-platform-client-v2/api/AuthorizationApi
|
|
@@ -3396,12 +3396,27 @@ if(divisionId===undefined||divisionId===null){throw'Missing the required paramet
|
|
|
3396
3396
|
* @param {Array.<String>} opts.id Optionally request specific divisions by their IDs
|
|
3397
3397
|
* @param {String} opts.name Search term to filter by division name
|
|
3398
3398
|
*/},{key:"getAuthorizationDivisions",value:function getAuthorizationDivisions(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/authorization/divisions','GET',{},{'pageSize':opts['pageSize'],'pageNumber':opts['pageNumber'],'sortBy':opts['sortBy'],'expand':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'nextPage':opts['nextPage'],'previousPage':opts['previousPage'],'objectCount':opts['objectCount'],'id':this.apiClient.buildCollectionParam(opts['id'],'multi'),'name':opts['name']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
3399
|
+
* Get a list of soft deleted divisions for the org
|
|
3400
|
+
*
|
|
3401
|
+
* @param {Object} opts Optional parameters
|
|
3402
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
3403
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
3404
|
+
*/},{key:"getAuthorizationDivisionsDeleted",value:function getAuthorizationDivisionsDeleted(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/authorization/divisions/deleted','GET',{},{'pageNumber':opts['pageNumber'],'pageSize':opts['pageSize']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
3399
3405
|
* Retrieve the home division for the organization.
|
|
3400
3406
|
* Will not include object counts.
|
|
3401
3407
|
*/},{key:"getAuthorizationDivisionsHome",value:function getAuthorizationDivisionsHome(){return this.apiClient.callApi('/api/v2/authorization/divisions/home','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
3402
3408
|
* Returns the maximum allowed number of divisions.
|
|
3403
3409
|
*
|
|
3404
3410
|
*/},{key:"getAuthorizationDivisionsLimit",value:function getAuthorizationDivisionsLimit(){return this.apiClient.callApi('/api/v2/authorization/divisions/limit','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
3411
|
+
* Retrieve a list of all divisions defined for the organization with cursor
|
|
3412
|
+
* Use "after" and "before" param to fetch next/previous page}
|
|
3413
|
+
* @param {Object} opts Optional parameters
|
|
3414
|
+
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
3415
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
3416
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
3417
|
+
* @param {Array.<String>} opts.id Optionally request specific divisions by their IDs
|
|
3418
|
+
* @param {String} opts.name Optionally request specific divisions by division name
|
|
3419
|
+
*/},{key:"getAuthorizationDivisionsQuery",value:function getAuthorizationDivisionsQuery(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/authorization/divisions/query','GET',{},{'before':opts['before'],'after':opts['after'],'pageSize':opts['pageSize'],'id':this.apiClient.buildCollectionParam(opts['id'],'multi'),'name':opts['name']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
3405
3420
|
* Returns which divisions the current user has the given permission in.
|
|
3406
3421
|
* This route is deprecated, use authorization/divisionspermitted/paged/me instead.
|
|
3407
3422
|
* @param {String} permission The permission string, including the object to access, e.g. routing:queue:view
|
|
@@ -3751,7 +3766,7 @@ if(subjectId===undefined||subjectId===null){throw'Missing the required parameter
|
|
|
3751
3766
|
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(){/**
|
|
3752
3767
|
* Billing service.
|
|
3753
3768
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
3754
|
-
* @version
|
|
3769
|
+
* @version 219.0.0
|
|
3755
3770
|
*//**
|
|
3756
3771
|
* Constructs a new BillingApi.
|
|
3757
3772
|
* @alias module:purecloud-platform-client-v2/api/BillingApi
|
|
@@ -3775,7 +3790,7 @@ if(endDate===undefined||endDate===null){throw'Missing the required parameter "en
|
|
|
3775
3790
|
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(){/**
|
|
3776
3791
|
* CarrierServices service.
|
|
3777
3792
|
* @module purecloud-platform-client-v2/api/CarrierServicesApi
|
|
3778
|
-
* @version
|
|
3793
|
+
* @version 219.0.0
|
|
3779
3794
|
*//**
|
|
3780
3795
|
* Constructs a new CarrierServicesApi.
|
|
3781
3796
|
* @alias module:purecloud-platform-client-v2/api/CarrierServicesApi
|
|
@@ -3795,7 +3810,7 @@ if(phoneNumber===undefined||phoneNumber===null){throw'Missing the required param
|
|
|
3795
3810
|
*/},{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(){/**
|
|
3796
3811
|
* Chat service.
|
|
3797
3812
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
3798
|
-
* @version
|
|
3813
|
+
* @version 219.0.0
|
|
3799
3814
|
*//**
|
|
3800
3815
|
* Constructs a new ChatApi.
|
|
3801
3816
|
* @alias module:purecloud-platform-client-v2/api/ChatApi
|
|
@@ -4013,7 +4028,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
4013
4028
|
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(){/**
|
|
4014
4029
|
* Coaching service.
|
|
4015
4030
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
4016
|
-
* @version
|
|
4031
|
+
* @version 219.0.0
|
|
4017
4032
|
*//**
|
|
4018
4033
|
* Constructs a new CoachingApi.
|
|
4019
4034
|
* @alias module:purecloud-platform-client-v2/api/CoachingApi
|
|
@@ -4166,7 +4181,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
4166
4181
|
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(){/**
|
|
4167
4182
|
* ContentManagement service.
|
|
4168
4183
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
4169
|
-
* @version
|
|
4184
|
+
* @version 219.0.0
|
|
4170
4185
|
*//**
|
|
4171
4186
|
* Constructs a new ContentManagementApi.
|
|
4172
4187
|
* @alias module:purecloud-platform-client-v2/api/ContentManagementApi
|
|
@@ -4448,7 +4463,7 @@ if(tagId===undefined||tagId===null){throw'Missing the required parameter "tagId"
|
|
|
4448
4463
|
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(){/**
|
|
4449
4464
|
* Conversations service.
|
|
4450
4465
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
4451
|
-
* @version
|
|
4466
|
+
* @version 219.0.0
|
|
4452
4467
|
*//**
|
|
4453
4468
|
* Constructs a new ConversationsApi.
|
|
4454
4469
|
* @alias module:purecloud-platform-client-v2/api/ConversationsApi
|
|
@@ -6297,7 +6312,7 @@ if(conversationId===undefined||conversationId===null){throw'Missing the required
|
|
|
6297
6312
|
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(){/**
|
|
6298
6313
|
* DataExtensions service.
|
|
6299
6314
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
6300
|
-
* @version
|
|
6315
|
+
* @version 219.0.0
|
|
6301
6316
|
*//**
|
|
6302
6317
|
* Constructs a new DataExtensionsApi.
|
|
6303
6318
|
* @alias module:purecloud-platform-client-v2/api/DataExtensionsApi
|
|
@@ -6318,7 +6333,7 @@ if(coretypeName===undefined||coretypeName===null){throw'Missing the required par
|
|
|
6318
6333
|
*/},{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(){/**
|
|
6319
6334
|
* DataPrivacy service.
|
|
6320
6335
|
* @module purecloud-platform-client-v2/api/DataPrivacyApi
|
|
6321
|
-
* @version
|
|
6336
|
+
* @version 219.0.0
|
|
6322
6337
|
*//**
|
|
6323
6338
|
* Constructs a new DataPrivacyApi.
|
|
6324
6339
|
* @alias module:purecloud-platform-client-v2/api/DataPrivacyApi
|
|
@@ -6358,7 +6373,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
6358
6373
|
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(){/**
|
|
6359
6374
|
* Downloads service.
|
|
6360
6375
|
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
6361
|
-
* @version
|
|
6376
|
+
* @version 219.0.0
|
|
6362
6377
|
*//**
|
|
6363
6378
|
* Constructs a new DownloadsApi.
|
|
6364
6379
|
* @alias module:purecloud-platform-client-v2/api/DownloadsApi
|
|
@@ -6377,7 +6392,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
6377
6392
|
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(){/**
|
|
6378
6393
|
* Emails service.
|
|
6379
6394
|
* @module purecloud-platform-client-v2/api/EmailsApi
|
|
6380
|
-
* @version
|
|
6395
|
+
* @version 219.0.0
|
|
6381
6396
|
*//**
|
|
6382
6397
|
* Constructs a new EmailsApi.
|
|
6383
6398
|
* @alias module:purecloud-platform-client-v2/api/EmailsApi
|
|
@@ -6406,7 +6421,7 @@ if(downloadId===undefined||downloadId===null){throw'Missing the required paramet
|
|
|
6406
6421
|
*/},{key:"patchEmailsSettingsThreading",value:function patchEmailsSettingsThreading(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/emails/settings/threading','PATCH',{},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var EmployeeEngagementApi=/*#__PURE__*/function(){/**
|
|
6407
6422
|
* EmployeeEngagement service.
|
|
6408
6423
|
* @module purecloud-platform-client-v2/api/EmployeeEngagementApi
|
|
6409
|
-
* @version
|
|
6424
|
+
* @version 219.0.0
|
|
6410
6425
|
*//**
|
|
6411
6426
|
* Constructs a new EmployeeEngagementApi.
|
|
6412
6427
|
* @alias module:purecloud-platform-client-v2/api/EmployeeEngagementApi
|
|
@@ -6444,7 +6459,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
6444
6459
|
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(){/**
|
|
6445
6460
|
* Events service.
|
|
6446
6461
|
* @module purecloud-platform-client-v2/api/EventsApi
|
|
6447
|
-
* @version
|
|
6462
|
+
* @version 219.0.0
|
|
6448
6463
|
*//**
|
|
6449
6464
|
* Constructs a new EventsApi.
|
|
6450
6465
|
* @alias module:purecloud-platform-client-v2/api/EventsApi
|
|
@@ -6469,7 +6484,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
6469
6484
|
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(){/**
|
|
6470
6485
|
* ExternalContacts service.
|
|
6471
6486
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
6472
|
-
* @version
|
|
6487
|
+
* @version 219.0.0
|
|
6473
6488
|
*//**
|
|
6474
6489
|
* Constructs a new ExternalContactsApi.
|
|
6475
6490
|
* @alias module:purecloud-platform-client-v2/api/ExternalContactsApi
|
|
@@ -6620,6 +6635,17 @@ if(schemaId===undefined||schemaId===null){throw'Missing the required parameter "
|
|
|
6620
6635
|
* Get a list of schemas.
|
|
6621
6636
|
*
|
|
6622
6637
|
*/},{key:"getExternalcontactsContactsSchemas",value:function getExternalcontactsContactsSchemas(){return this.apiClient.callApi('/api/v2/externalcontacts/contacts/schemas','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
6638
|
+
* Get the core types from which all schemas are built.
|
|
6639
|
+
*
|
|
6640
|
+
* @param {String} coreTypeName Name of the core type
|
|
6641
|
+
*/},{key:"getExternalcontactsContactsSchemasCoretype",value:function getExternalcontactsContactsSchemasCoretype(coreTypeName){// verify the required parameter 'coreTypeName' is set
|
|
6642
|
+
if(coreTypeName===undefined||coreTypeName===null){throw'Missing the required parameter "coreTypeName" when calling getExternalcontactsContactsSchemasCoretype';}return this.apiClient.callApi('/api/v2/externalcontacts/contacts/schemas/coretypes/{coreTypeName}','GET',{'coreTypeName':coreTypeName},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
6643
|
+
* Get the core types from which all schemas are built.
|
|
6644
|
+
*
|
|
6645
|
+
*/},{key:"getExternalcontactsContactsSchemasCoretypes",value:function getExternalcontactsContactsSchemasCoretypes(){return this.apiClient.callApi('/api/v2/externalcontacts/contacts/schemas/coretypes','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
6646
|
+
* Get quantitative limits on schemas
|
|
6647
|
+
*
|
|
6648
|
+
*/},{key:"getExternalcontactsContactsSchemasLimits",value:function getExternalcontactsContactsSchemasLimits(){return this.apiClient.callApi('/api/v2/externalcontacts/contacts/schemas/limits','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
6623
6649
|
* Fetch an External Source
|
|
6624
6650
|
*
|
|
6625
6651
|
* @param {String} externalSourceId External Source ID
|
|
@@ -6703,6 +6729,12 @@ if(externalOrganizationId===undefined||externalOrganizationId===null){throw'Miss
|
|
|
6703
6729
|
* @param {Array.<String>} opts.expand which fields, if any, to expand
|
|
6704
6730
|
*/},{key:"getExternalcontactsOrganizationContacts",value:function getExternalcontactsOrganizationContacts(externalOrganizationId,opts){opts=opts||{};// verify the required parameter 'externalOrganizationId' is set
|
|
6705
6731
|
if(externalOrganizationId===undefined||externalOrganizationId===null){throw'Missing the required parameter "externalOrganizationId" when calling getExternalcontactsOrganizationContacts';}return this.apiClient.callApi('/api/v2/externalcontacts/organizations/{externalOrganizationId}/contacts','GET',{'externalOrganizationId':externalOrganizationId},{'pageSize':opts['pageSize'],'pageNumber':opts['pageNumber'],'q':opts['q'],'sortOrder':opts['sortOrder'],'expand':this.apiClient.buildCollectionParam(opts['expand'],'multi')},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
6732
|
+
* List the identifiers for an external organization
|
|
6733
|
+
*
|
|
6734
|
+
* @param {String} externalOrganizationId External Organization ID
|
|
6735
|
+
* getExternalcontactsOrganizationIdentifiers is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
6736
|
+
*/},{key:"getExternalcontactsOrganizationIdentifiers",value:function getExternalcontactsOrganizationIdentifiers(externalOrganizationId){// verify the required parameter 'externalOrganizationId' is set
|
|
6737
|
+
if(externalOrganizationId===undefined||externalOrganizationId===null){throw'Missing the required parameter "externalOrganizationId" when calling getExternalcontactsOrganizationIdentifiers';}return this.apiClient.callApi('/api/v2/externalcontacts/organizations/{externalOrganizationId}/identifiers','GET',{'externalOrganizationId':externalOrganizationId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
6706
6738
|
* Fetch a note for an external organization
|
|
6707
6739
|
*
|
|
6708
6740
|
* @param {String} externalOrganizationId External Organization Id
|
|
@@ -6764,6 +6796,17 @@ if(schemaId===undefined||schemaId===null){throw'Missing the required parameter "
|
|
|
6764
6796
|
* Get a list of schemas.
|
|
6765
6797
|
*
|
|
6766
6798
|
*/},{key:"getExternalcontactsOrganizationsSchemas",value:function getExternalcontactsOrganizationsSchemas(){return this.apiClient.callApi('/api/v2/externalcontacts/organizations/schemas','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
6799
|
+
* Get the core types from which all schemas are built.
|
|
6800
|
+
*
|
|
6801
|
+
* @param {String} coreTypeName Name of the core type
|
|
6802
|
+
*/},{key:"getExternalcontactsOrganizationsSchemasCoretype",value:function getExternalcontactsOrganizationsSchemasCoretype(coreTypeName){// verify the required parameter 'coreTypeName' is set
|
|
6803
|
+
if(coreTypeName===undefined||coreTypeName===null){throw'Missing the required parameter "coreTypeName" when calling getExternalcontactsOrganizationsSchemasCoretype';}return this.apiClient.callApi('/api/v2/externalcontacts/organizations/schemas/coretypes/{coreTypeName}','GET',{'coreTypeName':coreTypeName},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
6804
|
+
* Get the core types from which all schemas are built.
|
|
6805
|
+
*
|
|
6806
|
+
*/},{key:"getExternalcontactsOrganizationsSchemasCoretypes",value:function getExternalcontactsOrganizationsSchemasCoretypes(){return this.apiClient.callApi('/api/v2/externalcontacts/organizations/schemas/coretypes','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
6807
|
+
* Get quantitative limits on schemas
|
|
6808
|
+
*
|
|
6809
|
+
*/},{key:"getExternalcontactsOrganizationsSchemasLimits",value:function getExternalcontactsOrganizationsSchemasLimits(){return this.apiClient.callApi('/api/v2/externalcontacts/organizations/schemas/limits','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
6767
6810
|
* Fetch a relationship
|
|
6768
6811
|
*
|
|
6769
6812
|
* @param {String} relationshipId Relationship Id
|
|
@@ -6842,6 +6885,14 @@ if(lookupVal===undefined||lookupVal===null){throw'Missing the required parameter
|
|
|
6842
6885
|
*/},{key:"patchExternalcontactsContactIdentifiers",value:function patchExternalcontactsContactIdentifiers(contactId,body){// verify the required parameter 'contactId' is set
|
|
6843
6886
|
if(contactId===undefined||contactId===null){throw'Missing the required parameter "contactId" when calling patchExternalcontactsContactIdentifiers';}// verify the required parameter 'body' is set
|
|
6844
6887
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling patchExternalcontactsContactIdentifiers';}return this.apiClient.callApi('/api/v2/externalcontacts/contacts/{contactId}/identifiers','PATCH',{'contactId':contactId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
6888
|
+
* Claim or release identifiers for an external organization
|
|
6889
|
+
*
|
|
6890
|
+
* @param {String} externalOrganizationId External Organization ID
|
|
6891
|
+
* @param {Object} body ClaimRequest
|
|
6892
|
+
* patchExternalcontactsOrganizationIdentifiers is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
6893
|
+
*/},{key:"patchExternalcontactsOrganizationIdentifiers",value:function patchExternalcontactsOrganizationIdentifiers(externalOrganizationId,body){// verify the required parameter 'externalOrganizationId' is set
|
|
6894
|
+
if(externalOrganizationId===undefined||externalOrganizationId===null){throw'Missing the required parameter "externalOrganizationId" when calling patchExternalcontactsOrganizationIdentifiers';}// verify the required parameter 'body' is set
|
|
6895
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling patchExternalcontactsOrganizationIdentifiers';}return this.apiClient.callApi('/api/v2/externalcontacts/organizations/{externalOrganizationId}/identifiers','PATCH',{'externalOrganizationId':externalOrganizationId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
6845
6896
|
* Bulk fetch contacts
|
|
6846
6897
|
*
|
|
6847
6898
|
* @param {Object} body Contact ids
|
|
@@ -6858,6 +6909,14 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
6858
6909
|
* postExternalcontactsBulkContactsDivisionviews is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
6859
6910
|
*/},{key:"postExternalcontactsBulkContactsDivisionviews",value:function postExternalcontactsBulkContactsDivisionviews(body){// verify the required parameter 'body' is set
|
|
6860
6911
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postExternalcontactsBulkContactsDivisionviews';}return this.apiClient.callApi('/api/v2/externalcontacts/bulk/contacts/divisionviews','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
6912
|
+
* Bulk Enrich Contacts - Run up to 10 Enrich operations per request
|
|
6913
|
+
* See the API endpoint /externalcontacts/contacts/enrich for docs on individual Enrich operations.
|
|
6914
|
+
* @param {Object} body Contact Enrich Requests
|
|
6915
|
+
* @param {Object} opts Optional parameters
|
|
6916
|
+
* @param {Boolean} opts.dryRun If true, the request will not make any modifications, but will show you what the end result *would* be.
|
|
6917
|
+
* postExternalcontactsBulkContactsEnrich is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
6918
|
+
*/},{key:"postExternalcontactsBulkContactsEnrich",value:function postExternalcontactsBulkContactsEnrich(body,opts){opts=opts||{};// verify the required parameter 'body' is set
|
|
6919
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postExternalcontactsBulkContactsEnrich';}return this.apiClient.callApi('/api/v2/externalcontacts/bulk/contacts/enrich','POST',{},{'dryRun':opts['dryRun']},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
6861
6920
|
* Bulk remove contacts
|
|
6862
6921
|
*
|
|
6863
6922
|
* @param {Object} body Contact ids
|
|
@@ -6909,6 +6968,14 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
6909
6968
|
* postExternalcontactsBulkOrganizationsDivisionviews is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
6910
6969
|
*/},{key:"postExternalcontactsBulkOrganizationsDivisionviews",value:function postExternalcontactsBulkOrganizationsDivisionviews(body){// verify the required parameter 'body' is set
|
|
6911
6970
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postExternalcontactsBulkOrganizationsDivisionviews';}return this.apiClient.callApi('/api/v2/externalcontacts/bulk/organizations/divisionviews','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
6971
|
+
* Bulk enrich external organizations - Run up to 10 Enrich operations per request
|
|
6972
|
+
* See the API endpoint /externalcontacts/organizations/enrich for docs on individual Enrich operations.
|
|
6973
|
+
* @param {Object} body External Organization Enrich Requests
|
|
6974
|
+
* @param {Object} opts Optional parameters
|
|
6975
|
+
* @param {Boolean} opts.dryRun If true, the request will not make any modifications, but will show you what the end result *would* be.
|
|
6976
|
+
* postExternalcontactsBulkOrganizationsEnrich is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
6977
|
+
*/},{key:"postExternalcontactsBulkOrganizationsEnrich",value:function postExternalcontactsBulkOrganizationsEnrich(body,opts){opts=opts||{};// verify the required parameter 'body' is set
|
|
6978
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postExternalcontactsBulkOrganizationsEnrich';}return this.apiClient.callApi('/api/v2/externalcontacts/bulk/organizations/enrich','POST',{},{'dryRun':opts['dryRun']},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
6912
6979
|
* Bulk remove organizations
|
|
6913
6980
|
*
|
|
6914
6981
|
* @param {Object} body Organization ids
|
|
@@ -6956,11 +7023,25 @@ if(contactId===undefined||contactId===null){throw'Missing the required parameter
|
|
|
6956
7023
|
* @param {Object} body ExternalContact
|
|
6957
7024
|
*/},{key:"postExternalcontactsContacts",value:function postExternalcontactsContacts(body){// verify the required parameter 'body' is set
|
|
6958
7025
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postExternalcontactsContacts';}return this.apiClient.callApi('/api/v2/externalcontacts/contacts','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
7026
|
+
* Modify or create an External Contact, with powerful behaviors for finding and combining data with pre-existing Contacts.
|
|
7027
|
+
* You may also submit multiple Enrich operations in one request via the Bulk Enrich API at /externalcontacts/bulk/contacts. A 201 response status indicates that a new Contact was created, whereas a 200 status indicates that a Contact was updated or a merge occurred.
|
|
7028
|
+
* @param {Object} body ContactEnrichRequest
|
|
7029
|
+
* @param {Object} opts Optional parameters
|
|
7030
|
+
* @param {Boolean} opts.dryRun If true, the request will not make any modifications, but will show you what the end result *would* be.
|
|
7031
|
+
* postExternalcontactsContactsEnrich is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
7032
|
+
*/},{key:"postExternalcontactsContactsEnrich",value:function postExternalcontactsContactsEnrich(body,opts){opts=opts||{};// verify the required parameter 'body' is set
|
|
7033
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postExternalcontactsContactsEnrich';}return this.apiClient.callApi('/api/v2/externalcontacts/contacts/enrich','POST',{},{'dryRun':opts['dryRun']},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
6959
7034
|
* Create bulk export
|
|
6960
7035
|
*
|
|
6961
7036
|
* @param {Object} body Export
|
|
6962
7037
|
*/},{key:"postExternalcontactsContactsExports",value:function postExternalcontactsContactsExports(body){// verify the required parameter 'body' is set
|
|
6963
7038
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postExternalcontactsContactsExports';}return this.apiClient.callApi('/api/v2/externalcontacts/contacts/exports','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
7039
|
+
* Merge up to 25 contacts into a new contact record
|
|
7040
|
+
* Merge operation may fail if the resulting mergeset exceeds our default limit of 52. The valueOverride field lets you override any of the Contact fields post-merge. If any Contact field is left null in `valueOverride`, it will be taken from the most recently-modified contact in the merge set. Exception for *phone/*email fields: Conflicting data will be moved to any other available phone/email fields in the merged contact.
|
|
7041
|
+
* @param {Object} body MergeRequest
|
|
7042
|
+
* postExternalcontactsContactsMerge is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
7043
|
+
*/},{key:"postExternalcontactsContactsMerge",value:function postExternalcontactsContactsMerge(body){// verify the required parameter 'body' is set
|
|
7044
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postExternalcontactsContactsMerge';}return this.apiClient.callApi('/api/v2/externalcontacts/contacts/merge','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
6964
7045
|
* Create a schema
|
|
6965
7046
|
*
|
|
6966
7047
|
* @param {Object} body Schema
|
|
@@ -6979,6 +7060,22 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
6979
7060
|
* @deprecated
|
|
6980
7061
|
*/},{key:"postExternalcontactsIdentifierlookup",value:function postExternalcontactsIdentifierlookup(identifier,opts){opts=opts||{};// verify the required parameter 'identifier' is set
|
|
6981
7062
|
if(identifier===undefined||identifier===null){throw'Missing the required parameter "identifier" when calling postExternalcontactsIdentifierlookup';}return this.apiClient.callApi('/api/v2/externalcontacts/identifierlookup','POST',{},{'expand':this.apiClient.buildCollectionParam(opts['expand'],'multi')},{},{},identifier,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
7063
|
+
* Fetch a contact using an identifier type and value.
|
|
7064
|
+
* Phone number identifier values must be provided with the country code and a leading + symbol. Example: "+1 704 298 4733"
|
|
7065
|
+
* @param {Object} identifier
|
|
7066
|
+
* @param {Object} opts Optional parameters
|
|
7067
|
+
* @param {Array.<String>} opts.expand which field, if any, to expand
|
|
7068
|
+
* postExternalcontactsIdentifierlookupContacts is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
7069
|
+
*/},{key:"postExternalcontactsIdentifierlookupContacts",value:function postExternalcontactsIdentifierlookupContacts(identifier,opts){opts=opts||{};// verify the required parameter 'identifier' is set
|
|
7070
|
+
if(identifier===undefined||identifier===null){throw'Missing the required parameter "identifier" when calling postExternalcontactsIdentifierlookupContacts';}return this.apiClient.callApi('/api/v2/externalcontacts/identifierlookup/contacts','POST',{},{'expand':this.apiClient.buildCollectionParam(opts['expand'],'multi')},{},{},identifier,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
7071
|
+
* Fetch an external organization using an identifier type and value.
|
|
7072
|
+
* This endpoint will only accept ExternalId type identifiers.
|
|
7073
|
+
* @param {Object} identifier
|
|
7074
|
+
* @param {Object} opts Optional parameters
|
|
7075
|
+
* @param {Array.<String>} opts.expand which field, if any, to expand
|
|
7076
|
+
* postExternalcontactsIdentifierlookupOrganizations is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
7077
|
+
*/},{key:"postExternalcontactsIdentifierlookupOrganizations",value:function postExternalcontactsIdentifierlookupOrganizations(identifier,opts){opts=opts||{};// verify the required parameter 'identifier' is set
|
|
7078
|
+
if(identifier===undefined||identifier===null){throw'Missing the required parameter "identifier" when calling postExternalcontactsIdentifierlookupOrganizations';}return this.apiClient.callApi('/api/v2/externalcontacts/identifierlookup/organizations','POST',{},{'expand':this.apiClient.buildCollectionParam(opts['expand'],'multi')},{},{},identifier,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
6982
7079
|
* Create CSV import job
|
|
6983
7080
|
*
|
|
6984
7081
|
* @param {Object} body ImportRequest
|
|
@@ -7005,8 +7102,9 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
7005
7102
|
*/},{key:"postExternalcontactsImportSettings",value:function postExternalcontactsImportSettings(body){// verify the required parameter 'body' is set
|
|
7006
7103
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postExternalcontactsImportSettings';}return this.apiClient.callApi('/api/v2/externalcontacts/import/settings','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
7007
7104
|
* Merge two contacts into a new contact record
|
|
7008
|
-
* Two curated contacts cannot be merged. Refer to the Contact Merging article on the Developer Center for details
|
|
7105
|
+
* Two curated contacts cannot be merged. Refer to the Contact Merging article on the Developer Center for details. Deprecated: This API has been superseded by a new merge API. You are encouraged to instead use /api/v2/externalcontacts/contacts/merge, which supports merging up to 25 Contacts of any type, and overriding specific fields in the resulting Contact.
|
|
7009
7106
|
* @param {Object} body MergeRequest
|
|
7107
|
+
* @deprecated
|
|
7010
7108
|
*/},{key:"postExternalcontactsMergeContacts",value:function postExternalcontactsMergeContacts(body){// verify the required parameter 'body' is set
|
|
7011
7109
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postExternalcontactsMergeContacts';}return this.apiClient.callApi('/api/v2/externalcontacts/merge/contacts','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
7012
7110
|
* Create a note for an external organization
|
|
@@ -7021,6 +7119,14 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
7021
7119
|
* @param {Object} body ExternalOrganization
|
|
7022
7120
|
*/},{key:"postExternalcontactsOrganizations",value:function postExternalcontactsOrganizations(body){// verify the required parameter 'body' is set
|
|
7023
7121
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postExternalcontactsOrganizations';}return this.apiClient.callApi('/api/v2/externalcontacts/organizations','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
7122
|
+
* Modify or create an External Org, with powerful behaviors for finding and combining data with pre-existing External Orgs.
|
|
7123
|
+
* You may also submit multiple Enrich operations in one request via the Bulk Enrich API at /externalcontacts/bulk/organizations. A 201 response status indicates that a new External Organization was created, whereas a 200 status indicates that an External Organization was updated
|
|
7124
|
+
* @param {Object} body ExternalOrgEnrichRequest
|
|
7125
|
+
* @param {Object} opts Optional parameters
|
|
7126
|
+
* @param {Boolean} opts.dryRun If true, the request will not make any modifications, but will show you what the end result *would* be.
|
|
7127
|
+
* postExternalcontactsOrganizationsEnrich is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
7128
|
+
*/},{key:"postExternalcontactsOrganizationsEnrich",value:function postExternalcontactsOrganizationsEnrich(body,opts){opts=opts||{};// verify the required parameter 'body' is set
|
|
7129
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postExternalcontactsOrganizationsEnrich';}return this.apiClient.callApi('/api/v2/externalcontacts/organizations/enrich','POST',{},{'dryRun':opts['dryRun']},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
7024
7130
|
* Create a schema
|
|
7025
7131
|
*
|
|
7026
7132
|
* @param {Object} body Schema
|
|
@@ -7128,7 +7234,7 @@ if(relationshipId===undefined||relationshipId===null){throw'Missing the required
|
|
|
7128
7234
|
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(){/**
|
|
7129
7235
|
* Fax service.
|
|
7130
7236
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
7131
|
-
* @version
|
|
7237
|
+
* @version 219.0.0
|
|
7132
7238
|
*//**
|
|
7133
7239
|
* Constructs a new FaxApi.
|
|
7134
7240
|
* @alias module:purecloud-platform-client-v2/api/FaxApi
|
|
@@ -7177,7 +7283,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
7177
7283
|
*/},{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(){/**
|
|
7178
7284
|
* Flows service.
|
|
7179
7285
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
7180
|
-
* @version
|
|
7286
|
+
* @version 219.0.0
|
|
7181
7287
|
*//**
|
|
7182
7288
|
* Constructs a new FlowsApi.
|
|
7183
7289
|
* @alias module:purecloud-platform-client-v2/api/FlowsApi
|
|
@@ -7225,7 +7331,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
7225
7331
|
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(){/**
|
|
7226
7332
|
* Gamification service.
|
|
7227
7333
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
7228
|
-
* @version
|
|
7334
|
+
* @version 219.0.0
|
|
7229
7335
|
*//**
|
|
7230
7336
|
* Constructs a new GamificationApi.
|
|
7231
7337
|
* @alias module:purecloud-platform-client-v2/api/GamificationApi
|
|
@@ -7238,6 +7344,11 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
7238
7344
|
* @param {String} metricId Specifies the External Metric Definition ID
|
|
7239
7345
|
*/return _createClass(GamificationApi,[{key:"deleteEmployeeperformanceExternalmetricsDefinition",value:function deleteEmployeeperformanceExternalmetricsDefinition(metricId){// verify the required parameter 'metricId' is set
|
|
7240
7346
|
if(metricId===undefined||metricId===null){throw'Missing the required parameter "metricId" when calling deleteEmployeeperformanceExternalmetricsDefinition';}return this.apiClient.callApi('/api/v2/employeeperformance/externalmetrics/definitions/{metricId}','DELETE',{'metricId':metricId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
7347
|
+
* Delete a Contest by Id
|
|
7348
|
+
*
|
|
7349
|
+
* @param {String} contestId The ID of the contest
|
|
7350
|
+
*/},{key:"deleteGamificationContest",value:function deleteGamificationContest(contestId){// verify the required parameter 'contestId' is set
|
|
7351
|
+
if(contestId===undefined||contestId===null){throw'Missing the required parameter "contestId" when calling deleteGamificationContest';}return this.apiClient.callApi('/api/v2/gamification/contests/{contestId}','DELETE',{'contestId':contestId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
7241
7352
|
* Get an External Metric Definition
|
|
7242
7353
|
*
|
|
7243
7354
|
* @param {String} metricId Specifies the External Metric Definition ID
|
|
@@ -7249,6 +7360,71 @@ if(metricId===undefined||metricId===null){throw'Missing the required parameter "
|
|
|
7249
7360
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
7250
7361
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
7251
7362
|
*/},{key:"getEmployeeperformanceExternalmetricsDefinitions",value:function getEmployeeperformanceExternalmetricsDefinitions(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/employeeperformance/externalmetrics/definitions','GET',{},{'pageSize':opts['pageSize'],'pageNumber':opts['pageNumber']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
7363
|
+
* Get a Contest by Id
|
|
7364
|
+
*
|
|
7365
|
+
* @param {String} contestId The ID of the contest
|
|
7366
|
+
*/},{key:"getGamificationContest",value:function getGamificationContest(contestId){// verify the required parameter 'contestId' is set
|
|
7367
|
+
if(contestId===undefined||contestId===null){throw'Missing the required parameter "contestId" when calling getGamificationContest';}return this.apiClient.callApi('/api/v2/gamification/contests/{contestId}','GET',{'contestId':contestId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
7368
|
+
* Get Contest Scores (Admin)
|
|
7369
|
+
*
|
|
7370
|
+
* @param {String} contestId The ID of the contest
|
|
7371
|
+
* @param {Object} opts Optional parameters
|
|
7372
|
+
* @param {Number} opts.pageNumber (default to 1)
|
|
7373
|
+
* @param {Number} opts.pageSize (default to 25)
|
|
7374
|
+
* @param {String} opts.workday Target querying workday. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
7375
|
+
* @param {Object} opts.returnsView Desired response results (default to All)
|
|
7376
|
+
*/},{key:"getGamificationContestAgentsScores",value:function getGamificationContestAgentsScores(contestId,opts){opts=opts||{};// verify the required parameter 'contestId' is set
|
|
7377
|
+
if(contestId===undefined||contestId===null){throw'Missing the required parameter "contestId" when calling getGamificationContestAgentsScores';}return this.apiClient.callApi('/api/v2/gamification/contests/{contestId}/agents/scores','GET',{'contestId':contestId},{'pageNumber':opts['pageNumber'],'pageSize':opts['pageSize'],'workday':opts['workday'],'returnsView':opts['returnsView']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
7378
|
+
* Get Contest Scores for the requesting Agent/Supervisor
|
|
7379
|
+
*
|
|
7380
|
+
* @param {String} contestId The ID of the contest
|
|
7381
|
+
* @param {Object} opts Optional parameters
|
|
7382
|
+
* @param {Number} opts.pageNumber (default to 1)
|
|
7383
|
+
* @param {Number} opts.pageSize (default to 25)
|
|
7384
|
+
* @param {String} opts.workday Target querying workday. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
7385
|
+
* @param {Object} opts.returnsView Desired response results (Supervisor Only) (default to All)
|
|
7386
|
+
*/},{key:"getGamificationContestAgentsScoresMe",value:function getGamificationContestAgentsScoresMe(contestId,opts){opts=opts||{};// verify the required parameter 'contestId' is set
|
|
7387
|
+
if(contestId===undefined||contestId===null){throw'Missing the required parameter "contestId" when calling getGamificationContestAgentsScoresMe';}return this.apiClient.callApi('/api/v2/gamification/contests/{contestId}/agents/scores/me','GET',{'contestId':contestId},{'pageNumber':opts['pageNumber'],'pageSize':opts['pageSize'],'workday':opts['workday'],'returnsView':opts['returnsView']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
7388
|
+
* Get a Contest Score Trend (Average Trend)
|
|
7389
|
+
*
|
|
7390
|
+
* @param {String} contestId The ID of the contest
|
|
7391
|
+
*/},{key:"getGamificationContestAgentsScoresTrends",value:function getGamificationContestAgentsScoresTrends(contestId){// verify the required parameter 'contestId' is set
|
|
7392
|
+
if(contestId===undefined||contestId===null){throw'Missing the required parameter "contestId" when calling getGamificationContestAgentsScoresTrends';}return this.apiClient.callApi('/api/v2/gamification/contests/{contestId}/agents/scores/trends','GET',{'contestId':contestId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
7393
|
+
* Get a Contest Score Trend for the requesting Agent
|
|
7394
|
+
*
|
|
7395
|
+
* @param {String} contestId The ID of the contest
|
|
7396
|
+
*/},{key:"getGamificationContestAgentsScoresTrendsMe",value:function getGamificationContestAgentsScoresTrendsMe(contestId){// verify the required parameter 'contestId' is set
|
|
7397
|
+
if(contestId===undefined||contestId===null){throw'Missing the required parameter "contestId" when calling getGamificationContestAgentsScoresTrendsMe';}return this.apiClient.callApi('/api/v2/gamification/contests/{contestId}/agents/scores/trends/me','GET',{'contestId':contestId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
7398
|
+
* Get a Contest Prize Image by Id
|
|
7399
|
+
*
|
|
7400
|
+
* @param {String} contestId The ID of the contest
|
|
7401
|
+
* @param {String} prizeImageId The ID of the prize image
|
|
7402
|
+
*/},{key:"getGamificationContestPrizeimage",value:function getGamificationContestPrizeimage(contestId,prizeImageId){// verify the required parameter 'contestId' is set
|
|
7403
|
+
if(contestId===undefined||contestId===null){throw'Missing the required parameter "contestId" when calling getGamificationContestPrizeimage';}// verify the required parameter 'prizeImageId' is set
|
|
7404
|
+
if(prizeImageId===undefined||prizeImageId===null){throw'Missing the required parameter "prizeImageId" when calling getGamificationContestPrizeimage';}return this.apiClient.callApi('/api/v2/gamification/contests/{contestId}/prizeimages/{prizeImageId}','GET',{'contestId':contestId,'prizeImageId':prizeImageId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
7405
|
+
* Get a List of Contests (Admin)
|
|
7406
|
+
*
|
|
7407
|
+
* @param {Object} opts Optional parameters
|
|
7408
|
+
* @param {Number} opts.pageNumber (default to 1)
|
|
7409
|
+
* @param {Number} opts.pageSize (default to 25)
|
|
7410
|
+
* @param {String} opts.dateStart Start date for the query. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
7411
|
+
* @param {String} opts.dateEnd End date for the query. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
7412
|
+
* @param {Array.<String>} opts.status
|
|
7413
|
+
* @param {Object} opts.sortBy (default to dateStart)
|
|
7414
|
+
* @param {Object} opts.sortOrder (default to desc)
|
|
7415
|
+
*/},{key:"getGamificationContests",value:function getGamificationContests(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/gamification/contests','GET',{},{'pageNumber':opts['pageNumber'],'pageSize':opts['pageSize'],'dateStart':opts['dateStart'],'dateEnd':opts['dateEnd'],'status':this.apiClient.buildCollectionParam(opts['status'],'multi'),'sortBy':opts['sortBy'],'sortOrder':opts['sortOrder']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
7416
|
+
* Get a List of Contests (Agent/Supervisor)
|
|
7417
|
+
*
|
|
7418
|
+
* @param {Object} opts Optional parameters
|
|
7419
|
+
* @param {Number} opts.pageNumber (default to 1)
|
|
7420
|
+
* @param {Number} opts.pageSize (default to 25)
|
|
7421
|
+
* @param {String} opts.dateStart Start date for the query. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
7422
|
+
* @param {String} opts.dateEnd End date for the query. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
7423
|
+
* @param {Array.<String>} opts.status
|
|
7424
|
+
* @param {Object} opts.sortBy (default to dateStart)
|
|
7425
|
+
* @param {Object} opts.sortOrder (default to desc)
|
|
7426
|
+
* @param {Object} opts.view (default to participant)
|
|
7427
|
+
*/},{key:"getGamificationContestsMe",value:function getGamificationContestsMe(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/gamification/contests/me','GET',{},{'pageNumber':opts['pageNumber'],'pageSize':opts['pageSize'],'dateStart':opts['dateStart'],'dateEnd':opts['dateEnd'],'status':this.apiClient.buildCollectionParam(opts['status'],'multi'),'sortBy':opts['sortBy'],'sortOrder':opts['sortOrder'],'view':opts['view']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
7252
7428
|
* Get insights summary
|
|
7253
7429
|
*
|
|
7254
7430
|
* @param {Object} filterType Filter type for the query request.
|
|
@@ -7692,6 +7868,13 @@ if(templateId===undefined||templateId===null){throw'Missing the required paramet
|
|
|
7692
7868
|
*/},{key:"patchEmployeeperformanceExternalmetricsDefinition",value:function patchEmployeeperformanceExternalmetricsDefinition(metricId,body){// verify the required parameter 'metricId' is set
|
|
7693
7869
|
if(metricId===undefined||metricId===null){throw'Missing the required parameter "metricId" when calling patchEmployeeperformanceExternalmetricsDefinition';}// verify the required parameter 'body' is set
|
|
7694
7870
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling patchEmployeeperformanceExternalmetricsDefinition';}return this.apiClient.callApi('/api/v2/employeeperformance/externalmetrics/definitions/{metricId}','PATCH',{'metricId':metricId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
7871
|
+
* Finalize a Contest by Id
|
|
7872
|
+
*
|
|
7873
|
+
* @param {String} contestId The ID of the contest
|
|
7874
|
+
* @param {Object} body Finalize Contest
|
|
7875
|
+
*/},{key:"patchGamificationContest",value:function patchGamificationContest(contestId,body){// verify the required parameter 'contestId' is set
|
|
7876
|
+
if(contestId===undefined||contestId===null){throw'Missing the required parameter "contestId" when calling patchGamificationContest';}// verify the required parameter 'body' is set
|
|
7877
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling patchGamificationContest';}return this.apiClient.callApi('/api/v2/gamification/contests/{contestId}','PATCH',{'contestId':contestId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
7695
7878
|
* Write External Metric Data
|
|
7696
7879
|
*
|
|
7697
7880
|
* @param {Object} opts Optional parameters
|
|
@@ -7702,6 +7885,16 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
7702
7885
|
* @param {Object} opts Optional parameters
|
|
7703
7886
|
* @param {Object} opts.body The External Metric Definition to be created
|
|
7704
7887
|
*/},{key:"postEmployeeperformanceExternalmetricsDefinitions",value:function postEmployeeperformanceExternalmetricsDefinitions(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/employeeperformance/externalmetrics/definitions','POST',{},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
7888
|
+
* Creates a Contest
|
|
7889
|
+
*
|
|
7890
|
+
* @param {Object} body Create Contest
|
|
7891
|
+
*/},{key:"postGamificationContests",value:function postGamificationContests(body){// verify the required parameter 'body' is set
|
|
7892
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postGamificationContests';}return this.apiClient.callApi('/api/v2/gamification/contests','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
7893
|
+
* Generates pre-signed URL to upload a prize image for gamification contests
|
|
7894
|
+
*
|
|
7895
|
+
* @param {Object} body query
|
|
7896
|
+
*/},{key:"postGamificationContestsUploadsPrizeimages",value:function postGamificationContestsUploadsPrizeimages(body){// verify the required parameter 'body' is set
|
|
7897
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postGamificationContestsUploadsPrizeimages';}return this.apiClient.callApi('/api/v2/gamification/contests/uploads/prizeimages','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
7705
7898
|
* Activate a performance profile
|
|
7706
7899
|
*
|
|
7707
7900
|
* @param {String} profileId performanceProfileId
|
|
@@ -7761,6 +7954,13 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
7761
7954
|
* @param {Object} body The date range of work day.
|
|
7762
7955
|
*/},{key:"postGamificationProfilesUsersMeQuery",value:function postGamificationProfilesUsersMeQuery(body){// verify the required parameter 'body' is set
|
|
7763
7956
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postGamificationProfilesUsersMeQuery';}return this.apiClient.callApi('/api/v2/gamification/profiles/users/me/query','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
7957
|
+
* Update a Contest by Id
|
|
7958
|
+
*
|
|
7959
|
+
* @param {String} contestId The ID of the contest
|
|
7960
|
+
* @param {Object} body Contest
|
|
7961
|
+
*/},{key:"putGamificationContest",value:function putGamificationContest(contestId,body){// verify the required parameter 'contestId' is set
|
|
7962
|
+
if(contestId===undefined||contestId===null){throw'Missing the required parameter "contestId" when calling putGamificationContest';}// verify the required parameter 'body' is set
|
|
7963
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putGamificationContest';}return this.apiClient.callApi('/api/v2/gamification/contests/{contestId}','PUT',{'contestId':contestId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
7764
7964
|
* Updates a performance profile
|
|
7765
7965
|
*
|
|
7766
7966
|
* @param {String} profileId performanceProfileId
|
|
@@ -7784,7 +7984,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
7784
7984
|
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(){/**
|
|
7785
7985
|
* GeneralDataProtectionRegulation service.
|
|
7786
7986
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
7787
|
-
* @version
|
|
7987
|
+
* @version 219.0.0
|
|
7788
7988
|
*//**
|
|
7789
7989
|
* Constructs a new GeneralDataProtectionRegulationApi.
|
|
7790
7990
|
* @alias module:purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
@@ -7819,7 +8019,7 @@ if(searchValue===undefined||searchValue===null){throw'Missing the required param
|
|
|
7819
8019
|
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(){/**
|
|
7820
8020
|
* Geolocation service.
|
|
7821
8021
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
7822
|
-
* @version
|
|
8022
|
+
* @version 219.0.0
|
|
7823
8023
|
*//**
|
|
7824
8024
|
* Constructs a new GeolocationApi.
|
|
7825
8025
|
* @alias module:purecloud-platform-client-v2/api/GeolocationApi
|
|
@@ -7853,7 +8053,7 @@ if(clientId===undefined||clientId===null){throw'Missing the required parameter "
|
|
|
7853
8053
|
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(){/**
|
|
7854
8054
|
* Greetings service.
|
|
7855
8055
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
7856
|
-
* @version
|
|
8056
|
+
* @version 219.0.0
|
|
7857
8057
|
*//**
|
|
7858
8058
|
* Constructs a new GreetingsApi.
|
|
7859
8059
|
* @alias module:purecloud-platform-client-v2/api/GreetingsApi
|
|
@@ -7960,7 +8160,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
7960
8160
|
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(){/**
|
|
7961
8161
|
* Groups service.
|
|
7962
8162
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
7963
|
-
* @version
|
|
8163
|
+
* @version 219.0.0
|
|
7964
8164
|
*//**
|
|
7965
8165
|
* Constructs a new GroupsApi.
|
|
7966
8166
|
* @alias module:purecloud-platform-client-v2/api/GroupsApi
|
|
@@ -8093,7 +8293,7 @@ if(groupId===undefined||groupId===null){throw'Missing the required parameter "gr
|
|
|
8093
8293
|
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(){/**
|
|
8094
8294
|
* IdentityProvider service.
|
|
8095
8295
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
8096
|
-
* @version
|
|
8296
|
+
* @version 219.0.0
|
|
8097
8297
|
*//**
|
|
8098
8298
|
* Constructs a new IdentityProviderApi.
|
|
8099
8299
|
* @alias module:purecloud-platform-client-v2/api/IdentityProviderApi
|
|
@@ -8249,7 +8449,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
8249
8449
|
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(){/**
|
|
8250
8450
|
* InfrastructureAsCode service.
|
|
8251
8451
|
* @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
8252
|
-
* @version
|
|
8452
|
+
* @version 219.0.0
|
|
8253
8453
|
*//**
|
|
8254
8454
|
* Constructs a new InfrastructureAsCodeApi.
|
|
8255
8455
|
* @alias module:purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
@@ -8303,7 +8503,7 @@ if(jobId===undefined||jobId===null){throw'Missing the required parameter "jobId"
|
|
|
8303
8503
|
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(){/**
|
|
8304
8504
|
* Integrations service.
|
|
8305
8505
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
8306
|
-
* @version
|
|
8506
|
+
* @version 219.0.0
|
|
8307
8507
|
*//**
|
|
8308
8508
|
* Constructs a new IntegrationsApi.
|
|
8309
8509
|
* @alias module:purecloud-platform-client-v2/api/IntegrationsApi
|
|
@@ -8942,7 +9142,7 @@ if(ucIntegrationId===undefined||ucIntegrationId===null){throw'Missing the requir
|
|
|
8942
9142
|
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(){/**
|
|
8943
9143
|
* Journey service.
|
|
8944
9144
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
8945
|
-
* @version
|
|
9145
|
+
* @version 219.0.0
|
|
8946
9146
|
*//**
|
|
8947
9147
|
* Constructs a new JourneyApi.
|
|
8948
9148
|
* @alias module:purecloud-platform-client-v2/api/JourneyApi
|
|
@@ -9422,7 +9622,7 @@ if(versionId===undefined||versionId===null){throw'Missing the required parameter
|
|
|
9422
9622
|
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(){/**
|
|
9423
9623
|
* Knowledge service.
|
|
9424
9624
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
9425
|
-
* @version
|
|
9625
|
+
* @version 219.0.0
|
|
9426
9626
|
*//**
|
|
9427
9627
|
* Constructs a new KnowledgeApi.
|
|
9428
9628
|
* @alias module:purecloud-platform-client-v2/api/KnowledgeApi
|
|
@@ -10485,7 +10685,7 @@ if(sourceId===undefined||sourceId===null){throw'Missing the required parameter "
|
|
|
10485
10685
|
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(){/**
|
|
10486
10686
|
* LanguageUnderstanding service.
|
|
10487
10687
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
10488
|
-
* @version
|
|
10688
|
+
* @version 219.0.0
|
|
10489
10689
|
*//**
|
|
10490
10690
|
* Constructs a new LanguageUnderstandingApi.
|
|
10491
10691
|
* @alias module:purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
@@ -10744,7 +10944,7 @@ if(domainVersionId===undefined||domainVersionId===null){throw'Missing the requir
|
|
|
10744
10944
|
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(){/**
|
|
10745
10945
|
* Languages service.
|
|
10746
10946
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
10747
|
-
* @version
|
|
10947
|
+
* @version 219.0.0
|
|
10748
10948
|
*//**
|
|
10749
10949
|
* Constructs a new LanguagesApi.
|
|
10750
10950
|
* @alias module:purecloud-platform-client-v2/api/LanguagesApi
|
|
@@ -10799,7 +10999,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
10799
10999
|
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(){/**
|
|
10800
11000
|
* Learning service.
|
|
10801
11001
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
10802
|
-
* @version
|
|
11002
|
+
* @version 219.0.0
|
|
10803
11003
|
*//**
|
|
10804
11004
|
* Constructs a new LearningApi.
|
|
10805
11005
|
* @alias module:purecloud-platform-client-v2/api/LearningApi
|
|
@@ -11070,7 +11270,7 @@ if(moduleId===undefined||moduleId===null){throw'Missing the required parameter "
|
|
|
11070
11270
|
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(){/**
|
|
11071
11271
|
* License service.
|
|
11072
11272
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
11073
|
-
* @version
|
|
11273
|
+
* @version 219.0.0
|
|
11074
11274
|
*//**
|
|
11075
11275
|
* Constructs a new LicenseApi.
|
|
11076
11276
|
* @alias module:purecloud-platform-client-v2/api/LicenseApi
|
|
@@ -11124,7 +11324,7 @@ if(featureName===undefined||featureName===null){throw'Missing the required param
|
|
|
11124
11324
|
*/},{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(){/**
|
|
11125
11325
|
* Locations service.
|
|
11126
11326
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
11127
|
-
* @version
|
|
11327
|
+
* @version 219.0.0
|
|
11128
11328
|
*//**
|
|
11129
11329
|
* Constructs a new LocationsApi.
|
|
11130
11330
|
* @alias module:purecloud-platform-client-v2/api/LocationsApi
|
|
@@ -11183,7 +11383,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
11183
11383
|
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(){/**
|
|
11184
11384
|
* LogCapture service.
|
|
11185
11385
|
* @module purecloud-platform-client-v2/api/LogCaptureApi
|
|
11186
|
-
* @version
|
|
11386
|
+
* @version 219.0.0
|
|
11187
11387
|
*//**
|
|
11188
11388
|
* Constructs a new LogCaptureApi.
|
|
11189
11389
|
* @alias module:purecloud-platform-client-v2/api/LogCaptureApi
|
|
@@ -11233,7 +11433,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
11233
11433
|
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(){/**
|
|
11234
11434
|
* Messaging service.
|
|
11235
11435
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
11236
|
-
* @version
|
|
11436
|
+
* @version 219.0.0
|
|
11237
11437
|
*//**
|
|
11238
11438
|
* Constructs a new MessagingApi.
|
|
11239
11439
|
* @alias module:purecloud-platform-client-v2/api/MessagingApi
|
|
@@ -11323,7 +11523,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
11323
11523
|
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(){/**
|
|
11324
11524
|
* MobileDevices service.
|
|
11325
11525
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
11326
|
-
* @version
|
|
11526
|
+
* @version 219.0.0
|
|
11327
11527
|
*//**
|
|
11328
11528
|
* Constructs a new MobileDevicesApi.
|
|
11329
11529
|
* @alias module:purecloud-platform-client-v2/api/MobileDevicesApi
|
|
@@ -11362,7 +11562,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
11362
11562
|
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(){/**
|
|
11363
11563
|
* Notifications service.
|
|
11364
11564
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
11365
|
-
* @version
|
|
11565
|
+
* @version 219.0.0
|
|
11366
11566
|
*//**
|
|
11367
11567
|
* Constructs a new NotificationsApi.
|
|
11368
11568
|
* @alias module:purecloud-platform-client-v2/api/NotificationsApi
|
|
@@ -11419,7 +11619,7 @@ if(channelId===undefined||channelId===null){throw'Missing the required parameter
|
|
|
11419
11619
|
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(){/**
|
|
11420
11620
|
* OAuth service.
|
|
11421
11621
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
11422
|
-
* @version
|
|
11622
|
+
* @version 219.0.0
|
|
11423
11623
|
*//**
|
|
11424
11624
|
* Constructs a new OAuthApi.
|
|
11425
11625
|
* @alias module:purecloud-platform-client-v2/api/OAuthApi
|
|
@@ -11504,7 +11704,7 @@ if(clientId===undefined||clientId===null){throw'Missing the required parameter "
|
|
|
11504
11704
|
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(){/**
|
|
11505
11705
|
* Objects service.
|
|
11506
11706
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
11507
|
-
* @version
|
|
11707
|
+
* @version 219.0.0
|
|
11508
11708
|
*//**
|
|
11509
11709
|
* Constructs a new ObjectsApi.
|
|
11510
11710
|
* @alias module:purecloud-platform-client-v2/api/ObjectsApi
|
|
@@ -11539,12 +11739,27 @@ if(divisionId===undefined||divisionId===null){throw'Missing the required paramet
|
|
|
11539
11739
|
* @param {Array.<String>} opts.id Optionally request specific divisions by their IDs
|
|
11540
11740
|
* @param {String} opts.name Search term to filter by division name
|
|
11541
11741
|
*/},{key:"getAuthorizationDivisions",value:function getAuthorizationDivisions(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/authorization/divisions','GET',{},{'pageSize':opts['pageSize'],'pageNumber':opts['pageNumber'],'sortBy':opts['sortBy'],'expand':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'nextPage':opts['nextPage'],'previousPage':opts['previousPage'],'objectCount':opts['objectCount'],'id':this.apiClient.buildCollectionParam(opts['id'],'multi'),'name':opts['name']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
11742
|
+
* Get a list of soft deleted divisions for the org
|
|
11743
|
+
*
|
|
11744
|
+
* @param {Object} opts Optional parameters
|
|
11745
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
11746
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
11747
|
+
*/},{key:"getAuthorizationDivisionsDeleted",value:function getAuthorizationDivisionsDeleted(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/authorization/divisions/deleted','GET',{},{'pageNumber':opts['pageNumber'],'pageSize':opts['pageSize']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
11542
11748
|
* Retrieve the home division for the organization.
|
|
11543
11749
|
* Will not include object counts.
|
|
11544
11750
|
*/},{key:"getAuthorizationDivisionsHome",value:function getAuthorizationDivisionsHome(){return this.apiClient.callApi('/api/v2/authorization/divisions/home','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
11545
11751
|
* Returns the maximum allowed number of divisions.
|
|
11546
11752
|
*
|
|
11547
11753
|
*/},{key:"getAuthorizationDivisionsLimit",value:function getAuthorizationDivisionsLimit(){return this.apiClient.callApi('/api/v2/authorization/divisions/limit','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
11754
|
+
* Retrieve a list of all divisions defined for the organization with cursor
|
|
11755
|
+
* Use "after" and "before" param to fetch next/previous page}
|
|
11756
|
+
* @param {Object} opts Optional parameters
|
|
11757
|
+
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
11758
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
11759
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
11760
|
+
* @param {Array.<String>} opts.id Optionally request specific divisions by their IDs
|
|
11761
|
+
* @param {String} opts.name Optionally request specific divisions by division name
|
|
11762
|
+
*/},{key:"getAuthorizationDivisionsQuery",value:function getAuthorizationDivisionsQuery(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/authorization/divisions/query','GET',{},{'before':opts['before'],'after':opts['after'],'pageSize':opts['pageSize'],'id':this.apiClient.buildCollectionParam(opts['id'],'multi'),'name':opts['name']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
11548
11763
|
* Assign a list of objects to a division
|
|
11549
11764
|
* Set the division of a specified list of objects. The objects must all be of the same type, one of: CAMPAIGN, MANAGEMENTUNIT, FLOW, QUEUE, DATATABLES or USER. The body of the request is a list of object IDs, which are expected to be GUIDs, e.g. ["206ce31f-61ec-40ed-a8b1-be6f06303998","250a754e-f5e4-4f51-800f-a92f09d3bf8c"]
|
|
11550
11765
|
* @param {String} divisionId Division ID
|
|
@@ -11575,7 +11790,7 @@ if(divisionId===undefined||divisionId===null){throw'Missing the required paramet
|
|
|
11575
11790
|
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(){/**
|
|
11576
11791
|
* OperationalEvents service.
|
|
11577
11792
|
* @module purecloud-platform-client-v2/api/OperationalEventsApi
|
|
11578
|
-
* @version
|
|
11793
|
+
* @version 219.0.0
|
|
11579
11794
|
*//**
|
|
11580
11795
|
* Constructs a new OperationalEventsApi.
|
|
11581
11796
|
* @alias module:purecloud-platform-client-v2/api/OperationalEventsApi
|
|
@@ -11606,7 +11821,7 @@ if(eventDefinitionId===undefined||eventDefinitionId===null){throw'Missing the re
|
|
|
11606
11821
|
*/},{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(){/**
|
|
11607
11822
|
* Organization service.
|
|
11608
11823
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
11609
|
-
* @version
|
|
11824
|
+
* @version 219.0.0
|
|
11610
11825
|
*//**
|
|
11611
11826
|
* Constructs a new OrganizationApi.
|
|
11612
11827
|
* @alias module:purecloud-platform-client-v2/api/OrganizationApi
|
|
@@ -11711,7 +11926,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
11711
11926
|
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(){/**
|
|
11712
11927
|
* OrganizationAuthorization service.
|
|
11713
11928
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
11714
|
-
* @version
|
|
11929
|
+
* @version 219.0.0
|
|
11715
11930
|
*//**
|
|
11716
11931
|
* Constructs a new OrganizationAuthorizationApi.
|
|
11717
11932
|
* @alias module:purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
@@ -12045,7 +12260,7 @@ if(trustorOrgId===undefined||trustorOrgId===null){throw'Missing the required par
|
|
|
12045
12260
|
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(){/**
|
|
12046
12261
|
* Outbound service.
|
|
12047
12262
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
12048
|
-
* @version
|
|
12263
|
+
* @version 219.0.0
|
|
12049
12264
|
*//**
|
|
12050
12265
|
* Constructs a new OutboundApi.
|
|
12051
12266
|
* @alias module:purecloud-platform-client-v2/api/OutboundApi
|
|
@@ -12153,6 +12368,13 @@ if(dncListId===undefined||dncListId===null){throw'Missing the required parameter
|
|
|
12153
12368
|
* @param {Boolean} opts.expiredOnly Set to true to only remove DNC entries that are expired (default to false)
|
|
12154
12369
|
*/},{key:"deleteOutboundDnclistPhonenumbers",value:function deleteOutboundDnclistPhonenumbers(dncListId,opts){opts=opts||{};// verify the required parameter 'dncListId' is set
|
|
12155
12370
|
if(dncListId===undefined||dncListId===null){throw'Missing the required parameter "dncListId" when calling deleteOutboundDnclistPhonenumbers';}return this.apiClient.callApi('/api/v2/outbound/dnclists/{dncListId}/phonenumbers','DELETE',{'dncListId':dncListId},{'expiredOnly':opts['expiredOnly']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
12371
|
+
* Deletes all or expired whatsApp numbers from a DNC list.
|
|
12372
|
+
* This operation is only for Internal DNC lists of whatsApp numbers
|
|
12373
|
+
* @param {String} dncListId DncList ID
|
|
12374
|
+
* @param {Object} opts Optional parameters
|
|
12375
|
+
* @param {Boolean} opts.expiredOnly Set to true to only remove DNC whatsApp numbers that are expired (default to false)
|
|
12376
|
+
*/},{key:"deleteOutboundDnclistWhatsappnumbers",value:function deleteOutboundDnclistWhatsappnumbers(dncListId,opts){opts=opts||{};// verify the required parameter 'dncListId' is set
|
|
12377
|
+
if(dncListId===undefined||dncListId===null){throw'Missing the required parameter "dncListId" when calling deleteOutboundDnclistWhatsappnumbers';}return this.apiClient.callApi('/api/v2/outbound/dnclists/{dncListId}/whatsappnumbers','DELETE',{'dncListId':dncListId},{'expiredOnly':opts['expiredOnly']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
12156
12378
|
* Delete File Specification Template
|
|
12157
12379
|
*
|
|
12158
12380
|
* @param {String} fileSpecificationTemplateId File Specification Template ID
|
|
@@ -12773,6 +12995,13 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
12773
12995
|
*/},{key:"patchOutboundDnclistPhonenumbers",value:function patchOutboundDnclistPhonenumbers(dncListId,body){// verify the required parameter 'dncListId' is set
|
|
12774
12996
|
if(dncListId===undefined||dncListId===null){throw'Missing the required parameter "dncListId" when calling patchOutboundDnclistPhonenumbers';}// verify the required parameter 'body' is set
|
|
12775
12997
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling patchOutboundDnclistPhonenumbers';}return this.apiClient.callApi('/api/v2/outbound/dnclists/{dncListId}/phonenumbers','PATCH',{'dncListId':dncListId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
12998
|
+
* Add entries to or delete entries from a DNC list.
|
|
12999
|
+
* Only Internal DNC lists may be deleted from
|
|
13000
|
+
* @param {String} dncListId DncList ID
|
|
13001
|
+
* @param {Object} body DNC whatsApp numbers
|
|
13002
|
+
*/},{key:"patchOutboundDnclistWhatsappnumbers",value:function patchOutboundDnclistWhatsappnumbers(dncListId,body){// verify the required parameter 'dncListId' is set
|
|
13003
|
+
if(dncListId===undefined||dncListId===null){throw'Missing the required parameter "dncListId" when calling patchOutboundDnclistWhatsappnumbers';}// verify the required parameter 'body' is set
|
|
13004
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling patchOutboundDnclistWhatsappnumbers';}return this.apiClient.callApi('/api/v2/outbound/dnclists/{dncListId}/whatsappnumbers','PATCH',{'dncListId':dncListId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
12776
13005
|
* Update the outbound settings for this organization
|
|
12777
13006
|
*
|
|
12778
13007
|
* @param {Object} body outboundSettings
|
|
@@ -13162,7 +13391,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
13162
13391
|
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(){/**
|
|
13163
13392
|
* Presence service.
|
|
13164
13393
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
13165
|
-
* @version
|
|
13394
|
+
* @version 219.0.0
|
|
13166
13395
|
*//**
|
|
13167
13396
|
* Constructs a new PresenceApi.
|
|
13168
13397
|
* @alias module:purecloud-platform-client-v2/api/PresenceApi
|
|
@@ -13173,8 +13402,8 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
13173
13402
|
* Delete a Presence Definition
|
|
13174
13403
|
*
|
|
13175
13404
|
* @param {String} definitionId Presence Definition ID
|
|
13176
|
-
*/return _createClass(PresenceApi,[{key:"
|
|
13177
|
-
if(definitionId===undefined||definitionId===null){throw'Missing the required parameter "definitionId" when calling
|
|
13405
|
+
*/return _createClass(PresenceApi,[{key:"deletePresenceDefinition0",value:function deletePresenceDefinition0(definitionId){// verify the required parameter 'definitionId' is set
|
|
13406
|
+
if(definitionId===undefined||definitionId===null){throw'Missing the required parameter "definitionId" when calling deletePresenceDefinition0';}return this.apiClient.callApi('/api/v2/presence/definitions/{definitionId}','DELETE',{'definitionId':definitionId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
13178
13407
|
* Delete a Presence Source
|
|
13179
13408
|
*
|
|
13180
13409
|
* @param {String} sourceId Presence Source ID
|
|
@@ -13191,15 +13420,15 @@ if(presenceId===undefined||presenceId===null){throw'Missing the required paramet
|
|
|
13191
13420
|
* @param {String} definitionId Presence Definition ID
|
|
13192
13421
|
* @param {Object} opts Optional parameters
|
|
13193
13422
|
* @param {Object} opts.localeCode The locale code to fetch for the presence definition. Use ALL to fetch everything.
|
|
13194
|
-
*/},{key:"
|
|
13195
|
-
if(definitionId===undefined||definitionId===null){throw'Missing the required parameter "definitionId" when calling
|
|
13423
|
+
*/},{key:"getPresenceDefinition0",value:function getPresenceDefinition0(definitionId,opts){opts=opts||{};// verify the required parameter 'definitionId' is set
|
|
13424
|
+
if(definitionId===undefined||definitionId===null){throw'Missing the required parameter "definitionId" when calling getPresenceDefinition0';}return this.apiClient.callApi('/api/v2/presence/definitions/{definitionId}','GET',{'definitionId':definitionId},{'localeCode':opts['localeCode']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
13196
13425
|
* Get a list of Presence Definitions
|
|
13197
13426
|
*
|
|
13198
13427
|
* @param {Object} opts Optional parameters
|
|
13199
13428
|
* @param {String} opts.deactivated Deactivated query can be TRUE or FALSE (default to false)
|
|
13200
13429
|
* @param {Array.<String>} opts.divisionId One or more division IDs. If nothing is provided, the definitions associated withthe list of divisions that the user has access to will be returned.
|
|
13201
13430
|
* @param {Object} opts.localeCode The locale code to fetch for the presence definition. Use ALL to fetch everything.
|
|
13202
|
-
*/},{key:"
|
|
13431
|
+
*/},{key:"getPresenceDefinitions0",value:function getPresenceDefinitions0(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/presence/definitions','GET',{},{'deactivated':opts['deactivated'],'divisionId':this.apiClient.buildCollectionParam(opts['divisionId'],'multi'),'localeCode':opts['localeCode']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
13203
13432
|
* Get the presence settings
|
|
13204
13433
|
*
|
|
13205
13434
|
*/},{key:"getPresenceSettings",value:function getPresenceSettings(){return this.apiClient.callApi('/api/v2/presence/settings','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
@@ -13281,8 +13510,8 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
13281
13510
|
* Create a Presence Definition
|
|
13282
13511
|
*
|
|
13283
13512
|
* @param {Object} body The Presence Definition to create
|
|
13284
|
-
*/},{key:"
|
|
13285
|
-
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling
|
|
13513
|
+
*/},{key:"postPresenceDefinitions0",value:function postPresenceDefinitions0(body){// verify the required parameter 'body' is set
|
|
13514
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postPresenceDefinitions0';}return this.apiClient.callApi('/api/v2/presence/definitions','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
13286
13515
|
* Create a Presence Source
|
|
13287
13516
|
*
|
|
13288
13517
|
* @param {Object} body The Presence Source to create
|
|
@@ -13298,9 +13527,9 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
13298
13527
|
*
|
|
13299
13528
|
* @param {String} definitionId Presence Definition ID
|
|
13300
13529
|
* @param {Object} body The updated Presence Definition
|
|
13301
|
-
*/},{key:"
|
|
13302
|
-
if(definitionId===undefined||definitionId===null){throw'Missing the required parameter "definitionId" when calling
|
|
13303
|
-
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling
|
|
13530
|
+
*/},{key:"putPresenceDefinition0",value:function putPresenceDefinition0(definitionId,body){// verify the required parameter 'definitionId' is set
|
|
13531
|
+
if(definitionId===undefined||definitionId===null){throw'Missing the required parameter "definitionId" when calling putPresenceDefinition0';}// verify the required parameter 'body' is set
|
|
13532
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putPresenceDefinition0';}return this.apiClient.callApi('/api/v2/presence/definitions/{definitionId}','PUT',{'definitionId':definitionId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
13304
13533
|
* Update the presence settings
|
|
13305
13534
|
*
|
|
13306
13535
|
* @param {Object} body Presence Settings
|
|
@@ -13335,7 +13564,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
13335
13564
|
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(){/**
|
|
13336
13565
|
* ProcessAutomation service.
|
|
13337
13566
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
13338
|
-
* @version
|
|
13567
|
+
* @version 219.0.0
|
|
13339
13568
|
*//**
|
|
13340
13569
|
* Constructs a new ProcessAutomationApi.
|
|
13341
13570
|
* @alias module:purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
@@ -13398,7 +13627,7 @@ if(triggerId===undefined||triggerId===null){throw'Missing the required parameter
|
|
|
13398
13627
|
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(){/**
|
|
13399
13628
|
* Quality service.
|
|
13400
13629
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
13401
|
-
* @version
|
|
13630
|
+
* @version 219.0.0
|
|
13402
13631
|
*//**
|
|
13403
13632
|
* Constructs a new QualityApi.
|
|
13404
13633
|
* @alias module:purecloud-platform-client-v2/api/QualityApi
|
|
@@ -13876,7 +14105,7 @@ if(customerSurveyUrl===undefined||customerSurveyUrl===null){throw'Missing the re
|
|
|
13876
14105
|
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(){/**
|
|
13877
14106
|
* Recording service.
|
|
13878
14107
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
13879
|
-
* @version
|
|
14108
|
+
* @version 219.0.0
|
|
13880
14109
|
*//**
|
|
13881
14110
|
* Constructs a new RecordingApi.
|
|
13882
14111
|
* @alias module:purecloud-platform-client-v2/api/RecordingApi
|
|
@@ -14275,7 +14504,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
14275
14504
|
*/},{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(){/**
|
|
14276
14505
|
* ResponseManagement service.
|
|
14277
14506
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
14278
|
-
* @version
|
|
14507
|
+
* @version 219.0.0
|
|
14279
14508
|
*//**
|
|
14280
14509
|
* Constructs a new ResponseManagementApi.
|
|
14281
14510
|
* @alias module:purecloud-platform-client-v2/api/ResponseManagementApi
|
|
@@ -14396,7 +14625,7 @@ if(responseAssetId===undefined||responseAssetId===null){throw'Missing the requir
|
|
|
14396
14625
|
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(){/**
|
|
14397
14626
|
* Routing service.
|
|
14398
14627
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
14399
|
-
* @version
|
|
14628
|
+
* @version 219.0.0
|
|
14400
14629
|
*//**
|
|
14401
14630
|
* Constructs a new RoutingApi.
|
|
14402
14631
|
* @alias module:purecloud-platform-client-v2/api/RoutingApi
|
|
@@ -14603,7 +14832,7 @@ if(domainName===undefined||domainName===null){throw'Missing the required paramet
|
|
|
14603
14832
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
14604
14833
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
14605
14834
|
* @param {Boolean} opts.excludeStatus Exclude MX record data (default to false)
|
|
14606
|
-
* @param {String} opts.filter Optional search filter
|
|
14835
|
+
* @param {String} opts.filter Optional search filter that, if defined, use the **filter** syntax, eg: **mySearchedPattern**. Note that **** is considered no filter.
|
|
14607
14836
|
*/},{key:"getRoutingEmailDomains",value:function getRoutingEmailDomains(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/routing/email/domains','GET',{},{'pageSize':opts['pageSize'],'pageNumber':opts['pageNumber'],'excludeStatus':opts['excludeStatus'],'filter':opts['filter']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
14608
14837
|
* Get domain
|
|
14609
14838
|
*
|
|
@@ -14623,8 +14852,10 @@ if(domainId===undefined||domainId===null){throw'Missing the required parameter "
|
|
|
14623
14852
|
* Get outbound domains
|
|
14624
14853
|
*
|
|
14625
14854
|
* @param {Object} opts Optional parameters
|
|
14626
|
-
* @param {
|
|
14627
|
-
|
|
14855
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
14856
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
14857
|
+
* @param {String} opts.filter Optional search filter that, if defined, use the **filter** syntax, eg: **mySearchedPattern**. Note that **** is considered no filter.
|
|
14858
|
+
*/},{key:"getRoutingEmailOutboundDomains",value:function getRoutingEmailOutboundDomains(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/routing/email/outbound/domains','GET',{},{'pageSize':opts['pageSize'],'pageNumber':opts['pageNumber'],'filter':opts['filter']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
14628
14859
|
* Get email setup
|
|
14629
14860
|
*
|
|
14630
14861
|
*/},{key:"getRoutingEmailSetup",value:function getRoutingEmailSetup(){return this.apiClient.callApi('/api/v2/routing/email/setup','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
@@ -15441,7 +15672,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
15441
15672
|
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(){/**
|
|
15442
15673
|
* SCIM service.
|
|
15443
15674
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
15444
|
-
* @version
|
|
15675
|
+
* @version 219.0.0
|
|
15445
15676
|
*//**
|
|
15446
15677
|
* Constructs a new SCIMApi.
|
|
15447
15678
|
* @alias module:purecloud-platform-client-v2/api/SCIMApi
|
|
@@ -15666,7 +15897,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
15666
15897
|
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(){/**
|
|
15667
15898
|
* ScreenRecording service.
|
|
15668
15899
|
* @module purecloud-platform-client-v2/api/ScreenRecordingApi
|
|
15669
|
-
* @version
|
|
15900
|
+
* @version 219.0.0
|
|
15670
15901
|
*//**
|
|
15671
15902
|
* Constructs a new ScreenRecordingApi.
|
|
15672
15903
|
* @alias module:purecloud-platform-client-v2/api/ScreenRecordingApi
|
|
@@ -15681,7 +15912,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
15681
15912
|
*/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(){/**
|
|
15682
15913
|
* Scripts service.
|
|
15683
15914
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
15684
|
-
* @version
|
|
15915
|
+
* @version 219.0.0
|
|
15685
15916
|
*//**
|
|
15686
15917
|
* Constructs a new ScriptsApi.
|
|
15687
15918
|
* @alias module:purecloud-platform-client-v2/api/ScriptsApi
|
|
@@ -15817,7 +16048,7 @@ if(scriptId===undefined||scriptId===null){throw'Missing the required parameter "
|
|
|
15817
16048
|
*/},{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(){/**
|
|
15818
16049
|
* Search service.
|
|
15819
16050
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
15820
|
-
* @version
|
|
16051
|
+
* @version 219.0.0
|
|
15821
16052
|
*//**
|
|
15822
16053
|
* Constructs a new SearchApi.
|
|
15823
16054
|
* @alias module:purecloud-platform-client-v2/api/SearchApi
|
|
@@ -15989,7 +16220,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
15989
16220
|
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(){/**
|
|
15990
16221
|
* Settings service.
|
|
15991
16222
|
* @module purecloud-platform-client-v2/api/SettingsApi
|
|
15992
|
-
* @version
|
|
16223
|
+
* @version 219.0.0
|
|
15993
16224
|
*//**
|
|
15994
16225
|
* Constructs a new SettingsApi.
|
|
15995
16226
|
* @alias module:purecloud-platform-client-v2/api/SettingsApi
|
|
@@ -16050,7 +16281,7 @@ if(agentId===undefined||agentId===null){throw'Missing the required parameter "ag
|
|
|
16050
16281
|
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(){/**
|
|
16051
16282
|
* SocialMedia service.
|
|
16052
16283
|
* @module purecloud-platform-client-v2/api/SocialMediaApi
|
|
16053
|
-
* @version
|
|
16284
|
+
* @version 219.0.0
|
|
16054
16285
|
*//**
|
|
16055
16286
|
* Constructs a new SocialMediaApi.
|
|
16056
16287
|
* @alias module:purecloud-platform-client-v2/api/SocialMediaApi
|
|
@@ -16387,7 +16618,7 @@ if(topicId===undefined||topicId===null){throw'Missing the required parameter "to
|
|
|
16387
16618
|
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(){/**
|
|
16388
16619
|
* SpeechTextAnalytics service.
|
|
16389
16620
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
16390
|
-
* @version
|
|
16621
|
+
* @version 219.0.0
|
|
16391
16622
|
*//**
|
|
16392
16623
|
* Constructs a new SpeechTextAnalyticsApi.
|
|
16393
16624
|
* @alias module:purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
@@ -16710,7 +16941,7 @@ if(topicId===undefined||topicId===null){throw'Missing the required parameter "to
|
|
|
16710
16941
|
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(){/**
|
|
16711
16942
|
* Stations service.
|
|
16712
16943
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
16713
|
-
* @version
|
|
16944
|
+
* @version 219.0.0
|
|
16714
16945
|
*//**
|
|
16715
16946
|
* Constructs a new StationsApi.
|
|
16716
16947
|
* @alias module:purecloud-platform-client-v2/api/StationsApi
|
|
@@ -16742,7 +16973,7 @@ if(stationId===undefined||stationId===null){throw'Missing the required parameter
|
|
|
16742
16973
|
*/},{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(){/**
|
|
16743
16974
|
* Suggest service.
|
|
16744
16975
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
16745
|
-
* @version
|
|
16976
|
+
* @version 219.0.0
|
|
16746
16977
|
*//**
|
|
16747
16978
|
* Constructs a new SuggestApi.
|
|
16748
16979
|
* @alias module:purecloud-platform-client-v2/api/SuggestApi
|
|
@@ -16782,7 +17013,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
16782
17013
|
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(){/**
|
|
16783
17014
|
* TaskManagement service.
|
|
16784
17015
|
* @module purecloud-platform-client-v2/api/TaskManagementApi
|
|
16785
|
-
* @version
|
|
17016
|
+
* @version 219.0.0
|
|
16786
17017
|
*//**
|
|
16787
17018
|
* Constructs a new TaskManagementApi.
|
|
16788
17019
|
* @alias module:purecloud-platform-client-v2/api/TaskManagementApi
|
|
@@ -16996,6 +17227,17 @@ if(schemaId===undefined||schemaId===null){throw'Missing the required parameter "
|
|
|
16996
17227
|
* Get a list of schemas.
|
|
16997
17228
|
*
|
|
16998
17229
|
*/},{key:"getTaskmanagementWorkitemsSchemas",value:function getTaskmanagementWorkitemsSchemas(){return this.apiClient.callApi('/api/v2/taskmanagement/workitems/schemas','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
17230
|
+
* Get the core types from which all schemas are built.
|
|
17231
|
+
*
|
|
17232
|
+
* @param {String} coreTypeName Name of the core type
|
|
17233
|
+
*/},{key:"getTaskmanagementWorkitemsSchemasCoretype",value:function getTaskmanagementWorkitemsSchemasCoretype(coreTypeName){// verify the required parameter 'coreTypeName' is set
|
|
17234
|
+
if(coreTypeName===undefined||coreTypeName===null){throw'Missing the required parameter "coreTypeName" when calling getTaskmanagementWorkitemsSchemasCoretype';}return this.apiClient.callApi('/api/v2/taskmanagement/workitems/schemas/coretypes/{coreTypeName}','GET',{'coreTypeName':coreTypeName},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
17235
|
+
* Get the core types from which all schemas are built.
|
|
17236
|
+
*
|
|
17237
|
+
*/},{key:"getTaskmanagementWorkitemsSchemasCoretypes",value:function getTaskmanagementWorkitemsSchemasCoretypes(){return this.apiClient.callApi('/api/v2/taskmanagement/workitems/schemas/coretypes','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
17238
|
+
* Get quantitative limits on schemas
|
|
17239
|
+
*
|
|
17240
|
+
*/},{key:"getTaskmanagementWorkitemsSchemasLimits",value:function getTaskmanagementWorkitemsSchemasLimits(){return this.apiClient.callApi('/api/v2/taskmanagement/workitems/schemas/limits','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
16999
17241
|
* Get a worktype
|
|
17000
17242
|
*
|
|
17001
17243
|
* @param {String} worktypeId Worktype id
|
|
@@ -17288,7 +17530,7 @@ if(schemaId===undefined||schemaId===null){throw'Missing the required parameter "
|
|
|
17288
17530
|
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(){/**
|
|
17289
17531
|
* Teams service.
|
|
17290
17532
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
17291
|
-
* @version
|
|
17533
|
+
* @version 219.0.0
|
|
17292
17534
|
*//**
|
|
17293
17535
|
* Constructs a new TeamsApi.
|
|
17294
17536
|
* @alias module:purecloud-platform-client-v2/api/TeamsApi
|
|
@@ -17368,7 +17610,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
17368
17610
|
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(){/**
|
|
17369
17611
|
* Telephony service.
|
|
17370
17612
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
17371
|
-
* @version
|
|
17613
|
+
* @version 219.0.0
|
|
17372
17614
|
*//**
|
|
17373
17615
|
* Constructs a new TelephonyApi.
|
|
17374
17616
|
* @alias module:purecloud-platform-client-v2/api/TelephonyApi
|
|
@@ -17415,7 +17657,7 @@ if(downloadId===undefined||downloadId===null){throw'Missing the required paramet
|
|
|
17415
17657
|
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(){/**
|
|
17416
17658
|
* TelephonyProvidersEdge service.
|
|
17417
17659
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
17418
|
-
* @version
|
|
17660
|
+
* @version 219.0.0
|
|
17419
17661
|
*//**
|
|
17420
17662
|
* Constructs a new TelephonyProvidersEdgeApi.
|
|
17421
17663
|
* @alias module:purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
@@ -18251,7 +18493,7 @@ if(trunkBaseSettingsId===undefined||trunkBaseSettingsId===null){throw'Missing th
|
|
|
18251
18493
|
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(){/**
|
|
18252
18494
|
* Textbots service.
|
|
18253
18495
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
18254
|
-
* @version
|
|
18496
|
+
* @version 219.0.0
|
|
18255
18497
|
*//**
|
|
18256
18498
|
* Constructs a new TextbotsApi.
|
|
18257
18499
|
* @alias module:purecloud-platform-client-v2/api/TextbotsApi
|
|
@@ -18286,7 +18528,7 @@ if(launchRequest===undefined||launchRequest===null){throw'Missing the required p
|
|
|
18286
18528
|
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(){/**
|
|
18287
18529
|
* Tokens service.
|
|
18288
18530
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
18289
|
-
* @version
|
|
18531
|
+
* @version 219.0.0
|
|
18290
18532
|
*//**
|
|
18291
18533
|
* Constructs a new TokensApi.
|
|
18292
18534
|
* @alias module:purecloud-platform-client-v2/api/TokensApi
|
|
@@ -18320,7 +18562,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
18320
18562
|
*/},{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(){/**
|
|
18321
18563
|
* Uploads service.
|
|
18322
18564
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
18323
|
-
* @version
|
|
18565
|
+
* @version 219.0.0
|
|
18324
18566
|
*//**
|
|
18325
18567
|
* Constructs a new UploadsApi.
|
|
18326
18568
|
* @alias module:purecloud-platform-client-v2/api/UploadsApi
|
|
@@ -18335,6 +18577,11 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
18335
18577
|
*/return _createClass(UploadsApi,[{key:"getKnowledgeKnowledgebaseUploadsUrlsJob",value:function getKnowledgeKnowledgebaseUploadsUrlsJob(knowledgeBaseId,jobId){// verify the required parameter 'knowledgeBaseId' is set
|
|
18336
18578
|
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseUploadsUrlsJob';}// verify the required parameter 'jobId' is set
|
|
18337
18579
|
if(jobId===undefined||jobId===null){throw'Missing the required parameter "jobId" when calling getKnowledgeKnowledgebaseUploadsUrlsJob';}return this.apiClient.callApi('/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/uploads/urls/jobs/{jobId}','GET',{'knowledgeBaseId':knowledgeBaseId,'jobId':jobId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
18580
|
+
* Generates pre-signed URL to upload a prize image for gamification contests
|
|
18581
|
+
*
|
|
18582
|
+
* @param {Object} body query
|
|
18583
|
+
*/},{key:"postGamificationContestsUploadsPrizeimages",value:function postGamificationContestsUploadsPrizeimages(body){// verify the required parameter 'body' is set
|
|
18584
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postGamificationContestsUploadsPrizeimages';}return this.apiClient.callApi('/api/v2/gamification/contests/uploads/prizeimages','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
18338
18585
|
* Create upload presigned URL for draft function package file.
|
|
18339
18586
|
*
|
|
18340
18587
|
* @param {String} actionId actionId
|
|
@@ -18383,7 +18630,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
18383
18630
|
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(){/**
|
|
18384
18631
|
* Usage service.
|
|
18385
18632
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
18386
|
-
* @version
|
|
18633
|
+
* @version 219.0.0
|
|
18387
18634
|
*//**
|
|
18388
18635
|
* Constructs a new UsageApi.
|
|
18389
18636
|
* @alias module:purecloud-platform-client-v2/api/UsageApi
|
|
@@ -18437,7 +18684,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
18437
18684
|
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(){/**
|
|
18438
18685
|
* UserRecordings service.
|
|
18439
18686
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
18440
|
-
* @version
|
|
18687
|
+
* @version 219.0.0
|
|
18441
18688
|
*//**
|
|
18442
18689
|
* Constructs a new UserRecordingsApi.
|
|
18443
18690
|
* @alias module:purecloud-platform-client-v2/api/UserRecordingsApi
|
|
@@ -18494,7 +18741,7 @@ if(recordingId===undefined||recordingId===null){throw'Missing the required param
|
|
|
18494
18741
|
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(){/**
|
|
18495
18742
|
* Users service.
|
|
18496
18743
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
18497
|
-
* @version
|
|
18744
|
+
* @version 219.0.0
|
|
18498
18745
|
*//**
|
|
18499
18746
|
* Constructs a new UsersApi.
|
|
18500
18747
|
* @alias module:purecloud-platform-client-v2/api/UsersApi
|
|
@@ -19221,7 +19468,7 @@ if(verifierId===undefined||verifierId===null){throw'Missing the required paramet
|
|
|
19221
19468
|
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(){/**
|
|
19222
19469
|
* Utilities service.
|
|
19223
19470
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
19224
|
-
* @version
|
|
19471
|
+
* @version 219.0.0
|
|
19225
19472
|
*//**
|
|
19226
19473
|
* Constructs a new UtilitiesApi.
|
|
19227
19474
|
* @alias module:purecloud-platform-client-v2/api/UtilitiesApi
|
|
@@ -19248,7 +19495,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
19248
19495
|
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(){/**
|
|
19249
19496
|
* Voicemail service.
|
|
19250
19497
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
19251
|
-
* @version
|
|
19498
|
+
* @version 219.0.0
|
|
19252
19499
|
*//**
|
|
19253
19500
|
* Constructs a new VoicemailApi.
|
|
19254
19501
|
* @alias module:purecloud-platform-client-v2/api/VoicemailApi
|
|
@@ -19410,7 +19657,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
19410
19657
|
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(){/**
|
|
19411
19658
|
* WebChat service.
|
|
19412
19659
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
19413
|
-
* @version
|
|
19660
|
+
* @version 219.0.0
|
|
19414
19661
|
*//**
|
|
19415
19662
|
* Constructs a new WebChatApi.
|
|
19416
19663
|
* @alias module:purecloud-platform-client-v2/api/WebChatApi
|
|
@@ -19554,7 +19801,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
19554
19801
|
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(){/**
|
|
19555
19802
|
* WebDeployments service.
|
|
19556
19803
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
19557
|
-
* @version
|
|
19804
|
+
* @version 219.0.0
|
|
19558
19805
|
*//**
|
|
19559
19806
|
* Constructs a new WebDeploymentsApi.
|
|
19560
19807
|
* @alias module:purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
@@ -19689,7 +19936,7 @@ if(deploymentId===undefined||deploymentId===null){throw'Missing the required par
|
|
|
19689
19936
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putWebdeploymentsDeploymentIdentityresolution';}return this.apiClient.callApi('/api/v2/webdeployments/deployments/{deploymentId}/identityresolution','PUT',{'deploymentId':deploymentId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var WebMessagingApi=/*#__PURE__*/function(){/**
|
|
19690
19937
|
* WebMessaging service.
|
|
19691
19938
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
19692
|
-
* @version
|
|
19939
|
+
* @version 219.0.0
|
|
19693
19940
|
*//**
|
|
19694
19941
|
* Constructs a new WebMessagingApi.
|
|
19695
19942
|
* @alias module:purecloud-platform-client-v2/api/WebMessagingApi
|
|
@@ -19705,7 +19952,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
19705
19952
|
*/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(){/**
|
|
19706
19953
|
* Widgets service.
|
|
19707
19954
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
19708
|
-
* @version
|
|
19955
|
+
* @version 219.0.0
|
|
19709
19956
|
*//**
|
|
19710
19957
|
* Constructs a new WidgetsApi.
|
|
19711
19958
|
* @alias module:purecloud-platform-client-v2/api/WidgetsApi
|
|
@@ -19745,7 +19992,7 @@ if(deploymentId===undefined||deploymentId===null){throw'Missing the required par
|
|
|
19745
19992
|
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(){/**
|
|
19746
19993
|
* WorkforceManagement service.
|
|
19747
19994
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
19748
|
-
* @version
|
|
19995
|
+
* @version 219.0.0
|
|
19749
19996
|
*//**
|
|
19750
19997
|
* Constructs a new WorkforceManagementApi.
|
|
19751
19998
|
* @alias module:purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
@@ -20357,8 +20604,9 @@ if(jobId===undefined||jobId===null){throw'Missing the required parameter "jobId"
|
|
|
20357
20604
|
* Retrieves all delete job status for historical data
|
|
20358
20605
|
*
|
|
20359
20606
|
*/},{key:"getWorkforcemanagementHistoricaldataBulkRemoveJobs",value:function getWorkforcemanagementHistoricaldataBulkRemoveJobs(){return this.apiClient.callApi('/api/v2/workforcemanagement/historicaldata/bulk/remove/jobs','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
20360
|
-
* Retrieves delete job status for historical data imports of the organization
|
|
20361
|
-
*
|
|
20607
|
+
* Retrieves delete job status for historical data imports of the organization.
|
|
20608
|
+
* Deprecated: Please use GET /workforcemanagement/historicaldata/bulk/remove/jobs instead.
|
|
20609
|
+
* @deprecated
|
|
20362
20610
|
*/},{key:"getWorkforcemanagementHistoricaldataDeletejob",value:function getWorkforcemanagementHistoricaldataDeletejob(){return this.apiClient.callApi('/api/v2/workforcemanagement/historicaldata/deletejob','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
20363
20611
|
* Retrieves status of the historical data imports of the organization
|
|
20364
20612
|
*
|
|
@@ -21235,8 +21483,9 @@ if(businessUnitId===undefined||businessUnitId===null){throw'Missing the required
|
|
|
21235
21483
|
* @param {Object} opts Optional parameters
|
|
21236
21484
|
* @param {Object} opts.body body
|
|
21237
21485
|
*/},{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']);}/**
|
|
21238
|
-
* Delete the entries of the historical data imports in the organization
|
|
21239
|
-
*
|
|
21486
|
+
* Delete the entries of the historical data imports in the organization.
|
|
21487
|
+
* Deprecated: Please use POST /workforcemanagement/historicaldata/bulk/remove/jobs instead.
|
|
21488
|
+
* @deprecated
|
|
21240
21489
|
*/},{key:"postWorkforcemanagementHistoricaldataDeletejob",value:function postWorkforcemanagementHistoricaldataDeletejob(){return this.apiClient.callApi('/api/v2/workforcemanagement/historicaldata/deletejob','POST',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
21241
21490
|
* Trigger validation process for historical import
|
|
21242
21491
|
*
|
|
@@ -21564,7 +21813,7 @@ if(timeOffLimitId===undefined||timeOffLimitId===null){throw'Missing the required
|
|
|
21564
21813
|
* </pre>
|
|
21565
21814
|
* </p>
|
|
21566
21815
|
* @module purecloud-platform-client-v2/index
|
|
21567
|
-
* @version
|
|
21816
|
+
* @version 219.0.0
|
|
21568
21817
|
*/var platformClient=/*#__PURE__*/_createClass(function platformClient(){_classCallCheck(this,platformClient);/**
|
|
21569
21818
|
* The ApiClient constructor.
|
|
21570
21819
|
* @property {module:purecloud-platform-client-v2/ApiClient}
|