purecloud-platform-client-v2 212.1.0 → 213.1.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 +150 -103
- package/dist/web-amd/purecloud-platform-client-v2.js +150 -103
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +130 -103
- package/dist/web-cjs/purecloud-platform-client-v2.js +168 -110
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +281 -229
- 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 +3 -2
- package/src/purecloud-platform-client-v2/api/ArchitectApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AuditApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/BillingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/CarrierServicesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ChatApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/CoachingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ContentManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ConversationsApi.js +35 -18
- 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 +1 -1
- package/src/purecloud-platform-client-v2/api/FaxApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/FlowsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GamificationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GeolocationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GreetingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GroupsApi.js +2 -2
- 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 +1 -1
- package/src/purecloud-platform-client-v2/api/OperationalEventsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OrganizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OutboundApi.js +7 -3
- package/src/purecloud-platform-client-v2/api/PresenceApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ProcessAutomationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/QualityApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RecordingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RoutingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ScreenRecordingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ScriptsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SearchApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SettingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SocialMediaApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/StationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SuggestApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TaskManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TeamsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TelephonyApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TextbotsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TokensApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UploadsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsageApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsersApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/VoicemailApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebChatApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebMessagingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WidgetsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +26 -1
- package/src/purecloud-platform-client-v2/index.js +1 -1
package/dist/web-cjs/bundle.js
CHANGED
|
@@ -882,7 +882,7 @@ if(env)this.environment=env;else this.environment=this.host?this.host:'mypureclo
|
|
|
882
882
|
this.environment=this.environment.replace(/\/+$/,'');// Strip protocol and subdomain
|
|
883
883
|
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];}}}]);}();/**
|
|
884
884
|
* @module purecloud-platform-client-v2/ApiClient
|
|
885
|
-
* @version
|
|
885
|
+
* @version 213.1.0
|
|
886
886
|
*/var ApiClient=/*#__PURE__*/function(){/**
|
|
887
887
|
* Manages low level client-server communications, parameter marshalling, etc. There should not be any need for an
|
|
888
888
|
* application to use this class directly - the *Api and model classes provide the public API for the service. The
|
|
@@ -1219,7 +1219,7 @@ resolve(data);})["catch"](function(error){var data=error;if(error.response&&erro
|
|
|
1219
1219
|
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(){/**
|
|
1220
1220
|
* AgentAssistants service.
|
|
1221
1221
|
* @module purecloud-platform-client-v2/api/AgentAssistantsApi
|
|
1222
|
-
* @version
|
|
1222
|
+
* @version 213.1.0
|
|
1223
1223
|
*//**
|
|
1224
1224
|
* Constructs a new AgentAssistantsApi.
|
|
1225
1225
|
* @alias module:purecloud-platform-client-v2/api/AgentAssistantsApi
|
|
@@ -1320,7 +1320,7 @@ if(queueId===undefined||queueId===null){throw'Missing the required parameter "qu
|
|
|
1320
1320
|
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(){/**
|
|
1321
1321
|
* AgentCopilot service.
|
|
1322
1322
|
* @module purecloud-platform-client-v2/api/AgentCopilotApi
|
|
1323
|
-
* @version
|
|
1323
|
+
* @version 213.1.0
|
|
1324
1324
|
*//**
|
|
1325
1325
|
* Constructs a new AgentCopilotApi.
|
|
1326
1326
|
* @alias module:purecloud-platform-client-v2/api/AgentCopilotApi
|
|
@@ -1342,7 +1342,7 @@ if(assistantId===undefined||assistantId===null){throw'Missing the required param
|
|
|
1342
1342
|
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(){/**
|
|
1343
1343
|
* AgentUI service.
|
|
1344
1344
|
* @module purecloud-platform-client-v2/api/AgentUIApi
|
|
1345
|
-
* @version
|
|
1345
|
+
* @version 213.1.0
|
|
1346
1346
|
*//**
|
|
1347
1347
|
* Constructs a new AgentUIApi.
|
|
1348
1348
|
* @alias module:purecloud-platform-client-v2/api/AgentUIApi
|
|
@@ -1376,7 +1376,7 @@ if(agentId===undefined||agentId===null){throw'Missing the required parameter "ag
|
|
|
1376
1376
|
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(){/**
|
|
1377
1377
|
* Alerting service.
|
|
1378
1378
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
1379
|
-
* @version
|
|
1379
|
+
* @version 213.1.0
|
|
1380
1380
|
*//**
|
|
1381
1381
|
* Constructs a new AlertingApi.
|
|
1382
1382
|
* @alias module:purecloud-platform-client-v2/api/AlertingApi
|
|
@@ -1533,7 +1533,7 @@ if(ruleId===undefined||ruleId===null){throw'Missing the required parameter "rule
|
|
|
1533
1533
|
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(){/**
|
|
1534
1534
|
* Analytics service.
|
|
1535
1535
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
1536
|
-
* @version
|
|
1536
|
+
* @version 213.1.0
|
|
1537
1537
|
*//**
|
|
1538
1538
|
* Constructs a new AnalyticsApi.
|
|
1539
1539
|
* @alias module:purecloud-platform-client-v2/api/AnalyticsApi
|
|
@@ -1783,12 +1783,13 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
1783
1783
|
* @param {Object} dashboardAccessFilter Filter dashboard based on the owner of dashboard
|
|
1784
1784
|
* @param {Object} opts Optional parameters
|
|
1785
1785
|
* @param {String} opts.name name of the dashboard
|
|
1786
|
+
* @param {Object} opts.dashboardState List dashboard of given state (default to Active)
|
|
1786
1787
|
* @param {String} opts.sortBy (default to desc)
|
|
1787
1788
|
* @param {Number} opts.pageNumber (default to 1)
|
|
1788
1789
|
* @param {Number} opts.pageSize (default to 9)
|
|
1789
1790
|
*/},{key:"getAnalyticsReportingSettingsDashboardsQuery",value:function getAnalyticsReportingSettingsDashboardsQuery(dashboardType,dashboardAccessFilter,opts){opts=opts||{};// verify the required parameter 'dashboardType' is set
|
|
1790
1791
|
if(dashboardType===undefined||dashboardType===null){throw'Missing the required parameter "dashboardType" when calling getAnalyticsReportingSettingsDashboardsQuery';}// verify the required parameter 'dashboardAccessFilter' is set
|
|
1791
|
-
if(dashboardAccessFilter===undefined||dashboardAccessFilter===null){throw'Missing the required parameter "dashboardAccessFilter" when calling getAnalyticsReportingSettingsDashboardsQuery';}return this.apiClient.callApi('/api/v2/analytics/reporting/settings/dashboards/query','GET',{},{'name':opts['name'],'dashboardType':dashboardType,'dashboardAccessFilter':dashboardAccessFilter,'sortBy':opts['sortBy'],'pageNumber':opts['pageNumber'],'pageSize':opts['pageSize']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
1792
|
+
if(dashboardAccessFilter===undefined||dashboardAccessFilter===null){throw'Missing the required parameter "dashboardAccessFilter" when calling getAnalyticsReportingSettingsDashboardsQuery';}return this.apiClient.callApi('/api/v2/analytics/reporting/settings/dashboards/query','GET',{},{'name':opts['name'],'dashboardType':dashboardType,'dashboardState':opts['dashboardState'],'dashboardAccessFilter':dashboardAccessFilter,'sortBy':opts['sortBy'],'pageNumber':opts['pageNumber'],'pageSize':opts['pageSize']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
1792
1793
|
* Get list of dashboards for an user
|
|
1793
1794
|
*
|
|
1794
1795
|
* @param {String} userId User ID
|
|
@@ -2204,7 +2205,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
2204
2205
|
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(){/**
|
|
2205
2206
|
* Architect service.
|
|
2206
2207
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
2207
|
-
* @version
|
|
2208
|
+
* @version 213.1.0
|
|
2208
2209
|
*//**
|
|
2209
2210
|
* Constructs a new ArchitectApi.
|
|
2210
2211
|
* @alias module:purecloud-platform-client-v2/api/ArchitectApi
|
|
@@ -3296,7 +3297,7 @@ if(milestoneId===undefined||milestoneId===null){throw'Missing the required param
|
|
|
3296
3297
|
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(){/**
|
|
3297
3298
|
* Audit service.
|
|
3298
3299
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
3299
|
-
* @version
|
|
3300
|
+
* @version 213.1.0
|
|
3300
3301
|
*//**
|
|
3301
3302
|
* Constructs a new AuditApi.
|
|
3302
3303
|
* @alias module:purecloud-platform-client-v2/api/AuditApi
|
|
@@ -3346,7 +3347,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
3346
3347
|
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(){/**
|
|
3347
3348
|
* Authorization service.
|
|
3348
3349
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
3349
|
-
* @version
|
|
3350
|
+
* @version 213.1.0
|
|
3350
3351
|
*//**
|
|
3351
3352
|
* Constructs a new AuthorizationApi.
|
|
3352
3353
|
* @alias module:purecloud-platform-client-v2/api/AuthorizationApi
|
|
@@ -3669,7 +3670,7 @@ if(subjectId===undefined||subjectId===null){throw'Missing the required parameter
|
|
|
3669
3670
|
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(){/**
|
|
3670
3671
|
* Billing service.
|
|
3671
3672
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
3672
|
-
* @version
|
|
3673
|
+
* @version 213.1.0
|
|
3673
3674
|
*//**
|
|
3674
3675
|
* Constructs a new BillingApi.
|
|
3675
3676
|
* @alias module:purecloud-platform-client-v2/api/BillingApi
|
|
@@ -3693,7 +3694,7 @@ if(endDate===undefined||endDate===null){throw'Missing the required parameter "en
|
|
|
3693
3694
|
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(){/**
|
|
3694
3695
|
* CarrierServices service.
|
|
3695
3696
|
* @module purecloud-platform-client-v2/api/CarrierServicesApi
|
|
3696
|
-
* @version
|
|
3697
|
+
* @version 213.1.0
|
|
3697
3698
|
*//**
|
|
3698
3699
|
* Constructs a new CarrierServicesApi.
|
|
3699
3700
|
* @alias module:purecloud-platform-client-v2/api/CarrierServicesApi
|
|
@@ -3713,7 +3714,7 @@ if(phoneNumber===undefined||phoneNumber===null){throw'Missing the required param
|
|
|
3713
3714
|
*/},{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(){/**
|
|
3714
3715
|
* Chat service.
|
|
3715
3716
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
3716
|
-
* @version
|
|
3717
|
+
* @version 213.1.0
|
|
3717
3718
|
*//**
|
|
3718
3719
|
* Constructs a new ChatApi.
|
|
3719
3720
|
* @alias module:purecloud-platform-client-v2/api/ChatApi
|
|
@@ -3938,7 +3939,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
3938
3939
|
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(){/**
|
|
3939
3940
|
* Coaching service.
|
|
3940
3941
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
3941
|
-
* @version
|
|
3942
|
+
* @version 213.1.0
|
|
3942
3943
|
*//**
|
|
3943
3944
|
* Constructs a new CoachingApi.
|
|
3944
3945
|
* @alias module:purecloud-platform-client-v2/api/CoachingApi
|
|
@@ -4091,7 +4092,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
4091
4092
|
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(){/**
|
|
4092
4093
|
* ContentManagement service.
|
|
4093
4094
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
4094
|
-
* @version
|
|
4095
|
+
* @version 213.1.0
|
|
4095
4096
|
*//**
|
|
4096
4097
|
* Constructs a new ContentManagementApi.
|
|
4097
4098
|
* @alias module:purecloud-platform-client-v2/api/ContentManagementApi
|
|
@@ -4373,7 +4374,7 @@ if(tagId===undefined||tagId===null){throw'Missing the required parameter "tagId"
|
|
|
4373
4374
|
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(){/**
|
|
4374
4375
|
* Conversations service.
|
|
4375
4376
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
4376
|
-
* @version
|
|
4377
|
+
* @version 213.1.0
|
|
4377
4378
|
*//**
|
|
4378
4379
|
* Constructs a new ConversationsApi.
|
|
4379
4380
|
* @alias module:purecloud-platform-client-v2/api/ConversationsApi
|
|
@@ -4646,56 +4647,63 @@ if(participantId===undefined||participantId===null){throw'Missing the required p
|
|
|
4646
4647
|
*
|
|
4647
4648
|
*/},{key:"getConversationsCallsMaximumconferenceparties",value:function getConversationsCallsMaximumconferenceparties(){return this.apiClient.callApi('/api/v2/conversations/calls/maximumconferenceparties','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
4648
4649
|
* Get chat conversation
|
|
4649
|
-
*
|
|
4650
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/.
|
|
4650
4651
|
* @param {String} conversationId conversationId
|
|
4652
|
+
* @deprecated
|
|
4651
4653
|
*/},{key:"getConversationsChat",value:function getConversationsChat(conversationId){// verify the required parameter 'conversationId' is set
|
|
4652
4654
|
if(conversationId===undefined||conversationId===null){throw'Missing the required parameter "conversationId" when calling getConversationsChat';}return this.apiClient.callApi('/api/v2/conversations/chats/{conversationId}','GET',{'conversationId':conversationId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
4653
4655
|
* Get a web chat conversation message
|
|
4654
|
-
* The current user must be involved with the conversation to get its messages.
|
|
4656
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/. The current user must be involved with the conversation to get its messages.
|
|
4655
4657
|
* @param {String} conversationId conversationId
|
|
4656
4658
|
* @param {String} messageId messageId
|
|
4659
|
+
* @deprecated
|
|
4657
4660
|
*/},{key:"getConversationsChatMessage",value:function getConversationsChatMessage(conversationId,messageId){// verify the required parameter 'conversationId' is set
|
|
4658
4661
|
if(conversationId===undefined||conversationId===null){throw'Missing the required parameter "conversationId" when calling getConversationsChatMessage';}// verify the required parameter 'messageId' is set
|
|
4659
4662
|
if(messageId===undefined||messageId===null){throw'Missing the required parameter "messageId" when calling getConversationsChatMessage';}return this.apiClient.callApi('/api/v2/conversations/chats/{conversationId}/messages/{messageId}','GET',{'conversationId':conversationId,'messageId':messageId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
4660
4663
|
* Get the messages of a chat conversation.
|
|
4661
|
-
* The current user must be involved with the conversation to get its messages.
|
|
4664
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/. The current user must be involved with the conversation to get its messages.
|
|
4662
4665
|
* @param {String} conversationId conversationId
|
|
4663
4666
|
* @param {Object} opts Optional parameters
|
|
4664
4667
|
* @param {String} opts.after If specified, get the messages chronologically after the id of this message
|
|
4665
4668
|
* @param {String} opts.before If specified, get the messages chronologically before the id of this message
|
|
4666
4669
|
* @param {Object} opts.sortOrder Sort order (default to ascending)
|
|
4667
4670
|
* @param {Number} opts.maxResults Limit the returned number of messages, up to a maximum of 100 (default to 100)
|
|
4671
|
+
* @deprecated
|
|
4668
4672
|
*/},{key:"getConversationsChatMessages",value:function getConversationsChatMessages(conversationId,opts){opts=opts||{};// verify the required parameter 'conversationId' is set
|
|
4669
4673
|
if(conversationId===undefined||conversationId===null){throw'Missing the required parameter "conversationId" when calling getConversationsChatMessages';}return this.apiClient.callApi('/api/v2/conversations/chats/{conversationId}/messages','GET',{'conversationId':conversationId},{'after':opts['after'],'before':opts['before'],'sortOrder':opts['sortOrder'],'maxResults':opts['maxResults']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
4670
4674
|
* Get the wrap-up for this conversation communication.
|
|
4671
|
-
*
|
|
4675
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/.
|
|
4672
4676
|
* @param {String} conversationId conversationId
|
|
4673
4677
|
* @param {String} participantId participantId
|
|
4674
4678
|
* @param {String} communicationId communicationId
|
|
4675
4679
|
* @param {Object} opts Optional parameters
|
|
4676
4680
|
* @param {Boolean} opts.provisional Indicates if the wrap-up code is provisional. (default to false)
|
|
4681
|
+
* @deprecated
|
|
4677
4682
|
*/},{key:"getConversationsChatParticipantCommunicationWrapup",value:function getConversationsChatParticipantCommunicationWrapup(conversationId,participantId,communicationId,opts){opts=opts||{};// verify the required parameter 'conversationId' is set
|
|
4678
4683
|
if(conversationId===undefined||conversationId===null){throw'Missing the required parameter "conversationId" when calling getConversationsChatParticipantCommunicationWrapup';}// verify the required parameter 'participantId' is set
|
|
4679
4684
|
if(participantId===undefined||participantId===null){throw'Missing the required parameter "participantId" when calling getConversationsChatParticipantCommunicationWrapup';}// verify the required parameter 'communicationId' is set
|
|
4680
4685
|
if(communicationId===undefined||communicationId===null){throw'Missing the required parameter "communicationId" when calling getConversationsChatParticipantCommunicationWrapup';}return this.apiClient.callApi('/api/v2/conversations/chats/{conversationId}/participants/{participantId}/communications/{communicationId}/wrapup','GET',{'conversationId':conversationId,'participantId':participantId,'communicationId':communicationId},{'provisional':opts['provisional']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
4681
4686
|
* Get the wrap-up for this conversation participant.
|
|
4682
|
-
*
|
|
4687
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/.
|
|
4683
4688
|
* @param {String} conversationId conversationId
|
|
4684
4689
|
* @param {String} participantId participantId
|
|
4685
4690
|
* @param {Object} opts Optional parameters
|
|
4686
4691
|
* @param {Boolean} opts.provisional Indicates if the wrap-up code is provisional. (default to false)
|
|
4692
|
+
* @deprecated
|
|
4687
4693
|
*/},{key:"getConversationsChatParticipantWrapup",value:function getConversationsChatParticipantWrapup(conversationId,participantId,opts){opts=opts||{};// verify the required parameter 'conversationId' is set
|
|
4688
4694
|
if(conversationId===undefined||conversationId===null){throw'Missing the required parameter "conversationId" when calling getConversationsChatParticipantWrapup';}// verify the required parameter 'participantId' is set
|
|
4689
4695
|
if(participantId===undefined||participantId===null){throw'Missing the required parameter "participantId" when calling getConversationsChatParticipantWrapup';}return this.apiClient.callApi('/api/v2/conversations/chats/{conversationId}/participants/{participantId}/wrapup','GET',{'conversationId':conversationId,'participantId':participantId},{'provisional':opts['provisional']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
4690
4696
|
* Get list of wrapup codes for this conversation participant
|
|
4691
|
-
*
|
|
4697
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/.
|
|
4692
4698
|
* @param {String} conversationId conversationId
|
|
4693
4699
|
* @param {String} participantId participantId
|
|
4700
|
+
* @deprecated
|
|
4694
4701
|
*/},{key:"getConversationsChatParticipantWrapupcodes",value:function getConversationsChatParticipantWrapupcodes(conversationId,participantId){// verify the required parameter 'conversationId' is set
|
|
4695
4702
|
if(conversationId===undefined||conversationId===null){throw'Missing the required parameter "conversationId" when calling getConversationsChatParticipantWrapupcodes';}// verify the required parameter 'participantId' is set
|
|
4696
4703
|
if(participantId===undefined||participantId===null){throw'Missing the required parameter "participantId" when calling getConversationsChatParticipantWrapupcodes';}return this.apiClient.callApi('/api/v2/conversations/chats/{conversationId}/participants/{participantId}/wrapupcodes','GET',{'conversationId':conversationId,'participantId':participantId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
4697
4704
|
* Get active chat conversations for the logged in user
|
|
4698
|
-
*
|
|
4705
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/.
|
|
4706
|
+
* @deprecated
|
|
4699
4707
|
*/},{key:"getConversationsChats",value:function getConversationsChats(){return this.apiClient.callApi('/api/v2/conversations/chats','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
4700
4708
|
* Get cobrowse conversation
|
|
4701
4709
|
*
|
|
@@ -5161,36 +5169,40 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
5161
5169
|
*/},{key:"patchConversationsCallbacks",value:function patchConversationsCallbacks(body){// verify the required parameter 'body' is set
|
|
5162
5170
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling patchConversationsCallbacks';}return this.apiClient.callApi('/api/v2/conversations/callbacks','PATCH',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
5163
5171
|
* Update a conversation by disconnecting all of the participants
|
|
5164
|
-
*
|
|
5172
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/.
|
|
5165
5173
|
* @param {String} conversationId conversationId
|
|
5166
5174
|
* @param {Object} body Conversation
|
|
5175
|
+
* @deprecated
|
|
5167
5176
|
*/},{key:"patchConversationsChat",value:function patchConversationsChat(conversationId,body){// verify the required parameter 'conversationId' is set
|
|
5168
5177
|
if(conversationId===undefined||conversationId===null){throw'Missing the required parameter "conversationId" when calling patchConversationsChat';}// verify the required parameter 'body' is set
|
|
5169
5178
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling patchConversationsChat';}return this.apiClient.callApi('/api/v2/conversations/chats/{conversationId}','PATCH',{'conversationId':conversationId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
5170
5179
|
* Update conversation participant
|
|
5171
|
-
*
|
|
5180
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/.
|
|
5172
5181
|
* @param {String} conversationId conversationId
|
|
5173
5182
|
* @param {String} participantId participantId
|
|
5174
5183
|
* @param {Object} body Update request
|
|
5184
|
+
* @deprecated
|
|
5175
5185
|
*/},{key:"patchConversationsChatParticipant",value:function patchConversationsChatParticipant(conversationId,participantId,body){// verify the required parameter 'conversationId' is set
|
|
5176
5186
|
if(conversationId===undefined||conversationId===null){throw'Missing the required parameter "conversationId" when calling patchConversationsChatParticipant';}// verify the required parameter 'participantId' is set
|
|
5177
5187
|
if(participantId===undefined||participantId===null){throw'Missing the required parameter "participantId" when calling patchConversationsChatParticipant';}// verify the required parameter 'body' is set
|
|
5178
5188
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling patchConversationsChatParticipant';}return this.apiClient.callApi('/api/v2/conversations/chats/{conversationId}/participants/{participantId}','PATCH',{'conversationId':conversationId,'participantId':participantId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
5179
5189
|
* Update the attributes on a conversation participant.
|
|
5180
|
-
*
|
|
5190
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/.
|
|
5181
5191
|
* @param {String} conversationId conversationId
|
|
5182
5192
|
* @param {String} participantId participantId
|
|
5183
5193
|
* @param {Object} body Participant attributes
|
|
5194
|
+
* @deprecated
|
|
5184
5195
|
*/},{key:"patchConversationsChatParticipantAttributes",value:function patchConversationsChatParticipantAttributes(conversationId,participantId,body){// verify the required parameter 'conversationId' is set
|
|
5185
5196
|
if(conversationId===undefined||conversationId===null){throw'Missing the required parameter "conversationId" when calling patchConversationsChatParticipantAttributes';}// verify the required parameter 'participantId' is set
|
|
5186
5197
|
if(participantId===undefined||participantId===null){throw'Missing the required parameter "participantId" when calling patchConversationsChatParticipantAttributes';}// verify the required parameter 'body' is set
|
|
5187
5198
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling patchConversationsChatParticipantAttributes';}return this.apiClient.callApi('/api/v2/conversations/chats/{conversationId}/participants/{participantId}/attributes','PATCH',{'conversationId':conversationId,'participantId':participantId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
5188
5199
|
* Update conversation participant's communication by disconnecting it.
|
|
5189
|
-
*
|
|
5200
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/.
|
|
5190
5201
|
* @param {String} conversationId conversationId
|
|
5191
5202
|
* @param {String} participantId participantId
|
|
5192
5203
|
* @param {String} communicationId communicationId
|
|
5193
5204
|
* @param {Object} body Participant
|
|
5205
|
+
* @deprecated
|
|
5194
5206
|
*/},{key:"patchConversationsChatParticipantCommunication",value:function patchConversationsChatParticipantCommunication(conversationId,participantId,communicationId,body){// verify the required parameter 'conversationId' is set
|
|
5195
5207
|
if(conversationId===undefined||conversationId===null){throw'Missing the required parameter "conversationId" when calling patchConversationsChatParticipantCommunication';}// verify the required parameter 'participantId' is set
|
|
5196
5208
|
if(participantId===undefined||participantId===null){throw'Missing the required parameter "participantId" when calling patchConversationsChatParticipantCommunication';}// verify the required parameter 'communicationId' is set
|
|
@@ -5659,44 +5671,49 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
5659
5671
|
*/},{key:"postConversationsCalls",value:function postConversationsCalls(body){// verify the required parameter 'body' is set
|
|
5660
5672
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postConversationsCalls';}return this.apiClient.callApi('/api/v2/conversations/calls','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
5661
5673
|
* Send a message on behalf of a communication in a chat conversation.
|
|
5662
|
-
*
|
|
5674
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/.
|
|
5663
5675
|
* @param {String} conversationId conversationId
|
|
5664
5676
|
* @param {String} communicationId communicationId
|
|
5665
5677
|
* @param {Object} body Message
|
|
5678
|
+
* @deprecated
|
|
5666
5679
|
*/},{key:"postConversationsChatCommunicationMessages",value:function postConversationsChatCommunicationMessages(conversationId,communicationId,body){// verify the required parameter 'conversationId' is set
|
|
5667
5680
|
if(conversationId===undefined||conversationId===null){throw'Missing the required parameter "conversationId" when calling postConversationsChatCommunicationMessages';}// verify the required parameter 'communicationId' is set
|
|
5668
5681
|
if(communicationId===undefined||communicationId===null){throw'Missing the required parameter "communicationId" when calling postConversationsChatCommunicationMessages';}// verify the required parameter 'body' is set
|
|
5669
5682
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postConversationsChatCommunicationMessages';}return this.apiClient.callApi('/api/v2/conversations/chats/{conversationId}/communications/{communicationId}/messages','POST',{'conversationId':conversationId,'communicationId':communicationId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
5670
5683
|
* Send a typing-indicator on behalf of a communication in a chat conversation.
|
|
5671
|
-
*
|
|
5684
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/.
|
|
5672
5685
|
* @param {String} conversationId conversationId
|
|
5673
5686
|
* @param {String} communicationId communicationId
|
|
5687
|
+
* @deprecated
|
|
5674
5688
|
*/},{key:"postConversationsChatCommunicationTyping",value:function postConversationsChatCommunicationTyping(conversationId,communicationId){// verify the required parameter 'conversationId' is set
|
|
5675
5689
|
if(conversationId===undefined||conversationId===null){throw'Missing the required parameter "conversationId" when calling postConversationsChatCommunicationTyping';}// verify the required parameter 'communicationId' is set
|
|
5676
5690
|
if(communicationId===undefined||communicationId===null){throw'Missing the required parameter "communicationId" when calling postConversationsChatCommunicationTyping';}return this.apiClient.callApi('/api/v2/conversations/chats/{conversationId}/communications/{communicationId}/typing','POST',{'conversationId':conversationId,'communicationId':communicationId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
5677
5691
|
* Apply wrap-up for this conversation communication
|
|
5678
|
-
*
|
|
5692
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/.
|
|
5679
5693
|
* @param {String} conversationId conversationId
|
|
5680
5694
|
* @param {String} participantId participantId
|
|
5681
5695
|
* @param {String} communicationId communicationId
|
|
5682
5696
|
* @param {Object} opts Optional parameters
|
|
5683
5697
|
* @param {Object} opts.body Wrap-up
|
|
5698
|
+
* @deprecated
|
|
5684
5699
|
*/},{key:"postConversationsChatParticipantCommunicationWrapup",value:function postConversationsChatParticipantCommunicationWrapup(conversationId,participantId,communicationId,opts){opts=opts||{};// verify the required parameter 'conversationId' is set
|
|
5685
5700
|
if(conversationId===undefined||conversationId===null){throw'Missing the required parameter "conversationId" when calling postConversationsChatParticipantCommunicationWrapup';}// verify the required parameter 'participantId' is set
|
|
5686
5701
|
if(participantId===undefined||participantId===null){throw'Missing the required parameter "participantId" when calling postConversationsChatParticipantCommunicationWrapup';}// verify the required parameter 'communicationId' is set
|
|
5687
5702
|
if(communicationId===undefined||communicationId===null){throw'Missing the required parameter "communicationId" when calling postConversationsChatParticipantCommunicationWrapup';}return this.apiClient.callApi('/api/v2/conversations/chats/{conversationId}/participants/{participantId}/communications/{communicationId}/wrapup','POST',{'conversationId':conversationId,'participantId':participantId,'communicationId':communicationId},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
5688
5703
|
* Replace this participant with the specified user and/or address
|
|
5689
|
-
*
|
|
5704
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/.
|
|
5690
5705
|
* @param {String} conversationId conversationId
|
|
5691
5706
|
* @param {String} participantId participantId
|
|
5692
5707
|
* @param {Object} body Transfer request
|
|
5708
|
+
* @deprecated
|
|
5693
5709
|
*/},{key:"postConversationsChatParticipantReplace",value:function postConversationsChatParticipantReplace(conversationId,participantId,body){// verify the required parameter 'conversationId' is set
|
|
5694
5710
|
if(conversationId===undefined||conversationId===null){throw'Missing the required parameter "conversationId" when calling postConversationsChatParticipantReplace';}// verify the required parameter 'participantId' is set
|
|
5695
5711
|
if(participantId===undefined||participantId===null){throw'Missing the required parameter "participantId" when calling postConversationsChatParticipantReplace';}// verify the required parameter 'body' is set
|
|
5696
5712
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postConversationsChatParticipantReplace';}return this.apiClient.callApi('/api/v2/conversations/chats/{conversationId}/participants/{participantId}/replace','POST',{'conversationId':conversationId,'participantId':participantId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
5697
5713
|
* Create a web chat conversation
|
|
5698
|
-
*
|
|
5714
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/.
|
|
5699
5715
|
* @param {Object} body Create web chat request
|
|
5716
|
+
* @deprecated
|
|
5700
5717
|
*/},{key:"postConversationsChats",value:function postConversationsChats(body){// verify the required parameter 'body' is set
|
|
5701
5718
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postConversationsChats';}return this.apiClient.callApi('/api/v2/conversations/chats','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
5702
5719
|
* Apply wrap-up for this conversation communication
|
|
@@ -6023,9 +6040,10 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
6023
6040
|
if(conversationId===undefined||conversationId===null){throw'Missing the required parameter "conversationId" when calling putConversationsCallbackRecordingstate';}// verify the required parameter 'body' is set
|
|
6024
6041
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putConversationsCallbackRecordingstate';}return this.apiClient.callApi('/api/v2/conversations/callbacks/{conversationId}/recordingstate','PUT',{'conversationId':conversationId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
6025
6042
|
* Update a conversation by setting its recording state
|
|
6026
|
-
*
|
|
6043
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-removal-of-acd-web-chat-version-2/.
|
|
6027
6044
|
* @param {String} conversationId conversationId
|
|
6028
6045
|
* @param {Object} body SetRecordingState
|
|
6046
|
+
* @deprecated
|
|
6029
6047
|
*/},{key:"putConversationsChatRecordingstate",value:function putConversationsChatRecordingstate(conversationId,body){// verify the required parameter 'conversationId' is set
|
|
6030
6048
|
if(conversationId===undefined||conversationId===null){throw'Missing the required parameter "conversationId" when calling putConversationsChatRecordingstate';}// verify the required parameter 'body' is set
|
|
6031
6049
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putConversationsChatRecordingstate';}return this.apiClient.callApi('/api/v2/conversations/chats/{conversationId}/recordingstate','PUT',{'conversationId':conversationId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
@@ -6103,7 +6121,7 @@ if(conversationId===undefined||conversationId===null){throw'Missing the required
|
|
|
6103
6121
|
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(){/**
|
|
6104
6122
|
* DataExtensions service.
|
|
6105
6123
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
6106
|
-
* @version
|
|
6124
|
+
* @version 213.1.0
|
|
6107
6125
|
*//**
|
|
6108
6126
|
* Constructs a new DataExtensionsApi.
|
|
6109
6127
|
* @alias module:purecloud-platform-client-v2/api/DataExtensionsApi
|
|
@@ -6124,7 +6142,7 @@ if(coretypeName===undefined||coretypeName===null){throw'Missing the required par
|
|
|
6124
6142
|
*/},{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(){/**
|
|
6125
6143
|
* DataPrivacy service.
|
|
6126
6144
|
* @module purecloud-platform-client-v2/api/DataPrivacyApi
|
|
6127
|
-
* @version
|
|
6145
|
+
* @version 213.1.0
|
|
6128
6146
|
*//**
|
|
6129
6147
|
* Constructs a new DataPrivacyApi.
|
|
6130
6148
|
* @alias module:purecloud-platform-client-v2/api/DataPrivacyApi
|
|
@@ -6164,7 +6182,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
6164
6182
|
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(){/**
|
|
6165
6183
|
* Downloads service.
|
|
6166
6184
|
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
6167
|
-
* @version
|
|
6185
|
+
* @version 213.1.0
|
|
6168
6186
|
*//**
|
|
6169
6187
|
* Constructs a new DownloadsApi.
|
|
6170
6188
|
* @alias module:purecloud-platform-client-v2/api/DownloadsApi
|
|
@@ -6183,7 +6201,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
6183
6201
|
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(){/**
|
|
6184
6202
|
* Emails service.
|
|
6185
6203
|
* @module purecloud-platform-client-v2/api/EmailsApi
|
|
6186
|
-
* @version
|
|
6204
|
+
* @version 213.1.0
|
|
6187
6205
|
*//**
|
|
6188
6206
|
* Constructs a new EmailsApi.
|
|
6189
6207
|
* @alias module:purecloud-platform-client-v2/api/EmailsApi
|
|
@@ -6201,7 +6219,7 @@ if(downloadId===undefined||downloadId===null){throw'Missing the required paramet
|
|
|
6201
6219
|
*/},{key:"patchEmailsSettings",value:function patchEmailsSettings(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/emails/settings','PATCH',{},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var EmployeeEngagementApi=/*#__PURE__*/function(){/**
|
|
6202
6220
|
* EmployeeEngagement service.
|
|
6203
6221
|
* @module purecloud-platform-client-v2/api/EmployeeEngagementApi
|
|
6204
|
-
* @version
|
|
6222
|
+
* @version 213.1.0
|
|
6205
6223
|
*//**
|
|
6206
6224
|
* Constructs a new EmployeeEngagementApi.
|
|
6207
6225
|
* @alias module:purecloud-platform-client-v2/api/EmployeeEngagementApi
|
|
@@ -6239,7 +6257,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
6239
6257
|
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(){/**
|
|
6240
6258
|
* Events service.
|
|
6241
6259
|
* @module purecloud-platform-client-v2/api/EventsApi
|
|
6242
|
-
* @version
|
|
6260
|
+
* @version 213.1.0
|
|
6243
6261
|
*//**
|
|
6244
6262
|
* Constructs a new EventsApi.
|
|
6245
6263
|
* @alias module:purecloud-platform-client-v2/api/EventsApi
|
|
@@ -6264,7 +6282,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
6264
6282
|
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(){/**
|
|
6265
6283
|
* ExternalContacts service.
|
|
6266
6284
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
6267
|
-
* @version
|
|
6285
|
+
* @version 213.1.0
|
|
6268
6286
|
*//**
|
|
6269
6287
|
* Constructs a new ExternalContactsApi.
|
|
6270
6288
|
* @alias module:purecloud-platform-client-v2/api/ExternalContactsApi
|
|
@@ -6856,7 +6874,7 @@ if(relationshipId===undefined||relationshipId===null){throw'Missing the required
|
|
|
6856
6874
|
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(){/**
|
|
6857
6875
|
* Fax service.
|
|
6858
6876
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
6859
|
-
* @version
|
|
6877
|
+
* @version 213.1.0
|
|
6860
6878
|
*//**
|
|
6861
6879
|
* Constructs a new FaxApi.
|
|
6862
6880
|
* @alias module:purecloud-platform-client-v2/api/FaxApi
|
|
@@ -6905,7 +6923,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
6905
6923
|
*/},{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(){/**
|
|
6906
6924
|
* Flows service.
|
|
6907
6925
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
6908
|
-
* @version
|
|
6926
|
+
* @version 213.1.0
|
|
6909
6927
|
*//**
|
|
6910
6928
|
* Constructs a new FlowsApi.
|
|
6911
6929
|
* @alias module:purecloud-platform-client-v2/api/FlowsApi
|
|
@@ -6953,7 +6971,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
6953
6971
|
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(){/**
|
|
6954
6972
|
* Gamification service.
|
|
6955
6973
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
6956
|
-
* @version
|
|
6974
|
+
* @version 213.1.0
|
|
6957
6975
|
*//**
|
|
6958
6976
|
* Constructs a new GamificationApi.
|
|
6959
6977
|
* @alias module:purecloud-platform-client-v2/api/GamificationApi
|
|
@@ -7512,7 +7530,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
7512
7530
|
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(){/**
|
|
7513
7531
|
* GeneralDataProtectionRegulation service.
|
|
7514
7532
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
7515
|
-
* @version
|
|
7533
|
+
* @version 213.1.0
|
|
7516
7534
|
*//**
|
|
7517
7535
|
* Constructs a new GeneralDataProtectionRegulationApi.
|
|
7518
7536
|
* @alias module:purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
@@ -7547,7 +7565,7 @@ if(searchValue===undefined||searchValue===null){throw'Missing the required param
|
|
|
7547
7565
|
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(){/**
|
|
7548
7566
|
* Geolocation service.
|
|
7549
7567
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
7550
|
-
* @version
|
|
7568
|
+
* @version 213.1.0
|
|
7551
7569
|
*//**
|
|
7552
7570
|
* Constructs a new GeolocationApi.
|
|
7553
7571
|
* @alias module:purecloud-platform-client-v2/api/GeolocationApi
|
|
@@ -7581,7 +7599,7 @@ if(clientId===undefined||clientId===null){throw'Missing the required parameter "
|
|
|
7581
7599
|
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(){/**
|
|
7582
7600
|
* Greetings service.
|
|
7583
7601
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
7584
|
-
* @version
|
|
7602
|
+
* @version 213.1.0
|
|
7585
7603
|
*//**
|
|
7586
7604
|
* Constructs a new GreetingsApi.
|
|
7587
7605
|
* @alias module:purecloud-platform-client-v2/api/GreetingsApi
|
|
@@ -7688,7 +7706,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
7688
7706
|
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(){/**
|
|
7689
7707
|
* Groups service.
|
|
7690
7708
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
7691
|
-
* @version
|
|
7709
|
+
* @version 213.1.0
|
|
7692
7710
|
*//**
|
|
7693
7711
|
* Constructs a new GroupsApi.
|
|
7694
7712
|
* @alias module:purecloud-platform-client-v2/api/GroupsApi
|
|
@@ -7710,7 +7728,7 @@ if(groupId===undefined||groupId===null){throw'Missing the required parameter "gr
|
|
|
7710
7728
|
* Remove members
|
|
7711
7729
|
*
|
|
7712
7730
|
* @param {String} groupId Group ID
|
|
7713
|
-
* @param {String} ids Comma separated list of userIds to remove
|
|
7731
|
+
* @param {String} ids Comma separated list of userIds to remove. A maximum of 50 members are allowed per request.
|
|
7714
7732
|
*/},{key:"deleteGroupMembers",value:function deleteGroupMembers(groupId,ids){// verify the required parameter 'groupId' is set
|
|
7715
7733
|
if(groupId===undefined||groupId===null){throw'Missing the required parameter "groupId" when calling deleteGroupMembers';}// verify the required parameter 'ids' is set
|
|
7716
7734
|
if(ids===undefined||ids===null){throw'Missing the required parameter "ids" when calling deleteGroupMembers';}return this.apiClient.callApi('/api/v2/groups/{groupId}/members','DELETE',{'groupId':groupId},{'ids':ids},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
@@ -7821,7 +7839,7 @@ if(groupId===undefined||groupId===null){throw'Missing the required parameter "gr
|
|
|
7821
7839
|
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(){/**
|
|
7822
7840
|
* IdentityProvider service.
|
|
7823
7841
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
7824
|
-
* @version
|
|
7842
|
+
* @version 213.1.0
|
|
7825
7843
|
*//**
|
|
7826
7844
|
* Constructs a new IdentityProviderApi.
|
|
7827
7845
|
* @alias module:purecloud-platform-client-v2/api/IdentityProviderApi
|
|
@@ -7977,7 +7995,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
7977
7995
|
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(){/**
|
|
7978
7996
|
* InfrastructureAsCode service.
|
|
7979
7997
|
* @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
7980
|
-
* @version
|
|
7998
|
+
* @version 213.1.0
|
|
7981
7999
|
*//**
|
|
7982
8000
|
* Constructs a new InfrastructureAsCodeApi.
|
|
7983
8001
|
* @alias module:purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
@@ -8031,7 +8049,7 @@ if(jobId===undefined||jobId===null){throw'Missing the required parameter "jobId"
|
|
|
8031
8049
|
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(){/**
|
|
8032
8050
|
* Integrations service.
|
|
8033
8051
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
8034
|
-
* @version
|
|
8052
|
+
* @version 213.1.0
|
|
8035
8053
|
*//**
|
|
8036
8054
|
* Constructs a new IntegrationsApi.
|
|
8037
8055
|
* @alias module:purecloud-platform-client-v2/api/IntegrationsApi
|
|
@@ -8666,7 +8684,7 @@ if(ucIntegrationId===undefined||ucIntegrationId===null){throw'Missing the requir
|
|
|
8666
8684
|
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(){/**
|
|
8667
8685
|
* Journey service.
|
|
8668
8686
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
8669
|
-
* @version
|
|
8687
|
+
* @version 213.1.0
|
|
8670
8688
|
*//**
|
|
8671
8689
|
* Constructs a new JourneyApi.
|
|
8672
8690
|
* @alias module:purecloud-platform-client-v2/api/JourneyApi
|
|
@@ -9143,7 +9161,7 @@ if(versionId===undefined||versionId===null){throw'Missing the required parameter
|
|
|
9143
9161
|
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(){/**
|
|
9144
9162
|
* Knowledge service.
|
|
9145
9163
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
9146
|
-
* @version
|
|
9164
|
+
* @version 213.1.0
|
|
9147
9165
|
*//**
|
|
9148
9166
|
* Constructs a new KnowledgeApi.
|
|
9149
9167
|
* @alias module:purecloud-platform-client-v2/api/KnowledgeApi
|
|
@@ -10213,7 +10231,7 @@ if(sourceId===undefined||sourceId===null){throw'Missing the required parameter "
|
|
|
10213
10231
|
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(){/**
|
|
10214
10232
|
* LanguageUnderstanding service.
|
|
10215
10233
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
10216
|
-
* @version
|
|
10234
|
+
* @version 213.1.0
|
|
10217
10235
|
*//**
|
|
10218
10236
|
* Constructs a new LanguageUnderstandingApi.
|
|
10219
10237
|
* @alias module:purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
@@ -10472,7 +10490,7 @@ if(domainVersionId===undefined||domainVersionId===null){throw'Missing the requir
|
|
|
10472
10490
|
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(){/**
|
|
10473
10491
|
* Languages service.
|
|
10474
10492
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
10475
|
-
* @version
|
|
10493
|
+
* @version 213.1.0
|
|
10476
10494
|
*//**
|
|
10477
10495
|
* Constructs a new LanguagesApi.
|
|
10478
10496
|
* @alias module:purecloud-platform-client-v2/api/LanguagesApi
|
|
@@ -10527,7 +10545,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
10527
10545
|
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(){/**
|
|
10528
10546
|
* Learning service.
|
|
10529
10547
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
10530
|
-
* @version
|
|
10548
|
+
* @version 213.1.0
|
|
10531
10549
|
*//**
|
|
10532
10550
|
* Constructs a new LearningApi.
|
|
10533
10551
|
* @alias module:purecloud-platform-client-v2/api/LearningApi
|
|
@@ -10798,7 +10816,7 @@ if(moduleId===undefined||moduleId===null){throw'Missing the required parameter "
|
|
|
10798
10816
|
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(){/**
|
|
10799
10817
|
* License service.
|
|
10800
10818
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
10801
|
-
* @version
|
|
10819
|
+
* @version 213.1.0
|
|
10802
10820
|
*//**
|
|
10803
10821
|
* Constructs a new LicenseApi.
|
|
10804
10822
|
* @alias module:purecloud-platform-client-v2/api/LicenseApi
|
|
@@ -10852,7 +10870,7 @@ if(featureName===undefined||featureName===null){throw'Missing the required param
|
|
|
10852
10870
|
*/},{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(){/**
|
|
10853
10871
|
* Locations service.
|
|
10854
10872
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
10855
|
-
* @version
|
|
10873
|
+
* @version 213.1.0
|
|
10856
10874
|
*//**
|
|
10857
10875
|
* Constructs a new LocationsApi.
|
|
10858
10876
|
* @alias module:purecloud-platform-client-v2/api/LocationsApi
|
|
@@ -10911,7 +10929,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
10911
10929
|
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(){/**
|
|
10912
10930
|
* LogCapture service.
|
|
10913
10931
|
* @module purecloud-platform-client-v2/api/LogCaptureApi
|
|
10914
|
-
* @version
|
|
10932
|
+
* @version 213.1.0
|
|
10915
10933
|
*//**
|
|
10916
10934
|
* Constructs a new LogCaptureApi.
|
|
10917
10935
|
* @alias module:purecloud-platform-client-v2/api/LogCaptureApi
|
|
@@ -10961,7 +10979,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
10961
10979
|
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(){/**
|
|
10962
10980
|
* Messaging service.
|
|
10963
10981
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
10964
|
-
* @version
|
|
10982
|
+
* @version 213.1.0
|
|
10965
10983
|
*//**
|
|
10966
10984
|
* Constructs a new MessagingApi.
|
|
10967
10985
|
* @alias module:purecloud-platform-client-v2/api/MessagingApi
|
|
@@ -11051,7 +11069,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
11051
11069
|
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(){/**
|
|
11052
11070
|
* MobileDevices service.
|
|
11053
11071
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
11054
|
-
* @version
|
|
11072
|
+
* @version 213.1.0
|
|
11055
11073
|
*//**
|
|
11056
11074
|
* Constructs a new MobileDevicesApi.
|
|
11057
11075
|
* @alias module:purecloud-platform-client-v2/api/MobileDevicesApi
|
|
@@ -11090,7 +11108,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
11090
11108
|
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(){/**
|
|
11091
11109
|
* Notifications service.
|
|
11092
11110
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
11093
|
-
* @version
|
|
11111
|
+
* @version 213.1.0
|
|
11094
11112
|
*//**
|
|
11095
11113
|
* Constructs a new NotificationsApi.
|
|
11096
11114
|
* @alias module:purecloud-platform-client-v2/api/NotificationsApi
|
|
@@ -11147,7 +11165,7 @@ if(channelId===undefined||channelId===null){throw'Missing the required parameter
|
|
|
11147
11165
|
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(){/**
|
|
11148
11166
|
* OAuth service.
|
|
11149
11167
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
11150
|
-
* @version
|
|
11168
|
+
* @version 213.1.0
|
|
11151
11169
|
*//**
|
|
11152
11170
|
* Constructs a new OAuthApi.
|
|
11153
11171
|
* @alias module:purecloud-platform-client-v2/api/OAuthApi
|
|
@@ -11232,7 +11250,7 @@ if(clientId===undefined||clientId===null){throw'Missing the required parameter "
|
|
|
11232
11250
|
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(){/**
|
|
11233
11251
|
* Objects service.
|
|
11234
11252
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
11235
|
-
* @version
|
|
11253
|
+
* @version 213.1.0
|
|
11236
11254
|
*//**
|
|
11237
11255
|
* Constructs a new ObjectsApi.
|
|
11238
11256
|
* @alias module:purecloud-platform-client-v2/api/ObjectsApi
|
|
@@ -11303,7 +11321,7 @@ if(divisionId===undefined||divisionId===null){throw'Missing the required paramet
|
|
|
11303
11321
|
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(){/**
|
|
11304
11322
|
* OperationalEvents service.
|
|
11305
11323
|
* @module purecloud-platform-client-v2/api/OperationalEventsApi
|
|
11306
|
-
* @version
|
|
11324
|
+
* @version 213.1.0
|
|
11307
11325
|
*//**
|
|
11308
11326
|
* Constructs a new OperationalEventsApi.
|
|
11309
11327
|
* @alias module:purecloud-platform-client-v2/api/OperationalEventsApi
|
|
@@ -11334,7 +11352,7 @@ if(eventDefinitionId===undefined||eventDefinitionId===null){throw'Missing the re
|
|
|
11334
11352
|
*/},{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(){/**
|
|
11335
11353
|
* Organization service.
|
|
11336
11354
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
11337
|
-
* @version
|
|
11355
|
+
* @version 213.1.0
|
|
11338
11356
|
*//**
|
|
11339
11357
|
* Constructs a new OrganizationApi.
|
|
11340
11358
|
* @alias module:purecloud-platform-client-v2/api/OrganizationApi
|
|
@@ -11459,7 +11477,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
11459
11477
|
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(){/**
|
|
11460
11478
|
* OrganizationAuthorization service.
|
|
11461
11479
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
11462
|
-
* @version
|
|
11480
|
+
* @version 213.1.0
|
|
11463
11481
|
*//**
|
|
11464
11482
|
* Constructs a new OrganizationAuthorizationApi.
|
|
11465
11483
|
* @alias module:purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
@@ -11793,7 +11811,7 @@ if(trustorOrgId===undefined||trustorOrgId===null){throw'Missing the required par
|
|
|
11793
11811
|
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(){/**
|
|
11794
11812
|
* Outbound service.
|
|
11795
11813
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
11796
|
-
* @version
|
|
11814
|
+
* @version 213.1.0
|
|
11797
11815
|
*//**
|
|
11798
11816
|
* Constructs a new OutboundApi.
|
|
11799
11817
|
* @alias module:purecloud-platform-client-v2/api/OutboundApi
|
|
@@ -12402,7 +12420,9 @@ if(messagingCampaignId===undefined||messagingCampaignId===null){throw'Missing th
|
|
|
12402
12420
|
* @param {Object} opts.type Campaign Type
|
|
12403
12421
|
* @param {String} opts.senderSmsPhoneNumber Sender SMS Phone Number
|
|
12404
12422
|
* @param {Array.<String>} opts.id A list of messaging campaign ids to bulk fetch
|
|
12405
|
-
|
|
12423
|
+
* @param {String} opts.contentTemplateId Content template ID
|
|
12424
|
+
* @param {Object} opts.campaignStatus Campaign Status
|
|
12425
|
+
*/},{key:"getOutboundMessagingcampaigns",value:function getOutboundMessagingcampaigns(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/outbound/messagingcampaigns','GET',{},{'pageSize':opts['pageSize'],'pageNumber':opts['pageNumber'],'sortBy':opts['sortBy'],'sortOrder':opts['sortOrder'],'name':opts['name'],'contactListId':opts['contactListId'],'divisionId':this.apiClient.buildCollectionParam(opts['divisionId'],'multi'),'type':opts['type'],'senderSmsPhoneNumber':opts['senderSmsPhoneNumber'],'id':this.apiClient.buildCollectionParam(opts['id'],'multi'),'contentTemplateId':opts['contentTemplateId'],'campaignStatus':opts['campaignStatus']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
12406
12426
|
* Get a basic Messaging Campaign information object
|
|
12407
12427
|
* This returns a simplified version of a Messaging Campaign, consisting of id, name, and division.
|
|
12408
12428
|
* @param {String} messagingCampaignId The Messaging Campaign ID
|
|
@@ -12418,7 +12438,9 @@ if(messagingCampaignId===undefined||messagingCampaignId===null){throw'Missing th
|
|
|
12418
12438
|
* @param {Object} opts.type Campaign Type
|
|
12419
12439
|
* @param {Array.<String>} opts.id id
|
|
12420
12440
|
* @param {String} opts.senderSmsPhoneNumber Sender SMS Phone Number
|
|
12421
|
-
|
|
12441
|
+
* @param {String} opts.contentTemplateId Content template ID
|
|
12442
|
+
* @param {Object} opts.campaignStatus Campaign Status
|
|
12443
|
+
*/},{key:"getOutboundMessagingcampaignsDivisionviews",value:function getOutboundMessagingcampaignsDivisionviews(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/outbound/messagingcampaigns/divisionviews','GET',{},{'pageSize':opts['pageSize'],'pageNumber':opts['pageNumber'],'sortOrder':opts['sortOrder'],'name':opts['name'],'type':opts['type'],'id':this.apiClient.buildCollectionParam(opts['id'],'multi'),'senderSmsPhoneNumber':opts['senderSmsPhoneNumber'],'contentTemplateId':opts['contentTemplateId'],'campaignStatus':opts['campaignStatus']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
12422
12444
|
* Get a Rule Set by ID.
|
|
12423
12445
|
*
|
|
12424
12446
|
* @param {String} ruleSetId Rule Set ID
|
|
@@ -12900,7 +12922,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
12900
12922
|
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(){/**
|
|
12901
12923
|
* Presence service.
|
|
12902
12924
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
12903
|
-
* @version
|
|
12925
|
+
* @version 213.1.0
|
|
12904
12926
|
*//**
|
|
12905
12927
|
* Constructs a new PresenceApi.
|
|
12906
12928
|
* @alias module:purecloud-platform-client-v2/api/PresenceApi
|
|
@@ -13073,7 +13095,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
13073
13095
|
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(){/**
|
|
13074
13096
|
* ProcessAutomation service.
|
|
13075
13097
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
13076
|
-
* @version
|
|
13098
|
+
* @version 213.1.0
|
|
13077
13099
|
*//**
|
|
13078
13100
|
* Constructs a new ProcessAutomationApi.
|
|
13079
13101
|
* @alias module:purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
@@ -13136,7 +13158,7 @@ if(triggerId===undefined||triggerId===null){throw'Missing the required parameter
|
|
|
13136
13158
|
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(){/**
|
|
13137
13159
|
* Quality service.
|
|
13138
13160
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
13139
|
-
* @version
|
|
13161
|
+
* @version 213.1.0
|
|
13140
13162
|
*//**
|
|
13141
13163
|
* Constructs a new QualityApi.
|
|
13142
13164
|
* @alias module:purecloud-platform-client-v2/api/QualityApi
|
|
@@ -13615,7 +13637,7 @@ if(customerSurveyUrl===undefined||customerSurveyUrl===null){throw'Missing the re
|
|
|
13615
13637
|
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(){/**
|
|
13616
13638
|
* Recording service.
|
|
13617
13639
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
13618
|
-
* @version
|
|
13640
|
+
* @version 213.1.0
|
|
13619
13641
|
*//**
|
|
13620
13642
|
* Constructs a new RecordingApi.
|
|
13621
13643
|
* @alias module:purecloud-platform-client-v2/api/RecordingApi
|
|
@@ -14027,7 +14049,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
14027
14049
|
*/},{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(){/**
|
|
14028
14050
|
* ResponseManagement service.
|
|
14029
14051
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
14030
|
-
* @version
|
|
14052
|
+
* @version 213.1.0
|
|
14031
14053
|
*//**
|
|
14032
14054
|
* Constructs a new ResponseManagementApi.
|
|
14033
14055
|
* @alias module:purecloud-platform-client-v2/api/ResponseManagementApi
|
|
@@ -14148,7 +14170,7 @@ if(responseAssetId===undefined||responseAssetId===null){throw'Missing the requir
|
|
|
14148
14170
|
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(){/**
|
|
14149
14171
|
* Routing service.
|
|
14150
14172
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
14151
|
-
* @version
|
|
14173
|
+
* @version 213.1.0
|
|
14152
14174
|
*//**
|
|
14153
14175
|
* Constructs a new RoutingApi.
|
|
14154
14176
|
* @alias module:purecloud-platform-client-v2/api/RoutingApi
|
|
@@ -15154,7 +15176,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
15154
15176
|
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(){/**
|
|
15155
15177
|
* SCIM service.
|
|
15156
15178
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
15157
|
-
* @version
|
|
15179
|
+
* @version 213.1.0
|
|
15158
15180
|
*//**
|
|
15159
15181
|
* Constructs a new SCIMApi.
|
|
15160
15182
|
* @alias module:purecloud-platform-client-v2/api/SCIMApi
|
|
@@ -15379,7 +15401,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
15379
15401
|
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(){/**
|
|
15380
15402
|
* ScreenRecording service.
|
|
15381
15403
|
* @module purecloud-platform-client-v2/api/ScreenRecordingApi
|
|
15382
|
-
* @version
|
|
15404
|
+
* @version 213.1.0
|
|
15383
15405
|
*//**
|
|
15384
15406
|
* Constructs a new ScreenRecordingApi.
|
|
15385
15407
|
* @alias module:purecloud-platform-client-v2/api/ScreenRecordingApi
|
|
@@ -15394,7 +15416,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
15394
15416
|
*/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(){/**
|
|
15395
15417
|
* Scripts service.
|
|
15396
15418
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
15397
|
-
* @version
|
|
15419
|
+
* @version 213.1.0
|
|
15398
15420
|
*//**
|
|
15399
15421
|
* Constructs a new ScriptsApi.
|
|
15400
15422
|
* @alias module:purecloud-platform-client-v2/api/ScriptsApi
|
|
@@ -15530,7 +15552,7 @@ if(scriptId===undefined||scriptId===null){throw'Missing the required parameter "
|
|
|
15530
15552
|
*/},{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(){/**
|
|
15531
15553
|
* Search service.
|
|
15532
15554
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
15533
|
-
* @version
|
|
15555
|
+
* @version 213.1.0
|
|
15534
15556
|
*//**
|
|
15535
15557
|
* Constructs a new SearchApi.
|
|
15536
15558
|
* @alias module:purecloud-platform-client-v2/api/SearchApi
|
|
@@ -15702,7 +15724,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
15702
15724
|
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(){/**
|
|
15703
15725
|
* Settings service.
|
|
15704
15726
|
* @module purecloud-platform-client-v2/api/SettingsApi
|
|
15705
|
-
* @version
|
|
15727
|
+
* @version 213.1.0
|
|
15706
15728
|
*//**
|
|
15707
15729
|
* Constructs a new SettingsApi.
|
|
15708
15730
|
* @alias module:purecloud-platform-client-v2/api/SettingsApi
|
|
@@ -15752,7 +15774,7 @@ if(agentId===undefined||agentId===null){throw'Missing the required parameter "ag
|
|
|
15752
15774
|
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(){/**
|
|
15753
15775
|
* SocialMedia service.
|
|
15754
15776
|
* @module purecloud-platform-client-v2/api/SocialMediaApi
|
|
15755
|
-
* @version
|
|
15777
|
+
* @version 213.1.0
|
|
15756
15778
|
*//**
|
|
15757
15779
|
* Constructs a new SocialMediaApi.
|
|
15758
15780
|
* @alias module:purecloud-platform-client-v2/api/SocialMediaApi
|
|
@@ -16017,7 +16039,7 @@ if(topicId===undefined||topicId===null){throw'Missing the required parameter "to
|
|
|
16017
16039
|
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(){/**
|
|
16018
16040
|
* SpeechTextAnalytics service.
|
|
16019
16041
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
16020
|
-
* @version
|
|
16042
|
+
* @version 213.1.0
|
|
16021
16043
|
*//**
|
|
16022
16044
|
* Constructs a new SpeechTextAnalyticsApi.
|
|
16023
16045
|
* @alias module:purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
@@ -16316,7 +16338,7 @@ if(topicId===undefined||topicId===null){throw'Missing the required parameter "to
|
|
|
16316
16338
|
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(){/**
|
|
16317
16339
|
* Stations service.
|
|
16318
16340
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
16319
|
-
* @version
|
|
16341
|
+
* @version 213.1.0
|
|
16320
16342
|
*//**
|
|
16321
16343
|
* Constructs a new StationsApi.
|
|
16322
16344
|
* @alias module:purecloud-platform-client-v2/api/StationsApi
|
|
@@ -16348,7 +16370,7 @@ if(stationId===undefined||stationId===null){throw'Missing the required parameter
|
|
|
16348
16370
|
*/},{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(){/**
|
|
16349
16371
|
* Suggest service.
|
|
16350
16372
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
16351
|
-
* @version
|
|
16373
|
+
* @version 213.1.0
|
|
16352
16374
|
*//**
|
|
16353
16375
|
* Constructs a new SuggestApi.
|
|
16354
16376
|
* @alias module:purecloud-platform-client-v2/api/SuggestApi
|
|
@@ -16388,7 +16410,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
16388
16410
|
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(){/**
|
|
16389
16411
|
* TaskManagement service.
|
|
16390
16412
|
* @module purecloud-platform-client-v2/api/TaskManagementApi
|
|
16391
|
-
* @version
|
|
16413
|
+
* @version 213.1.0
|
|
16392
16414
|
*//**
|
|
16393
16415
|
* Constructs a new TaskManagementApi.
|
|
16394
16416
|
* @alias module:purecloud-platform-client-v2/api/TaskManagementApi
|
|
@@ -16894,7 +16916,7 @@ if(schemaId===undefined||schemaId===null){throw'Missing the required parameter "
|
|
|
16894
16916
|
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(){/**
|
|
16895
16917
|
* Teams service.
|
|
16896
16918
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
16897
|
-
* @version
|
|
16919
|
+
* @version 213.1.0
|
|
16898
16920
|
*//**
|
|
16899
16921
|
* Constructs a new TeamsApi.
|
|
16900
16922
|
* @alias module:purecloud-platform-client-v2/api/TeamsApi
|
|
@@ -16974,7 +16996,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
16974
16996
|
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(){/**
|
|
16975
16997
|
* Telephony service.
|
|
16976
16998
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
16977
|
-
* @version
|
|
16999
|
+
* @version 213.1.0
|
|
16978
17000
|
*//**
|
|
16979
17001
|
* Constructs a new TelephonyApi.
|
|
16980
17002
|
* @alias module:purecloud-platform-client-v2/api/TelephonyApi
|
|
@@ -17021,7 +17043,7 @@ if(downloadId===undefined||downloadId===null){throw'Missing the required paramet
|
|
|
17021
17043
|
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(){/**
|
|
17022
17044
|
* TelephonyProvidersEdge service.
|
|
17023
17045
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
17024
|
-
* @version
|
|
17046
|
+
* @version 213.1.0
|
|
17025
17047
|
*//**
|
|
17026
17048
|
* Constructs a new TelephonyProvidersEdgeApi.
|
|
17027
17049
|
* @alias module:purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
@@ -17856,7 +17878,7 @@ if(trunkBaseSettingsId===undefined||trunkBaseSettingsId===null){throw'Missing th
|
|
|
17856
17878
|
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(){/**
|
|
17857
17879
|
* Textbots service.
|
|
17858
17880
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
17859
|
-
* @version
|
|
17881
|
+
* @version 213.1.0
|
|
17860
17882
|
*//**
|
|
17861
17883
|
* Constructs a new TextbotsApi.
|
|
17862
17884
|
* @alias module:purecloud-platform-client-v2/api/TextbotsApi
|
|
@@ -17891,7 +17913,7 @@ if(launchRequest===undefined||launchRequest===null){throw'Missing the required p
|
|
|
17891
17913
|
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(){/**
|
|
17892
17914
|
* Tokens service.
|
|
17893
17915
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
17894
|
-
* @version
|
|
17916
|
+
* @version 213.1.0
|
|
17895
17917
|
*//**
|
|
17896
17918
|
* Constructs a new TokensApi.
|
|
17897
17919
|
* @alias module:purecloud-platform-client-v2/api/TokensApi
|
|
@@ -17925,7 +17947,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
17925
17947
|
*/},{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(){/**
|
|
17926
17948
|
* Uploads service.
|
|
17927
17949
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
17928
|
-
* @version
|
|
17950
|
+
* @version 213.1.0
|
|
17929
17951
|
*//**
|
|
17930
17952
|
* Constructs a new UploadsApi.
|
|
17931
17953
|
* @alias module:purecloud-platform-client-v2/api/UploadsApi
|
|
@@ -17991,7 +18013,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
17991
18013
|
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(){/**
|
|
17992
18014
|
* Usage service.
|
|
17993
18015
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
17994
|
-
* @version
|
|
18016
|
+
* @version 213.1.0
|
|
17995
18017
|
*//**
|
|
17996
18018
|
* Constructs a new UsageApi.
|
|
17997
18019
|
* @alias module:purecloud-platform-client-v2/api/UsageApi
|
|
@@ -18045,7 +18067,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
18045
18067
|
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(){/**
|
|
18046
18068
|
* UserRecordings service.
|
|
18047
18069
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
18048
|
-
* @version
|
|
18070
|
+
* @version 213.1.0
|
|
18049
18071
|
*//**
|
|
18050
18072
|
* Constructs a new UserRecordingsApi.
|
|
18051
18073
|
* @alias module:purecloud-platform-client-v2/api/UserRecordingsApi
|
|
@@ -18102,7 +18124,7 @@ if(recordingId===undefined||recordingId===null){throw'Missing the required param
|
|
|
18102
18124
|
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(){/**
|
|
18103
18125
|
* Users service.
|
|
18104
18126
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
18105
|
-
* @version
|
|
18127
|
+
* @version 213.1.0
|
|
18106
18128
|
*//**
|
|
18107
18129
|
* Constructs a new UsersApi.
|
|
18108
18130
|
* @alias module:purecloud-platform-client-v2/api/UsersApi
|
|
@@ -18799,7 +18821,7 @@ if(verifierId===undefined||verifierId===null){throw'Missing the required paramet
|
|
|
18799
18821
|
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(){/**
|
|
18800
18822
|
* Utilities service.
|
|
18801
18823
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
18802
|
-
* @version
|
|
18824
|
+
* @version 213.1.0
|
|
18803
18825
|
*//**
|
|
18804
18826
|
* Constructs a new UtilitiesApi.
|
|
18805
18827
|
* @alias module:purecloud-platform-client-v2/api/UtilitiesApi
|
|
@@ -18826,7 +18848,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
18826
18848
|
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(){/**
|
|
18827
18849
|
* Voicemail service.
|
|
18828
18850
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
18829
|
-
* @version
|
|
18851
|
+
* @version 213.1.0
|
|
18830
18852
|
*//**
|
|
18831
18853
|
* Constructs a new VoicemailApi.
|
|
18832
18854
|
* @alias module:purecloud-platform-client-v2/api/VoicemailApi
|
|
@@ -18988,7 +19010,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
18988
19010
|
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(){/**
|
|
18989
19011
|
* WebChat service.
|
|
18990
19012
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
18991
|
-
* @version
|
|
19013
|
+
* @version 213.1.0
|
|
18992
19014
|
*//**
|
|
18993
19015
|
* Constructs a new WebChatApi.
|
|
18994
19016
|
* @alias module:purecloud-platform-client-v2/api/WebChatApi
|
|
@@ -19123,7 +19145,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
19123
19145
|
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(){/**
|
|
19124
19146
|
* WebDeployments service.
|
|
19125
19147
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
19126
|
-
* @version
|
|
19148
|
+
* @version 213.1.0
|
|
19127
19149
|
*//**
|
|
19128
19150
|
* Constructs a new WebDeploymentsApi.
|
|
19129
19151
|
* @alias module:purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
@@ -19244,7 +19266,7 @@ if(deploymentId===undefined||deploymentId===null){throw'Missing the required par
|
|
|
19244
19266
|
if(deployment===undefined||deployment===null){throw'Missing the required parameter "deployment" when calling putWebdeploymentsDeployment';}return this.apiClient.callApi('/api/v2/webdeployments/deployments/{deploymentId}','PUT',{'deploymentId':deploymentId},{},{},{},deployment,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var WebMessagingApi=/*#__PURE__*/function(){/**
|
|
19245
19267
|
* WebMessaging service.
|
|
19246
19268
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
19247
|
-
* @version
|
|
19269
|
+
* @version 213.1.0
|
|
19248
19270
|
*//**
|
|
19249
19271
|
* Constructs a new WebMessagingApi.
|
|
19250
19272
|
* @alias module:purecloud-platform-client-v2/api/WebMessagingApi
|
|
@@ -19260,7 +19282,7 @@ if(deployment===undefined||deployment===null){throw'Missing the required paramet
|
|
|
19260
19282
|
*/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(){/**
|
|
19261
19283
|
* Widgets service.
|
|
19262
19284
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
19263
|
-
* @version
|
|
19285
|
+
* @version 213.1.0
|
|
19264
19286
|
*//**
|
|
19265
19287
|
* Constructs a new WidgetsApi.
|
|
19266
19288
|
* @alias module:purecloud-platform-client-v2/api/WidgetsApi
|
|
@@ -19295,7 +19317,7 @@ if(deploymentId===undefined||deploymentId===null){throw'Missing the required par
|
|
|
19295
19317
|
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(){/**
|
|
19296
19318
|
* WorkforceManagement service.
|
|
19297
19319
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
19298
|
-
* @version
|
|
19320
|
+
* @version 213.1.0
|
|
19299
19321
|
*//**
|
|
19300
19322
|
* Constructs a new WorkforceManagementApi.
|
|
19301
19323
|
* @alias module:purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
@@ -19905,6 +19927,11 @@ if(calendarId===undefined||calendarId===null){throw'Missing the required paramet
|
|
|
19905
19927
|
* Retrieves status of the historical data imports of the organization
|
|
19906
19928
|
*
|
|
19907
19929
|
*/},{key:"getWorkforcemanagementHistoricaldataImportstatus",value:function getWorkforcemanagementHistoricaldataImportstatus(){return this.apiClient.callApi('/api/v2/workforcemanagement/historicaldata/importstatus','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
19930
|
+
* Retrieves status of the historical data imports associated with job id
|
|
19931
|
+
*
|
|
19932
|
+
* @param {String} jobId The job Id of the historical data import request
|
|
19933
|
+
*/},{key:"getWorkforcemanagementHistoricaldataImportstatusJobId",value:function getWorkforcemanagementHistoricaldataImportstatusJobId(jobId){// verify the required parameter 'jobId' is set
|
|
19934
|
+
if(jobId===undefined||jobId===null){throw'Missing the required parameter "jobId" when calling getWorkforcemanagementHistoricaldataImportstatusJobId';}return this.apiClient.callApi('/api/v2/workforcemanagement/historicaldata/importstatus/{jobId}','GET',{'jobId':jobId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
19908
19935
|
* Get integrations
|
|
19909
19936
|
*
|
|
19910
19937
|
*/},{key:"getWorkforcemanagementIntegrationsHris",value:function getWorkforcemanagementIntegrationsHris(){return this.apiClient.callApi('/api/v2/workforcemanagement/integrations/hris','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
@@ -21096,7 +21123,7 @@ if(timeOffLimitId===undefined||timeOffLimitId===null){throw'Missing the required
|
|
|
21096
21123
|
* </pre>
|
|
21097
21124
|
* </p>
|
|
21098
21125
|
* @module purecloud-platform-client-v2/index
|
|
21099
|
-
* @version
|
|
21126
|
+
* @version 213.1.0
|
|
21100
21127
|
*/var platformClient=/*#__PURE__*/_createClass(function platformClient(){_classCallCheck(this,platformClient);/**
|
|
21101
21128
|
* The ApiClient constructor.
|
|
21102
21129
|
* @property {module:purecloud-platform-client-v2/ApiClient}
|