purecloud-platform-client-v2 188.0.1 → 189.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +2 -2
- package/dist/node/purecloud-platform-client-v2.js +1059 -113
- package/dist/web-amd/purecloud-platform-client-v2.js +1059 -113
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +340 -115
- package/dist/web-cjs/purecloud-platform-client-v2.js +359 -122
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +727 -7
- package/package.json +1 -1
- package/src/purecloud-platform-client-v2/ApiClient.js +1 -1
- package/src/purecloud-platform-client-v2/api/AlertingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +1 -2
- package/src/purecloud-platform-client-v2/api/ArchitectApi.js +298 -6
- 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 +13 -9
- package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/DownloadsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EmailsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EventsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +5 -5
- package/src/purecloud-platform-client-v2/api/FaxApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/FlowsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GamificationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GeolocationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GreetingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GroupsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/IdentityProviderApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/InfrastructureAsCodeApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +240 -11
- package/src/purecloud-platform-client-v2/api/JourneyApi.js +187 -1
- package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +161 -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 +4 -4
- 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 +48 -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 +27 -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 -3
- 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 +4 -3
- package/src/purecloud-platform-client-v2/index.js +1 -1
package/dist/web-cjs/bundle.js
CHANGED
|
@@ -847,7 +847,7 @@ if(env)this.environment=env;else this.environment=this.host?this.host:'mypureclo
|
|
|
847
847
|
this.environment=this.environment.replace(/\/+$/,'');// Strip protocol and subdomain
|
|
848
848
|
if(this.environment.startsWith('https://'))this.environment=this.environment.substring(8);if(this.environment.startsWith('http://'))this.environment=this.environment.substring(7);if(this.environment.startsWith('api.'))this.environment=this.environment.substring(4);this.basePath="https://api.".concat(this.environment);this.authUrl="https://login.".concat(this.environment);}},{key:"getConfigString",value:function getConfigString(section,key){if(this.config._sections[section])return this.config._sections[section][key];}},{key:"getConfigBoolean",value:function getConfigBoolean(section,key){if(this.config._sections[section]&&this.config._sections[section][key]!==undefined){if(typeof this.config._sections[section][key]==='string'){return this.config._sections[section][key]==='true';}else return this.config._sections[section][key];}}},{key:"getConfigInt",value:function getConfigInt(section,key){if(this.config._sections[section]&&this.config._sections[section][key]){if(typeof this.config._sections[section][key]==='string'){return parseInt(this.config._sections[section][key]);}else return this.config._sections[section][key];}}}]);return Configuration;}();/**
|
|
849
849
|
* @module purecloud-platform-client-v2/ApiClient
|
|
850
|
-
* @version
|
|
850
|
+
* @version 189.0.0
|
|
851
851
|
*/var ApiClient=/*#__PURE__*/function(){/**
|
|
852
852
|
* Manages low level client-server communications, parameter marshalling, etc. There should not be any need for an
|
|
853
853
|
* application to use this class directly - the *Api and model classes provide the public API for the service. The
|
|
@@ -1159,7 +1159,7 @@ resolve(data);})["catch"](function(error){var data=error;if(error.response&&erro
|
|
|
1159
1159
|
that.config.logger.log('error',error.response.status,httpMethod,url,request.headers,error.response.headers,bodyParam,error.response.data);data=that.returnExtended===true?{status:error.response.status,statusText:error.response.statusText,headers:error.response.headers,body:error.response.data,text:error.response.text,error:error}:error.response.data?error.response.data:error.response.text;}reject(data);});}});}}]);return ApiClient;}();var AlertingApi=/*#__PURE__*/function(){/**
|
|
1160
1160
|
* Alerting service.
|
|
1161
1161
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
1162
|
-
* @version
|
|
1162
|
+
* @version 189.0.0
|
|
1163
1163
|
*/ /**
|
|
1164
1164
|
* Constructs a new AlertingApi.
|
|
1165
1165
|
* @alias module:purecloud-platform-client-v2/api/AlertingApi
|
|
@@ -1316,7 +1316,7 @@ if(ruleId===undefined||ruleId===null){throw'Missing the required parameter "rule
|
|
|
1316
1316
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putAlertingRule';}return this.apiClient.callApi('/api/v2/alerting/rules/{ruleId}','PUT',{'ruleId':ruleId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return AlertingApi;}();var AnalyticsApi=/*#__PURE__*/function(){/**
|
|
1317
1317
|
* Analytics service.
|
|
1318
1318
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
1319
|
-
* @version
|
|
1319
|
+
* @version 189.0.0
|
|
1320
1320
|
*/ /**
|
|
1321
1321
|
* Constructs a new AnalyticsApi.
|
|
1322
1322
|
* @alias module:purecloud-platform-client-v2/api/AnalyticsApi
|
|
@@ -1789,7 +1789,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
1789
1789
|
* Query for knowledge aggregates
|
|
1790
1790
|
*
|
|
1791
1791
|
* @param {Object} body query
|
|
1792
|
-
* postAnalyticsKnowledgeAggregatesQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
1793
1792
|
*/},{key:"postAnalyticsKnowledgeAggregatesQuery",value:function postAnalyticsKnowledgeAggregatesQuery(body){// verify the required parameter 'body' is set
|
|
1794
1793
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postAnalyticsKnowledgeAggregatesQuery';}return this.apiClient.callApi('/api/v2/analytics/knowledge/aggregates/query','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
1795
1794
|
* Query for queue observations
|
|
@@ -1927,7 +1926,7 @@ if(scheduleId===undefined||scheduleId===null){throw'Missing the required paramet
|
|
|
1927
1926
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putAnalyticsReportingSchedule';}return this.apiClient.callApi('/api/v2/analytics/reporting/schedules/{scheduleId}','PUT',{'scheduleId':scheduleId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return AnalyticsApi;}();var ArchitectApi=/*#__PURE__*/function(){/**
|
|
1928
1927
|
* Architect service.
|
|
1929
1928
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
1930
|
-
* @version
|
|
1929
|
+
* @version 189.0.0
|
|
1931
1930
|
*/ /**
|
|
1932
1931
|
* Constructs a new ArchitectApi.
|
|
1933
1932
|
* @alias module:purecloud-platform-client-v2/api/ArchitectApi
|
|
@@ -2023,6 +2022,12 @@ if(languageCode===undefined||languageCode===null){throw'Missing the required par
|
|
|
2023
2022
|
* @param {String} flowId Flow ID
|
|
2024
2023
|
*/},{key:"deleteFlow",value:function deleteFlow(flowId){// verify the required parameter 'flowId' is set
|
|
2025
2024
|
if(flowId===undefined||flowId===null){throw'Missing the required parameter "flowId" when calling deleteFlow';}return this.apiClient.callApi('/api/v2/flows/{flowId}','DELETE',{'flowId':flowId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
2025
|
+
* Deletes a log level for a flow by flow id.
|
|
2026
|
+
* Deletes the associated log level for a flow by flow id
|
|
2027
|
+
* @param {String} flowId The flow id to delete the loglevel for
|
|
2028
|
+
* deleteFlowInstancesSettingsLoglevels is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2029
|
+
*/},{key:"deleteFlowInstancesSettingsLoglevels",value:function deleteFlowInstancesSettingsLoglevels(flowId){// verify the required parameter 'flowId' is set
|
|
2030
|
+
if(flowId===undefined||flowId===null){throw'Missing the required parameter "flowId" when calling deleteFlowInstancesSettingsLoglevels';}return this.apiClient.callApi('/api/v2/flows/{flowId}/instances/settings/loglevels','DELETE',{'flowId':flowId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
2026
2031
|
* Batch-delete a list of flows
|
|
2027
2032
|
* Multiple IDs can be specified, in which case all specified flows will be deleted. Asynchronous. Notification topic: v2.flows.{flowId}
|
|
2028
2033
|
* @param {Array.<String>} id List of Flow IDs
|
|
@@ -2042,6 +2047,10 @@ if(datatableId===undefined||datatableId===null){throw'Missing the required param
|
|
|
2042
2047
|
*/},{key:"deleteFlowsDatatableRow",value:function deleteFlowsDatatableRow(datatableId,rowId){// verify the required parameter 'datatableId' is set
|
|
2043
2048
|
if(datatableId===undefined||datatableId===null){throw'Missing the required parameter "datatableId" when calling deleteFlowsDatatableRow';}// verify the required parameter 'rowId' is set
|
|
2044
2049
|
if(rowId===undefined||rowId===null){throw'Missing the required parameter "rowId" when calling deleteFlowsDatatableRow';}return this.apiClient.callApi('/api/v2/flows/datatables/{datatableId}/rows/{rowId}','DELETE',{'datatableId':datatableId,'rowId':rowId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
2050
|
+
* Resets the org log level to default, base
|
|
2051
|
+
* Resets the org log level to default, base
|
|
2052
|
+
* deleteFlowsInstancesSettingsLoglevelsDefault is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2053
|
+
*/},{key:"deleteFlowsInstancesSettingsLoglevelsDefault",value:function deleteFlowsInstancesSettingsLoglevelsDefault(){return this.apiClient.callApi('/api/v2/flows/instances/settings/loglevels/default','DELETE',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
2045
2054
|
* Delete a flow milestone.
|
|
2046
2055
|
*
|
|
2047
2056
|
* @param {String} milestoneId flow milestone ID
|
|
@@ -2393,6 +2402,14 @@ if(flowId===undefined||flowId===null){throw'Missing the required parameter "flow
|
|
|
2393
2402
|
*/},{key:"getFlowHistoryHistoryId",value:function getFlowHistoryHistoryId(flowId,historyId,opts){opts=opts||{};// verify the required parameter 'flowId' is set
|
|
2394
2403
|
if(flowId===undefined||flowId===null){throw'Missing the required parameter "flowId" when calling getFlowHistoryHistoryId';}// verify the required parameter 'historyId' is set
|
|
2395
2404
|
if(historyId===undefined||historyId===null){throw'Missing the required parameter "historyId" when calling getFlowHistoryHistoryId';}return this.apiClient.callApi('/api/v2/flows/{flowId}/history/{historyId}','GET',{'flowId':flowId,'historyId':historyId},{'pageNumber':opts['pageNumber'],'pageSize':opts['pageSize'],'sortOrder':opts['sortOrder'],'sortBy':opts['sortBy'],'action':this.apiClient.buildCollectionParam(opts['action'],'multi')},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
2405
|
+
* Retrieves the log level for a flow by flow id.
|
|
2406
|
+
* Retrieves the log level for a flow by flow id.
|
|
2407
|
+
* @param {String} flowId The flow id to get the loglevel for
|
|
2408
|
+
* @param {Object} opts Optional parameters
|
|
2409
|
+
* @param {Array.<String>} opts.expand Expand instructions for the result
|
|
2410
|
+
* getFlowInstancesSettingsLoglevels is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2411
|
+
*/},{key:"getFlowInstancesSettingsLoglevels",value:function getFlowInstancesSettingsLoglevels(flowId,opts){opts=opts||{};// verify the required parameter 'flowId' is set
|
|
2412
|
+
if(flowId===undefined||flowId===null){throw'Missing the required parameter "flowId" when calling getFlowInstancesSettingsLoglevels';}return this.apiClient.callApi('/api/v2/flows/{flowId}/instances/settings/loglevels','GET',{'flowId':flowId},{'expand':this.apiClient.buildCollectionParam(opts['expand'],'multi')},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
2396
2413
|
* Get the latest configuration for flow
|
|
2397
2414
|
*
|
|
2398
2415
|
* @param {String} flowId Flow ID
|
|
@@ -2586,21 +2603,40 @@ if(flowExecutionId===undefined||flowExecutionId===null){throw'Missing the requir
|
|
|
2586
2603
|
* @param {String} instanceId Instance ID
|
|
2587
2604
|
* @param {Object} opts Optional parameters
|
|
2588
2605
|
* @param {Object} opts.expand Expand various details.
|
|
2589
|
-
* getFlowsInstance is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2590
2606
|
*/},{key:"getFlowsInstance",value:function getFlowsInstance(instanceId,opts){opts=opts||{};// verify the required parameter 'instanceId' is set
|
|
2591
2607
|
if(instanceId===undefined||instanceId===null){throw'Missing the required parameter "instanceId" when calling getFlowsInstance';}return this.apiClient.callApi('/api/v2/flows/instances/{instanceId}','GET',{'instanceId':instanceId},{'expand':opts['expand']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
2592
2608
|
* Get the status and/or results of an asynchronous flow execution data retrieval job
|
|
2593
2609
|
*
|
|
2594
2610
|
* @param {String} jobId The asynchronous job ID
|
|
2595
|
-
* getFlowsInstancesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2596
2611
|
*/},{key:"getFlowsInstancesJob",value:function getFlowsInstancesJob(jobId){// verify the required parameter 'jobId' is set
|
|
2597
2612
|
if(jobId===undefined||jobId===null){throw'Missing the required parameter "jobId" when calling getFlowsInstancesJob';}return this.apiClient.callApi('/api/v2/flows/instances/jobs/{jobId}','GET',{'jobId':jobId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
2598
2613
|
* Retrieve a list of capabilities that the org can use to query for execution data
|
|
2599
2614
|
* Returns the queryable parameters that can be used to build a query for execution data.
|
|
2600
2615
|
* @param {Object} opts Optional parameters
|
|
2601
2616
|
* @param {Object} opts.expand Expand various query types.
|
|
2602
|
-
* getFlowsInstancesQuerycapabilities is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2603
2617
|
*/},{key:"getFlowsInstancesQuerycapabilities",value:function getFlowsInstancesQuerycapabilities(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/flows/instances/querycapabilities','GET',{},{'expand':opts['expand']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
2618
|
+
* Get the execution history enabled setting.
|
|
2619
|
+
* Get the execution history enabled setting.
|
|
2620
|
+
* getFlowsInstancesSettingsExecutiondata is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2621
|
+
*/},{key:"getFlowsInstancesSettingsExecutiondata",value:function getFlowsInstancesSettingsExecutiondata(){return this.apiClient.callApi('/api/v2/flows/instances/settings/executiondata','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
2622
|
+
* Retrieve a list of LogLevels for the organization.
|
|
2623
|
+
* Returns a paged set of LogLevels per flow id
|
|
2624
|
+
* @param {Object} opts Optional parameters
|
|
2625
|
+
* @param {Array.<String>} opts.expand Expand instructions for the result
|
|
2626
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
2627
|
+
* @param {Number} opts.pageSize Number of entities to return. Maximum of 200. (default to 25)
|
|
2628
|
+
* getFlowsInstancesSettingsLoglevels is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2629
|
+
*/},{key:"getFlowsInstancesSettingsLoglevels",value:function getFlowsInstancesSettingsLoglevels(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/flows/instances/settings/loglevels','GET',{},{'expand':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'pageNumber':opts['pageNumber'],'pageSize':opts['pageSize']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
2630
|
+
* Gets the available flow log level characteristics for this organization.
|
|
2631
|
+
* Log levels can be customized and this returns the set of available characteristics that can be enabled/disabled.
|
|
2632
|
+
* getFlowsInstancesSettingsLoglevelsCharacteristics is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2633
|
+
*/},{key:"getFlowsInstancesSettingsLoglevelsCharacteristics",value:function getFlowsInstancesSettingsLoglevelsCharacteristics(){return this.apiClient.callApi('/api/v2/flows/instances/settings/loglevels/characteristics','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
2634
|
+
* Returns the flow default log level.
|
|
2635
|
+
* Returns the flow default log level which will be used if no specific flow id log level is found.
|
|
2636
|
+
* @param {Object} opts Optional parameters
|
|
2637
|
+
* @param {Array.<String>} opts.expand Expand instructions for the result
|
|
2638
|
+
* getFlowsInstancesSettingsLoglevelsDefault is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2639
|
+
*/},{key:"getFlowsInstancesSettingsLoglevelsDefault",value:function getFlowsInstancesSettingsLoglevelsDefault(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/flows/instances/settings/loglevels/default','GET',{},{'expand':this.apiClient.buildCollectionParam(opts['expand'],'multi')},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
2604
2640
|
* Fetch Architect Job Status
|
|
2605
2641
|
*
|
|
2606
2642
|
* @param {String} jobId Job ID
|
|
@@ -2684,6 +2720,12 @@ if(grammarId===undefined||grammarId===null){throw'Missing the required parameter
|
|
|
2684
2720
|
*/},{key:"patchArchitectGrammarLanguage",value:function patchArchitectGrammarLanguage(grammarId,languageCode,opts){opts=opts||{};// verify the required parameter 'grammarId' is set
|
|
2685
2721
|
if(grammarId===undefined||grammarId===null){throw'Missing the required parameter "grammarId" when calling patchArchitectGrammarLanguage';}// verify the required parameter 'languageCode' is set
|
|
2686
2722
|
if(languageCode===undefined||languageCode===null){throw'Missing the required parameter "languageCode" when calling patchArchitectGrammarLanguage';}return this.apiClient.callApi('/api/v2/architect/grammars/{grammarId}/languages/{languageCode}','PATCH',{'grammarId':grammarId,'languageCode':languageCode},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
2723
|
+
* Edit the execution history enabled setting.
|
|
2724
|
+
* Edit the execution history enabled setting.
|
|
2725
|
+
* @param {Object} body New Execution Data Setting
|
|
2726
|
+
* patchFlowsInstancesSettingsExecutiondata is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2727
|
+
*/},{key:"patchFlowsInstancesSettingsExecutiondata",value:function patchFlowsInstancesSettingsExecutiondata(body){// verify the required parameter 'body' is set
|
|
2728
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling patchFlowsInstancesSettingsExecutiondata';}return this.apiClient.callApi('/api/v2/flows/instances/settings/executiondata','PATCH',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
2687
2729
|
* Rebuild Dependency Tracking data for an organization
|
|
2688
2730
|
* Asynchronous. Notification topic: v2.architect.dependencytracking.build
|
|
2689
2731
|
*/},{key:"postArchitectDependencytrackingBuild",value:function postArchitectDependencytrackingBuild(){return this.apiClient.callApi('/api/v2/architect/dependencytracking/build','POST',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
@@ -2775,6 +2817,16 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
2775
2817
|
* @param {String} flowId Flow ID
|
|
2776
2818
|
*/},{key:"postFlowHistory",value:function postFlowHistory(flowId){// verify the required parameter 'flowId' is set
|
|
2777
2819
|
if(flowId===undefined||flowId===null){throw'Missing the required parameter "flowId" when calling postFlowHistory';}return this.apiClient.callApi('/api/v2/flows/{flowId}/history','POST',{'flowId':flowId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
2820
|
+
* Set the logLevel for a particular flow id
|
|
2821
|
+
* Assigns a new loglevel to a flow id
|
|
2822
|
+
* @param {String} flowId The flow id to set the loglevel for
|
|
2823
|
+
* @param {Object} body New LogLevel settings
|
|
2824
|
+
* @param {Object} opts Optional parameters
|
|
2825
|
+
* @param {Array.<String>} opts.expand Expand instructions for the result
|
|
2826
|
+
* postFlowInstancesSettingsLoglevels is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2827
|
+
*/},{key:"postFlowInstancesSettingsLoglevels",value:function postFlowInstancesSettingsLoglevels(flowId,body,opts){opts=opts||{};// verify the required parameter 'flowId' is set
|
|
2828
|
+
if(flowId===undefined||flowId===null){throw'Missing the required parameter "flowId" when calling postFlowInstancesSettingsLoglevels';}// verify the required parameter 'body' is set
|
|
2829
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postFlowInstancesSettingsLoglevels';}return this.apiClient.callApi('/api/v2/flows/{flowId}/instances/settings/loglevels','POST',{'flowId':flowId},{'expand':this.apiClient.buildCollectionParam(opts['expand'],'multi')},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
2778
2830
|
* Create flow version
|
|
2779
2831
|
*
|
|
2780
2832
|
* @param {String} flowId Flow ID
|
|
@@ -2855,7 +2907,6 @@ if(flowLaunchRequest===undefined||flowLaunchRequest===null){throw'Missing the re
|
|
|
2855
2907
|
* @param {Object} body Requested Flow Ids
|
|
2856
2908
|
* @param {Object} opts Optional parameters
|
|
2857
2909
|
* @param {Object} opts.expand Expand various query types.
|
|
2858
|
-
* postFlowsInstancesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2859
2910
|
*/},{key:"postFlowsInstancesJobs",value:function postFlowsInstancesJobs(body,opts){opts=opts||{};// verify the required parameter 'body' is set
|
|
2860
2911
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postFlowsInstancesJobs';}return this.apiClient.callApi('/api/v2/flows/instances/jobs','POST',{},{'expand':opts['expand']},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
2861
2912
|
* Query the database of existing flow histories to look for particular flow criteria
|
|
@@ -2864,7 +2915,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
2864
2915
|
* @param {Object} opts Optional parameters
|
|
2865
2916
|
* @param {Boolean} opts.indexOnly indexes only
|
|
2866
2917
|
* @param {Number} opts.pageSize number of results to return (default to 50)
|
|
2867
|
-
* postFlowsInstancesQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2868
2918
|
*/},{key:"postFlowsInstancesQuery",value:function postFlowsInstancesQuery(body,opts){opts=opts||{};// verify the required parameter 'body' is set
|
|
2869
2919
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postFlowsInstancesQuery';}return this.apiClient.callApi('/api/v2/flows/instances/query','POST',{},{'indexOnly':opts['indexOnly'],'pageSize':opts['pageSize']},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
2870
2920
|
* Register Architect Job. Returns a URL where a file, such as an Architect flow YAML file, can be PUT which will then initiate the job.
|
|
@@ -2940,6 +2990,16 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
2940
2990
|
*/},{key:"putFlow",value:function putFlow(flowId,body){// verify the required parameter 'flowId' is set
|
|
2941
2991
|
if(flowId===undefined||flowId===null){throw'Missing the required parameter "flowId" when calling putFlow';}// verify the required parameter 'body' is set
|
|
2942
2992
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putFlow';}return this.apiClient.callApi('/api/v2/flows/{flowId}','PUT',{'flowId':flowId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
2993
|
+
* Edit the logLevel for a particular flow id
|
|
2994
|
+
* Updates the loglevel for a flow id
|
|
2995
|
+
* @param {String} flowId The flow id to edit the loglevel for
|
|
2996
|
+
* @param {Object} body New LogLevel settings
|
|
2997
|
+
* @param {Object} opts Optional parameters
|
|
2998
|
+
* @param {Array.<String>} opts.expand Expand instructions for the result
|
|
2999
|
+
* putFlowInstancesSettingsLoglevels is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
3000
|
+
*/},{key:"putFlowInstancesSettingsLoglevels",value:function putFlowInstancesSettingsLoglevels(flowId,body,opts){opts=opts||{};// verify the required parameter 'flowId' is set
|
|
3001
|
+
if(flowId===undefined||flowId===null){throw'Missing the required parameter "flowId" when calling putFlowInstancesSettingsLoglevels';}// verify the required parameter 'body' is set
|
|
3002
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putFlowInstancesSettingsLoglevels';}return this.apiClient.callApi('/api/v2/flows/{flowId}/instances/settings/loglevels','PUT',{'flowId':flowId},{'expand':this.apiClient.buildCollectionParam(opts['expand'],'multi')},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
2943
3003
|
* Updates a specific datatable by id
|
|
2944
3004
|
* Updates a schema for a datatable with the given datatableId -updates allow only new fields to be added in the schema, no changes or removals of existing fields.
|
|
2945
3005
|
* @param {String} datatableId id of datatable
|
|
@@ -2958,6 +3018,14 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
2958
3018
|
*/},{key:"putFlowsDatatableRow",value:function putFlowsDatatableRow(datatableId,rowId,opts){opts=opts||{};// verify the required parameter 'datatableId' is set
|
|
2959
3019
|
if(datatableId===undefined||datatableId===null){throw'Missing the required parameter "datatableId" when calling putFlowsDatatableRow';}// verify the required parameter 'rowId' is set
|
|
2960
3020
|
if(rowId===undefined||rowId===null){throw'Missing the required parameter "rowId" when calling putFlowsDatatableRow';}return this.apiClient.callApi('/api/v2/flows/datatables/{datatableId}/rows/{rowId}','PUT',{'datatableId':datatableId,'rowId':rowId},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
3021
|
+
* Edit the flow default log level.
|
|
3022
|
+
* Edit the flow default log level.
|
|
3023
|
+
* @param {Object} body New LogLevel settings
|
|
3024
|
+
* @param {Object} opts Optional parameters
|
|
3025
|
+
* @param {Array.<String>} opts.expand Expand instructions for the result
|
|
3026
|
+
* putFlowsInstancesSettingsLoglevelsDefault is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
3027
|
+
*/},{key:"putFlowsInstancesSettingsLoglevelsDefault",value:function putFlowsInstancesSettingsLoglevelsDefault(body,opts){opts=opts||{};// verify the required parameter 'body' is set
|
|
3028
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putFlowsInstancesSettingsLoglevelsDefault';}return this.apiClient.callApi('/api/v2/flows/instances/settings/loglevels/default','PUT',{},{'expand':this.apiClient.buildCollectionParam(opts['expand'],'multi')},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
2961
3029
|
* Updates a flow milestone
|
|
2962
3030
|
*
|
|
2963
3031
|
* @param {String} milestoneId flow milestone ID
|
|
@@ -2974,7 +3042,7 @@ if(milestoneId===undefined||milestoneId===null){throw'Missing the required param
|
|
|
2974
3042
|
if(flowOutcomeId===undefined||flowOutcomeId===null){throw'Missing the required parameter "flowOutcomeId" when calling putFlowsOutcome';}return this.apiClient.callApi('/api/v2/flows/outcomes/{flowOutcomeId}','PUT',{'flowOutcomeId':flowOutcomeId},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}}]);return ArchitectApi;}();var AuditApi=/*#__PURE__*/function(){/**
|
|
2975
3043
|
* Audit service.
|
|
2976
3044
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
2977
|
-
* @version
|
|
3045
|
+
* @version 189.0.0
|
|
2978
3046
|
*/ /**
|
|
2979
3047
|
* Constructs a new AuditApi.
|
|
2980
3048
|
* @alias module:purecloud-platform-client-v2/api/AuditApi
|
|
@@ -3016,7 +3084,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
3016
3084
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postAuditsQueryRealtime';}return this.apiClient.callApi('/api/v2/audits/query/realtime','POST',{},{'expand':this.apiClient.buildCollectionParam(opts['expand'],'multi')},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return AuditApi;}();var AuthorizationApi=/*#__PURE__*/function(){/**
|
|
3017
3085
|
* Authorization service.
|
|
3018
3086
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
3019
|
-
* @version
|
|
3087
|
+
* @version 189.0.0
|
|
3020
3088
|
*/ /**
|
|
3021
3089
|
* Constructs a new AuthorizationApi.
|
|
3022
3090
|
* @alias module:purecloud-platform-client-v2/api/AuthorizationApi
|
|
@@ -3327,7 +3395,7 @@ if(subjectId===undefined||subjectId===null){throw'Missing the required parameter
|
|
|
3327
3395
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putUserRoles';}return this.apiClient.callApi('/api/v2/users/{subjectId}/roles','PUT',{'subjectId':subjectId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return AuthorizationApi;}();var BillingApi=/*#__PURE__*/function(){/**
|
|
3328
3396
|
* Billing service.
|
|
3329
3397
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
3330
|
-
* @version
|
|
3398
|
+
* @version 189.0.0
|
|
3331
3399
|
*/ /**
|
|
3332
3400
|
* Constructs a new BillingApi.
|
|
3333
3401
|
* @alias module:purecloud-platform-client-v2/api/BillingApi
|
|
@@ -3351,7 +3419,7 @@ if(endDate===undefined||endDate===null){throw'Missing the required parameter "en
|
|
|
3351
3419
|
if(trustorOrgId===undefined||trustorOrgId===null){throw'Missing the required parameter "trustorOrgId" when calling getBillingTrusteebillingoverviewTrustorOrgId';}return this.apiClient.callApi('/api/v2/billing/trusteebillingoverview/{trustorOrgId}','GET',{'trustorOrgId':trustorOrgId},{'billingPeriodIndex':opts['billingPeriodIndex']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return BillingApi;}();var CarrierServicesApi=/*#__PURE__*/function(){/**
|
|
3352
3420
|
* CarrierServices service.
|
|
3353
3421
|
* @module purecloud-platform-client-v2/api/CarrierServicesApi
|
|
3354
|
-
* @version
|
|
3422
|
+
* @version 189.0.0
|
|
3355
3423
|
*/ /**
|
|
3356
3424
|
* Constructs a new CarrierServicesApi.
|
|
3357
3425
|
* @alias module:purecloud-platform-client-v2/api/CarrierServicesApi
|
|
@@ -3371,7 +3439,7 @@ if(phoneNumber===undefined||phoneNumber===null){throw'Missing the required param
|
|
|
3371
3439
|
*/},{key:"postCarrierservicesIntegrationsEmergencylocationsMe",value:function postCarrierservicesIntegrationsEmergencylocationsMe(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/carrierservices/integrations/emergencylocations/me','POST',{},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}}]);return CarrierServicesApi;}();var ChatApi=/*#__PURE__*/function(){/**
|
|
3372
3440
|
* Chat service.
|
|
3373
3441
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
3374
|
-
* @version
|
|
3442
|
+
* @version 189.0.0
|
|
3375
3443
|
*/ /**
|
|
3376
3444
|
* Constructs a new ChatApi.
|
|
3377
3445
|
* @alias module:purecloud-platform-client-v2/api/ChatApi
|
|
@@ -3564,7 +3632,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
3564
3632
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putChatsSettings';}return this.apiClient.callApi('/api/v2/chats/settings','PUT',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return ChatApi;}();var CoachingApi=/*#__PURE__*/function(){/**
|
|
3565
3633
|
* Coaching service.
|
|
3566
3634
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
3567
|
-
* @version
|
|
3635
|
+
* @version 189.0.0
|
|
3568
3636
|
*/ /**
|
|
3569
3637
|
* Constructs a new CoachingApi.
|
|
3570
3638
|
* @alias module:purecloud-platform-client-v2/api/CoachingApi
|
|
@@ -3717,7 +3785,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
3717
3785
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postCoachingScheduleslotsQuery';}return this.apiClient.callApi('/api/v2/coaching/scheduleslots/query','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return CoachingApi;}();var ContentManagementApi=/*#__PURE__*/function(){/**
|
|
3718
3786
|
* ContentManagement service.
|
|
3719
3787
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
3720
|
-
* @version
|
|
3788
|
+
* @version 189.0.0
|
|
3721
3789
|
*/ /**
|
|
3722
3790
|
* Constructs a new ContentManagementApi.
|
|
3723
3791
|
* @alias module:purecloud-platform-client-v2/api/ContentManagementApi
|
|
@@ -4000,7 +4068,7 @@ if(tagId===undefined||tagId===null){throw'Missing the required parameter "tagId"
|
|
|
4000
4068
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putContentmanagementWorkspaceTagvalue';}return this.apiClient.callApi('/api/v2/contentmanagement/workspaces/{workspaceId}/tagvalues/{tagId}','PUT',{'workspaceId':workspaceId,'tagId':tagId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return ContentManagementApi;}();var ConversationsApi=/*#__PURE__*/function(){/**
|
|
4001
4069
|
* Conversations service.
|
|
4002
4070
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
4003
|
-
* @version
|
|
4071
|
+
* @version 189.0.0
|
|
4004
4072
|
*/ /**
|
|
4005
4073
|
* Constructs a new ConversationsApi.
|
|
4006
4074
|
* @alias module:purecloud-platform-client-v2/api/ConversationsApi
|
|
@@ -4058,9 +4126,10 @@ if(integrationId===undefined||integrationId===null){throw'Missing the required p
|
|
|
4058
4126
|
* @param {String} integrationId Integration ID
|
|
4059
4127
|
*/},{key:"deleteConversationsMessagingIntegrationsInstagramIntegrationId",value:function deleteConversationsMessagingIntegrationsInstagramIntegrationId(integrationId){// verify the required parameter 'integrationId' is set
|
|
4060
4128
|
if(integrationId===undefined||integrationId===null){throw'Missing the required parameter "integrationId" when calling deleteConversationsMessagingIntegrationsInstagramIntegrationId';}return this.apiClient.callApi('/api/v2/conversations/messaging/integrations/instagram/{integrationId}','DELETE',{'integrationId':integrationId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
4061
|
-
* Delete a LINE messenger integration
|
|
4062
|
-
*
|
|
4129
|
+
* Delete a LINE messenger integration (Deprecated)
|
|
4130
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-native-line-third-party-messaging-channel/
|
|
4063
4131
|
* @param {String} integrationId Integration ID
|
|
4132
|
+
* @deprecated
|
|
4064
4133
|
*/},{key:"deleteConversationsMessagingIntegrationsLineIntegrationId",value:function deleteConversationsMessagingIntegrationsLineIntegrationId(integrationId){// verify the required parameter 'integrationId' is set
|
|
4065
4134
|
if(integrationId===undefined||integrationId===null){throw'Missing the required parameter "integrationId" when calling deleteConversationsMessagingIntegrationsLineIntegrationId';}return this.apiClient.callApi('/api/v2/conversations/messaging/integrations/line/{integrationId}','DELETE',{'integrationId':integrationId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
4066
4135
|
* Delete an Open messaging integration
|
|
@@ -4527,20 +4596,22 @@ if(integrationId===undefined||integrationId===null){throw'Missing the required p
|
|
|
4527
4596
|
* @param {Object} opts.expand Expand instructions for the return value.
|
|
4528
4597
|
*/},{key:"getConversationsMessagingIntegrationsInstagramIntegrationId",value:function getConversationsMessagingIntegrationsInstagramIntegrationId(integrationId,opts){opts=opts||{};// verify the required parameter 'integrationId' is set
|
|
4529
4598
|
if(integrationId===undefined||integrationId===null){throw'Missing the required parameter "integrationId" when calling getConversationsMessagingIntegrationsInstagramIntegrationId';}return this.apiClient.callApi('/api/v2/conversations/messaging/integrations/instagram/{integrationId}','GET',{'integrationId':integrationId},{'expand':opts['expand']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
4530
|
-
* Get a list of LINE messenger Integrations
|
|
4531
|
-
*
|
|
4599
|
+
* Get a list of LINE messenger Integrations (Deprecated)
|
|
4600
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-native-line-third-party-messaging-channel/
|
|
4532
4601
|
* @param {Object} opts Optional parameters
|
|
4533
4602
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
4534
4603
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
4535
4604
|
* @param {Object} opts.expand Expand instructions for the return value.
|
|
4536
4605
|
* @param {String} opts.supportedContentId Filter integrations returned based on the supported content ID
|
|
4537
4606
|
* @param {String} opts.messagingSettingId Filter integrations returned based on the setting ID
|
|
4607
|
+
* @deprecated
|
|
4538
4608
|
*/},{key:"getConversationsMessagingIntegrationsLine",value:function getConversationsMessagingIntegrationsLine(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/conversations/messaging/integrations/line','GET',{},{'pageSize':opts['pageSize'],'pageNumber':opts['pageNumber'],'expand':opts['expand'],'supportedContent.id':opts['supportedContentId'],'messagingSetting.id':opts['messagingSettingId']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
4539
|
-
* Get a LINE messenger integration
|
|
4540
|
-
*
|
|
4609
|
+
* Get a LINE messenger integration (Deprecated)
|
|
4610
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-native-line-third-party-messaging-channel/
|
|
4541
4611
|
* @param {String} integrationId Integration ID
|
|
4542
4612
|
* @param {Object} opts Optional parameters
|
|
4543
4613
|
* @param {Object} opts.expand Expand instructions for the return value.
|
|
4614
|
+
* @deprecated
|
|
4544
4615
|
*/},{key:"getConversationsMessagingIntegrationsLineIntegrationId",value:function getConversationsMessagingIntegrationsLineIntegrationId(integrationId,opts){opts=opts||{};// verify the required parameter 'integrationId' is set
|
|
4545
4616
|
if(integrationId===undefined||integrationId===null){throw'Missing the required parameter "integrationId" when calling getConversationsMessagingIntegrationsLineIntegrationId';}return this.apiClient.callApi('/api/v2/conversations/messaging/integrations/line/{integrationId}','GET',{'integrationId':integrationId},{'expand':opts['expand']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
4546
4617
|
* Get a list of Open messaging integrations
|
|
@@ -5682,10 +5753,11 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
5682
5753
|
*/},{key:"putConversationsMessageRecordingstate",value:function putConversationsMessageRecordingstate(conversationId,body){// verify the required parameter 'conversationId' is set
|
|
5683
5754
|
if(conversationId===undefined||conversationId===null){throw'Missing the required parameter "conversationId" when calling putConversationsMessageRecordingstate';}// verify the required parameter 'body' is set
|
|
5684
5755
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putConversationsMessageRecordingstate';}return this.apiClient.callApi('/api/v2/conversations/messages/{conversationId}/recordingstate','PUT',{'conversationId':conversationId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
5685
|
-
* Update a LINE messenger integration
|
|
5686
|
-
*
|
|
5756
|
+
* Update a LINE messenger integration (Deprecated)
|
|
5757
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-native-line-third-party-messaging-channel/
|
|
5687
5758
|
* @param {String} integrationId Integration ID
|
|
5688
5759
|
* @param {Object} body LineIntegrationRequest
|
|
5760
|
+
* @deprecated
|
|
5689
5761
|
*/},{key:"putConversationsMessagingIntegrationsLineIntegrationId",value:function putConversationsMessagingIntegrationsLineIntegrationId(integrationId,body){// verify the required parameter 'integrationId' is set
|
|
5690
5762
|
if(integrationId===undefined||integrationId===null){throw'Missing the required parameter "integrationId" when calling putConversationsMessagingIntegrationsLineIntegrationId';}// verify the required parameter 'body' is set
|
|
5691
5763
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putConversationsMessagingIntegrationsLineIntegrationId';}return this.apiClient.callApi('/api/v2/conversations/messaging/integrations/line/{integrationId}','PUT',{'integrationId':integrationId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
@@ -5727,7 +5799,7 @@ if(conversationId===undefined||conversationId===null){throw'Missing the required
|
|
|
5727
5799
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putConversationsVideoRecordingstate';}return this.apiClient.callApi('/api/v2/conversations/videos/{conversationId}/recordingstate','PUT',{'conversationId':conversationId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return ConversationsApi;}();var DataExtensionsApi=/*#__PURE__*/function(){/**
|
|
5728
5800
|
* DataExtensions service.
|
|
5729
5801
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
5730
|
-
* @version
|
|
5802
|
+
* @version 189.0.0
|
|
5731
5803
|
*/ /**
|
|
5732
5804
|
* Constructs a new DataExtensionsApi.
|
|
5733
5805
|
* @alias module:purecloud-platform-client-v2/api/DataExtensionsApi
|
|
@@ -5748,7 +5820,7 @@ if(coretypeName===undefined||coretypeName===null){throw'Missing the required par
|
|
|
5748
5820
|
*/},{key:"getDataextensionsLimits",value:function getDataextensionsLimits(){return this.apiClient.callApi('/api/v2/dataextensions/limits','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return DataExtensionsApi;}();var DownloadsApi=/*#__PURE__*/function(){/**
|
|
5749
5821
|
* Downloads service.
|
|
5750
5822
|
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
5751
|
-
* @version
|
|
5823
|
+
* @version 189.0.0
|
|
5752
5824
|
*/ /**
|
|
5753
5825
|
* Constructs a new DownloadsApi.
|
|
5754
5826
|
* @alias module:purecloud-platform-client-v2/api/DownloadsApi
|
|
@@ -5767,7 +5839,7 @@ if(coretypeName===undefined||coretypeName===null){throw'Missing the required par
|
|
|
5767
5839
|
if(downloadId===undefined||downloadId===null){throw'Missing the required parameter "downloadId" when calling getDownload';}return this.apiClient.callApi('/api/v2/downloads/{downloadId}','GET',{'downloadId':downloadId},{'contentDisposition':opts['contentDisposition'],'issueRedirect':opts['issueRedirect'],'redirectToAuth':opts['redirectToAuth']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return DownloadsApi;}();var EmailsApi=/*#__PURE__*/function(){/**
|
|
5768
5840
|
* Emails service.
|
|
5769
5841
|
* @module purecloud-platform-client-v2/api/EmailsApi
|
|
5770
|
-
* @version
|
|
5842
|
+
* @version 189.0.0
|
|
5771
5843
|
*/ /**
|
|
5772
5844
|
* Constructs a new EmailsApi.
|
|
5773
5845
|
* @alias module:purecloud-platform-client-v2/api/EmailsApi
|
|
@@ -5785,7 +5857,7 @@ if(downloadId===undefined||downloadId===null){throw'Missing the required paramet
|
|
|
5785
5857
|
*/},{key:"patchEmailsSettings",value:function patchEmailsSettings(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/emails/settings','PATCH',{},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}}]);return EmailsApi;}();var EventsApi=/*#__PURE__*/function(){/**
|
|
5786
5858
|
* Events service.
|
|
5787
5859
|
* @module purecloud-platform-client-v2/api/EventsApi
|
|
5788
|
-
* @version
|
|
5860
|
+
* @version 189.0.0
|
|
5789
5861
|
*/ /**
|
|
5790
5862
|
* Constructs a new EventsApi.
|
|
5791
5863
|
* @alias module:purecloud-platform-client-v2/api/EventsApi
|
|
@@ -5810,7 +5882,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
5810
5882
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postEventsUsersRoutingstatus';}return this.apiClient.callApi('/api/v2/events/users/routingstatus','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return EventsApi;}();var ExternalContactsApi=/*#__PURE__*/function(){/**
|
|
5811
5883
|
* ExternalContacts service.
|
|
5812
5884
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
5813
|
-
* @version
|
|
5885
|
+
* @version 189.0.0
|
|
5814
5886
|
*/ /**
|
|
5815
5887
|
* Constructs a new ExternalContactsApi.
|
|
5816
5888
|
* @alias module:purecloud-platform-client-v2/api/ExternalContactsApi
|
|
@@ -6029,25 +6101,25 @@ if(lookupVal===undefined||lookupVal===null){throw'Missing the required parameter
|
|
|
6029
6101
|
* Scan for external contacts using paging
|
|
6030
6102
|
*
|
|
6031
6103
|
* @param {Object} opts Optional parameters
|
|
6032
|
-
* @param {Number} opts.limit The number of contacts per page; must be between 10 and 200, default is 100
|
|
6104
|
+
* @param {Number} opts.limit The number of contacts per page; must be between 10 and 200, default is 100
|
|
6033
6105
|
* @param {String} opts.cursor Indicates where to resume query results (not required for first page), each page returns a new cursor with a 24h TTL
|
|
6034
6106
|
*/},{key:"getExternalcontactsScanContacts",value:function getExternalcontactsScanContacts(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/externalcontacts/scan/contacts','GET',{},{'limit':opts['limit'],'cursor':opts['cursor']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
6035
6107
|
* Scan for notes using paging
|
|
6036
6108
|
*
|
|
6037
6109
|
* @param {Object} opts Optional parameters
|
|
6038
|
-
* @param {Number} opts.limit The number of notes per page; must be between 10 and 200, default is 100
|
|
6110
|
+
* @param {Number} opts.limit The number of notes per page; must be between 10 and 200, default is 100
|
|
6039
6111
|
* @param {String} opts.cursor Indicates where to resume query results (not required for first page), each page returns a new cursor with a 24h TTL
|
|
6040
6112
|
*/},{key:"getExternalcontactsScanNotes",value:function getExternalcontactsScanNotes(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/externalcontacts/scan/notes','GET',{},{'limit':opts['limit'],'cursor':opts['cursor']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
6041
6113
|
* Scan for external organizations using paging
|
|
6042
6114
|
*
|
|
6043
6115
|
* @param {Object} opts Optional parameters
|
|
6044
|
-
* @param {Number} opts.limit The number of organizations per page; must be between 10 and 200, default is 100
|
|
6116
|
+
* @param {Number} opts.limit The number of organizations per page; must be between 10 and 200, default is 100
|
|
6045
6117
|
* @param {String} opts.cursor Indicates where to resume query results (not required for first page), each page returns a new cursor with a 24h TTL
|
|
6046
6118
|
*/},{key:"getExternalcontactsScanOrganizations",value:function getExternalcontactsScanOrganizations(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/externalcontacts/scan/organizations','GET',{},{'limit':opts['limit'],'cursor':opts['cursor']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
6047
6119
|
* Scan for relationships
|
|
6048
6120
|
*
|
|
6049
6121
|
* @param {Object} opts Optional parameters
|
|
6050
|
-
* @param {Number} opts.limit The number of relationships per page; must be between 10 and 200, default is 100
|
|
6122
|
+
* @param {Number} opts.limit The number of relationships per page; must be between 10 and 200, default is 100
|
|
6051
6123
|
* @param {String} opts.cursor Indicates where to resume query results (not required for first page), each page returns a new cursor with a 24h TTL
|
|
6052
6124
|
*/},{key:"getExternalcontactsScanRelationships",value:function getExternalcontactsScanRelationships(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/externalcontacts/scan/relationships','GET',{},{'limit':opts['limit'],'cursor':opts['cursor']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
6053
6125
|
* Claim or release identifiers for a contact
|
|
@@ -6265,7 +6337,7 @@ if(relationshipId===undefined||relationshipId===null){throw'Missing the required
|
|
|
6265
6337
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putExternalcontactsRelationship';}return this.apiClient.callApi('/api/v2/externalcontacts/relationships/{relationshipId}','PUT',{'relationshipId':relationshipId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return ExternalContactsApi;}();var FaxApi=/*#__PURE__*/function(){/**
|
|
6266
6338
|
* Fax service.
|
|
6267
6339
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
6268
|
-
* @version
|
|
6340
|
+
* @version 189.0.0
|
|
6269
6341
|
*/ /**
|
|
6270
6342
|
* Constructs a new FaxApi.
|
|
6271
6343
|
* @alias module:purecloud-platform-client-v2/api/FaxApi
|
|
@@ -6306,7 +6378,7 @@ if(documentId===undefined||documentId===null){throw'Missing the required paramet
|
|
|
6306
6378
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putFaxDocument';}return this.apiClient.callApi('/api/v2/fax/documents/{documentId}','PUT',{'documentId':documentId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return FaxApi;}();var FlowsApi=/*#__PURE__*/function(){/**
|
|
6307
6379
|
* Flows service.
|
|
6308
6380
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
6309
|
-
* @version
|
|
6381
|
+
* @version 189.0.0
|
|
6310
6382
|
*/ /**
|
|
6311
6383
|
* Constructs a new FlowsApi.
|
|
6312
6384
|
* @alias module:purecloud-platform-client-v2/api/FlowsApi
|
|
@@ -6355,7 +6427,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
6355
6427
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postAnalyticsFlowsObservationsQuery';}return this.apiClient.callApi('/api/v2/analytics/flows/observations/query','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return FlowsApi;}();var GamificationApi=/*#__PURE__*/function(){/**
|
|
6356
6428
|
* Gamification service.
|
|
6357
6429
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
6358
|
-
* @version
|
|
6430
|
+
* @version 189.0.0
|
|
6359
6431
|
*/ /**
|
|
6360
6432
|
* Constructs a new GamificationApi.
|
|
6361
6433
|
* @alias module:purecloud-platform-client-v2/api/GamificationApi
|
|
@@ -6895,7 +6967,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
6895
6967
|
if(status===undefined||status===null){throw'Missing the required parameter "status" when calling putGamificationStatus';}return this.apiClient.callApi('/api/v2/gamification/status','PUT',{},{},{},{},status,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return GamificationApi;}();var GeneralDataProtectionRegulationApi=/*#__PURE__*/function(){/**
|
|
6896
6968
|
* GeneralDataProtectionRegulation service.
|
|
6897
6969
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
6898
|
-
* @version
|
|
6970
|
+
* @version 189.0.0
|
|
6899
6971
|
*/ /**
|
|
6900
6972
|
* Constructs a new GeneralDataProtectionRegulationApi.
|
|
6901
6973
|
* @alias module:purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
@@ -6930,7 +7002,7 @@ if(searchValue===undefined||searchValue===null){throw'Missing the required param
|
|
|
6930
7002
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postGdprRequests';}return this.apiClient.callApi('/api/v2/gdpr/requests','POST',{},{'deleteConfirmed':opts['deleteConfirmed']},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return GeneralDataProtectionRegulationApi;}();var GeolocationApi=/*#__PURE__*/function(){/**
|
|
6931
7003
|
* Geolocation service.
|
|
6932
7004
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
6933
|
-
* @version
|
|
7005
|
+
* @version 189.0.0
|
|
6934
7006
|
*/ /**
|
|
6935
7007
|
* Constructs a new GeolocationApi.
|
|
6936
7008
|
* @alias module:purecloud-platform-client-v2/api/GeolocationApi
|
|
@@ -6964,7 +7036,7 @@ if(clientId===undefined||clientId===null){throw'Missing the required parameter "
|
|
|
6964
7036
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling patchUserGeolocation';}return this.apiClient.callApi('/api/v2/users/{userId}/geolocations/{clientId}','PATCH',{'userId':userId,'clientId':clientId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return GeolocationApi;}();var GreetingsApi=/*#__PURE__*/function(){/**
|
|
6965
7037
|
* Greetings service.
|
|
6966
7038
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
6967
|
-
* @version
|
|
7039
|
+
* @version 189.0.0
|
|
6968
7040
|
*/ /**
|
|
6969
7041
|
* Constructs a new GreetingsApi.
|
|
6970
7042
|
* @alias module:purecloud-platform-client-v2/api/GreetingsApi
|
|
@@ -7071,7 +7143,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
7071
7143
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putUserGreetingsDefaults';}return this.apiClient.callApi('/api/v2/users/{userId}/greetings/defaults','PUT',{'userId':userId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return GreetingsApi;}();var GroupsApi=/*#__PURE__*/function(){/**
|
|
7072
7144
|
* Groups service.
|
|
7073
7145
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
7074
|
-
* @version
|
|
7146
|
+
* @version 189.0.0
|
|
7075
7147
|
*/ /**
|
|
7076
7148
|
* Constructs a new GroupsApi.
|
|
7077
7149
|
* @alias module:purecloud-platform-client-v2/api/GroupsApi
|
|
@@ -7204,7 +7276,7 @@ if(groupId===undefined||groupId===null){throw'Missing the required parameter "gr
|
|
|
7204
7276
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putGroupDynamicsettings';}return this.apiClient.callApi('/api/v2/groups/{groupId}/dynamicsettings','PUT',{'groupId':groupId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return GroupsApi;}();var IdentityProviderApi=/*#__PURE__*/function(){/**
|
|
7205
7277
|
* IdentityProvider service.
|
|
7206
7278
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
7207
|
-
* @version
|
|
7279
|
+
* @version 189.0.0
|
|
7208
7280
|
*/ /**
|
|
7209
7281
|
* Constructs a new IdentityProviderApi.
|
|
7210
7282
|
* @alias module:purecloud-platform-client-v2/api/IdentityProviderApi
|
|
@@ -7360,7 +7432,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
7360
7432
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putIdentityprovidersSalesforce';}return this.apiClient.callApi('/api/v2/identityproviders/salesforce','PUT',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return IdentityProviderApi;}();var InfrastructureAsCodeApi=/*#__PURE__*/function(){/**
|
|
7361
7433
|
* InfrastructureAsCode service.
|
|
7362
7434
|
* @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
7363
|
-
* @version
|
|
7435
|
+
* @version 189.0.0
|
|
7364
7436
|
*/ /**
|
|
7365
7437
|
* Constructs a new InfrastructureAsCodeApi.
|
|
7366
7438
|
* @alias module:purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
@@ -7414,7 +7486,7 @@ if(jobId===undefined||jobId===null){throw'Missing the required parameter "jobId"
|
|
|
7414
7486
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postInfrastructureascodeJobs';}return this.apiClient.callApi('/api/v2/infrastructureascode/jobs','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return InfrastructureAsCodeApi;}();var IntegrationsApi=/*#__PURE__*/function(){/**
|
|
7415
7487
|
* Integrations service.
|
|
7416
7488
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
7417
|
-
* @version
|
|
7489
|
+
* @version 189.0.0
|
|
7418
7490
|
*/ /**
|
|
7419
7491
|
* Constructs a new IntegrationsApi.
|
|
7420
7492
|
* @alias module:purecloud-platform-client-v2/api/IntegrationsApi
|
|
@@ -7659,6 +7731,18 @@ if(agentId===undefined||agentId===null){throw'Missing the required parameter "ag
|
|
|
7659
7731
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
7660
7732
|
* @param {String} opts.name Filter on agent name
|
|
7661
7733
|
*/},{key:"getIntegrationsSpeechDialogflowAgents",value:function getIntegrationsSpeechDialogflowAgents(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/integrations/speech/dialogflow/agents','GET',{},{'pageNumber':opts['pageNumber'],'pageSize':opts['pageSize'],'name':opts['name']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
7734
|
+
* Get details about a Dialogflow CX agent
|
|
7735
|
+
*
|
|
7736
|
+
* @param {String} agentId The agent ID
|
|
7737
|
+
*/},{key:"getIntegrationsSpeechDialogflowcxAgent",value:function getIntegrationsSpeechDialogflowcxAgent(agentId){// verify the required parameter 'agentId' is set
|
|
7738
|
+
if(agentId===undefined||agentId===null){throw'Missing the required parameter "agentId" when calling getIntegrationsSpeechDialogflowcxAgent';}return this.apiClient.callApi('/api/v2/integrations/speech/dialogflowcx/agents/{agentId}','GET',{'agentId':agentId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
7739
|
+
* Get a list of Dialogflow CX agents in the customers' Google accounts
|
|
7740
|
+
*
|
|
7741
|
+
* @param {Object} opts Optional parameters
|
|
7742
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
7743
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
7744
|
+
* @param {String} opts.name Filter on agent name
|
|
7745
|
+
*/},{key:"getIntegrationsSpeechDialogflowcxAgents",value:function getIntegrationsSpeechDialogflowcxAgents(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/integrations/speech/dialogflowcx/agents','GET',{},{'pageNumber':opts['pageNumber'],'pageSize':opts['pageSize'],'name':opts['name']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
7662
7746
|
* Get details about a Lex bot alias
|
|
7663
7747
|
*
|
|
7664
7748
|
* @param {String} aliasId The alias ID
|
|
@@ -7681,6 +7765,28 @@ if(botId===undefined||botId===null){throw'Missing the required parameter "botId"
|
|
|
7681
7765
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
7682
7766
|
* @param {String} opts.name Filter on bot name
|
|
7683
7767
|
*/},{key:"getIntegrationsSpeechLexBots",value:function getIntegrationsSpeechLexBots(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/integrations/speech/lex/bots','GET',{},{'pageNumber':opts['pageNumber'],'pageSize':opts['pageSize'],'name':opts['name']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
7768
|
+
* Get details about a Lex V2 bot alias
|
|
7769
|
+
*
|
|
7770
|
+
* @param {String} aliasId The Alias ID
|
|
7771
|
+
*/},{key:"getIntegrationsSpeechLexv2BotAlias",value:function getIntegrationsSpeechLexv2BotAlias(aliasId){// verify the required parameter 'aliasId' is set
|
|
7772
|
+
if(aliasId===undefined||aliasId===null){throw'Missing the required parameter "aliasId" when calling getIntegrationsSpeechLexv2BotAlias';}return this.apiClient.callApi('/api/v2/integrations/speech/lexv2/bot/alias/{aliasId}','GET',{'aliasId':aliasId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
7773
|
+
* Get a list of aliases for a Lex V2 bot
|
|
7774
|
+
*
|
|
7775
|
+
* @param {String} botId The Bot ID
|
|
7776
|
+
* @param {Object} opts Optional parameters
|
|
7777
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
7778
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
7779
|
+
* @param {Object} opts.status Filter on alias status
|
|
7780
|
+
* @param {String} opts.name Filter on alias name
|
|
7781
|
+
*/},{key:"getIntegrationsSpeechLexv2BotBotIdAliases",value:function getIntegrationsSpeechLexv2BotBotIdAliases(botId,opts){opts=opts||{};// verify the required parameter 'botId' is set
|
|
7782
|
+
if(botId===undefined||botId===null){throw'Missing the required parameter "botId" when calling getIntegrationsSpeechLexv2BotBotIdAliases';}return this.apiClient.callApi('/api/v2/integrations/speech/lexv2/bot/{botId}/aliases','GET',{'botId':botId},{'pageNumber':opts['pageNumber'],'pageSize':opts['pageSize'],'status':opts['status'],'name':opts['name']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
7783
|
+
* Get a list of Lex V2 bots
|
|
7784
|
+
*
|
|
7785
|
+
* @param {Object} opts Optional parameters
|
|
7786
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
7787
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
7788
|
+
* @param {String} opts.name Filter on bot name
|
|
7789
|
+
*/},{key:"getIntegrationsSpeechLexv2Bots",value:function getIntegrationsSpeechLexv2Bots(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/integrations/speech/lexv2/bots','GET',{},{'pageNumber':opts['pageNumber'],'pageSize':opts['pageSize'],'name':opts['name']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
7684
7790
|
* Get a Nuance bot in the specified Integration
|
|
7685
7791
|
*
|
|
7686
7792
|
* @param {String} nuanceIntegrationId The integration ID for this group of bots
|
|
@@ -7688,7 +7794,6 @@ if(botId===undefined||botId===null){throw'Missing the required parameter "botId"
|
|
|
7688
7794
|
* @param {Object} opts Optional parameters
|
|
7689
7795
|
* @param {Array.<String>} opts.expand expand
|
|
7690
7796
|
* @param {Object} opts.targetChannel targetChannel
|
|
7691
|
-
* getIntegrationsSpeechNuanceNuanceIntegrationIdBot is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
7692
7797
|
*/},{key:"getIntegrationsSpeechNuanceNuanceIntegrationIdBot",value:function getIntegrationsSpeechNuanceNuanceIntegrationIdBot(nuanceIntegrationId,botId,opts){opts=opts||{};// verify the required parameter 'nuanceIntegrationId' is set
|
|
7693
7798
|
if(nuanceIntegrationId===undefined||nuanceIntegrationId===null){throw'Missing the required parameter "nuanceIntegrationId" when calling getIntegrationsSpeechNuanceNuanceIntegrationIdBot';}// verify the required parameter 'botId' is set
|
|
7694
7799
|
if(botId===undefined||botId===null){throw'Missing the required parameter "botId" when calling getIntegrationsSpeechNuanceNuanceIntegrationIdBot';}return this.apiClient.callApi('/api/v2/integrations/speech/nuance/{nuanceIntegrationId}/bots/{botId}','GET',{'nuanceIntegrationId':nuanceIntegrationId,'botId':botId},{'expand':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'targetChannel':opts['targetChannel']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
@@ -7697,7 +7802,6 @@ if(botId===undefined||botId===null){throw'Missing the required parameter "botId"
|
|
|
7697
7802
|
* @param {String} nuanceIntegrationId The integration ID for this group of bots
|
|
7698
7803
|
* @param {String} botId The Nuance bot ID
|
|
7699
7804
|
* @param {String} jobId The asynchronous job ID
|
|
7700
|
-
* getIntegrationsSpeechNuanceNuanceIntegrationIdBotJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
7701
7805
|
*/},{key:"getIntegrationsSpeechNuanceNuanceIntegrationIdBotJob",value:function getIntegrationsSpeechNuanceNuanceIntegrationIdBotJob(nuanceIntegrationId,botId,jobId){// verify the required parameter 'nuanceIntegrationId' is set
|
|
7702
7806
|
if(nuanceIntegrationId===undefined||nuanceIntegrationId===null){throw'Missing the required parameter "nuanceIntegrationId" when calling getIntegrationsSpeechNuanceNuanceIntegrationIdBotJob';}// verify the required parameter 'botId' is set
|
|
7703
7807
|
if(botId===undefined||botId===null){throw'Missing the required parameter "botId" when calling getIntegrationsSpeechNuanceNuanceIntegrationIdBotJob';}// verify the required parameter 'jobId' is set
|
|
@@ -7707,7 +7811,6 @@ if(jobId===undefined||jobId===null){throw'Missing the required parameter "jobId"
|
|
|
7707
7811
|
* @param {String} nuanceIntegrationId The integration ID for this group of bots
|
|
7708
7812
|
* @param {String} botId The Nuance bot ID
|
|
7709
7813
|
* @param {String} jobId The asynchronous job ID
|
|
7710
|
-
* getIntegrationsSpeechNuanceNuanceIntegrationIdBotJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
7711
7814
|
*/},{key:"getIntegrationsSpeechNuanceNuanceIntegrationIdBotJobResults",value:function getIntegrationsSpeechNuanceNuanceIntegrationIdBotJobResults(nuanceIntegrationId,botId,jobId){// verify the required parameter 'nuanceIntegrationId' is set
|
|
7712
7815
|
if(nuanceIntegrationId===undefined||nuanceIntegrationId===null){throw'Missing the required parameter "nuanceIntegrationId" when calling getIntegrationsSpeechNuanceNuanceIntegrationIdBotJobResults';}// verify the required parameter 'botId' is set
|
|
7713
7816
|
if(botId===undefined||botId===null){throw'Missing the required parameter "botId" when calling getIntegrationsSpeechNuanceNuanceIntegrationIdBotJobResults';}// verify the required parameter 'jobId' is set
|
|
@@ -7719,14 +7822,12 @@ if(jobId===undefined||jobId===null){throw'Missing the required parameter "jobId"
|
|
|
7719
7822
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
7720
7823
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
7721
7824
|
* @param {Boolean} opts.onlyRegisteredBots Limit bots to the ones configured for Genesys Cloud usage (default to true)
|
|
7722
|
-
* getIntegrationsSpeechNuanceNuanceIntegrationIdBots is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
7723
7825
|
*/},{key:"getIntegrationsSpeechNuanceNuanceIntegrationIdBots",value:function getIntegrationsSpeechNuanceNuanceIntegrationIdBots(nuanceIntegrationId,opts){opts=opts||{};// verify the required parameter 'nuanceIntegrationId' is set
|
|
7724
7826
|
if(nuanceIntegrationId===undefined||nuanceIntegrationId===null){throw'Missing the required parameter "nuanceIntegrationId" when calling getIntegrationsSpeechNuanceNuanceIntegrationIdBots';}return this.apiClient.callApi('/api/v2/integrations/speech/nuance/{nuanceIntegrationId}/bots','GET',{'nuanceIntegrationId':nuanceIntegrationId},{'pageNumber':opts['pageNumber'],'pageSize':opts['pageSize'],'onlyRegisteredBots':opts['onlyRegisteredBots']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
7725
7827
|
* Get the status of an asynchronous Nuance bots GET job
|
|
7726
7828
|
*
|
|
7727
7829
|
* @param {String} nuanceIntegrationId The integration ID for this group of bots
|
|
7728
7830
|
* @param {String} jobId The asynchronous job ID
|
|
7729
|
-
* getIntegrationsSpeechNuanceNuanceIntegrationIdBotsJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
7730
7831
|
*/},{key:"getIntegrationsSpeechNuanceNuanceIntegrationIdBotsJob",value:function getIntegrationsSpeechNuanceNuanceIntegrationIdBotsJob(nuanceIntegrationId,jobId){// verify the required parameter 'nuanceIntegrationId' is set
|
|
7731
7832
|
if(nuanceIntegrationId===undefined||nuanceIntegrationId===null){throw'Missing the required parameter "nuanceIntegrationId" when calling getIntegrationsSpeechNuanceNuanceIntegrationIdBotsJob';}// verify the required parameter 'jobId' is set
|
|
7732
7833
|
if(jobId===undefined||jobId===null){throw'Missing the required parameter "jobId" when calling getIntegrationsSpeechNuanceNuanceIntegrationIdBotsJob';}return this.apiClient.callApi('/api/v2/integrations/speech/nuance/{nuanceIntegrationId}/bots/jobs/{jobId}','GET',{'nuanceIntegrationId':nuanceIntegrationId,'jobId':jobId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
@@ -7734,10 +7835,21 @@ if(jobId===undefined||jobId===null){throw'Missing the required parameter "jobId"
|
|
|
7734
7835
|
*
|
|
7735
7836
|
* @param {String} nuanceIntegrationId The integration ID for this group of bots
|
|
7736
7837
|
* @param {String} jobId The asynchronous job ID
|
|
7737
|
-
* getIntegrationsSpeechNuanceNuanceIntegrationIdBotsJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
7738
7838
|
*/},{key:"getIntegrationsSpeechNuanceNuanceIntegrationIdBotsJobResults",value:function getIntegrationsSpeechNuanceNuanceIntegrationIdBotsJobResults(nuanceIntegrationId,jobId){// verify the required parameter 'nuanceIntegrationId' is set
|
|
7739
7839
|
if(nuanceIntegrationId===undefined||nuanceIntegrationId===null){throw'Missing the required parameter "nuanceIntegrationId" when calling getIntegrationsSpeechNuanceNuanceIntegrationIdBotsJobResults';}// verify the required parameter 'jobId' is set
|
|
7740
7840
|
if(jobId===undefined||jobId===null){throw'Missing the required parameter "jobId" when calling getIntegrationsSpeechNuanceNuanceIntegrationIdBotsJobResults';}return this.apiClient.callApi('/api/v2/integrations/speech/nuance/{nuanceIntegrationId}/bots/jobs/{jobId}/results','GET',{'nuanceIntegrationId':nuanceIntegrationId,'jobId':jobId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
7841
|
+
* Get details about a STT engine
|
|
7842
|
+
*
|
|
7843
|
+
* @param {String} engineId The engine ID
|
|
7844
|
+
*/},{key:"getIntegrationsSpeechSttEngine",value:function getIntegrationsSpeechSttEngine(engineId){// verify the required parameter 'engineId' is set
|
|
7845
|
+
if(engineId===undefined||engineId===null){throw'Missing the required parameter "engineId" when calling getIntegrationsSpeechSttEngine';}return this.apiClient.callApi('/api/v2/integrations/speech/stt/engines/{engineId}','GET',{'engineId':engineId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
7846
|
+
* Get a list of STT engines enabled for org
|
|
7847
|
+
*
|
|
7848
|
+
* @param {Object} opts Optional parameters
|
|
7849
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
7850
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
7851
|
+
* @param {String} opts.name Filter on engine name
|
|
7852
|
+
*/},{key:"getIntegrationsSpeechSttEngines",value:function getIntegrationsSpeechSttEngines(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/integrations/speech/stt/engines','GET',{},{'pageNumber':opts['pageNumber'],'pageSize':opts['pageSize'],'name':opts['name']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
7741
7853
|
* Get details about a TTS engine
|
|
7742
7854
|
*
|
|
7743
7855
|
* @param {String} engineId The engine ID
|
|
@@ -7794,6 +7906,21 @@ if(configType===undefined||configType===null){throw'Missing the required paramet
|
|
|
7794
7906
|
* @param {String} opts.nextPage next page token
|
|
7795
7907
|
* @param {String} opts.previousPage Previous page token
|
|
7796
7908
|
*/},{key:"getIntegrationsTypes",value:function getIntegrationsTypes(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/integrations/types','GET',{},{'pageSize':opts['pageSize'],'pageNumber':opts['pageNumber'],'sortBy':opts['sortBy'],'expand':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'nextPage':opts['nextPage'],'previousPage':opts['previousPage']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
7909
|
+
* UC integration client application configuration.
|
|
7910
|
+
* This endpoint returns basic UI configuration data for the specified Unified Communications integration client application.
|
|
7911
|
+
* @param {String} ucIntegrationId 3rd Party Service Type
|
|
7912
|
+
*/},{key:"getIntegrationsUnifiedcommunicationsClientapp",value:function getIntegrationsUnifiedcommunicationsClientapp(ucIntegrationId){// verify the required parameter 'ucIntegrationId' is set
|
|
7913
|
+
if(ucIntegrationId===undefined||ucIntegrationId===null){throw'Missing the required parameter "ucIntegrationId" when calling getIntegrationsUnifiedcommunicationsClientapp';}return this.apiClient.callApi('/api/v2/integrations/unifiedcommunications/clientapps/{ucIntegrationId}','GET',{'ucIntegrationId':ucIntegrationId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
7914
|
+
* List UC integration client application configurations.
|
|
7915
|
+
* This endpoint returns basic UI configuration data for all Unified Communications integrations client applications enabled.
|
|
7916
|
+
* @param {Object} opts Optional parameters
|
|
7917
|
+
* @param {Number} opts.pageSize The total page size requested (default to 25)
|
|
7918
|
+
* @param {Number} opts.pageNumber The page number requested (default to 1)
|
|
7919
|
+
* @param {String} opts.sortBy variable name requested to sort by
|
|
7920
|
+
* @param {Array.<String>} opts.expand variable name requested by expand list
|
|
7921
|
+
* @param {String} opts.nextPage next page token
|
|
7922
|
+
* @param {String} opts.previousPage Previous page token
|
|
7923
|
+
*/},{key:"getIntegrationsUnifiedcommunicationsClientapps",value:function getIntegrationsUnifiedcommunicationsClientapps(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/integrations/unifiedcommunications/clientapps','GET',{},{'pageSize':opts['pageSize'],'pageNumber':opts['pageNumber'],'sortBy':opts['sortBy'],'expand':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'nextPage':opts['nextPage'],'previousPage':opts['previousPage']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
7797
7924
|
* List permitted user app integrations for the logged in user
|
|
7798
7925
|
*
|
|
7799
7926
|
* @param {Object} opts Optional parameters
|
|
@@ -7900,7 +8027,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
7900
8027
|
* @param {Object} opts Optional parameters
|
|
7901
8028
|
* @param {Array.<String>} opts.expand expand
|
|
7902
8029
|
* @param {String} opts.body targetChannel
|
|
7903
|
-
* postIntegrationsSpeechNuanceNuanceIntegrationIdBotJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
7904
8030
|
*/},{key:"postIntegrationsSpeechNuanceNuanceIntegrationIdBotJobs",value:function postIntegrationsSpeechNuanceNuanceIntegrationIdBotJobs(nuanceIntegrationId,botId,opts){opts=opts||{};// verify the required parameter 'nuanceIntegrationId' is set
|
|
7905
8031
|
if(nuanceIntegrationId===undefined||nuanceIntegrationId===null){throw'Missing the required parameter "nuanceIntegrationId" when calling postIntegrationsSpeechNuanceNuanceIntegrationIdBotJobs';}// verify the required parameter 'botId' is set
|
|
7906
8032
|
if(botId===undefined||botId===null){throw'Missing the required parameter "botId" when calling postIntegrationsSpeechNuanceNuanceIntegrationIdBotJobs';}return this.apiClient.callApi('/api/v2/integrations/speech/nuance/{nuanceIntegrationId}/bots/{botId}/jobs','POST',{'nuanceIntegrationId':nuanceIntegrationId,'botId':botId},{'expand':this.apiClient.buildCollectionParam(opts['expand'],'multi')},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
@@ -7911,14 +8037,12 @@ if(botId===undefined||botId===null){throw'Missing the required parameter "botId"
|
|
|
7911
8037
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
7912
8038
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
7913
8039
|
* @param {Boolean} opts.onlyRegisteredBots Limit bots to the ones configured for Genesys Cloud usage (default to true)
|
|
7914
|
-
* postIntegrationsSpeechNuanceNuanceIntegrationIdBotsJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
7915
8040
|
*/},{key:"postIntegrationsSpeechNuanceNuanceIntegrationIdBotsJobs",value:function postIntegrationsSpeechNuanceNuanceIntegrationIdBotsJobs(nuanceIntegrationId,opts){opts=opts||{};// verify the required parameter 'nuanceIntegrationId' is set
|
|
7916
8041
|
if(nuanceIntegrationId===undefined||nuanceIntegrationId===null){throw'Missing the required parameter "nuanceIntegrationId" when calling postIntegrationsSpeechNuanceNuanceIntegrationIdBotsJobs';}return this.apiClient.callApi('/api/v2/integrations/speech/nuance/{nuanceIntegrationId}/bots/jobs','POST',{'nuanceIntegrationId':nuanceIntegrationId},{'pageNumber':opts['pageNumber'],'pageSize':opts['pageSize'],'onlyRegisteredBots':opts['onlyRegisteredBots']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
7917
8042
|
* Try out a single credential for a Nuance bot to know if the secret is correct
|
|
7918
8043
|
*
|
|
7919
8044
|
* @param {String} nuanceIntegrationId The integration ID for this group of bots
|
|
7920
8045
|
* @param {Object} settings
|
|
7921
|
-
* postIntegrationsSpeechNuanceNuanceIntegrationIdBotsLaunchValidate is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
7922
8046
|
*/},{key:"postIntegrationsSpeechNuanceNuanceIntegrationIdBotsLaunchValidate",value:function postIntegrationsSpeechNuanceNuanceIntegrationIdBotsLaunchValidate(nuanceIntegrationId,settings){// verify the required parameter 'nuanceIntegrationId' is set
|
|
7923
8047
|
if(nuanceIntegrationId===undefined||nuanceIntegrationId===null){throw'Missing the required parameter "nuanceIntegrationId" when calling postIntegrationsSpeechNuanceNuanceIntegrationIdBotsLaunchValidate';}// verify the required parameter 'settings' is set
|
|
7924
8048
|
if(settings===undefined||settings===null){throw'Missing the required parameter "settings" when calling postIntegrationsSpeechNuanceNuanceIntegrationIdBotsLaunchValidate';}return this.apiClient.callApi('/api/v2/integrations/speech/nuance/{nuanceIntegrationId}/bots/launch/validate','POST',{'nuanceIntegrationId':nuanceIntegrationId},{},{},{},settings,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
@@ -7955,7 +8079,6 @@ if(credentialId===undefined||credentialId===null){throw'Missing the required par
|
|
|
7955
8079
|
*
|
|
7956
8080
|
* @param {String} nuanceIntegrationId The integration ID for this group of bots
|
|
7957
8081
|
* @param {Object} settings
|
|
7958
|
-
* putIntegrationsSpeechNuanceNuanceIntegrationIdBotsLaunchSettings is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
7959
8082
|
*/},{key:"putIntegrationsSpeechNuanceNuanceIntegrationIdBotsLaunchSettings",value:function putIntegrationsSpeechNuanceNuanceIntegrationIdBotsLaunchSettings(nuanceIntegrationId,settings){// verify the required parameter 'nuanceIntegrationId' is set
|
|
7960
8083
|
if(nuanceIntegrationId===undefined||nuanceIntegrationId===null){throw'Missing the required parameter "nuanceIntegrationId" when calling putIntegrationsSpeechNuanceNuanceIntegrationIdBotsLaunchSettings';}// verify the required parameter 'settings' is set
|
|
7961
8084
|
if(settings===undefined||settings===null){throw'Missing the required parameter "settings" when calling putIntegrationsSpeechNuanceNuanceIntegrationIdBotsLaunchSettings';}return this.apiClient.callApi('/api/v2/integrations/speech/nuance/{nuanceIntegrationId}/bots/launch/settings','PUT',{'nuanceIntegrationId':nuanceIntegrationId},{},{},{},settings,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
@@ -7973,7 +8096,7 @@ if(ucIntegrationId===undefined||ucIntegrationId===null){throw'Missing the requir
|
|
|
7973
8096
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putIntegrationsUnifiedcommunicationThirdpartypresences';}return this.apiClient.callApi('/api/v2/integrations/unifiedcommunications/{ucIntegrationId}/thirdpartypresences','PUT',{'ucIntegrationId':ucIntegrationId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return IntegrationsApi;}();var JourneyApi=/*#__PURE__*/function(){/**
|
|
7974
8097
|
* Journey service.
|
|
7975
8098
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
7976
|
-
* @version
|
|
8099
|
+
* @version 189.0.0
|
|
7977
8100
|
*/ /**
|
|
7978
8101
|
* Constructs a new JourneyApi.
|
|
7979
8102
|
* @alias module:purecloud-platform-client-v2/api/JourneyApi
|
|
@@ -8008,6 +8131,12 @@ if(predictorId===undefined||predictorId===null){throw'Missing the required param
|
|
|
8008
8131
|
* @param {String} segmentId ID of the segment.
|
|
8009
8132
|
*/},{key:"deleteJourneySegment",value:function deleteJourneySegment(segmentId){// verify the required parameter 'segmentId' is set
|
|
8010
8133
|
if(segmentId===undefined||segmentId===null){throw'Missing the required parameter "segmentId" when calling deleteJourneySegment';}return this.apiClient.callApi('/api/v2/journey/segments/{segmentId}','DELETE',{'segmentId':segmentId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
8134
|
+
* Delete a Journey View by ID
|
|
8135
|
+
* deletes all versions
|
|
8136
|
+
* @param {String} viewId viewId
|
|
8137
|
+
* deleteJourneyView is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
8138
|
+
*/},{key:"deleteJourneyView",value:function deleteJourneyView(viewId){// verify the required parameter 'viewId' is set
|
|
8139
|
+
if(viewId===undefined||viewId===null){throw'Missing the required parameter "viewId" when calling deleteJourneyView';}return this.apiClient.callApi('/api/v2/journey/views/{viewId}','DELETE',{'viewId':viewId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
8011
8140
|
* Get status for async query for journey aggregates
|
|
8012
8141
|
*
|
|
8013
8142
|
* @param {String} jobId jobId
|
|
@@ -8168,6 +8297,24 @@ if(sessionId===undefined||sessionId===null){throw'Missing the required parameter
|
|
|
8168
8297
|
* @param {String} sessionId ID of the session.
|
|
8169
8298
|
*/},{key:"getJourneySessionOutcomescores",value:function getJourneySessionOutcomescores(sessionId){// verify the required parameter 'sessionId' is set
|
|
8170
8299
|
if(sessionId===undefined||sessionId===null){throw'Missing the required parameter "sessionId" when calling getJourneySessionOutcomescores';}return this.apiClient.callApi('/api/v2/journey/sessions/{sessionId}/outcomescores','GET',{'sessionId':sessionId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
8300
|
+
* Get a Journey View by ID
|
|
8301
|
+
* returns the latest version
|
|
8302
|
+
* @param {String} viewId viewId
|
|
8303
|
+
* getJourneyView is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
8304
|
+
*/},{key:"getJourneyView",value:function getJourneyView(viewId){// verify the required parameter 'viewId' is set
|
|
8305
|
+
if(viewId===undefined||viewId===null){throw'Missing the required parameter "viewId" when calling getJourneyView';}return this.apiClient.callApi('/api/v2/journey/views/{viewId}','GET',{'viewId':viewId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
8306
|
+
* Get a Journey View by ID and version
|
|
8307
|
+
*
|
|
8308
|
+
* @param {String} viewId viewId
|
|
8309
|
+
* @param {String} versionId versionId
|
|
8310
|
+
* getJourneyViewVersion is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
8311
|
+
*/},{key:"getJourneyViewVersion",value:function getJourneyViewVersion(viewId,versionId){// verify the required parameter 'viewId' is set
|
|
8312
|
+
if(viewId===undefined||viewId===null){throw'Missing the required parameter "viewId" when calling getJourneyViewVersion';}// verify the required parameter 'versionId' is set
|
|
8313
|
+
if(versionId===undefined||versionId===null){throw'Missing the required parameter "versionId" when calling getJourneyViewVersion';}return this.apiClient.callApi('/api/v2/journey/views/{viewId}/versions/{versionId}','GET',{'viewId':viewId,'versionId':versionId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
8314
|
+
* Get a list of Journey Views
|
|
8315
|
+
*
|
|
8316
|
+
* getJourneyViews is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
8317
|
+
*/},{key:"getJourneyViews",value:function getJourneyViews(){return this.apiClient.callApi('/api/v2/journey/views','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
8171
8318
|
* Update single action map.
|
|
8172
8319
|
*
|
|
8173
8320
|
* @param {String} actionMapId ID of the action map.
|
|
@@ -8243,6 +8390,12 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
8243
8390
|
* @param {Object} opts.body
|
|
8244
8391
|
*/},{key:"postJourneyDeploymentAppevents",value:function postJourneyDeploymentAppevents(deploymentId,opts){opts=opts||{};// verify the required parameter 'deploymentId' is set
|
|
8245
8392
|
if(deploymentId===undefined||deploymentId===null){throw'Missing the required parameter "deploymentId" when calling postJourneyDeploymentAppevents';}return this.apiClient.callApi('/api/v2/journey/deployments/{deploymentId}/appevents','POST',{'deploymentId':deploymentId},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
8393
|
+
* Query for flow paths.
|
|
8394
|
+
*
|
|
8395
|
+
* @param {Object} opts Optional parameters
|
|
8396
|
+
* @param {Object} opts.body
|
|
8397
|
+
* postJourneyFlowsPathsQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
8398
|
+
*/},{key:"postJourneyFlowsPathsQuery",value:function postJourneyFlowsPathsQuery(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/journey/flows/paths/query','POST',{},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
8246
8399
|
* Create an outcome.
|
|
8247
8400
|
*
|
|
8248
8401
|
* @param {Object} opts Optional parameters
|
|
@@ -8263,10 +8416,24 @@ if(deploymentId===undefined||deploymentId===null){throw'Missing the required par
|
|
|
8263
8416
|
*
|
|
8264
8417
|
* @param {Object} opts Optional parameters
|
|
8265
8418
|
* @param {Object} opts.body
|
|
8266
|
-
*/},{key:"postJourneySegments",value:function postJourneySegments(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/journey/segments','POST',{},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}
|
|
8419
|
+
*/},{key:"postJourneySegments",value:function postJourneySegments(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/journey/segments','POST',{},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
8420
|
+
* Update a Journey View by ID
|
|
8421
|
+
* creates a new version
|
|
8422
|
+
* @param {String} viewId viewId
|
|
8423
|
+
* @param {Object} body JourneyView
|
|
8424
|
+
* postJourneyViewVersions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
8425
|
+
*/},{key:"postJourneyViewVersions",value:function postJourneyViewVersions(viewId,body){// verify the required parameter 'viewId' is set
|
|
8426
|
+
if(viewId===undefined||viewId===null){throw'Missing the required parameter "viewId" when calling postJourneyViewVersions';}// verify the required parameter 'body' is set
|
|
8427
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postJourneyViewVersions';}return this.apiClient.callApi('/api/v2/journey/views/{viewId}/versions','POST',{'viewId':viewId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
8428
|
+
* Create a new Journey View
|
|
8429
|
+
*
|
|
8430
|
+
* @param {Object} body JourneyView
|
|
8431
|
+
* postJourneyViews is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
8432
|
+
*/},{key:"postJourneyViews",value:function postJourneyViews(body){// verify the required parameter 'body' is set
|
|
8433
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postJourneyViews';}return this.apiClient.callApi('/api/v2/journey/views','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return JourneyApi;}();var KnowledgeApi=/*#__PURE__*/function(){/**
|
|
8267
8434
|
* Knowledge service.
|
|
8268
8435
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
8269
|
-
* @version
|
|
8436
|
+
* @version 189.0.0
|
|
8270
8437
|
*/ /**
|
|
8271
8438
|
* Constructs a new KnowledgeApi.
|
|
8272
8439
|
* @alias module:purecloud-platform-client-v2/api/KnowledgeApi
|
|
@@ -8896,6 +9063,15 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
8896
9063
|
* @param {Object} body query
|
|
8897
9064
|
*/},{key:"postKnowledgeDocumentuploads",value:function postKnowledgeDocumentuploads(body){// verify the required parameter 'body' is set
|
|
8898
9065
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postKnowledgeDocumentuploads';}return this.apiClient.callApi('/api/v2/knowledge/documentuploads','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
9066
|
+
* Indicate that the document was copied by the user.
|
|
9067
|
+
*
|
|
9068
|
+
* @param {String} sessionId Knowledge guest session ID.
|
|
9069
|
+
* @param {String} documentId Document ID
|
|
9070
|
+
* @param {Object} opts Optional parameters
|
|
9071
|
+
* @param {Object} opts.body
|
|
9072
|
+
*/},{key:"postKnowledgeGuestSessionDocumentCopies",value:function postKnowledgeGuestSessionDocumentCopies(sessionId,documentId,opts){opts=opts||{};// verify the required parameter 'sessionId' is set
|
|
9073
|
+
if(sessionId===undefined||sessionId===null){throw'Missing the required parameter "sessionId" when calling postKnowledgeGuestSessionDocumentCopies';}// verify the required parameter 'documentId' is set
|
|
9074
|
+
if(documentId===undefined||documentId===null){throw'Missing the required parameter "documentId" when calling postKnowledgeGuestSessionDocumentCopies';}return this.apiClient.callApi('/api/v2/knowledge/guest/sessions/{sessionId}/documents/{documentId}/copies','POST',{'sessionId':sessionId,'documentId':documentId},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
8899
9075
|
* Give feedback on a document
|
|
8900
9076
|
*
|
|
8901
9077
|
* @param {String} sessionId Knowledge guest session ID.
|
|
@@ -8905,6 +9081,22 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
8905
9081
|
*/},{key:"postKnowledgeGuestSessionDocumentFeedback",value:function postKnowledgeGuestSessionDocumentFeedback(sessionId,documentId,opts){opts=opts||{};// verify the required parameter 'sessionId' is set
|
|
8906
9082
|
if(sessionId===undefined||sessionId===null){throw'Missing the required parameter "sessionId" when calling postKnowledgeGuestSessionDocumentFeedback';}// verify the required parameter 'documentId' is set
|
|
8907
9083
|
if(documentId===undefined||documentId===null){throw'Missing the required parameter "documentId" when calling postKnowledgeGuestSessionDocumentFeedback';}return this.apiClient.callApi('/api/v2/knowledge/guest/sessions/{sessionId}/documents/{documentId}/feedback','POST',{'sessionId':sessionId,'documentId':documentId},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
9084
|
+
* Create view event for a document.
|
|
9085
|
+
*
|
|
9086
|
+
* @param {String} sessionId Knowledge guest session ID.
|
|
9087
|
+
* @param {String} documentId Document ID
|
|
9088
|
+
* @param {Object} opts Optional parameters
|
|
9089
|
+
* @param {Object} opts.body
|
|
9090
|
+
*/},{key:"postKnowledgeGuestSessionDocumentViews",value:function postKnowledgeGuestSessionDocumentViews(sessionId,documentId,opts){opts=opts||{};// verify the required parameter 'sessionId' is set
|
|
9091
|
+
if(sessionId===undefined||sessionId===null){throw'Missing the required parameter "sessionId" when calling postKnowledgeGuestSessionDocumentViews';}// verify the required parameter 'documentId' is set
|
|
9092
|
+
if(documentId===undefined||documentId===null){throw'Missing the required parameter "documentId" when calling postKnowledgeGuestSessionDocumentViews';}return this.apiClient.callApi('/api/v2/knowledge/guest/sessions/{sessionId}/documents/{documentId}/views','POST',{'sessionId':sessionId,'documentId':documentId},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
9093
|
+
* Indicate that documents were presented to the user.
|
|
9094
|
+
*
|
|
9095
|
+
* @param {String} sessionId Knowledge guest session ID.
|
|
9096
|
+
* @param {Object} opts Optional parameters
|
|
9097
|
+
* @param {Object} opts.body
|
|
9098
|
+
*/},{key:"postKnowledgeGuestSessionDocumentsPresentations",value:function postKnowledgeGuestSessionDocumentsPresentations(sessionId,opts){opts=opts||{};// verify the required parameter 'sessionId' is set
|
|
9099
|
+
if(sessionId===undefined||sessionId===null){throw'Missing the required parameter "sessionId" when calling postKnowledgeGuestSessionDocumentsPresentations';}return this.apiClient.callApi('/api/v2/knowledge/guest/sessions/{sessionId}/documents/presentations','POST',{'sessionId':sessionId},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
8908
9100
|
* Search the documents in a guest session.
|
|
8909
9101
|
*
|
|
8910
9102
|
* @param {String} sessionId Knowledge guest session ID.
|
|
@@ -8932,6 +9124,15 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
8932
9124
|
*/},{key:"postKnowledgeKnowledgebaseCategories",value:function postKnowledgeKnowledgebaseCategories(knowledgeBaseId,body){// verify the required parameter 'knowledgeBaseId' is set
|
|
8933
9125
|
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseCategories';}// verify the required parameter 'body' is set
|
|
8934
9126
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postKnowledgeKnowledgebaseCategories';}return this.apiClient.callApi('/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/categories','POST',{'knowledgeBaseId':knowledgeBaseId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
9127
|
+
* Indicate that the document was copied by the user.
|
|
9128
|
+
*
|
|
9129
|
+
* @param {String} knowledgeBaseId Knowledge base ID.
|
|
9130
|
+
* @param {String} documentId Document ID.
|
|
9131
|
+
* @param {Object} opts Optional parameters
|
|
9132
|
+
* @param {Object} opts.body
|
|
9133
|
+
*/},{key:"postKnowledgeKnowledgebaseDocumentCopies",value:function postKnowledgeKnowledgebaseDocumentCopies(knowledgeBaseId,documentId,opts){opts=opts||{};// verify the required parameter 'knowledgeBaseId' is set
|
|
9134
|
+
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseDocumentCopies';}// verify the required parameter 'documentId' is set
|
|
9135
|
+
if(documentId===undefined||documentId===null){throw'Missing the required parameter "documentId" when calling postKnowledgeKnowledgebaseDocumentCopies';}return this.apiClient.callApi('/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/copies','POST',{'knowledgeBaseId':knowledgeBaseId,'documentId':documentId},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
8935
9136
|
* Give feedback on a document
|
|
8936
9137
|
*
|
|
8937
9138
|
* @param {String} knowledgeBaseId Knowledge base ID.
|
|
@@ -8991,6 +9192,13 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
8991
9192
|
*/},{key:"postKnowledgeKnowledgebaseDocumentsBulkUpdate",value:function postKnowledgeKnowledgebaseDocumentsBulkUpdate(knowledgeBaseId,body){// verify the required parameter 'knowledgeBaseId' is set
|
|
8992
9193
|
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseDocumentsBulkUpdate';}// verify the required parameter 'body' is set
|
|
8993
9194
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postKnowledgeKnowledgebaseDocumentsBulkUpdate';}return this.apiClient.callApi('/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/bulk/update','POST',{'knowledgeBaseId':knowledgeBaseId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
9195
|
+
* Indicate that documents were presented to the user.
|
|
9196
|
+
*
|
|
9197
|
+
* @param {String} knowledgeBaseId Knowledge base ID.
|
|
9198
|
+
* @param {Object} opts Optional parameters
|
|
9199
|
+
* @param {Object} opts.body
|
|
9200
|
+
*/},{key:"postKnowledgeKnowledgebaseDocumentsPresentations",value:function postKnowledgeKnowledgebaseDocumentsPresentations(knowledgeBaseId,opts){opts=opts||{};// verify the required parameter 'knowledgeBaseId' is set
|
|
9201
|
+
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseDocumentsPresentations';}return this.apiClient.callApi('/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/presentations','POST',{'knowledgeBaseId':knowledgeBaseId},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
8994
9202
|
* Search the documents in a knowledge base.
|
|
8995
9203
|
*
|
|
8996
9204
|
* @param {String} knowledgeBaseId The ID of knowledge base containing the documents to query.
|
|
@@ -9137,7 +9345,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
9137
9345
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postKnowledgeKnowledgebases';}return this.apiClient.callApi('/api/v2/knowledge/knowledgebases','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return KnowledgeApi;}();var LanguageUnderstandingApi=/*#__PURE__*/function(){/**
|
|
9138
9346
|
* LanguageUnderstanding service.
|
|
9139
9347
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
9140
|
-
* @version
|
|
9348
|
+
* @version 189.0.0
|
|
9141
9349
|
*/ /**
|
|
9142
9350
|
* Constructs a new LanguageUnderstandingApi.
|
|
9143
9351
|
* @alias module:purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
@@ -9393,7 +9601,7 @@ if(domainVersionId===undefined||domainVersionId===null){throw'Missing the requir
|
|
|
9393
9601
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putLanguageunderstandingDomainVersion';}return this.apiClient.callApi('/api/v2/languageunderstanding/domains/{domainId}/versions/{domainVersionId}','PUT',{'domainId':domainId,'domainVersionId':domainVersionId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return LanguageUnderstandingApi;}();var LanguagesApi=/*#__PURE__*/function(){/**
|
|
9394
9602
|
* Languages service.
|
|
9395
9603
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
9396
|
-
* @version
|
|
9604
|
+
* @version 189.0.0
|
|
9397
9605
|
*/ /**
|
|
9398
9606
|
* Constructs a new LanguagesApi.
|
|
9399
9607
|
* @alias module:purecloud-platform-client-v2/api/LanguagesApi
|
|
@@ -9448,7 +9656,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
9448
9656
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postLanguages';}return this.apiClient.callApi('/api/v2/languages','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return LanguagesApi;}();var LearningApi=/*#__PURE__*/function(){/**
|
|
9449
9657
|
* Learning service.
|
|
9450
9658
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
9451
|
-
* @version
|
|
9659
|
+
* @version 189.0.0
|
|
9452
9660
|
*/ /**
|
|
9453
9661
|
* Constructs a new LearningApi.
|
|
9454
9662
|
* @alias module:purecloud-platform-client-v2/api/LearningApi
|
|
@@ -9678,7 +9886,7 @@ if(moduleId===undefined||moduleId===null){throw'Missing the required parameter "
|
|
|
9678
9886
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putLearningModuleRule';}return this.apiClient.callApi('/api/v2/learning/modules/{moduleId}/rule','PUT',{'moduleId':moduleId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return LearningApi;}();var LicenseApi=/*#__PURE__*/function(){/**
|
|
9679
9887
|
* License service.
|
|
9680
9888
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
9681
|
-
* @version
|
|
9889
|
+
* @version 189.0.0
|
|
9682
9890
|
*/ /**
|
|
9683
9891
|
* Constructs a new LicenseApi.
|
|
9684
9892
|
* @alias module:purecloud-platform-client-v2/api/LicenseApi
|
|
@@ -9732,7 +9940,7 @@ if(featureName===undefined||featureName===null){throw'Missing the required param
|
|
|
9732
9940
|
*/},{key:"postLicenseUsers",value:function postLicenseUsers(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/license/users','POST',{},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}}]);return LicenseApi;}();var LocationsApi=/*#__PURE__*/function(){/**
|
|
9733
9941
|
* Locations service.
|
|
9734
9942
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
9735
|
-
* @version
|
|
9943
|
+
* @version 189.0.0
|
|
9736
9944
|
*/ /**
|
|
9737
9945
|
* Constructs a new LocationsApi.
|
|
9738
9946
|
* @alias module:purecloud-platform-client-v2/api/LocationsApi
|
|
@@ -9791,7 +9999,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
9791
9999
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postLocationsSearch';}return this.apiClient.callApi('/api/v2/locations/search','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return LocationsApi;}();var LogCaptureApi=/*#__PURE__*/function(){/**
|
|
9792
10000
|
* LogCapture service.
|
|
9793
10001
|
* @module purecloud-platform-client-v2/api/LogCaptureApi
|
|
9794
|
-
* @version
|
|
10002
|
+
* @version 189.0.0
|
|
9795
10003
|
*/ /**
|
|
9796
10004
|
* Constructs a new LogCaptureApi.
|
|
9797
10005
|
* @alias module:purecloud-platform-client-v2/api/LogCaptureApi
|
|
@@ -9841,7 +10049,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
9841
10049
|
if(userId===undefined||userId===null){throw'Missing the required parameter "userId" when calling postDiagnosticsLogcaptureBrowserUser';}return this.apiClient.callApi('/api/v2/diagnostics/logcapture/browser/users/{userId}','POST',{'userId':userId},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}}]);return LogCaptureApi;}();var MessagingApi=/*#__PURE__*/function(){/**
|
|
9842
10050
|
* Messaging service.
|
|
9843
10051
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
9844
|
-
* @version
|
|
10052
|
+
* @version 189.0.0
|
|
9845
10053
|
*/ /**
|
|
9846
10054
|
* Constructs a new MessagingApi.
|
|
9847
10055
|
* @alias module:purecloud-platform-client-v2/api/MessagingApi
|
|
@@ -9931,7 +10139,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
9931
10139
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putMessagingSettingsDefault';}return this.apiClient.callApi('/api/v2/messaging/settings/default','PUT',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return MessagingApi;}();var MobileDevicesApi=/*#__PURE__*/function(){/**
|
|
9932
10140
|
* MobileDevices service.
|
|
9933
10141
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
9934
|
-
* @version
|
|
10142
|
+
* @version 189.0.0
|
|
9935
10143
|
*/ /**
|
|
9936
10144
|
* Constructs a new MobileDevicesApi.
|
|
9937
10145
|
* @alias module:purecloud-platform-client-v2/api/MobileDevicesApi
|
|
@@ -9970,7 +10178,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
9970
10178
|
if(deviceId===undefined||deviceId===null){throw'Missing the required parameter "deviceId" when calling putMobiledevice';}return this.apiClient.callApi('/api/v2/mobiledevices/{deviceId}','PUT',{'deviceId':deviceId},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}}]);return MobileDevicesApi;}();var NotificationsApi=/*#__PURE__*/function(){/**
|
|
9971
10179
|
* Notifications service.
|
|
9972
10180
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
9973
|
-
* @version
|
|
10181
|
+
* @version 189.0.0
|
|
9974
10182
|
*/ /**
|
|
9975
10183
|
* Constructs a new NotificationsApi.
|
|
9976
10184
|
* @alias module:purecloud-platform-client-v2/api/NotificationsApi
|
|
@@ -10027,7 +10235,7 @@ if(channelId===undefined||channelId===null){throw'Missing the required parameter
|
|
|
10027
10235
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putNotificationsChannelSubscriptions';}return this.apiClient.callApi('/api/v2/notifications/channels/{channelId}/subscriptions','PUT',{'channelId':channelId},{'ignoreErrors':opts['ignoreErrors']},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return NotificationsApi;}();var OAuthApi=/*#__PURE__*/function(){/**
|
|
10028
10236
|
* OAuth service.
|
|
10029
10237
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
10030
|
-
* @version
|
|
10238
|
+
* @version 189.0.0
|
|
10031
10239
|
*/ /**
|
|
10032
10240
|
* Constructs a new OAuthApi.
|
|
10033
10241
|
* @alias module:purecloud-platform-client-v2/api/OAuthApi
|
|
@@ -10112,7 +10320,7 @@ if(clientId===undefined||clientId===null){throw'Missing the required parameter "
|
|
|
10112
10320
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putOauthClient';}return this.apiClient.callApi('/api/v2/oauth/clients/{clientId}','PUT',{'clientId':clientId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return OAuthApi;}();var ObjectsApi=/*#__PURE__*/function(){/**
|
|
10113
10321
|
* Objects service.
|
|
10114
10322
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
10115
|
-
* @version
|
|
10323
|
+
* @version 189.0.0
|
|
10116
10324
|
*/ /**
|
|
10117
10325
|
* Constructs a new ObjectsApi.
|
|
10118
10326
|
* @alias module:purecloud-platform-client-v2/api/ObjectsApi
|
|
@@ -10183,7 +10391,7 @@ if(divisionId===undefined||divisionId===null){throw'Missing the required paramet
|
|
|
10183
10391
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putAuthorizationDivision';}return this.apiClient.callApi('/api/v2/authorization/divisions/{divisionId}','PUT',{'divisionId':divisionId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return ObjectsApi;}();var OperationalEventsApi=/*#__PURE__*/function(){/**
|
|
10184
10392
|
* OperationalEvents service.
|
|
10185
10393
|
* @module purecloud-platform-client-v2/api/OperationalEventsApi
|
|
10186
|
-
* @version
|
|
10394
|
+
* @version 189.0.0
|
|
10187
10395
|
*/ /**
|
|
10188
10396
|
* Constructs a new OperationalEventsApi.
|
|
10189
10397
|
* @alias module:purecloud-platform-client-v2/api/OperationalEventsApi
|
|
@@ -10201,7 +10409,7 @@ if(eventDefinitionId===undefined||eventDefinitionId===null){throw'Missing the re
|
|
|
10201
10409
|
*/},{key:"getUsageEventsDefinitions",value:function getUsageEventsDefinitions(){return this.apiClient.callApi('/api/v2/usage/events/definitions','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return OperationalEventsApi;}();var OrganizationApi=/*#__PURE__*/function(){/**
|
|
10202
10410
|
* Organization service.
|
|
10203
10411
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
10204
|
-
* @version
|
|
10412
|
+
* @version 189.0.0
|
|
10205
10413
|
*/ /**
|
|
10206
10414
|
* Constructs a new OrganizationApi.
|
|
10207
10415
|
* @alias module:purecloud-platform-client-v2/api/OrganizationApi
|
|
@@ -10303,7 +10511,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
10303
10511
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putOrganizationsWhitelist';}return this.apiClient.callApi('/api/v2/organizations/whitelist','PUT',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return OrganizationApi;}();var OrganizationAuthorizationApi=/*#__PURE__*/function(){/**
|
|
10304
10512
|
* OrganizationAuthorization service.
|
|
10305
10513
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
10306
|
-
* @version
|
|
10514
|
+
* @version 189.0.0
|
|
10307
10515
|
*/ /**
|
|
10308
10516
|
* Constructs a new OrganizationAuthorizationApi.
|
|
10309
10517
|
* @alias module:purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
@@ -10626,7 +10834,7 @@ if(trustorOrgId===undefined||trustorOrgId===null){throw'Missing the required par
|
|
|
10626
10834
|
if(trusteeUserId===undefined||trusteeUserId===null){throw'Missing the required parameter "trusteeUserId" when calling putOrgauthorizationTrustorUser';}return this.apiClient.callApi('/api/v2/orgauthorization/trustors/{trustorOrgId}/users/{trusteeUserId}','PUT',{'trustorOrgId':trustorOrgId,'trusteeUserId':trusteeUserId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return OrganizationAuthorizationApi;}();var OutboundApi=/*#__PURE__*/function(){/**
|
|
10627
10835
|
* Outbound service.
|
|
10628
10836
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
10629
|
-
* @version
|
|
10837
|
+
* @version 189.0.0
|
|
10630
10838
|
*/ /**
|
|
10631
10839
|
* Constructs a new OutboundApi.
|
|
10632
10840
|
* @alias module:purecloud-platform-client-v2/api/OutboundApi
|
|
@@ -11396,8 +11604,10 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
11396
11604
|
* Initiate the export of a contact list.
|
|
11397
11605
|
* Returns 200 if received OK.
|
|
11398
11606
|
* @param {String} contactListId ContactList ID
|
|
11399
|
-
|
|
11400
|
-
|
|
11607
|
+
* @param {Object} opts Optional parameters
|
|
11608
|
+
* @param {Object} opts.body Export information to get
|
|
11609
|
+
*/},{key:"postOutboundContactlistExport",value:function postOutboundContactlistExport(contactListId,opts){opts=opts||{};// verify the required parameter 'contactListId' is set
|
|
11610
|
+
if(contactListId===undefined||contactListId===null){throw'Missing the required parameter "contactListId" when calling postOutboundContactlistExport';}return this.apiClient.callApi('/api/v2/outbound/contactlists/{contactListId}/export','POST',{'contactListId':contactListId},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
11401
11611
|
* Create Contact List Filter
|
|
11402
11612
|
*
|
|
11403
11613
|
* @param {Object} body ContactListFilter
|
|
@@ -11662,7 +11872,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
11662
11872
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putOutboundWrapupcodemappings';}return this.apiClient.callApi('/api/v2/outbound/wrapupcodemappings','PUT',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return OutboundApi;}();var PresenceApi=/*#__PURE__*/function(){/**
|
|
11663
11873
|
* Presence service.
|
|
11664
11874
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
11665
|
-
* @version
|
|
11875
|
+
* @version 189.0.0
|
|
11666
11876
|
*/ /**
|
|
11667
11877
|
* Constructs a new PresenceApi.
|
|
11668
11878
|
* @alias module:purecloud-platform-client-v2/api/PresenceApi
|
|
@@ -11835,7 +12045,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
11835
12045
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putUsersPresencesBulk';}return this.apiClient.callApi('/api/v2/users/presences/bulk','PUT',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return PresenceApi;}();var ProcessAutomationApi=/*#__PURE__*/function(){/**
|
|
11836
12046
|
* ProcessAutomation service.
|
|
11837
12047
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
11838
|
-
* @version
|
|
12048
|
+
* @version 189.0.0
|
|
11839
12049
|
*/ /**
|
|
11840
12050
|
* Constructs a new ProcessAutomationApi.
|
|
11841
12051
|
* @alias module:purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
@@ -11898,7 +12108,7 @@ if(triggerId===undefined||triggerId===null){throw'Missing the required parameter
|
|
|
11898
12108
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putProcessautomationTrigger';}return this.apiClient.callApi('/api/v2/processautomation/triggers/{triggerId}','PUT',{'triggerId':triggerId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return ProcessAutomationApi;}();var QualityApi=/*#__PURE__*/function(){/**
|
|
11899
12109
|
* Quality service.
|
|
11900
12110
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
11901
|
-
* @version
|
|
12111
|
+
* @version 189.0.0
|
|
11902
12112
|
*/ /**
|
|
11903
12113
|
* Constructs a new QualityApi.
|
|
11904
12114
|
* @alias module:purecloud-platform-client-v2/api/QualityApi
|
|
@@ -12091,7 +12301,7 @@ if(formId===undefined||formId===null){throw'Missing the required parameter "form
|
|
|
12091
12301
|
* @deprecated
|
|
12092
12302
|
*/},{key:"getQualityFormVersions",value:function getQualityFormVersions(formId,opts){opts=opts||{};// verify the required parameter 'formId' is set
|
|
12093
12303
|
if(formId===undefined||formId===null){throw'Missing the required parameter "formId" when calling getQualityFormVersions';}return this.apiClient.callApi('/api/v2/quality/forms/{formId}/versions','GET',{'formId':formId},{'pageSize':opts['pageSize'],'pageNumber':opts['pageNumber']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
12094
|
-
* Get the list of evaluation forms
|
|
12304
|
+
* Get the list of evaluation forms. If you set expand=publishHistory, then you will be able to get published versions for each corresponding evaluation form.
|
|
12095
12305
|
*
|
|
12096
12306
|
* @param {Object} opts Optional parameters
|
|
12097
12307
|
* @param {Number} opts.pageSize The total page size requested (default to 25)
|
|
@@ -12119,7 +12329,7 @@ if(formId===undefined||formId===null){throw'Missing the required parameter "form
|
|
|
12119
12329
|
*/},{key:"getQualityFormsEvaluationVersions",value:function getQualityFormsEvaluationVersions(formId,opts){opts=opts||{};// verify the required parameter 'formId' is set
|
|
12120
12330
|
if(formId===undefined||formId===null){throw'Missing the required parameter "formId" when calling getQualityFormsEvaluationVersions';}return this.apiClient.callApi('/api/v2/quality/forms/evaluations/{formId}/versions','GET',{'formId':formId},{'pageSize':opts['pageSize'],'pageNumber':opts['pageNumber'],'sortOrder':opts['sortOrder']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
12121
12331
|
* Get the list of evaluation forms
|
|
12122
|
-
* By default, "published" field is always returned as false for all evaluation forms. If you set "expand=publishHistory", then you will be able to get published versions for each corresponding evaluation form. In addition, "questionGroups", the detailed information about evaluation form, is not returned
|
|
12332
|
+
* By default, "published" field is always returned as false for all evaluation forms. If you set "expand=publishHistory", then you will be able to get published versions for each corresponding evaluation form. In addition, "questionGroups", the detailed information about evaluation form, is not returned. We will enhance this field in a future release.
|
|
12123
12333
|
* @param {Object} opts Optional parameters
|
|
12124
12334
|
* @param {Number} opts.pageSize The total page size requested (default to 25)
|
|
12125
12335
|
* @param {Number} opts.pageNumber The page number requested (default to 1)
|
|
@@ -12148,7 +12358,7 @@ if(formId===undefined||formId===null){throw'Missing the required parameter "form
|
|
|
12148
12358
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
12149
12359
|
*/},{key:"getQualityFormsSurveyVersions",value:function getQualityFormsSurveyVersions(formId,opts){opts=opts||{};// verify the required parameter 'formId' is set
|
|
12150
12360
|
if(formId===undefined||formId===null){throw'Missing the required parameter "formId" when calling getQualityFormsSurveyVersions';}return this.apiClient.callApi('/api/v2/quality/forms/surveys/{formId}/versions','GET',{'formId':formId},{'pageSize':opts['pageSize'],'pageNumber':opts['pageNumber']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
12151
|
-
* Get the list of survey forms
|
|
12361
|
+
* Get the list of survey forms. If you set expand=publishHistory, then you will be able to get published versions for each corresponding survey form.
|
|
12152
12362
|
*
|
|
12153
12363
|
* @param {Object} opts Optional parameters
|
|
12154
12364
|
* @param {Number} opts.pageSize The total page size requested (default to 25)
|
|
@@ -12369,7 +12579,7 @@ if(customerSurveyUrl===undefined||customerSurveyUrl===null){throw'Missing the re
|
|
|
12369
12579
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putQualitySurveysScorable';}return this.apiClient.callApi('/api/v2/quality/surveys/scorable','PUT',{},{'customerSurveyUrl':customerSurveyUrl},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return QualityApi;}();var RecordingApi=/*#__PURE__*/function(){/**
|
|
12370
12580
|
* Recording service.
|
|
12371
12581
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
12372
|
-
* @version
|
|
12582
|
+
* @version 189.0.0
|
|
12373
12583
|
*/ /**
|
|
12374
12584
|
* Constructs a new RecordingApi.
|
|
12375
12585
|
* @alias module:purecloud-platform-client-v2/api/RecordingApi
|
|
@@ -12776,7 +12986,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
12776
12986
|
*/},{key:"putRecordingsDeletionprotection",value:function putRecordingsDeletionprotection(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/recordings/deletionprotection','PUT',{},{'protect':opts['protect']},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}}]);return RecordingApi;}();var ResponseManagementApi=/*#__PURE__*/function(){/**
|
|
12777
12987
|
* ResponseManagement service.
|
|
12778
12988
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
12779
|
-
* @version
|
|
12989
|
+
* @version 189.0.0
|
|
12780
12990
|
*/ /**
|
|
12781
12991
|
* Constructs a new ResponseManagementApi.
|
|
12782
12992
|
* @alias module:purecloud-platform-client-v2/api/ResponseManagementApi
|
|
@@ -12892,7 +13102,7 @@ if(responseAssetId===undefined||responseAssetId===null){throw'Missing the requir
|
|
|
12892
13102
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putResponsemanagementResponseasset';}return this.apiClient.callApi('/api/v2/responsemanagement/responseassets/{responseAssetId}','PUT',{'responseAssetId':responseAssetId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return ResponseManagementApi;}();var RoutingApi=/*#__PURE__*/function(){/**
|
|
12893
13103
|
* Routing service.
|
|
12894
13104
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
12895
|
-
* @version
|
|
13105
|
+
* @version 189.0.0
|
|
12896
13106
|
*/ /**
|
|
12897
13107
|
* Constructs a new RoutingApi.
|
|
12898
13108
|
* @alias module:purecloud-platform-client-v2/api/RoutingApi
|
|
@@ -13860,7 +14070,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
13860
14070
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putUserRoutingskillsBulk';}return this.apiClient.callApi('/api/v2/users/{userId}/routingskills/bulk','PUT',{'userId':userId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return RoutingApi;}();var SCIMApi=/*#__PURE__*/function(){/**
|
|
13861
14071
|
* SCIM service.
|
|
13862
14072
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
13863
|
-
* @version
|
|
14073
|
+
* @version 189.0.0
|
|
13864
14074
|
*/ /**
|
|
13865
14075
|
* Constructs a new SCIMApi.
|
|
13866
14076
|
* @alias module:purecloud-platform-client-v2/api/SCIMApi
|
|
@@ -14085,7 +14295,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
14085
14295
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putScimV2User';}return this.apiClient.callApi('/api/v2/scim/v2/users/{userId}','PUT',{'userId':userId},{},{'If-Match':opts['ifMatch']},{},body,['PureCloud OAuth'],['application/scim+json','application/json'],['application/scim+json','application/json']);}}]);return SCIMApi;}();var ScreenRecordingApi=/*#__PURE__*/function(){/**
|
|
14086
14296
|
* ScreenRecording service.
|
|
14087
14297
|
* @module purecloud-platform-client-v2/api/ScreenRecordingApi
|
|
14088
|
-
* @version
|
|
14298
|
+
* @version 189.0.0
|
|
14089
14299
|
*/ /**
|
|
14090
14300
|
* Constructs a new ScreenRecordingApi.
|
|
14091
14301
|
* @alias module:purecloud-platform-client-v2/api/ScreenRecordingApi
|
|
@@ -14100,7 +14310,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
14100
14310
|
*/_createClass(ScreenRecordingApi,[{key:"postScreenrecordingToken",value:function postScreenrecordingToken(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/screenrecording/token','POST',{},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}}]);return ScreenRecordingApi;}();var ScriptsApi=/*#__PURE__*/function(){/**
|
|
14101
14311
|
* Scripts service.
|
|
14102
14312
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
14103
|
-
* @version
|
|
14313
|
+
* @version 189.0.0
|
|
14104
14314
|
*/ /**
|
|
14105
14315
|
* Constructs a new ScriptsApi.
|
|
14106
14316
|
* @alias module:purecloud-platform-client-v2/api/ScriptsApi
|
|
@@ -14236,7 +14446,7 @@ if(scriptId===undefined||scriptId===null){throw'Missing the required parameter "
|
|
|
14236
14446
|
*/},{key:"postScriptsPublished",value:function postScriptsPublished(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/scripts/published','POST',{},{'scriptDataVersion':opts['scriptDataVersion']},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}}]);return ScriptsApi;}();var SearchApi=/*#__PURE__*/function(){/**
|
|
14237
14447
|
* Search service.
|
|
14238
14448
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
14239
|
-
* @version
|
|
14449
|
+
* @version 189.0.0
|
|
14240
14450
|
*/ /**
|
|
14241
14451
|
* Constructs a new SearchApi.
|
|
14242
14452
|
* @alias module:purecloud-platform-client-v2/api/SearchApi
|
|
@@ -14396,7 +14606,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
14396
14606
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postVoicemailSearch';}return this.apiClient.callApi('/api/v2/voicemail/search','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return SearchApi;}();var SettingsApi=/*#__PURE__*/function(){/**
|
|
14397
14607
|
* Settings service.
|
|
14398
14608
|
* @module purecloud-platform-client-v2/api/SettingsApi
|
|
14399
|
-
* @version
|
|
14609
|
+
* @version 189.0.0
|
|
14400
14610
|
*/ /**
|
|
14401
14611
|
* Constructs a new SettingsApi.
|
|
14402
14612
|
* @alias module:purecloud-platform-client-v2/api/SettingsApi
|
|
@@ -14407,14 +14617,24 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
14407
14617
|
* Get email Contact Center settings
|
|
14408
14618
|
*
|
|
14409
14619
|
*/_createClass(SettingsApi,[{key:"getEmailsSettings",value:function getEmailsSettings(){return this.apiClient.callApi('/api/v2/emails/settings','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
14620
|
+
* Get the execution history enabled setting.
|
|
14621
|
+
* Get the execution history enabled setting.
|
|
14622
|
+
* getSettingsExecutiondata is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
14623
|
+
*/},{key:"getSettingsExecutiondata",value:function getSettingsExecutiondata(){return this.apiClient.callApi('/api/v2/settings/executiondata','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
14410
14624
|
* Patch email Contact Center settings
|
|
14411
14625
|
*
|
|
14412
14626
|
* @param {Object} opts Optional parameters
|
|
14413
14627
|
* @param {Object} opts.body
|
|
14414
|
-
*/},{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']);}
|
|
14628
|
+
*/},{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']);}/**
|
|
14629
|
+
* Edit the execution history on off setting.
|
|
14630
|
+
* Edit the execution history on off setting.
|
|
14631
|
+
* @param {Object} body New Execution Data Setting
|
|
14632
|
+
* patchSettingsExecutiondata is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
14633
|
+
*/},{key:"patchSettingsExecutiondata",value:function patchSettingsExecutiondata(body){// verify the required parameter 'body' is set
|
|
14634
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling patchSettingsExecutiondata';}return this.apiClient.callApi('/api/v2/settings/executiondata','PATCH',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return SettingsApi;}();var SpeechTextAnalyticsApi=/*#__PURE__*/function(){/**
|
|
14415
14635
|
* SpeechTextAnalytics service.
|
|
14416
14636
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
14417
|
-
* @version
|
|
14637
|
+
* @version 189.0.0
|
|
14418
14638
|
*/ /**
|
|
14419
14639
|
* Constructs a new SpeechTextAnalyticsApi.
|
|
14420
14640
|
* @alias module:purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
@@ -14658,7 +14878,7 @@ if(topicId===undefined||topicId===null){throw'Missing the required parameter "to
|
|
|
14658
14878
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putSpeechandtextanalyticsTopic';}return this.apiClient.callApi('/api/v2/speechandtextanalytics/topics/{topicId}','PUT',{'topicId':topicId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return SpeechTextAnalyticsApi;}();var StationsApi=/*#__PURE__*/function(){/**
|
|
14659
14879
|
* Stations service.
|
|
14660
14880
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
14661
|
-
* @version
|
|
14881
|
+
* @version 189.0.0
|
|
14662
14882
|
*/ /**
|
|
14663
14883
|
* Constructs a new StationsApi.
|
|
14664
14884
|
* @alias module:purecloud-platform-client-v2/api/StationsApi
|
|
@@ -14690,7 +14910,7 @@ if(stationId===undefined||stationId===null){throw'Missing the required parameter
|
|
|
14690
14910
|
*/},{key:"getStations",value:function getStations(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/stations','GET',{},{'pageSize':opts['pageSize'],'pageNumber':opts['pageNumber'],'sortBy':opts['sortBy'],'name':opts['name'],'userSelectable':opts['userSelectable'],'webRtcUserId':opts['webRtcUserId'],'id':opts['id'],'lineAppearanceId':opts['lineAppearanceId']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return StationsApi;}();var SuggestApi=/*#__PURE__*/function(){/**
|
|
14691
14911
|
* Suggest service.
|
|
14692
14912
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
14693
|
-
* @version
|
|
14913
|
+
* @version 189.0.0
|
|
14694
14914
|
*/ /**
|
|
14695
14915
|
* Constructs a new SuggestApi.
|
|
14696
14916
|
* @alias module:purecloud-platform-client-v2/api/SuggestApi
|
|
@@ -14730,7 +14950,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
14730
14950
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postSearchSuggest';}return this.apiClient.callApi('/api/v2/search/suggest','POST',{},{'profile':opts['profile']},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return SuggestApi;}();var TaskManagementApi=/*#__PURE__*/function(){/**
|
|
14731
14951
|
* TaskManagement service.
|
|
14732
14952
|
* @module purecloud-platform-client-v2/api/TaskManagementApi
|
|
14733
|
-
* @version
|
|
14953
|
+
* @version 189.0.0
|
|
14734
14954
|
*/ /**
|
|
14735
14955
|
* Constructs a new TaskManagementApi.
|
|
14736
14956
|
* @alias module:purecloud-platform-client-v2/api/TaskManagementApi
|
|
@@ -14914,6 +15134,12 @@ if(worktypeId===undefined||worktypeId===null){throw'Missing the required paramet
|
|
|
14914
15134
|
*/},{key:"getTaskmanagementWorktypeStatus",value:function getTaskmanagementWorktypeStatus(worktypeId,statusId){// verify the required parameter 'worktypeId' is set
|
|
14915
15135
|
if(worktypeId===undefined||worktypeId===null){throw'Missing the required parameter "worktypeId" when calling getTaskmanagementWorktypeStatus';}// verify the required parameter 'statusId' is set
|
|
14916
15136
|
if(statusId===undefined||statusId===null){throw'Missing the required parameter "statusId" when calling getTaskmanagementWorktypeStatus';}return this.apiClient.callApi('/api/v2/taskmanagement/worktypes/{worktypeId}/statuses/{statusId}','GET',{'worktypeId':worktypeId,'statusId':statusId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
15137
|
+
* Get list of statuses for this worktype.
|
|
15138
|
+
*
|
|
15139
|
+
* @param {String} worktypeId Worktype id
|
|
15140
|
+
* getTaskmanagementWorktypeStatuses is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
15141
|
+
*/},{key:"getTaskmanagementWorktypeStatuses",value:function getTaskmanagementWorktypeStatuses(worktypeId){// verify the required parameter 'worktypeId' is set
|
|
15142
|
+
if(worktypeId===undefined||worktypeId===null){throw'Missing the required parameter "worktypeId" when calling getTaskmanagementWorktypeStatuses';}return this.apiClient.callApi('/api/v2/taskmanagement/worktypes/{worktypeId}/statuses','GET',{'worktypeId':worktypeId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
14917
15143
|
* Get a version of a worktype
|
|
14918
15144
|
*
|
|
14919
15145
|
* @param {String} worktypeId Worktype id
|
|
@@ -15072,7 +15298,7 @@ if(schemaId===undefined||schemaId===null){throw'Missing the required parameter "
|
|
|
15072
15298
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putTaskmanagementWorkitemsSchema';}return this.apiClient.callApi('/api/v2/taskmanagement/workitems/schemas/{schemaId}','PUT',{'schemaId':schemaId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return TaskManagementApi;}();var TeamsApi=/*#__PURE__*/function(){/**
|
|
15073
15299
|
* Teams service.
|
|
15074
15300
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
15075
|
-
* @version
|
|
15301
|
+
* @version 189.0.0
|
|
15076
15302
|
*/ /**
|
|
15077
15303
|
* Constructs a new TeamsApi.
|
|
15078
15304
|
* @alias module:purecloud-platform-client-v2/api/TeamsApi
|
|
@@ -15151,7 +15377,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
15151
15377
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postTeamsSearch';}return this.apiClient.callApi('/api/v2/teams/search','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return TeamsApi;}();var TelephonyApi=/*#__PURE__*/function(){/**
|
|
15152
15378
|
* Telephony service.
|
|
15153
15379
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
15154
|
-
* @version
|
|
15380
|
+
* @version 189.0.0
|
|
15155
15381
|
*/ /**
|
|
15156
15382
|
* Constructs a new TelephonyApi.
|
|
15157
15383
|
* @alias module:purecloud-platform-client-v2/api/TelephonyApi
|
|
@@ -15198,7 +15424,7 @@ if(downloadId===undefined||downloadId===null){throw'Missing the required paramet
|
|
|
15198
15424
|
if(sIPSearchPublicRequest===undefined||sIPSearchPublicRequest===null){throw'Missing the required parameter "sIPSearchPublicRequest" when calling postTelephonySiptracesDownload';}return this.apiClient.callApi('/api/v2/telephony/siptraces/download','POST',{},{},{},{},sIPSearchPublicRequest,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return TelephonyApi;}();var TelephonyProvidersEdgeApi=/*#__PURE__*/function(){/**
|
|
15199
15425
|
* TelephonyProvidersEdge service.
|
|
15200
15426
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
15201
|
-
* @version
|
|
15427
|
+
* @version 189.0.0
|
|
15202
15428
|
*/ /**
|
|
15203
15429
|
* Constructs a new TelephonyProvidersEdgeApi.
|
|
15204
15430
|
* @alias module:purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
@@ -16012,7 +16238,7 @@ if(trunkBaseSettingsId===undefined||trunkBaseSettingsId===null){throw'Missing th
|
|
|
16012
16238
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putTelephonyProvidersEdgesTrunkbasesetting';}return this.apiClient.callApi('/api/v2/telephony/providers/edges/trunkbasesettings/{trunkBaseSettingsId}','PUT',{'trunkBaseSettingsId':trunkBaseSettingsId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return TelephonyProvidersEdgeApi;}();var TextbotsApi=/*#__PURE__*/function(){/**
|
|
16013
16239
|
* Textbots service.
|
|
16014
16240
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
16015
|
-
* @version
|
|
16241
|
+
* @version 189.0.0
|
|
16016
16242
|
*/ /**
|
|
16017
16243
|
* Constructs a new TextbotsApi.
|
|
16018
16244
|
* @alias module:purecloud-platform-client-v2/api/TextbotsApi
|
|
@@ -16047,7 +16273,7 @@ if(launchRequest===undefined||launchRequest===null){throw'Missing the required p
|
|
|
16047
16273
|
if(postTextRequest===undefined||postTextRequest===null){throw'Missing the required parameter "postTextRequest" when calling postTextbotsBotsExecute';}return this.apiClient.callApi('/api/v2/textbots/bots/execute','POST',{},{},{},{},postTextRequest,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return TextbotsApi;}();var TokensApi=/*#__PURE__*/function(){/**
|
|
16048
16274
|
* Tokens service.
|
|
16049
16275
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
16050
|
-
* @version
|
|
16276
|
+
* @version 189.0.0
|
|
16051
16277
|
*/ /**
|
|
16052
16278
|
* Constructs a new TokensApi.
|
|
16053
16279
|
* @alias module:purecloud-platform-client-v2/api/TokensApi
|
|
@@ -16070,7 +16296,6 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
16070
16296
|
*/},{key:"getTokensMe",value:function getTokensMe(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/tokens/me','GET',{},{'preserveIdleTTL':opts['preserveIdleTTL']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
16071
16297
|
* Get the current Idle Token Timeout Value
|
|
16072
16298
|
*
|
|
16073
|
-
* getTokensTimeout is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
16074
16299
|
*/},{key:"getTokensTimeout",value:function getTokensTimeout(){return this.apiClient.callApi('/api/v2/tokens/timeout','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
16075
16300
|
* Verify user token
|
|
16076
16301
|
*
|
|
@@ -16079,11 +16304,10 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
16079
16304
|
*
|
|
16080
16305
|
* @param {Object} opts Optional parameters
|
|
16081
16306
|
* @param {Object} opts.body
|
|
16082
|
-
* putTokensTimeout is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
16083
16307
|
*/},{key:"putTokensTimeout",value:function putTokensTimeout(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/tokens/timeout','PUT',{},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}}]);return TokensApi;}();var UploadsApi=/*#__PURE__*/function(){/**
|
|
16084
16308
|
* Uploads service.
|
|
16085
16309
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
16086
|
-
* @version
|
|
16310
|
+
* @version 189.0.0
|
|
16087
16311
|
*/ /**
|
|
16088
16312
|
* Constructs a new UploadsApi.
|
|
16089
16313
|
* @alias module:purecloud-platform-client-v2/api/UploadsApi
|
|
@@ -16149,7 +16373,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
16149
16373
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postUploadsWorkforcemanagementHistoricaldataCsv';}return this.apiClient.callApi('/api/v2/uploads/workforcemanagement/historicaldata/csv','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return UploadsApi;}();var UsageApi=/*#__PURE__*/function(){/**
|
|
16150
16374
|
* Usage service.
|
|
16151
16375
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
16152
|
-
* @version
|
|
16376
|
+
* @version 189.0.0
|
|
16153
16377
|
*/ /**
|
|
16154
16378
|
* Constructs a new UsageApi.
|
|
16155
16379
|
* @alias module:purecloud-platform-client-v2/api/UsageApi
|
|
@@ -16200,7 +16424,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
16200
16424
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postUsageSimplesearch';}return this.apiClient.callApi('/api/v2/usage/simplesearch','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return UsageApi;}();var UserRecordingsApi=/*#__PURE__*/function(){/**
|
|
16201
16425
|
* UserRecordings service.
|
|
16202
16426
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
16203
|
-
* @version
|
|
16427
|
+
* @version 189.0.0
|
|
16204
16428
|
*/ /**
|
|
16205
16429
|
* Constructs a new UserRecordingsApi.
|
|
16206
16430
|
* @alias module:purecloud-platform-client-v2/api/UserRecordingsApi
|
|
@@ -16249,7 +16473,7 @@ if(recordingId===undefined||recordingId===null){throw'Missing the required param
|
|
|
16249
16473
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putUserrecording';}return this.apiClient.callApi('/api/v2/userrecordings/{recordingId}','PUT',{'recordingId':recordingId},{'expand':this.apiClient.buildCollectionParam(opts['expand'],'multi')},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return UserRecordingsApi;}();var UsersApi=/*#__PURE__*/function(){/**
|
|
16250
16474
|
* Users service.
|
|
16251
16475
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
16252
|
-
* @version
|
|
16476
|
+
* @version 189.0.0
|
|
16253
16477
|
*/ /**
|
|
16254
16478
|
* Constructs a new UsersApi.
|
|
16255
16479
|
* @alias module:purecloud-platform-client-v2/api/UsersApi
|
|
@@ -16908,7 +17132,7 @@ if(verifierId===undefined||verifierId===null){throw'Missing the required paramet
|
|
|
16908
17132
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putUserVerifier';}return this.apiClient.callApi('/api/v2/users/{userId}/verifiers/{verifierId}','PUT',{'userId':userId,'verifierId':verifierId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return UsersApi;}();var UtilitiesApi=/*#__PURE__*/function(){/**
|
|
16909
17133
|
* Utilities service.
|
|
16910
17134
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
16911
|
-
* @version
|
|
17135
|
+
* @version 189.0.0
|
|
16912
17136
|
*/ /**
|
|
16913
17137
|
* Constructs a new UtilitiesApi.
|
|
16914
17138
|
* @alias module:purecloud-platform-client-v2/api/UtilitiesApi
|
|
@@ -16935,7 +17159,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
16935
17159
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postCertificateDetails';}return this.apiClient.callApi('/api/v2/certificate/details','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return UtilitiesApi;}();var VoicemailApi=/*#__PURE__*/function(){/**
|
|
16936
17160
|
* Voicemail service.
|
|
16937
17161
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
16938
|
-
* @version
|
|
17162
|
+
* @version 189.0.0
|
|
16939
17163
|
*/ /**
|
|
16940
17164
|
* Constructs a new VoicemailApi.
|
|
16941
17165
|
* @alias module:purecloud-platform-client-v2/api/VoicemailApi
|
|
@@ -17084,7 +17308,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
17084
17308
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putVoicemailUserpolicy';}return this.apiClient.callApi('/api/v2/voicemail/userpolicies/{userId}','PUT',{'userId':userId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return VoicemailApi;}();var WebChatApi=/*#__PURE__*/function(){/**
|
|
17085
17309
|
* WebChat service.
|
|
17086
17310
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
17087
|
-
* @version
|
|
17311
|
+
* @version 189.0.0
|
|
17088
17312
|
*/ /**
|
|
17089
17313
|
* Constructs a new WebChatApi.
|
|
17090
17314
|
* @alias module:purecloud-platform-client-v2/api/WebChatApi
|
|
@@ -17217,7 +17441,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
17217
17441
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putWebchatSettings';}return this.apiClient.callApi('/api/v2/webchat/settings','PUT',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return WebChatApi;}();var WebDeploymentsApi=/*#__PURE__*/function(){/**
|
|
17218
17442
|
* WebDeployments service.
|
|
17219
17443
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
17220
|
-
* @version
|
|
17444
|
+
* @version 189.0.0
|
|
17221
17445
|
*/ /**
|
|
17222
17446
|
* Constructs a new WebDeploymentsApi.
|
|
17223
17447
|
* @alias module:purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
@@ -17338,7 +17562,7 @@ if(deploymentId===undefined||deploymentId===null){throw'Missing the required par
|
|
|
17338
17562
|
if(deployment===undefined||deployment===null){throw'Missing the required parameter "deployment" when calling putWebdeploymentsDeployment';}return this.apiClient.callApi('/api/v2/webdeployments/deployments/{deploymentId}','PUT',{'deploymentId':deploymentId},{},{},{},deployment,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return WebDeploymentsApi;}();var WebMessagingApi=/*#__PURE__*/function(){/**
|
|
17339
17563
|
* WebMessaging service.
|
|
17340
17564
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
17341
|
-
* @version
|
|
17565
|
+
* @version 189.0.0
|
|
17342
17566
|
*/ /**
|
|
17343
17567
|
* Constructs a new WebMessagingApi.
|
|
17344
17568
|
* @alias module:purecloud-platform-client-v2/api/WebMessagingApi
|
|
@@ -17354,7 +17578,7 @@ if(deployment===undefined||deployment===null){throw'Missing the required paramet
|
|
|
17354
17578
|
*/_createClass(WebMessagingApi,[{key:"getWebmessagingMessages",value:function getWebmessagingMessages(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/webmessaging/messages','GET',{},{'pageSize':opts['pageSize'],'pageNumber':opts['pageNumber']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return WebMessagingApi;}();var WidgetsApi=/*#__PURE__*/function(){/**
|
|
17355
17579
|
* Widgets service.
|
|
17356
17580
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
17357
|
-
* @version
|
|
17581
|
+
* @version 189.0.0
|
|
17358
17582
|
*/ /**
|
|
17359
17583
|
* Constructs a new WidgetsApi.
|
|
17360
17584
|
* @alias module:purecloud-platform-client-v2/api/WidgetsApi
|
|
@@ -17389,7 +17613,7 @@ if(deploymentId===undefined||deploymentId===null){throw'Missing the required par
|
|
|
17389
17613
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putWidgetsDeployment';}return this.apiClient.callApi('/api/v2/widgets/deployments/{deploymentId}','PUT',{'deploymentId':deploymentId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return WidgetsApi;}();var WorkforceManagementApi=/*#__PURE__*/function(){/**
|
|
17390
17614
|
* WorkforceManagement service.
|
|
17391
17615
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
17392
|
-
* @version
|
|
17616
|
+
* @version 189.0.0
|
|
17393
17617
|
*/ /**
|
|
17394
17618
|
* Constructs a new WorkforceManagementApi.
|
|
17395
17619
|
* @alias module:purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
@@ -17509,9 +17733,10 @@ if(jobId===undefined||jobId===null){throw'Missing the required parameter "jobId"
|
|
|
17509
17733
|
* @param {String} jobId jobId
|
|
17510
17734
|
*/},{key:"getWorkforcemanagementAdherenceHistoricalJob",value:function getWorkforcemanagementAdherenceHistoricalJob(jobId){// verify the required parameter 'jobId' is set
|
|
17511
17735
|
if(jobId===undefined||jobId===null){throw'Missing the required parameter "jobId" when calling getWorkforcemanagementAdherenceHistoricalJob';}return this.apiClient.callApi('/api/v2/workforcemanagement/adherence/historical/jobs/{jobId}','GET',{'jobId':jobId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
17512
|
-
*
|
|
17513
|
-
*
|
|
17736
|
+
* To get status of the modeling job.
|
|
17737
|
+
* This Endpoint is Deprecated, and not recommended to be used.
|
|
17514
17738
|
* @param {String} jobId The id of the modeling job
|
|
17739
|
+
* @deprecated
|
|
17515
17740
|
*/},{key:"getWorkforcemanagementAdhocmodelingjob",value:function getWorkforcemanagementAdhocmodelingjob(jobId){// verify the required parameter 'jobId' is set
|
|
17516
17741
|
if(jobId===undefined||jobId===null){throw'Missing the required parameter "jobId" when calling getWorkforcemanagementAdhocmodelingjob';}return this.apiClient.callApi('/api/v2/workforcemanagement/adhocmodelingjobs/{jobId}','GET',{'jobId':jobId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
17517
17742
|
* Get an adherence explanation
|
|
@@ -18740,7 +18965,7 @@ if(timeOffLimitId===undefined||timeOffLimitId===null){throw'Missing the required
|
|
|
18740
18965
|
* </pre>
|
|
18741
18966
|
* </p>
|
|
18742
18967
|
* @module purecloud-platform-client-v2/index
|
|
18743
|
-
* @version
|
|
18968
|
+
* @version 189.0.0
|
|
18744
18969
|
*/var platformClient=/*#__PURE__*/_createClass(function platformClient(){_classCallCheck(this,platformClient);/**
|
|
18745
18970
|
* The ApiClient constructor.
|
|
18746
18971
|
* @property {module:purecloud-platform-client-v2/ApiClient}
|