purecloud-platform-client-v2 252.1.0 → 254.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +3 -3
- package/dist/node/purecloud-platform-client-v2.js +1979 -556
- package/dist/web-amd/purecloud-platform-client-v2.js +1979 -556
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +686 -393
- package/dist/web-cjs/purecloud-platform-client-v2.js +686 -393
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +1094 -117
- package/package.json +1 -1
- package/src/purecloud-platform-client-v2/ApiClient.js +1 -1
- package/src/purecloud-platform-client-v2/api/AIStudioApi.js +6 -6
- package/src/purecloud-platform-client-v2/api/AgentAssistantsApi.js +3 -2
- package/src/purecloud-platform-client-v2/api/AgentCopilotApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AgentUIApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AlertingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +1 -62
- package/src/purecloud-platform-client-v2/api/ArchitectApi.js +3 -2
- package/src/purecloud-platform-client-v2/api/AssistantCopilotVariationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AuditApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/BackgroundAssistantApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/BillingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/BusinessRulesApi.js +435 -1
- package/src/purecloud-platform-client-v2/api/CarrierServicesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/CaseManagementApi.js +207 -125
- 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 +2 -6
- package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/DataPrivacyApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/DownloadsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EmailsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EmployeeEngagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EventsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/FaxApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/FlowsApi.js +1 -5
- package/src/purecloud-platform-client-v2/api/GamificationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GeolocationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GreetingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GroupsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/IdentityProviderApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/InfrastructureAsCodeApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/IntentsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/JourneyApi.js +122 -11
- package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +42 -1
- package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LanguagesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LearningApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LicenseApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LocationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LogCaptureApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/MessagingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/MobileDevicesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/NotificationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OAuthApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ObjectsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OperationalEventsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OrganizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OutboundApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/PresenceApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ProcessAutomationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/QualityApi.js +1 -9
- 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 +333 -158
- package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ScriptsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SearchApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SettingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SocialMediaApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/StationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SuggestApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TaskManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TeamsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TelephonyApi.js +268 -1
- package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +1 -47
- package/src/purecloud-platform-client-v2/api/TextbotsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TokensApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UploadsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsageApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsersApi.js +1 -5
- package/src/purecloud-platform-client-v2/api/UsersRulesApi.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 +481 -43
- package/src/purecloud-platform-client-v2/index.js +1 -1
package/dist/web-cjs/bundle.js
CHANGED
|
@@ -1082,7 +1082,7 @@ if(env)this.environment=env;else this.environment=this.host?this.host:'mypureclo
|
|
|
1082
1082
|
this.environment=this.environment.replace(/\/+$/,'');// Strip protocol and subdomain
|
|
1083
1083
|
if(this.environment.startsWith('https://'))this.environment=this.environment.substring(8);if(this.environment.startsWith('http://'))this.environment=this.environment.substring(7);if(this.environment.startsWith('api.'))this.environment=this.environment.substring(4);this.basePath="https://api.".concat(this.environment);this.authUrl="https://login.".concat(this.environment);}},{key:"getConfUrl",value:function getConfUrl(pathType,regionUrl){if(!this.gateway)return regionUrl;if(!this.gateway.host)return regionUrl;var url=this.gateway.protocol+'://'+this.gateway.host;if(this.gateway.port>-1)url=url+':'+this.gateway.port.toString();if(pathType==='login'){if(this.gateway.path_params_login){if(this.gateway.path_params_login.startsWith('/'))url=url+this.gateway.path_params_login;else url=url+'/'+this.gateway.path_params_login;}}else{if(this.gateway.path_params_api){if(this.gateway.path_params_api.startsWith('/'))url=url+this.gateway.path_params_api;else url=url+'/'+this.gateway.path_params_api;}}return url;}},{key:"getConfigString",value:function getConfigString(section,key){if(this.config._sections[section])return this.config._sections[section][key];}},{key:"getConfigBoolean",value:function getConfigBoolean(section,key){if(this.config._sections[section]&&this.config._sections[section][key]!==undefined){if(typeof this.config._sections[section][key]==='string'){return this.config._sections[section][key]==='true';}else return this.config._sections[section][key];}}},{key:"getConfigInt",value:function getConfigInt(section,key){if(this.config._sections[section]&&this.config._sections[section][key]){if(typeof this.config._sections[section][key]==='string'){return parseInt(this.config._sections[section][key]);}else return this.config._sections[section][key];}}}]);}();/**
|
|
1084
1084
|
* @module purecloud-platform-client-v2/ApiClient
|
|
1085
|
-
* @version
|
|
1085
|
+
* @version 254.0.0
|
|
1086
1086
|
*/var ApiClient=/*#__PURE__*/function(){/**
|
|
1087
1087
|
* Manages low level client-server communications, parameter marshalling, etc. There should not be any need for an
|
|
1088
1088
|
* application to use this class directly - the *Api and model classes provide the public API for the service. The
|
|
@@ -1451,7 +1451,7 @@ resolve(data);})["catch"](function(error){var data=error;if(error.response&&erro
|
|
|
1451
1451
|
that.config.logger.log('error',error.response.status,httpMethod,url,request.headers,error.response.headers,bodyParam,error.response.data);data=that.returnExtended===true?{status:error.response.status,statusText:error.response.statusText,headers:error.response.headers,body:error.response.data,text:error.response.text,error:error}:error.response.data?error.response.data:error.response.text;}reject(data);});}});}}]);}();var AIStudioApi=/*#__PURE__*/function(){/**
|
|
1452
1452
|
* AIStudio service.
|
|
1453
1453
|
* @module purecloud-platform-client-v2/api/AIStudioApi
|
|
1454
|
-
* @version
|
|
1454
|
+
* @version 254.0.0
|
|
1455
1455
|
*//**
|
|
1456
1456
|
* Constructs a new AIStudioApi.
|
|
1457
1457
|
* @alias module:purecloud-platform-client-v2/api/AIStudioApi
|
|
@@ -1483,14 +1483,14 @@ if(summarySettingId===undefined||summarySettingId===null||summarySettingId==='')
|
|
|
1483
1483
|
* Get all summary settings.
|
|
1484
1484
|
*
|
|
1485
1485
|
* @param {Object} opts Optional parameters
|
|
1486
|
-
* @param {String} opts.language Filter by matching language - case insensitive.
|
|
1487
|
-
* @param {String} opts.name Filter by partially matching name - case insensitive.
|
|
1488
|
-
* @param {Object} opts.sortBy Sort by. Default value dateModified. (default to dateModified)
|
|
1489
|
-
* @param {Object} opts.sortOrder Sort Order. Default value desc. (default to desc)
|
|
1490
1486
|
* @param {Number} opts.pageNumber Page number. (default to 1)
|
|
1491
1487
|
* @param {Number} opts.pageSize Page size. The maximum page size is 100. (default to 25)
|
|
1488
|
+
* @param {String} opts.name Filter by partially matching name - case insensitive.
|
|
1489
|
+
* @param {Object} opts.sortOrder Sort Order. Default value desc. (default to desc)
|
|
1490
|
+
* @param {String} opts.language Filter by matching language - case insensitive.
|
|
1491
|
+
* @param {Object} opts.sortBy Sort by. Default value dateModified. (default to dateModified)
|
|
1492
1492
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1493
|
-
*/},{key:"getConversationsSummariesSettings",value:function getConversationsSummariesSettings(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/conversations/summaries/settings','GET',{},{'
|
|
1493
|
+
*/},{key:"getConversationsSummariesSettings",value:function getConversationsSummariesSettings(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/conversations/summaries/settings','GET',{},{'pageNumber':opts['pageNumber'],'pageSize':opts['pageSize'],'name':opts['name'],'sortOrder':opts['sortOrder'],'language':opts['language'],'sortBy':opts['sortBy']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
1494
1494
|
* Get guide.
|
|
1495
1495
|
*
|
|
1496
1496
|
* @param {String} guideId Guide ID
|
|
@@ -1642,7 +1642,7 @@ if(summarySettingId===undefined||summarySettingId===null||summarySettingId==='')
|
|
|
1642
1642
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putConversationsSummariesSetting';}return this.apiClient.callApi('/api/v2/conversations/summaries/settings/{summarySettingId}','PUT',{'summarySettingId':summarySettingId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}}]);}();var AgentAssistantsApi=/*#__PURE__*/function(){/**
|
|
1643
1643
|
* AgentAssistants service.
|
|
1644
1644
|
* @module purecloud-platform-client-v2/api/AgentAssistantsApi
|
|
1645
|
-
* @version
|
|
1645
|
+
* @version 254.0.0
|
|
1646
1646
|
*//**
|
|
1647
1647
|
* Constructs a new AgentAssistantsApi.
|
|
1648
1648
|
* @alias module:purecloud-platform-client-v2/api/AgentAssistantsApi
|
|
@@ -1751,8 +1751,9 @@ if(agentChecklistId===undefined||agentChecklistId===null||agentChecklistId==='')
|
|
|
1751
1751
|
* @param {String} opts.language The agent checklist language filter applied to the listing.
|
|
1752
1752
|
* @param {Object} opts.sortOrder The sort order for the listing
|
|
1753
1753
|
* @param {Object} opts.sortBy The field to sort by for the listing.
|
|
1754
|
+
* @param {Array.<String>} opts.agentChecklistIds Agent checklist IDs (repeat param or comma-separated). Do not use with other optional filters.
|
|
1754
1755
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1755
|
-
*/},{key:"getAssistantsAgentchecklists",value:function getAssistantsAgentchecklists(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/assistants/agentchecklists','GET',{},{'before':opts['before'],'after':opts['after'],'pageSize':opts['pageSize'],'namePrefix':opts['namePrefix'],'language':opts['language'],'sortOrder':opts['sortOrder'],'sortBy':opts['sortBy']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
1756
|
+
*/},{key:"getAssistantsAgentchecklists",value:function getAssistantsAgentchecklists(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/assistants/agentchecklists','GET',{},{'before':opts['before'],'after':opts['after'],'pageSize':opts['pageSize'],'namePrefix':opts['namePrefix'],'language':opts['language'],'sortOrder':opts['sortOrder'],'sortBy':opts['sortBy'],'agentChecklistIds':this.apiClient.buildCollectionParam(opts['agentChecklistIds'],'multi')},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
1756
1757
|
* Get the list of supported languages
|
|
1757
1758
|
*
|
|
1758
1759
|
* @param {Object} opts Optional parameters
|
|
@@ -1867,7 +1868,7 @@ if(agentChecklistId===undefined||agentChecklistId===null||agentChecklistId==='')
|
|
|
1867
1868
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putAssistantsAgentchecklist';}return this.apiClient.callApi('/api/v2/assistants/agentchecklists/{agentChecklistId}','PUT',{'agentChecklistId':agentChecklistId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}}]);}();var AgentCopilotApi=/*#__PURE__*/function(){/**
|
|
1868
1869
|
* AgentCopilot service.
|
|
1869
1870
|
* @module purecloud-platform-client-v2/api/AgentCopilotApi
|
|
1870
|
-
* @version
|
|
1871
|
+
* @version 254.0.0
|
|
1871
1872
|
*//**
|
|
1872
1873
|
* Constructs a new AgentCopilotApi.
|
|
1873
1874
|
* @alias module:purecloud-platform-client-v2/api/AgentCopilotApi
|
|
@@ -1899,7 +1900,7 @@ if(assistantId===undefined||assistantId===null||assistantId===''){throw'Missing
|
|
|
1899
1900
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putAssistantCopilot';}return this.apiClient.callApi('/api/v2/assistants/{assistantId}/copilot','PUT',{'assistantId':assistantId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}}]);}();var AgentUIApi=/*#__PURE__*/function(){/**
|
|
1900
1901
|
* AgentUI service.
|
|
1901
1902
|
* @module purecloud-platform-client-v2/api/AgentUIApi
|
|
1902
|
-
* @version
|
|
1903
|
+
* @version 254.0.0
|
|
1903
1904
|
*//**
|
|
1904
1905
|
* Constructs a new AgentUIApi.
|
|
1905
1906
|
* @alias module:purecloud-platform-client-v2/api/AgentUIApi
|
|
@@ -1941,7 +1942,7 @@ if(agentId===undefined||agentId===null||agentId===''){throw'Missing the required
|
|
|
1941
1942
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putUsersAgentuiAgentsAutoanswerAgentIdSettings';}return this.apiClient.callApi('/api/v2/users/agentui/agents/autoanswer/{agentId}/settings','PUT',{'agentId':agentId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}}]);}();var AlertingApi=/*#__PURE__*/function(){/**
|
|
1942
1943
|
* Alerting service.
|
|
1943
1944
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
1944
|
-
* @version
|
|
1945
|
+
* @version 254.0.0
|
|
1945
1946
|
*//**
|
|
1946
1947
|
* Constructs a new AlertingApi.
|
|
1947
1948
|
* @alias module:purecloud-platform-client-v2/api/AlertingApi
|
|
@@ -2055,7 +2056,7 @@ if(ruleId===undefined||ruleId===null||ruleId===''){throw'Missing the required pa
|
|
|
2055
2056
|
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'],opts['customHeaders']);}}]);}();var AnalyticsApi=/*#__PURE__*/function(){/**
|
|
2056
2057
|
* Analytics service.
|
|
2057
2058
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
2058
|
-
* @version
|
|
2059
|
+
* @version 254.0.0
|
|
2059
2060
|
*//**
|
|
2060
2061
|
* Constructs a new AnalyticsApi.
|
|
2061
2062
|
* @alias module:purecloud-platform-client-v2/api/AnalyticsApi
|
|
@@ -2068,7 +2069,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
2068
2069
|
* @param {String} jobId jobId
|
|
2069
2070
|
* @param {Object} opts Optional parameters
|
|
2070
2071
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2071
|
-
* deleteAnalyticsActionsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2072
2072
|
*/return _createClass(AnalyticsApi,[{key:"deleteAnalyticsActionsAggregatesJob",value:function deleteAnalyticsActionsAggregatesJob(jobId,opts){opts=opts||{};// verify the required parameter 'jobId' is set
|
|
2073
2073
|
if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required parameter "jobId" when calling deleteAnalyticsActionsAggregatesJob';}return this.apiClient.callApi('/api/v2/analytics/actions/aggregates/jobs/{jobId}','DELETE',{'jobId':jobId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
2074
2074
|
* Delete/cancel an async request for agent copilot aggregates
|
|
@@ -2092,7 +2092,6 @@ if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required param
|
|
|
2092
2092
|
* @param {String} jobId jobId
|
|
2093
2093
|
* @param {Object} opts Optional parameters
|
|
2094
2094
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2095
|
-
* deleteAnalyticsBotsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2096
2095
|
*/},{key:"deleteAnalyticsBotsAggregatesJob",value:function deleteAnalyticsBotsAggregatesJob(jobId,opts){opts=opts||{};// verify the required parameter 'jobId' is set
|
|
2097
2096
|
if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required parameter "jobId" when calling deleteAnalyticsBotsAggregatesJob';}return this.apiClient.callApi('/api/v2/analytics/bots/aggregates/jobs/{jobId}','DELETE',{'jobId':jobId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
2098
2097
|
* Delete/cancel an async request for case management aggregates
|
|
@@ -2100,7 +2099,6 @@ if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required param
|
|
|
2100
2099
|
* @param {String} jobId jobId
|
|
2101
2100
|
* @param {Object} opts Optional parameters
|
|
2102
2101
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2103
|
-
* deleteAnalyticsCasemanagementAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2104
2102
|
*/},{key:"deleteAnalyticsCasemanagementAggregatesJob",value:function deleteAnalyticsCasemanagementAggregatesJob(jobId,opts){opts=opts||{};// verify the required parameter 'jobId' is set
|
|
2105
2103
|
if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required parameter "jobId" when calling deleteAnalyticsCasemanagementAggregatesJob';}return this.apiClient.callApi('/api/v2/analytics/casemanagement/aggregates/jobs/{jobId}','DELETE',{'jobId':jobId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
2106
2104
|
* Delete/cancel an async request for conversation aggregates
|
|
@@ -2108,7 +2106,6 @@ if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required param
|
|
|
2108
2106
|
* @param {String} jobId jobId
|
|
2109
2107
|
* @param {Object} opts Optional parameters
|
|
2110
2108
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2111
|
-
* deleteAnalyticsConversationsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2112
2109
|
*/},{key:"deleteAnalyticsConversationsAggregatesJob",value:function deleteAnalyticsConversationsAggregatesJob(jobId,opts){opts=opts||{};// verify the required parameter 'jobId' is set
|
|
2113
2110
|
if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required parameter "jobId" when calling deleteAnalyticsConversationsAggregatesJob';}return this.apiClient.callApi('/api/v2/analytics/conversations/aggregates/jobs/{jobId}','DELETE',{'jobId':jobId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
2114
2111
|
* Delete/cancel an async details job
|
|
@@ -2131,7 +2128,6 @@ if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required param
|
|
|
2131
2128
|
* @param {String} jobId jobId
|
|
2132
2129
|
* @param {Object} opts Optional parameters
|
|
2133
2130
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2134
|
-
* deleteAnalyticsEvaluationsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2135
2131
|
*/},{key:"deleteAnalyticsEvaluationsAggregatesJob",value:function deleteAnalyticsEvaluationsAggregatesJob(jobId,opts){opts=opts||{};// verify the required parameter 'jobId' is set
|
|
2136
2132
|
if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required parameter "jobId" when calling deleteAnalyticsEvaluationsAggregatesJob';}return this.apiClient.callApi('/api/v2/analytics/evaluations/aggregates/jobs/{jobId}','DELETE',{'jobId':jobId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
2137
2133
|
* Delete/cancel an async request for flow execution aggregates
|
|
@@ -2139,7 +2135,6 @@ if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required param
|
|
|
2139
2135
|
* @param {String} jobId jobId
|
|
2140
2136
|
* @param {Object} opts Optional parameters
|
|
2141
2137
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2142
|
-
* deleteAnalyticsFlowexecutionsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2143
2138
|
*/},{key:"deleteAnalyticsFlowexecutionsAggregatesJob",value:function deleteAnalyticsFlowexecutionsAggregatesJob(jobId,opts){opts=opts||{};// verify the required parameter 'jobId' is set
|
|
2144
2139
|
if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required parameter "jobId" when calling deleteAnalyticsFlowexecutionsAggregatesJob';}return this.apiClient.callApi('/api/v2/analytics/flowexecutions/aggregates/jobs/{jobId}','DELETE',{'jobId':jobId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
2145
2140
|
* Delete/cancel an async request for flow aggregates
|
|
@@ -2147,7 +2142,6 @@ if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required param
|
|
|
2147
2142
|
* @param {String} jobId jobId
|
|
2148
2143
|
* @param {Object} opts Optional parameters
|
|
2149
2144
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2150
|
-
* deleteAnalyticsFlowsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2151
2145
|
*/},{key:"deleteAnalyticsFlowsAggregatesJob",value:function deleteAnalyticsFlowsAggregatesJob(jobId,opts){opts=opts||{};// verify the required parameter 'jobId' is set
|
|
2152
2146
|
if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required parameter "jobId" when calling deleteAnalyticsFlowsAggregatesJob';}return this.apiClient.callApi('/api/v2/analytics/flows/aggregates/jobs/{jobId}','DELETE',{'jobId':jobId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
2153
2147
|
* Delete/cancel an async request for journey aggregates
|
|
@@ -2155,7 +2149,6 @@ if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required param
|
|
|
2155
2149
|
* @param {String} jobId jobId
|
|
2156
2150
|
* @param {Object} opts Optional parameters
|
|
2157
2151
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2158
|
-
* deleteAnalyticsJourneysAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2159
2152
|
*/},{key:"deleteAnalyticsJourneysAggregatesJob",value:function deleteAnalyticsJourneysAggregatesJob(jobId,opts){opts=opts||{};// verify the required parameter 'jobId' is set
|
|
2160
2153
|
if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required parameter "jobId" when calling deleteAnalyticsJourneysAggregatesJob';}return this.apiClient.callApi('/api/v2/analytics/journeys/aggregates/jobs/{jobId}','DELETE',{'jobId':jobId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
2161
2154
|
* Delete/cancel an async request for knowledge aggregates
|
|
@@ -2163,7 +2156,6 @@ if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required param
|
|
|
2163
2156
|
* @param {String} jobId jobId
|
|
2164
2157
|
* @param {Object} opts Optional parameters
|
|
2165
2158
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2166
|
-
* deleteAnalyticsKnowledgeAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2167
2159
|
*/},{key:"deleteAnalyticsKnowledgeAggregatesJob",value:function deleteAnalyticsKnowledgeAggregatesJob(jobId,opts){opts=opts||{};// verify the required parameter 'jobId' is set
|
|
2168
2160
|
if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required parameter "jobId" when calling deleteAnalyticsKnowledgeAggregatesJob';}return this.apiClient.callApi('/api/v2/analytics/knowledge/aggregates/jobs/{jobId}','DELETE',{'jobId':jobId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
2169
2161
|
* Delete/cancel an async request for resolution aggregates
|
|
@@ -2171,7 +2163,6 @@ if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required param
|
|
|
2171
2163
|
* @param {String} jobId jobId
|
|
2172
2164
|
* @param {Object} opts Optional parameters
|
|
2173
2165
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2174
|
-
* deleteAnalyticsResolutionsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2175
2166
|
*/},{key:"deleteAnalyticsResolutionsAggregatesJob",value:function deleteAnalyticsResolutionsAggregatesJob(jobId,opts){opts=opts||{};// verify the required parameter 'jobId' is set
|
|
2176
2167
|
if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required parameter "jobId" when calling deleteAnalyticsResolutionsAggregatesJob';}return this.apiClient.callApi('/api/v2/analytics/resolutions/aggregates/jobs/{jobId}','DELETE',{'jobId':jobId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
2177
2168
|
* Delete/cancel an async request for summary aggregates
|
|
@@ -2179,7 +2170,6 @@ if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required param
|
|
|
2179
2170
|
* @param {String} jobId jobId
|
|
2180
2171
|
* @param {Object} opts Optional parameters
|
|
2181
2172
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2182
|
-
* deleteAnalyticsSummariesAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2183
2173
|
*/},{key:"deleteAnalyticsSummariesAggregatesJob",value:function deleteAnalyticsSummariesAggregatesJob(jobId,opts){opts=opts||{};// verify the required parameter 'jobId' is set
|
|
2184
2174
|
if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required parameter "jobId" when calling deleteAnalyticsSummariesAggregatesJob';}return this.apiClient.callApi('/api/v2/analytics/summaries/aggregates/jobs/{jobId}','DELETE',{'jobId':jobId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
2185
2175
|
* Delete/cancel an async request for survey aggregates
|
|
@@ -2187,7 +2177,6 @@ if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required param
|
|
|
2187
2177
|
* @param {String} jobId jobId
|
|
2188
2178
|
* @param {Object} opts Optional parameters
|
|
2189
2179
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2190
|
-
* deleteAnalyticsSurveysAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2191
2180
|
*/},{key:"deleteAnalyticsSurveysAggregatesJob",value:function deleteAnalyticsSurveysAggregatesJob(jobId,opts){opts=opts||{};// verify the required parameter 'jobId' is set
|
|
2192
2181
|
if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required parameter "jobId" when calling deleteAnalyticsSurveysAggregatesJob';}return this.apiClient.callApi('/api/v2/analytics/surveys/aggregates/jobs/{jobId}','DELETE',{'jobId':jobId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
2193
2182
|
* Delete/cancel an async request for task management aggregates
|
|
@@ -2195,7 +2184,6 @@ if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required param
|
|
|
2195
2184
|
* @param {String} jobId jobId
|
|
2196
2185
|
* @param {Object} opts Optional parameters
|
|
2197
2186
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2198
|
-
* deleteAnalyticsTaskmanagementAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2199
2187
|
*/},{key:"deleteAnalyticsTaskmanagementAggregatesJob",value:function deleteAnalyticsTaskmanagementAggregatesJob(jobId,opts){opts=opts||{};// verify the required parameter 'jobId' is set
|
|
2200
2188
|
if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required parameter "jobId" when calling deleteAnalyticsTaskmanagementAggregatesJob';}return this.apiClient.callApi('/api/v2/analytics/taskmanagement/aggregates/jobs/{jobId}','DELETE',{'jobId':jobId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
2201
2189
|
* Delete/cancel an async request for transcript aggregates
|
|
@@ -2203,7 +2191,6 @@ if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required param
|
|
|
2203
2191
|
* @param {String} jobId jobId
|
|
2204
2192
|
* @param {Object} opts Optional parameters
|
|
2205
2193
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2206
|
-
* deleteAnalyticsTranscriptsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2207
2194
|
*/},{key:"deleteAnalyticsTranscriptsAggregatesJob",value:function deleteAnalyticsTranscriptsAggregatesJob(jobId,opts){opts=opts||{};// verify the required parameter 'jobId' is set
|
|
2208
2195
|
if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required parameter "jobId" when calling deleteAnalyticsTranscriptsAggregatesJob';}return this.apiClient.callApi('/api/v2/analytics/transcripts/aggregates/jobs/{jobId}','DELETE',{'jobId':jobId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
2209
2196
|
* Delete/cancel an async request for user aggregates
|
|
@@ -2211,7 +2198,6 @@ if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required param
|
|
|
2211
2198
|
* @param {String} jobId jobId
|
|
2212
2199
|
* @param {Object} opts Optional parameters
|
|
2213
2200
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2214
|
-
* deleteAnalyticsUsersAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2215
2201
|
*/},{key:"deleteAnalyticsUsersAggregatesJob",value:function deleteAnalyticsUsersAggregatesJob(jobId,opts){opts=opts||{};// verify the required parameter 'jobId' is set
|
|
2216
2202
|
if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required parameter "jobId" when calling deleteAnalyticsUsersAggregatesJob';}return this.apiClient.callApi('/api/v2/analytics/users/aggregates/jobs/{jobId}','DELETE',{'jobId':jobId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
2217
2203
|
* Delete/cancel an async request
|
|
@@ -2226,7 +2212,6 @@ if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required param
|
|
|
2226
2212
|
* @param {String} jobId jobId
|
|
2227
2213
|
* @param {Object} opts Optional parameters
|
|
2228
2214
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2229
|
-
* getAnalyticsActionsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2230
2215
|
*/},{key:"getAnalyticsActionsAggregatesJob",value:function getAnalyticsActionsAggregatesJob(jobId,opts){opts=opts||{};// verify the required parameter 'jobId' is set
|
|
2231
2216
|
if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required parameter "jobId" when calling getAnalyticsActionsAggregatesJob';}return this.apiClient.callApi('/api/v2/analytics/actions/aggregates/jobs/{jobId}','GET',{'jobId':jobId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
2232
2217
|
* Fetch a page of results for an async aggregates query
|
|
@@ -2235,7 +2220,6 @@ if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required param
|
|
|
2235
2220
|
* @param {Object} opts Optional parameters
|
|
2236
2221
|
* @param {String} opts.cursor Cursor token to retrieve next page
|
|
2237
2222
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2238
|
-
* getAnalyticsActionsAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2239
2223
|
*/},{key:"getAnalyticsActionsAggregatesJobResults",value:function getAnalyticsActionsAggregatesJobResults(jobId,opts){opts=opts||{};// verify the required parameter 'jobId' is set
|
|
2240
2224
|
if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required parameter "jobId" when calling getAnalyticsActionsAggregatesJobResults';}return this.apiClient.callApi('/api/v2/analytics/actions/aggregates/jobs/{jobId}/results','GET',{'jobId':jobId},{'cursor':opts['cursor']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
2241
2225
|
* Get an agent and their active sessions by user ID
|
|
@@ -2325,7 +2309,6 @@ if(botFlowId===undefined||botFlowId===null||botFlowId===''){throw'Missing the re
|
|
|
2325
2309
|
* @param {String} jobId jobId
|
|
2326
2310
|
* @param {Object} opts Optional parameters
|
|
2327
2311
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2328
|
-
* getAnalyticsBotsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2329
2312
|
*/},{key:"getAnalyticsBotsAggregatesJob",value:function getAnalyticsBotsAggregatesJob(jobId,opts){opts=opts||{};// verify the required parameter 'jobId' is set
|
|
2330
2313
|
if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required parameter "jobId" when calling getAnalyticsBotsAggregatesJob';}return this.apiClient.callApi('/api/v2/analytics/bots/aggregates/jobs/{jobId}','GET',{'jobId':jobId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
2331
2314
|
* Fetch a page of results for an async aggregates query
|
|
@@ -2334,7 +2317,6 @@ if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required param
|
|
|
2334
2317
|
* @param {Object} opts Optional parameters
|
|
2335
2318
|
* @param {String} opts.cursor Cursor token to retrieve next page
|
|
2336
2319
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2337
|
-
* getAnalyticsBotsAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2338
2320
|
*/},{key:"getAnalyticsBotsAggregatesJobResults",value:function getAnalyticsBotsAggregatesJobResults(jobId,opts){opts=opts||{};// verify the required parameter 'jobId' is set
|
|
2339
2321
|
if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required parameter "jobId" when calling getAnalyticsBotsAggregatesJobResults';}return this.apiClient.callApi('/api/v2/analytics/bots/aggregates/jobs/{jobId}/results','GET',{'jobId':jobId},{'cursor':opts['cursor']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
2340
2322
|
* Get status for async query for case management aggregates
|
|
@@ -2342,7 +2324,6 @@ if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required param
|
|
|
2342
2324
|
* @param {String} jobId jobId
|
|
2343
2325
|
* @param {Object} opts Optional parameters
|
|
2344
2326
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2345
|
-
* getAnalyticsCasemanagementAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2346
2327
|
*/},{key:"getAnalyticsCasemanagementAggregatesJob",value:function getAnalyticsCasemanagementAggregatesJob(jobId,opts){opts=opts||{};// verify the required parameter 'jobId' is set
|
|
2347
2328
|
if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required parameter "jobId" when calling getAnalyticsCasemanagementAggregatesJob';}return this.apiClient.callApi('/api/v2/analytics/casemanagement/aggregates/jobs/{jobId}','GET',{'jobId':jobId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
2348
2329
|
* Fetch a page of results for an async case management query
|
|
@@ -2351,7 +2332,6 @@ if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required param
|
|
|
2351
2332
|
* @param {Object} opts Optional parameters
|
|
2352
2333
|
* @param {String} opts.cursor Cursor token to retrieve next page
|
|
2353
2334
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2354
|
-
* getAnalyticsCasemanagementAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2355
2335
|
*/},{key:"getAnalyticsCasemanagementAggregatesJobResults",value:function getAnalyticsCasemanagementAggregatesJobResults(jobId,opts){opts=opts||{};// verify the required parameter 'jobId' is set
|
|
2356
2336
|
if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required parameter "jobId" when calling getAnalyticsCasemanagementAggregatesJobResults';}return this.apiClient.callApi('/api/v2/analytics/casemanagement/aggregates/jobs/{jobId}/results','GET',{'jobId':jobId},{'cursor':opts['cursor']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
2357
2337
|
* Get a conversation by id
|
|
@@ -2366,7 +2346,6 @@ if(conversationId===undefined||conversationId===null||conversationId===''){throw
|
|
|
2366
2346
|
* @param {String} jobId jobId
|
|
2367
2347
|
* @param {Object} opts Optional parameters
|
|
2368
2348
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2369
|
-
* getAnalyticsConversationsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2370
2349
|
*/},{key:"getAnalyticsConversationsAggregatesJob",value:function getAnalyticsConversationsAggregatesJob(jobId,opts){opts=opts||{};// verify the required parameter 'jobId' is set
|
|
2371
2350
|
if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required parameter "jobId" when calling getAnalyticsConversationsAggregatesJob';}return this.apiClient.callApi('/api/v2/analytics/conversations/aggregates/jobs/{jobId}','GET',{'jobId':jobId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
2372
2351
|
* Fetch a page of results for an async aggregates query
|
|
@@ -2375,7 +2354,6 @@ if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required param
|
|
|
2375
2354
|
* @param {Object} opts Optional parameters
|
|
2376
2355
|
* @param {String} opts.cursor Cursor token to retrieve next page
|
|
2377
2356
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2378
|
-
* getAnalyticsConversationsAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2379
2357
|
*/},{key:"getAnalyticsConversationsAggregatesJobResults",value:function getAnalyticsConversationsAggregatesJobResults(jobId,opts){opts=opts||{};// verify the required parameter 'jobId' is set
|
|
2380
2358
|
if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required parameter "jobId" when calling getAnalyticsConversationsAggregatesJobResults';}return this.apiClient.callApi('/api/v2/analytics/conversations/aggregates/jobs/{jobId}/results','GET',{'jobId':jobId},{'cursor':opts['cursor']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
2381
2359
|
* Gets multiple conversations by id
|
|
@@ -2452,7 +2430,6 @@ if(downloadId===undefined||downloadId===null||downloadId===''){throw'Missing the
|
|
|
2452
2430
|
* @param {String} jobId jobId
|
|
2453
2431
|
* @param {Object} opts Optional parameters
|
|
2454
2432
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2455
|
-
* getAnalyticsEvaluationsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2456
2433
|
*/},{key:"getAnalyticsEvaluationsAggregatesJob",value:function getAnalyticsEvaluationsAggregatesJob(jobId,opts){opts=opts||{};// verify the required parameter 'jobId' is set
|
|
2457
2434
|
if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required parameter "jobId" when calling getAnalyticsEvaluationsAggregatesJob';}return this.apiClient.callApi('/api/v2/analytics/evaluations/aggregates/jobs/{jobId}','GET',{'jobId':jobId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
2458
2435
|
* Fetch a page of results for an async aggregates query
|
|
@@ -2461,7 +2438,6 @@ if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required param
|
|
|
2461
2438
|
* @param {Object} opts Optional parameters
|
|
2462
2439
|
* @param {String} opts.cursor Cursor token to retrieve next page
|
|
2463
2440
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2464
|
-
* getAnalyticsEvaluationsAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2465
2441
|
*/},{key:"getAnalyticsEvaluationsAggregatesJobResults",value:function getAnalyticsEvaluationsAggregatesJobResults(jobId,opts){opts=opts||{};// verify the required parameter 'jobId' is set
|
|
2466
2442
|
if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required parameter "jobId" when calling getAnalyticsEvaluationsAggregatesJobResults';}return this.apiClient.callApi('/api/v2/analytics/evaluations/aggregates/jobs/{jobId}/results','GET',{'jobId':jobId},{'cursor':opts['cursor']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
2467
2443
|
* Get status for async query for flow execution aggregates
|
|
@@ -2469,7 +2445,6 @@ if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required param
|
|
|
2469
2445
|
* @param {String} jobId jobId
|
|
2470
2446
|
* @param {Object} opts Optional parameters
|
|
2471
2447
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2472
|
-
* getAnalyticsFlowexecutionsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2473
2448
|
*/},{key:"getAnalyticsFlowexecutionsAggregatesJob",value:function getAnalyticsFlowexecutionsAggregatesJob(jobId,opts){opts=opts||{};// verify the required parameter 'jobId' is set
|
|
2474
2449
|
if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required parameter "jobId" when calling getAnalyticsFlowexecutionsAggregatesJob';}return this.apiClient.callApi('/api/v2/analytics/flowexecutions/aggregates/jobs/{jobId}','GET',{'jobId':jobId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
2475
2450
|
* Fetch a page of results for an async aggregates query
|
|
@@ -2478,7 +2453,6 @@ if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required param
|
|
|
2478
2453
|
* @param {Object} opts Optional parameters
|
|
2479
2454
|
* @param {String} opts.cursor Cursor token to retrieve next page
|
|
2480
2455
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2481
|
-
* getAnalyticsFlowexecutionsAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2482
2456
|
*/},{key:"getAnalyticsFlowexecutionsAggregatesJobResults",value:function getAnalyticsFlowexecutionsAggregatesJobResults(jobId,opts){opts=opts||{};// verify the required parameter 'jobId' is set
|
|
2483
2457
|
if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required parameter "jobId" when calling getAnalyticsFlowexecutionsAggregatesJobResults';}return this.apiClient.callApi('/api/v2/analytics/flowexecutions/aggregates/jobs/{jobId}/results','GET',{'jobId':jobId},{'cursor':opts['cursor']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
2484
2458
|
* Get status for async query for Flow aggregates
|
|
@@ -2486,7 +2460,6 @@ if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required param
|
|
|
2486
2460
|
* @param {String} jobId jobId
|
|
2487
2461
|
* @param {Object} opts Optional parameters
|
|
2488
2462
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2489
|
-
* getAnalyticsFlowsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2490
2463
|
*/},{key:"getAnalyticsFlowsAggregatesJob",value:function getAnalyticsFlowsAggregatesJob(jobId,opts){opts=opts||{};// verify the required parameter 'jobId' is set
|
|
2491
2464
|
if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required parameter "jobId" when calling getAnalyticsFlowsAggregatesJob';}return this.apiClient.callApi('/api/v2/analytics/flows/aggregates/jobs/{jobId}','GET',{'jobId':jobId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
2492
2465
|
* Fetch a page of results for an async aggregates query
|
|
@@ -2495,7 +2468,6 @@ if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required param
|
|
|
2495
2468
|
* @param {Object} opts Optional parameters
|
|
2496
2469
|
* @param {String} opts.cursor Cursor token to retrieve next page
|
|
2497
2470
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2498
|
-
* getAnalyticsFlowsAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2499
2471
|
*/},{key:"getAnalyticsFlowsAggregatesJobResults",value:function getAnalyticsFlowsAggregatesJobResults(jobId,opts){opts=opts||{};// verify the required parameter 'jobId' is set
|
|
2500
2472
|
if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required parameter "jobId" when calling getAnalyticsFlowsAggregatesJobResults';}return this.apiClient.callApi('/api/v2/analytics/flows/aggregates/jobs/{jobId}/results','GET',{'jobId':jobId},{'cursor':opts['cursor']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
2501
2473
|
* Get status for async query for journey aggregates
|
|
@@ -2503,7 +2475,6 @@ if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required param
|
|
|
2503
2475
|
* @param {String} jobId jobId
|
|
2504
2476
|
* @param {Object} opts Optional parameters
|
|
2505
2477
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2506
|
-
* getAnalyticsJourneysAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2507
2478
|
*/},{key:"getAnalyticsJourneysAggregatesJob",value:function getAnalyticsJourneysAggregatesJob(jobId,opts){opts=opts||{};// verify the required parameter 'jobId' is set
|
|
2508
2479
|
if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required parameter "jobId" when calling getAnalyticsJourneysAggregatesJob';}return this.apiClient.callApi('/api/v2/analytics/journeys/aggregates/jobs/{jobId}','GET',{'jobId':jobId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
2509
2480
|
* Fetch a page of results for an async aggregates query
|
|
@@ -2512,7 +2483,6 @@ if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required param
|
|
|
2512
2483
|
* @param {Object} opts Optional parameters
|
|
2513
2484
|
* @param {String} opts.cursor Cursor token to retrieve next page
|
|
2514
2485
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2515
|
-
* getAnalyticsJourneysAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2516
2486
|
*/},{key:"getAnalyticsJourneysAggregatesJobResults",value:function getAnalyticsJourneysAggregatesJobResults(jobId,opts){opts=opts||{};// verify the required parameter 'jobId' is set
|
|
2517
2487
|
if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required parameter "jobId" when calling getAnalyticsJourneysAggregatesJobResults';}return this.apiClient.callApi('/api/v2/analytics/journeys/aggregates/jobs/{jobId}/results','GET',{'jobId':jobId},{'cursor':opts['cursor']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
2518
2488
|
* Get status for async query for knowledge aggregates
|
|
@@ -2520,7 +2490,6 @@ if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required param
|
|
|
2520
2490
|
* @param {String} jobId jobId
|
|
2521
2491
|
* @param {Object} opts Optional parameters
|
|
2522
2492
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2523
|
-
* getAnalyticsKnowledgeAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2524
2493
|
*/},{key:"getAnalyticsKnowledgeAggregatesJob",value:function getAnalyticsKnowledgeAggregatesJob(jobId,opts){opts=opts||{};// verify the required parameter 'jobId' is set
|
|
2525
2494
|
if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required parameter "jobId" when calling getAnalyticsKnowledgeAggregatesJob';}return this.apiClient.callApi('/api/v2/analytics/knowledge/aggregates/jobs/{jobId}','GET',{'jobId':jobId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
2526
2495
|
* Fetch a page of results for an async aggregates query
|
|
@@ -2529,7 +2498,6 @@ if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required param
|
|
|
2529
2498
|
* @param {Object} opts Optional parameters
|
|
2530
2499
|
* @param {String} opts.cursor Cursor token to retrieve next page
|
|
2531
2500
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2532
|
-
* getAnalyticsKnowledgeAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2533
2501
|
*/},{key:"getAnalyticsKnowledgeAggregatesJobResults",value:function getAnalyticsKnowledgeAggregatesJobResults(jobId,opts){opts=opts||{};// verify the required parameter 'jobId' is set
|
|
2534
2502
|
if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required parameter "jobId" when calling getAnalyticsKnowledgeAggregatesJobResults';}return this.apiClient.callApi('/api/v2/analytics/knowledge/aggregates/jobs/{jobId}/results','GET',{'jobId':jobId},{'cursor':opts['cursor']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
2535
2503
|
* Get dashboards summary for a user
|
|
@@ -2600,7 +2568,6 @@ if(userId===undefined||userId===null||userId===''){throw'Missing the required pa
|
|
|
2600
2568
|
* @param {String} jobId jobId
|
|
2601
2569
|
* @param {Object} opts Optional parameters
|
|
2602
2570
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2603
|
-
* getAnalyticsResolutionsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2604
2571
|
*/},{key:"getAnalyticsResolutionsAggregatesJob",value:function getAnalyticsResolutionsAggregatesJob(jobId,opts){opts=opts||{};// verify the required parameter 'jobId' is set
|
|
2605
2572
|
if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required parameter "jobId" when calling getAnalyticsResolutionsAggregatesJob';}return this.apiClient.callApi('/api/v2/analytics/resolutions/aggregates/jobs/{jobId}','GET',{'jobId':jobId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
2606
2573
|
* Fetch a page of results for an async aggregates query
|
|
@@ -2609,7 +2576,6 @@ if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required param
|
|
|
2609
2576
|
* @param {Object} opts Optional parameters
|
|
2610
2577
|
* @param {String} opts.cursor Cursor token to retrieve next page
|
|
2611
2578
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2612
|
-
* getAnalyticsResolutionsAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2613
2579
|
*/},{key:"getAnalyticsResolutionsAggregatesJobResults",value:function getAnalyticsResolutionsAggregatesJobResults(jobId,opts){opts=opts||{};// verify the required parameter 'jobId' is set
|
|
2614
2580
|
if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required parameter "jobId" when calling getAnalyticsResolutionsAggregatesJobResults';}return this.apiClient.callApi('/api/v2/analytics/resolutions/aggregates/jobs/{jobId}/results','GET',{'jobId':jobId},{'cursor':opts['cursor']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
2615
2581
|
* Get status for async query for summary aggregates
|
|
@@ -2617,7 +2583,6 @@ if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required param
|
|
|
2617
2583
|
* @param {String} jobId jobId
|
|
2618
2584
|
* @param {Object} opts Optional parameters
|
|
2619
2585
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2620
|
-
* getAnalyticsSummariesAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2621
2586
|
*/},{key:"getAnalyticsSummariesAggregatesJob",value:function getAnalyticsSummariesAggregatesJob(jobId,opts){opts=opts||{};// verify the required parameter 'jobId' is set
|
|
2622
2587
|
if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required parameter "jobId" when calling getAnalyticsSummariesAggregatesJob';}return this.apiClient.callApi('/api/v2/analytics/summaries/aggregates/jobs/{jobId}','GET',{'jobId':jobId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
2623
2588
|
* Fetch a page of results for an async aggregates query
|
|
@@ -2626,7 +2591,6 @@ if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required param
|
|
|
2626
2591
|
* @param {Object} opts Optional parameters
|
|
2627
2592
|
* @param {String} opts.cursor Cursor token to retrieve next page
|
|
2628
2593
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2629
|
-
* getAnalyticsSummariesAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2630
2594
|
*/},{key:"getAnalyticsSummariesAggregatesJobResults",value:function getAnalyticsSummariesAggregatesJobResults(jobId,opts){opts=opts||{};// verify the required parameter 'jobId' is set
|
|
2631
2595
|
if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required parameter "jobId" when calling getAnalyticsSummariesAggregatesJobResults';}return this.apiClient.callApi('/api/v2/analytics/summaries/aggregates/jobs/{jobId}/results','GET',{'jobId':jobId},{'cursor':opts['cursor']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
2632
2596
|
* Get status for async query for survey aggregates
|
|
@@ -2634,7 +2598,6 @@ if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required param
|
|
|
2634
2598
|
* @param {String} jobId jobId
|
|
2635
2599
|
* @param {Object} opts Optional parameters
|
|
2636
2600
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2637
|
-
* getAnalyticsSurveysAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2638
2601
|
*/},{key:"getAnalyticsSurveysAggregatesJob",value:function getAnalyticsSurveysAggregatesJob(jobId,opts){opts=opts||{};// verify the required parameter 'jobId' is set
|
|
2639
2602
|
if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required parameter "jobId" when calling getAnalyticsSurveysAggregatesJob';}return this.apiClient.callApi('/api/v2/analytics/surveys/aggregates/jobs/{jobId}','GET',{'jobId':jobId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
2640
2603
|
* Fetch a page of results for an async aggregates query
|
|
@@ -2643,7 +2606,6 @@ if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required param
|
|
|
2643
2606
|
* @param {Object} opts Optional parameters
|
|
2644
2607
|
* @param {String} opts.cursor Cursor token to retrieve next page
|
|
2645
2608
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2646
|
-
* getAnalyticsSurveysAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2647
2609
|
*/},{key:"getAnalyticsSurveysAggregatesJobResults",value:function getAnalyticsSurveysAggregatesJobResults(jobId,opts){opts=opts||{};// verify the required parameter 'jobId' is set
|
|
2648
2610
|
if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required parameter "jobId" when calling getAnalyticsSurveysAggregatesJobResults';}return this.apiClient.callApi('/api/v2/analytics/surveys/aggregates/jobs/{jobId}/results','GET',{'jobId':jobId},{'cursor':opts['cursor']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
2649
2611
|
* Get status for async query for task management aggregates
|
|
@@ -2651,7 +2613,6 @@ if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required param
|
|
|
2651
2613
|
* @param {String} jobId jobId
|
|
2652
2614
|
* @param {Object} opts Optional parameters
|
|
2653
2615
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2654
|
-
* getAnalyticsTaskmanagementAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2655
2616
|
*/},{key:"getAnalyticsTaskmanagementAggregatesJob",value:function getAnalyticsTaskmanagementAggregatesJob(jobId,opts){opts=opts||{};// verify the required parameter 'jobId' is set
|
|
2656
2617
|
if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required parameter "jobId" when calling getAnalyticsTaskmanagementAggregatesJob';}return this.apiClient.callApi('/api/v2/analytics/taskmanagement/aggregates/jobs/{jobId}','GET',{'jobId':jobId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
2657
2618
|
* Fetch a page of results for an async task management query
|
|
@@ -2660,7 +2621,6 @@ if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required param
|
|
|
2660
2621
|
* @param {Object} opts Optional parameters
|
|
2661
2622
|
* @param {String} opts.cursor Cursor token to retrieve next page
|
|
2662
2623
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2663
|
-
* getAnalyticsTaskmanagementAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2664
2624
|
*/},{key:"getAnalyticsTaskmanagementAggregatesJobResults",value:function getAnalyticsTaskmanagementAggregatesJobResults(jobId,opts){opts=opts||{};// verify the required parameter 'jobId' is set
|
|
2665
2625
|
if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required parameter "jobId" when calling getAnalyticsTaskmanagementAggregatesJobResults';}return this.apiClient.callApi('/api/v2/analytics/taskmanagement/aggregates/jobs/{jobId}/results','GET',{'jobId':jobId},{'cursor':opts['cursor']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
2666
2626
|
* Get status for async query for transcript aggregates
|
|
@@ -2668,7 +2628,6 @@ if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required param
|
|
|
2668
2628
|
* @param {String} jobId jobId
|
|
2669
2629
|
* @param {Object} opts Optional parameters
|
|
2670
2630
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2671
|
-
* getAnalyticsTranscriptsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2672
2631
|
*/},{key:"getAnalyticsTranscriptsAggregatesJob",value:function getAnalyticsTranscriptsAggregatesJob(jobId,opts){opts=opts||{};// verify the required parameter 'jobId' is set
|
|
2673
2632
|
if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required parameter "jobId" when calling getAnalyticsTranscriptsAggregatesJob';}return this.apiClient.callApi('/api/v2/analytics/transcripts/aggregates/jobs/{jobId}','GET',{'jobId':jobId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
2674
2633
|
* Fetch a page of results for an async aggregates query
|
|
@@ -2677,7 +2636,6 @@ if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required param
|
|
|
2677
2636
|
* @param {Object} opts Optional parameters
|
|
2678
2637
|
* @param {String} opts.cursor Cursor token to retrieve next page
|
|
2679
2638
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2680
|
-
* getAnalyticsTranscriptsAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2681
2639
|
*/},{key:"getAnalyticsTranscriptsAggregatesJobResults",value:function getAnalyticsTranscriptsAggregatesJobResults(jobId,opts){opts=opts||{};// verify the required parameter 'jobId' is set
|
|
2682
2640
|
if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required parameter "jobId" when calling getAnalyticsTranscriptsAggregatesJobResults';}return this.apiClient.callApi('/api/v2/analytics/transcripts/aggregates/jobs/{jobId}/results','GET',{'jobId':jobId},{'cursor':opts['cursor']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
2683
2641
|
* Get status for async query for user aggregates
|
|
@@ -2685,7 +2643,6 @@ if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required param
|
|
|
2685
2643
|
* @param {String} jobId jobId
|
|
2686
2644
|
* @param {Object} opts Optional parameters
|
|
2687
2645
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2688
|
-
* getAnalyticsUsersAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2689
2646
|
*/},{key:"getAnalyticsUsersAggregatesJob",value:function getAnalyticsUsersAggregatesJob(jobId,opts){opts=opts||{};// verify the required parameter 'jobId' is set
|
|
2690
2647
|
if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required parameter "jobId" when calling getAnalyticsUsersAggregatesJob';}return this.apiClient.callApi('/api/v2/analytics/users/aggregates/jobs/{jobId}','GET',{'jobId':jobId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
2691
2648
|
* Fetch a page of results for an async aggregates query
|
|
@@ -2694,7 +2651,6 @@ if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required param
|
|
|
2694
2651
|
* @param {Object} opts Optional parameters
|
|
2695
2652
|
* @param {String} opts.cursor Cursor token to retrieve next page
|
|
2696
2653
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2697
|
-
* getAnalyticsUsersAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2698
2654
|
*/},{key:"getAnalyticsUsersAggregatesJobResults",value:function getAnalyticsUsersAggregatesJobResults(jobId,opts){opts=opts||{};// verify the required parameter 'jobId' is set
|
|
2699
2655
|
if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required parameter "jobId" when calling getAnalyticsUsersAggregatesJobResults';}return this.apiClient.callApi('/api/v2/analytics/users/aggregates/jobs/{jobId}/results','GET',{'jobId':jobId},{'cursor':opts['cursor']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
2700
2656
|
* Get status for async query for user details
|
|
@@ -2730,7 +2686,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
2730
2686
|
* @param {Object} body query
|
|
2731
2687
|
* @param {Object} opts Optional parameters
|
|
2732
2688
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2733
|
-
* postAnalyticsActionsAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2734
2689
|
*/},{key:"postAnalyticsActionsAggregatesJobs",value:function postAnalyticsActionsAggregatesJobs(body,opts){opts=opts||{};// verify the required parameter 'body' is set
|
|
2735
2690
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postAnalyticsActionsAggregatesJobs';}return this.apiClient.callApi('/api/v2/analytics/actions/aggregates/jobs','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
2736
2691
|
* Query for action aggregates
|
|
@@ -2791,7 +2746,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
2791
2746
|
* @param {Object} body query
|
|
2792
2747
|
* @param {Object} opts Optional parameters
|
|
2793
2748
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2794
|
-
* postAnalyticsBotsAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2795
2749
|
*/},{key:"postAnalyticsBotsAggregatesJobs",value:function postAnalyticsBotsAggregatesJobs(body,opts){opts=opts||{};// verify the required parameter 'body' is set
|
|
2796
2750
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postAnalyticsBotsAggregatesJobs';}return this.apiClient.callApi('/api/v2/analytics/bots/aggregates/jobs','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
2797
2751
|
* Query for bot aggregates
|
|
@@ -2806,7 +2760,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
2806
2760
|
* @param {Object} body query
|
|
2807
2761
|
* @param {Object} opts Optional parameters
|
|
2808
2762
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2809
|
-
* postAnalyticsCasemanagementAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2810
2763
|
*/},{key:"postAnalyticsCasemanagementAggregatesJobs",value:function postAnalyticsCasemanagementAggregatesJobs(body,opts){opts=opts||{};// verify the required parameter 'body' is set
|
|
2811
2764
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postAnalyticsCasemanagementAggregatesJobs';}return this.apiClient.callApi('/api/v2/analytics/casemanagement/aggregates/jobs','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
2812
2765
|
* Query for case management aggregates
|
|
@@ -2814,7 +2767,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
2814
2767
|
* @param {Object} body query
|
|
2815
2768
|
* @param {Object} opts Optional parameters
|
|
2816
2769
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2817
|
-
* postAnalyticsCasemanagementAggregatesQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2818
2770
|
*/},{key:"postAnalyticsCasemanagementAggregatesQuery",value:function postAnalyticsCasemanagementAggregatesQuery(body,opts){opts=opts||{};// verify the required parameter 'body' is set
|
|
2819
2771
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postAnalyticsCasemanagementAggregatesQuery';}return this.apiClient.callApi('/api/v2/analytics/casemanagement/aggregates/query','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
2820
2772
|
* Index conversation properties
|
|
@@ -2840,7 +2792,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
2840
2792
|
* @param {Object} body query
|
|
2841
2793
|
* @param {Object} opts Optional parameters
|
|
2842
2794
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2843
|
-
* postAnalyticsConversationsAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2844
2795
|
*/},{key:"postAnalyticsConversationsAggregatesJobs",value:function postAnalyticsConversationsAggregatesJobs(body,opts){opts=opts||{};// verify the required parameter 'body' is set
|
|
2845
2796
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postAnalyticsConversationsAggregatesJobs';}return this.apiClient.callApi('/api/v2/analytics/conversations/aggregates/jobs','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
2846
2797
|
* Query for conversation aggregates
|
|
@@ -2893,7 +2844,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
2893
2844
|
* @param {Object} body query
|
|
2894
2845
|
* @param {Object} opts Optional parameters
|
|
2895
2846
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2896
|
-
* postAnalyticsEvaluationsAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2897
2847
|
*/},{key:"postAnalyticsEvaluationsAggregatesJobs",value:function postAnalyticsEvaluationsAggregatesJobs(body,opts){opts=opts||{};// verify the required parameter 'body' is set
|
|
2898
2848
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postAnalyticsEvaluationsAggregatesJobs';}return this.apiClient.callApi('/api/v2/analytics/evaluations/aggregates/jobs','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
2899
2849
|
* Query for evaluation aggregates
|
|
@@ -2908,7 +2858,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
2908
2858
|
* @param {Object} body query
|
|
2909
2859
|
* @param {Object} opts Optional parameters
|
|
2910
2860
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2911
|
-
* postAnalyticsFlowexecutionsAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2912
2861
|
*/},{key:"postAnalyticsFlowexecutionsAggregatesJobs",value:function postAnalyticsFlowexecutionsAggregatesJobs(body,opts){opts=opts||{};// verify the required parameter 'body' is set
|
|
2913
2862
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postAnalyticsFlowexecutionsAggregatesJobs';}return this.apiClient.callApi('/api/v2/analytics/flowexecutions/aggregates/jobs','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
2914
2863
|
* Query for flow execution aggregates
|
|
@@ -2932,7 +2881,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
2932
2881
|
* @param {Object} body query
|
|
2933
2882
|
* @param {Object} opts Optional parameters
|
|
2934
2883
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2935
|
-
* postAnalyticsFlowsAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2936
2884
|
*/},{key:"postAnalyticsFlowsAggregatesJobs",value:function postAnalyticsFlowsAggregatesJobs(body,opts){opts=opts||{};// verify the required parameter 'body' is set
|
|
2937
2885
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postAnalyticsFlowsAggregatesJobs';}return this.apiClient.callApi('/api/v2/analytics/flows/aggregates/jobs','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
2938
2886
|
* Query for flow aggregates
|
|
@@ -2954,7 +2902,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
2954
2902
|
* @param {Object} body query
|
|
2955
2903
|
* @param {Object} opts Optional parameters
|
|
2956
2904
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2957
|
-
* postAnalyticsJourneysAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2958
2905
|
*/},{key:"postAnalyticsJourneysAggregatesJobs",value:function postAnalyticsJourneysAggregatesJobs(body,opts){opts=opts||{};// verify the required parameter 'body' is set
|
|
2959
2906
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postAnalyticsJourneysAggregatesJobs';}return this.apiClient.callApi('/api/v2/analytics/journeys/aggregates/jobs','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
2960
2907
|
* Query for journey aggregates
|
|
@@ -2969,7 +2916,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
2969
2916
|
* @param {Object} body query
|
|
2970
2917
|
* @param {Object} opts Optional parameters
|
|
2971
2918
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2972
|
-
* postAnalyticsKnowledgeAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2973
2919
|
*/},{key:"postAnalyticsKnowledgeAggregatesJobs",value:function postAnalyticsKnowledgeAggregatesJobs(body,opts){opts=opts||{};// verify the required parameter 'body' is set
|
|
2974
2920
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postAnalyticsKnowledgeAggregatesJobs';}return this.apiClient.callApi('/api/v2/analytics/knowledge/aggregates/jobs','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
2975
2921
|
* Query for knowledge aggregates
|
|
@@ -3026,7 +2972,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
3026
2972
|
* @param {Object} body query
|
|
3027
2973
|
* @param {Object} opts Optional parameters
|
|
3028
2974
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
3029
|
-
* postAnalyticsResolutionsAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
3030
2975
|
*/},{key:"postAnalyticsResolutionsAggregatesJobs",value:function postAnalyticsResolutionsAggregatesJobs(body,opts){opts=opts||{};// verify the required parameter 'body' is set
|
|
3031
2976
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postAnalyticsResolutionsAggregatesJobs';}return this.apiClient.callApi('/api/v2/analytics/resolutions/aggregates/jobs','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
3032
2977
|
* Query for resolution aggregates
|
|
@@ -3050,7 +2995,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
3050
2995
|
* @param {Object} body query
|
|
3051
2996
|
* @param {Object} opts Optional parameters
|
|
3052
2997
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
3053
|
-
* postAnalyticsSummariesAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
3054
2998
|
*/},{key:"postAnalyticsSummariesAggregatesJobs",value:function postAnalyticsSummariesAggregatesJobs(body,opts){opts=opts||{};// verify the required parameter 'body' is set
|
|
3055
2999
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postAnalyticsSummariesAggregatesJobs';}return this.apiClient.callApi('/api/v2/analytics/summaries/aggregates/jobs','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
3056
3000
|
* Query for summary aggregates
|
|
@@ -3065,7 +3009,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
3065
3009
|
* @param {Object} body query
|
|
3066
3010
|
* @param {Object} opts Optional parameters
|
|
3067
3011
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
3068
|
-
* postAnalyticsSurveysAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
3069
3012
|
*/},{key:"postAnalyticsSurveysAggregatesJobs",value:function postAnalyticsSurveysAggregatesJobs(body,opts){opts=opts||{};// verify the required parameter 'body' is set
|
|
3070
3013
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postAnalyticsSurveysAggregatesJobs';}return this.apiClient.callApi('/api/v2/analytics/surveys/aggregates/jobs','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
3071
3014
|
* Query for survey aggregates
|
|
@@ -3080,7 +3023,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
3080
3023
|
* @param {Object} body query
|
|
3081
3024
|
* @param {Object} opts Optional parameters
|
|
3082
3025
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
3083
|
-
* postAnalyticsTaskmanagementAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
3084
3026
|
*/},{key:"postAnalyticsTaskmanagementAggregatesJobs",value:function postAnalyticsTaskmanagementAggregatesJobs(body,opts){opts=opts||{};// verify the required parameter 'body' is set
|
|
3085
3027
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postAnalyticsTaskmanagementAggregatesJobs';}return this.apiClient.callApi('/api/v2/analytics/taskmanagement/aggregates/jobs','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
3086
3028
|
* Query for task management aggregates
|
|
@@ -3113,7 +3055,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
3113
3055
|
* @param {Object} body query
|
|
3114
3056
|
* @param {Object} opts Optional parameters
|
|
3115
3057
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
3116
|
-
* postAnalyticsTranscriptsAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
3117
3058
|
*/},{key:"postAnalyticsTranscriptsAggregatesJobs",value:function postAnalyticsTranscriptsAggregatesJobs(body,opts){opts=opts||{};// verify the required parameter 'body' is set
|
|
3118
3059
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postAnalyticsTranscriptsAggregatesJobs';}return this.apiClient.callApi('/api/v2/analytics/transcripts/aggregates/jobs','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
3119
3060
|
* Query for transcript aggregates
|
|
@@ -3137,7 +3078,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
3137
3078
|
* @param {Object} body query
|
|
3138
3079
|
* @param {Object} opts Optional parameters
|
|
3139
3080
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
3140
|
-
* postAnalyticsUsersAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
3141
3081
|
*/},{key:"postAnalyticsUsersAggregatesJobs",value:function postAnalyticsUsersAggregatesJobs(body,opts){opts=opts||{};// verify the required parameter 'body' is set
|
|
3142
3082
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postAnalyticsUsersAggregatesJobs';}return this.apiClient.callApi('/api/v2/analytics/users/aggregates/jobs','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
3143
3083
|
* Query for user aggregates
|
|
@@ -3177,7 +3117,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
3177
3117
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putAnalyticsDataretentionSettings';}return this.apiClient.callApi('/api/v2/analytics/dataretention/settings','PUT',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}}]);}();var ArchitectApi=/*#__PURE__*/function(){/**
|
|
3178
3118
|
* Architect service.
|
|
3179
3119
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
3180
|
-
* @version
|
|
3120
|
+
* @version 254.0.0
|
|
3181
3121
|
*//**
|
|
3182
3122
|
* Constructs a new ArchitectApi.
|
|
3183
3123
|
* @alias module:purecloud-platform-client-v2/api/ArchitectApi
|
|
@@ -4391,8 +4331,9 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
4391
4331
|
* 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.
|
|
4392
4332
|
*
|
|
4393
4333
|
* @param {Object} opts Optional parameters
|
|
4334
|
+
* @param {Object} opts.body
|
|
4394
4335
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
4395
|
-
*/},{key:"postFlowsJobs",value:function postFlowsJobs(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/flows/jobs','POST',{},{},{},{},
|
|
4336
|
+
*/},{key:"postFlowsJobs",value:function postFlowsJobs(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/flows/jobs','POST',{},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
4396
4337
|
* Create a flow milestone
|
|
4397
4338
|
*
|
|
4398
4339
|
* @param {Object} opts Optional parameters
|
|
@@ -4546,7 +4487,7 @@ if(milestoneId===undefined||milestoneId===null||milestoneId===''){throw'Missing
|
|
|
4546
4487
|
if(flowOutcomeId===undefined||flowOutcomeId===null||flowOutcomeId===''){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'],opts['customHeaders']);}}]);}();var AssistantCopilotVariationsApi=/*#__PURE__*/function(){/**
|
|
4547
4488
|
* AssistantCopilotVariations service.
|
|
4548
4489
|
* @module purecloud-platform-client-v2/api/AssistantCopilotVariationsApi
|
|
4549
|
-
* @version
|
|
4490
|
+
* @version 254.0.0
|
|
4550
4491
|
*//**
|
|
4551
4492
|
* Constructs a new AssistantCopilotVariationsApi.
|
|
4552
4493
|
* @alias module:purecloud-platform-client-v2/api/AssistantCopilotVariationsApi
|
|
@@ -4601,7 +4542,7 @@ if(variationId===undefined||variationId===null||variationId===''){throw'Missing
|
|
|
4601
4542
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putAssistantVariation';}return this.apiClient.callApi('/api/v2/assistants/{assistantId}/variations/{variationId}','PUT',{'assistantId':assistantId,'variationId':variationId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}}]);}();var AuditApi=/*#__PURE__*/function(){/**
|
|
4602
4543
|
* Audit service.
|
|
4603
4544
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
4604
|
-
* @version
|
|
4545
|
+
* @version 254.0.0
|
|
4605
4546
|
*//**
|
|
4606
4547
|
* Constructs a new AuditApi.
|
|
4607
4548
|
* @alias module:purecloud-platform-client-v2/api/AuditApi
|
|
@@ -4662,7 +4603,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
4662
4603
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postAuditsQueryRealtimeRelated';}return this.apiClient.callApi('/api/v2/audits/query/realtime/related','POST',{},{'expand':this.apiClient.buildCollectionParam(opts['expand'],'multi')},{},{},body,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}}]);}();var AuthorizationApi=/*#__PURE__*/function(){/**
|
|
4663
4604
|
* Authorization service.
|
|
4664
4605
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
4665
|
-
* @version
|
|
4606
|
+
* @version 254.0.0
|
|
4666
4607
|
*//**
|
|
4667
4608
|
* Constructs a new AuthorizationApi.
|
|
4668
4609
|
* @alias module:purecloud-platform-client-v2/api/AuthorizationApi
|
|
@@ -5180,7 +5121,7 @@ if(subjectId===undefined||subjectId===null||subjectId===''){throw'Missing the re
|
|
|
5180
5121
|
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'],opts['customHeaders']);}}]);}();var BackgroundAssistantApi=/*#__PURE__*/function(){/**
|
|
5181
5122
|
* BackgroundAssistant service.
|
|
5182
5123
|
* @module purecloud-platform-client-v2/api/BackgroundAssistantApi
|
|
5183
|
-
* @version
|
|
5124
|
+
* @version 254.0.0
|
|
5184
5125
|
*//**
|
|
5185
5126
|
* Constructs a new BackgroundAssistantApi.
|
|
5186
5127
|
* @alias module:purecloud-platform-client-v2/api/BackgroundAssistantApi
|
|
@@ -5203,7 +5144,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
5203
5144
|
*/},{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'],opts['customHeaders']);}}]);}();var BillingApi=/*#__PURE__*/function(){/**
|
|
5204
5145
|
* Billing service.
|
|
5205
5146
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
5206
|
-
* @version
|
|
5147
|
+
* @version 254.0.0
|
|
5207
5148
|
*//**
|
|
5208
5149
|
* Constructs a new BillingApi.
|
|
5209
5150
|
* @alias module:purecloud-platform-client-v2/api/BillingApi
|
|
@@ -5292,7 +5233,7 @@ if(endDate===undefined||endDate===null){throw'Missing the required parameter "en
|
|
|
5292
5233
|
if(trustorOrgId===undefined||trustorOrgId===null||trustorOrgId===''){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'],opts['customHeaders']);}}]);}();var BusinessRulesApi=/*#__PURE__*/function(){/**
|
|
5293
5234
|
* BusinessRules service.
|
|
5294
5235
|
* @module purecloud-platform-client-v2/api/BusinessRulesApi
|
|
5295
|
-
* @version
|
|
5236
|
+
* @version 254.0.0
|
|
5296
5237
|
*//**
|
|
5297
5238
|
* Constructs a new BusinessRulesApi.
|
|
5298
5239
|
* @alias module:purecloud-platform-client-v2/api/BusinessRulesApi
|
|
@@ -5308,6 +5249,24 @@ if(trustorOrgId===undefined||trustorOrgId===null||trustorOrgId===''){throw'Missi
|
|
|
5308
5249
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
5309
5250
|
*/return _createClass(BusinessRulesApi,[{key:"deleteBusinessrulesDecisiontable",value:function deleteBusinessrulesDecisiontable(tableId,opts){opts=opts||{};// verify the required parameter 'tableId' is set
|
|
5310
5251
|
if(tableId===undefined||tableId===null||tableId===''){throw'Missing the required parameter "tableId" when calling deleteBusinessrulesDecisiontable';}return this.apiClient.callApi('/api/v2/businessrules/decisiontables/{tableId}','DELETE',{'tableId':tableId},{'forceDelete':opts['forceDelete']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
5252
|
+
* Delete an export job for a decision table
|
|
5253
|
+
*
|
|
5254
|
+
* @param {String} tableId Table ID
|
|
5255
|
+
* @param {String} exportJobId Export Job ID
|
|
5256
|
+
* @param {Object} opts Optional parameters
|
|
5257
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
5258
|
+
*/},{key:"deleteBusinessrulesDecisiontableExport",value:function deleteBusinessrulesDecisiontableExport(tableId,exportJobId,opts){opts=opts||{};// verify the required parameter 'tableId' is set
|
|
5259
|
+
if(tableId===undefined||tableId===null||tableId===''){throw'Missing the required parameter "tableId" when calling deleteBusinessrulesDecisiontableExport';}// verify the required parameter 'exportJobId' is set
|
|
5260
|
+
if(exportJobId===undefined||exportJobId===null||exportJobId===''){throw'Missing the required parameter "exportJobId" when calling deleteBusinessrulesDecisiontableExport';}return this.apiClient.callApi('/api/v2/businessrules/decisiontables/{tableId}/exports/{exportJobId}','DELETE',{'tableId':tableId,'exportJobId':exportJobId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
5261
|
+
* Delete decision table row import job
|
|
5262
|
+
*
|
|
5263
|
+
* @param {String} tableId Table ID
|
|
5264
|
+
* @param {String} importJobId Import job ID
|
|
5265
|
+
* @param {Object} opts Optional parameters
|
|
5266
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
5267
|
+
*/},{key:"deleteBusinessrulesDecisiontableImport",value:function deleteBusinessrulesDecisiontableImport(tableId,importJobId,opts){opts=opts||{};// verify the required parameter 'tableId' is set
|
|
5268
|
+
if(tableId===undefined||tableId===null||tableId===''){throw'Missing the required parameter "tableId" when calling deleteBusinessrulesDecisiontableImport';}// verify the required parameter 'importJobId' is set
|
|
5269
|
+
if(importJobId===undefined||importJobId===null||importJobId===''){throw'Missing the required parameter "importJobId" when calling deleteBusinessrulesDecisiontableImport';}return this.apiClient.callApi('/api/v2/businessrules/decisiontables/{tableId}/imports/{importJobId}','DELETE',{'tableId':tableId,'importJobId':importJobId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
5311
5270
|
* Delete a decision table version
|
|
5312
5271
|
*
|
|
5313
5272
|
* @param {String} tableId Table ID
|
|
@@ -5342,6 +5301,42 @@ if(schemaId===undefined||schemaId===null||schemaId===''){throw'Missing the requi
|
|
|
5342
5301
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
5343
5302
|
*/},{key:"getBusinessrulesDecisiontable",value:function getBusinessrulesDecisiontable(tableId,opts){opts=opts||{};// verify the required parameter 'tableId' is set
|
|
5344
5303
|
if(tableId===undefined||tableId===null||tableId===''){throw'Missing the required parameter "tableId" when calling getBusinessrulesDecisiontable';}return this.apiClient.callApi('/api/v2/businessrules/decisiontables/{tableId}','GET',{'tableId':tableId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
5304
|
+
* Get an export job for a decision table
|
|
5305
|
+
*
|
|
5306
|
+
* @param {String} tableId Table ID
|
|
5307
|
+
* @param {String} exportJobId Export Job ID
|
|
5308
|
+
* @param {Object} opts Optional parameters
|
|
5309
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
5310
|
+
*/},{key:"getBusinessrulesDecisiontableExport",value:function getBusinessrulesDecisiontableExport(tableId,exportJobId,opts){opts=opts||{};// verify the required parameter 'tableId' is set
|
|
5311
|
+
if(tableId===undefined||tableId===null||tableId===''){throw'Missing the required parameter "tableId" when calling getBusinessrulesDecisiontableExport';}// verify the required parameter 'exportJobId' is set
|
|
5312
|
+
if(exportJobId===undefined||exportJobId===null||exportJobId===''){throw'Missing the required parameter "exportJobId" when calling getBusinessrulesDecisiontableExport';}return this.apiClient.callApi('/api/v2/businessrules/decisiontables/{tableId}/exports/{exportJobId}','GET',{'tableId':tableId,'exportJobId':exportJobId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
5313
|
+
* List export jobs for a decision table
|
|
5314
|
+
*
|
|
5315
|
+
* @param {String} tableId Table ID
|
|
5316
|
+
* @param {Object} opts Optional parameters
|
|
5317
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
5318
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 100.
|
|
5319
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
5320
|
+
*/},{key:"getBusinessrulesDecisiontableExports",value:function getBusinessrulesDecisiontableExports(tableId,opts){opts=opts||{};// verify the required parameter 'tableId' is set
|
|
5321
|
+
if(tableId===undefined||tableId===null||tableId===''){throw'Missing the required parameter "tableId" when calling getBusinessrulesDecisiontableExports';}return this.apiClient.callApi('/api/v2/businessrules/decisiontables/{tableId}/exports','GET',{'tableId':tableId},{'after':opts['after'],'pageSize':opts['pageSize']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
5322
|
+
* Get decision table row import job
|
|
5323
|
+
*
|
|
5324
|
+
* @param {String} tableId Table ID
|
|
5325
|
+
* @param {String} importJobId Import job ID
|
|
5326
|
+
* @param {Object} opts Optional parameters
|
|
5327
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
5328
|
+
*/},{key:"getBusinessrulesDecisiontableImport",value:function getBusinessrulesDecisiontableImport(tableId,importJobId,opts){opts=opts||{};// verify the required parameter 'tableId' is set
|
|
5329
|
+
if(tableId===undefined||tableId===null||tableId===''){throw'Missing the required parameter "tableId" when calling getBusinessrulesDecisiontableImport';}// verify the required parameter 'importJobId' is set
|
|
5330
|
+
if(importJobId===undefined||importJobId===null||importJobId===''){throw'Missing the required parameter "importJobId" when calling getBusinessrulesDecisiontableImport';}return this.apiClient.callApi('/api/v2/businessrules/decisiontables/{tableId}/imports/{importJobId}','GET',{'tableId':tableId,'importJobId':importJobId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
5331
|
+
* List decision table row import jobs
|
|
5332
|
+
*
|
|
5333
|
+
* @param {String} tableId Table ID
|
|
5334
|
+
* @param {Object} opts Optional parameters
|
|
5335
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
5336
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 100.
|
|
5337
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
5338
|
+
*/},{key:"getBusinessrulesDecisiontableImports",value:function getBusinessrulesDecisiontableImports(tableId,opts){opts=opts||{};// verify the required parameter 'tableId' is set
|
|
5339
|
+
if(tableId===undefined||tableId===null||tableId===''){throw'Missing the required parameter "tableId" when calling getBusinessrulesDecisiontableImports';}return this.apiClient.callApi('/api/v2/businessrules/decisiontables/{tableId}/imports','GET',{'tableId':tableId},{'after':opts['after'],'pageSize':opts['pageSize']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
5345
5340
|
* Get a decision table version
|
|
5346
5341
|
*
|
|
5347
5342
|
* @param {String} tableId Table ID
|
|
@@ -5436,6 +5431,17 @@ if(coreTypeName===undefined||coreTypeName===null||coreTypeName===''){throw'Missi
|
|
|
5436
5431
|
*/},{key:"patchBusinessrulesDecisiontable",value:function patchBusinessrulesDecisiontable(tableId,body,opts){opts=opts||{};// verify the required parameter 'tableId' is set
|
|
5437
5432
|
if(tableId===undefined||tableId===null||tableId===''){throw'Missing the required parameter "tableId" when calling patchBusinessrulesDecisiontable';}// verify the required parameter 'body' is set
|
|
5438
5433
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling patchBusinessrulesDecisiontable';}return this.apiClient.callApi('/api/v2/businessrules/decisiontables/{tableId}','PATCH',{'tableId':tableId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
5434
|
+
* Update decision table row import job
|
|
5435
|
+
*
|
|
5436
|
+
* @param {String} tableId Table ID
|
|
5437
|
+
* @param {String} importJobId Import job ID
|
|
5438
|
+
* @param {Object} body Import job update request
|
|
5439
|
+
* @param {Object} opts Optional parameters
|
|
5440
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
5441
|
+
*/},{key:"patchBusinessrulesDecisiontableImport",value:function patchBusinessrulesDecisiontableImport(tableId,importJobId,body,opts){opts=opts||{};// verify the required parameter 'tableId' is set
|
|
5442
|
+
if(tableId===undefined||tableId===null||tableId===''){throw'Missing the required parameter "tableId" when calling patchBusinessrulesDecisiontableImport';}// verify the required parameter 'importJobId' is set
|
|
5443
|
+
if(importJobId===undefined||importJobId===null||importJobId===''){throw'Missing the required parameter "importJobId" when calling patchBusinessrulesDecisiontableImport';}// verify the required parameter 'body' is set
|
|
5444
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling patchBusinessrulesDecisiontableImport';}return this.apiClient.callApi('/api/v2/businessrules/decisiontables/{tableId}/imports/{importJobId}','PATCH',{'tableId':tableId,'importJobId':importJobId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
5439
5445
|
* Update a decision table version
|
|
5440
5446
|
*
|
|
5441
5447
|
* @param {String} tableId Table ID
|
|
@@ -5456,6 +5462,24 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
5456
5462
|
*/},{key:"postBusinessrulesDecisiontableExecute",value:function postBusinessrulesDecisiontableExecute(tableId,body,opts){opts=opts||{};// verify the required parameter 'tableId' is set
|
|
5457
5463
|
if(tableId===undefined||tableId===null||tableId===''){throw'Missing the required parameter "tableId" when calling postBusinessrulesDecisiontableExecute';}// verify the required parameter 'body' is set
|
|
5458
5464
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postBusinessrulesDecisiontableExecute';}return this.apiClient.callApi('/api/v2/businessrules/decisiontables/{tableId}/execute','POST',{'tableId':tableId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
5465
|
+
* Create an export job for a decision table version
|
|
5466
|
+
*
|
|
5467
|
+
* @param {String} tableId Table ID
|
|
5468
|
+
* @param {Object} body Export job request
|
|
5469
|
+
* @param {Object} opts Optional parameters
|
|
5470
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
5471
|
+
*/},{key:"postBusinessrulesDecisiontableExports",value:function postBusinessrulesDecisiontableExports(tableId,body,opts){opts=opts||{};// verify the required parameter 'tableId' is set
|
|
5472
|
+
if(tableId===undefined||tableId===null||tableId===''){throw'Missing the required parameter "tableId" when calling postBusinessrulesDecisiontableExports';}// verify the required parameter 'body' is set
|
|
5473
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postBusinessrulesDecisiontableExports';}return this.apiClient.callApi('/api/v2/businessrules/decisiontables/{tableId}/exports','POST',{'tableId':tableId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
5474
|
+
* Create a decision table row import job
|
|
5475
|
+
*
|
|
5476
|
+
* @param {String} tableId Table ID
|
|
5477
|
+
* @param {Object} body Import job create request
|
|
5478
|
+
* @param {Object} opts Optional parameters
|
|
5479
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
5480
|
+
*/},{key:"postBusinessrulesDecisiontableImports",value:function postBusinessrulesDecisiontableImports(tableId,body,opts){opts=opts||{};// verify the required parameter 'tableId' is set
|
|
5481
|
+
if(tableId===undefined||tableId===null||tableId===''){throw'Missing the required parameter "tableId" when calling postBusinessrulesDecisiontableImports';}// verify the required parameter 'body' is set
|
|
5482
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postBusinessrulesDecisiontableImports';}return this.apiClient.callApi('/api/v2/businessrules/decisiontables/{tableId}/imports','POST',{'tableId':tableId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
5459
5483
|
* Copy a decision table version
|
|
5460
5484
|
*
|
|
5461
5485
|
* @param {String} tableId Table ID
|
|
@@ -5489,6 +5513,39 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
5489
5513
|
if(tableId===undefined||tableId===null||tableId===''){throw'Missing the required parameter "tableId" when calling postBusinessrulesDecisiontableVersionRows';}// verify the required parameter 'tableVersion' is set
|
|
5490
5514
|
if(tableVersion===undefined||tableVersion===null){throw'Missing the required parameter "tableVersion" when calling postBusinessrulesDecisiontableVersionRows';}// verify the required parameter 'body' is set
|
|
5491
5515
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postBusinessrulesDecisiontableVersionRows';}return this.apiClient.callApi('/api/v2/businessrules/decisiontables/{tableId}/versions/{tableVersion}/rows','POST',{'tableId':tableId,'tableVersion':tableVersion},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
5516
|
+
* Bulk add decision table rows
|
|
5517
|
+
* Required permissions depend on table content: if the table or row contains queue references, routing:queue:view is required in each queues division. Future platform objects will require their associated permissions in the relevant divisions when the table or row contains references to them.
|
|
5518
|
+
* @param {String} tableId Table ID
|
|
5519
|
+
* @param {Number} tableVersion Table Version
|
|
5520
|
+
* @param {Object} body Bulk add decision table rows request
|
|
5521
|
+
* @param {Object} opts Optional parameters
|
|
5522
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
5523
|
+
*/},{key:"postBusinessrulesDecisiontableVersionRowsBulkAdd",value:function postBusinessrulesDecisiontableVersionRowsBulkAdd(tableId,tableVersion,body,opts){opts=opts||{};// verify the required parameter 'tableId' is set
|
|
5524
|
+
if(tableId===undefined||tableId===null||tableId===''){throw'Missing the required parameter "tableId" when calling postBusinessrulesDecisiontableVersionRowsBulkAdd';}// verify the required parameter 'tableVersion' is set
|
|
5525
|
+
if(tableVersion===undefined||tableVersion===null){throw'Missing the required parameter "tableVersion" when calling postBusinessrulesDecisiontableVersionRowsBulkAdd';}// verify the required parameter 'body' is set
|
|
5526
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postBusinessrulesDecisiontableVersionRowsBulkAdd';}return this.apiClient.callApi('/api/v2/businessrules/decisiontables/{tableId}/versions/{tableVersion}/rows/bulk/add','POST',{'tableId':tableId,'tableVersion':tableVersion},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
5527
|
+
* Bulk delete decision table rows
|
|
5528
|
+
* Required permissions depend on table content: if the table or row contains queue references, routing:queue:view is required in each queues division. Future platform objects will require their associated permissions in the relevant divisions when the table or row contains references to them.
|
|
5529
|
+
* @param {String} tableId Table ID
|
|
5530
|
+
* @param {Number} tableVersion Table Version
|
|
5531
|
+
* @param {Object} body
|
|
5532
|
+
* @param {Object} opts Optional parameters
|
|
5533
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
5534
|
+
*/},{key:"postBusinessrulesDecisiontableVersionRowsBulkRemove",value:function postBusinessrulesDecisiontableVersionRowsBulkRemove(tableId,tableVersion,body,opts){opts=opts||{};// verify the required parameter 'tableId' is set
|
|
5535
|
+
if(tableId===undefined||tableId===null||tableId===''){throw'Missing the required parameter "tableId" when calling postBusinessrulesDecisiontableVersionRowsBulkRemove';}// verify the required parameter 'tableVersion' is set
|
|
5536
|
+
if(tableVersion===undefined||tableVersion===null){throw'Missing the required parameter "tableVersion" when calling postBusinessrulesDecisiontableVersionRowsBulkRemove';}// verify the required parameter 'body' is set
|
|
5537
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postBusinessrulesDecisiontableVersionRowsBulkRemove';}return this.apiClient.callApi('/api/v2/businessrules/decisiontables/{tableId}/versions/{tableVersion}/rows/bulk/remove','POST',{'tableId':tableId,'tableVersion':tableVersion},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
5538
|
+
* Bulk update decision table rows
|
|
5539
|
+
* Required permissions depend on table content: if the table or row contains queue references, routing:queue:view is required in each queues division. Future platform objects will require their associated permissions in the relevant divisions when the table or row contains references to them.
|
|
5540
|
+
* @param {String} tableId Table ID
|
|
5541
|
+
* @param {Number} tableVersion Table Version
|
|
5542
|
+
* @param {Object} body Bulk update decision table rows request
|
|
5543
|
+
* @param {Object} opts Optional parameters
|
|
5544
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
5545
|
+
*/},{key:"postBusinessrulesDecisiontableVersionRowsBulkUpdate",value:function postBusinessrulesDecisiontableVersionRowsBulkUpdate(tableId,tableVersion,body,opts){opts=opts||{};// verify the required parameter 'tableId' is set
|
|
5546
|
+
if(tableId===undefined||tableId===null||tableId===''){throw'Missing the required parameter "tableId" when calling postBusinessrulesDecisiontableVersionRowsBulkUpdate';}// verify the required parameter 'tableVersion' is set
|
|
5547
|
+
if(tableVersion===undefined||tableVersion===null){throw'Missing the required parameter "tableVersion" when calling postBusinessrulesDecisiontableVersionRowsBulkUpdate';}// verify the required parameter 'body' is set
|
|
5548
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postBusinessrulesDecisiontableVersionRowsBulkUpdate';}return this.apiClient.callApi('/api/v2/businessrules/decisiontables/{tableId}/versions/{tableVersion}/rows/bulk/update','POST',{'tableId':tableId,'tableVersion':tableVersion},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
5492
5549
|
* Search for decision table rows
|
|
5493
5550
|
*
|
|
5494
5551
|
* @param {String} tableId Table ID
|
|
@@ -5565,7 +5622,7 @@ if(schemaId===undefined||schemaId===null||schemaId===''){throw'Missing the requi
|
|
|
5565
5622
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putBusinessrulesSchema';}return this.apiClient.callApi('/api/v2/businessrules/schemas/{schemaId}','PUT',{'schemaId':schemaId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}}]);}();var CarrierServicesApi=/*#__PURE__*/function(){/**
|
|
5566
5623
|
* CarrierServices service.
|
|
5567
5624
|
* @module purecloud-platform-client-v2/api/CarrierServicesApi
|
|
5568
|
-
* @version
|
|
5625
|
+
* @version 254.0.0
|
|
5569
5626
|
*//**
|
|
5570
5627
|
* Constructs a new CarrierServicesApi.
|
|
5571
5628
|
* @alias module:purecloud-platform-client-v2/api/CarrierServicesApi
|
|
@@ -5588,7 +5645,7 @@ if(phoneNumber===undefined||phoneNumber===null){throw'Missing the required param
|
|
|
5588
5645
|
*/},{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'],opts['customHeaders']);}}]);}();var CaseManagementApi=/*#__PURE__*/function(){/**
|
|
5589
5646
|
* CaseManagement service.
|
|
5590
5647
|
* @module purecloud-platform-client-v2/api/CaseManagementApi
|
|
5591
|
-
* @version
|
|
5648
|
+
* @version 254.0.0
|
|
5592
5649
|
*//**
|
|
5593
5650
|
* Constructs a new CaseManagementApi.
|
|
5594
5651
|
* @alias module:purecloud-platform-client-v2/api/CaseManagementApi
|
|
@@ -5598,167 +5655,160 @@ if(phoneNumber===undefined||phoneNumber===null){throw'Missing the required param
|
|
|
5598
5655
|
*/function CaseManagementApi(apiClient){_classCallCheck(this,CaseManagementApi);this.apiClient=apiClient||ApiClient.instance;}/**
|
|
5599
5656
|
* Delete a Case.
|
|
5600
5657
|
*
|
|
5601
|
-
* @param {String} caseId Case
|
|
5658
|
+
* @param {String} caseId Case identifier.
|
|
5602
5659
|
* @param {Object} opts Optional parameters
|
|
5603
5660
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
5604
|
-
* deleteCasemanagementCase is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
5605
5661
|
*/return _createClass(CaseManagementApi,[{key:"deleteCasemanagementCase",value:function deleteCasemanagementCase(caseId,opts){opts=opts||{};// verify the required parameter 'caseId' is set
|
|
5606
5662
|
if(caseId===undefined||caseId===null||caseId===''){throw'Missing the required parameter "caseId" when calling deleteCasemanagementCase';}return this.apiClient.callApi('/api/v2/casemanagement/cases/{caseId}','DELETE',{'caseId':caseId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
5607
5663
|
* Delete a Caseplan.
|
|
5608
5664
|
*
|
|
5609
|
-
* @param {String} caseplanId Caseplan
|
|
5665
|
+
* @param {String} caseplanId Caseplan identifier.
|
|
5610
5666
|
* @param {Object} opts Optional parameters
|
|
5611
5667
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
5612
|
-
* deleteCasemanagementCaseplan is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
5613
5668
|
*/},{key:"deleteCasemanagementCaseplan",value:function deleteCasemanagementCaseplan(caseplanId,opts){opts=opts||{};// verify the required parameter 'caseplanId' is set
|
|
5614
5669
|
if(caseplanId===undefined||caseplanId===null||caseplanId===''){throw'Missing the required parameter "caseplanId" when calling deleteCasemanagementCaseplan';}return this.apiClient.callApi('/api/v2/casemanagement/caseplans/{caseplanId}','DELETE',{'caseplanId':caseplanId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
5670
|
+
* Remove a data schema from a draft Caseplan.
|
|
5671
|
+
*
|
|
5672
|
+
* @param {String} caseplanId Caseplan identifier.
|
|
5673
|
+
* @param {String} schemaKeyName Schema key (for example default).
|
|
5674
|
+
* @param {Object} opts Optional parameters
|
|
5675
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
5676
|
+
*/},{key:"deleteCasemanagementCaseplanDataschema",value:function deleteCasemanagementCaseplanDataschema(caseplanId,schemaKeyName,opts){opts=opts||{};// verify the required parameter 'caseplanId' is set
|
|
5677
|
+
if(caseplanId===undefined||caseplanId===null||caseplanId===''){throw'Missing the required parameter "caseplanId" when calling deleteCasemanagementCaseplanDataschema';}// verify the required parameter 'schemaKeyName' is set
|
|
5678
|
+
if(schemaKeyName===undefined||schemaKeyName===null||schemaKeyName===''){throw'Missing the required parameter "schemaKeyName" when calling deleteCasemanagementCaseplanDataschema';}return this.apiClient.callApi('/api/v2/casemanagement/caseplans/{caseplanId}/dataschemas/{schemaKeyName}','DELETE',{'caseplanId':caseplanId,'schemaKeyName':schemaKeyName},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
5615
5679
|
* Get a Case.
|
|
5616
5680
|
*
|
|
5617
|
-
* @param {String} caseId Case
|
|
5681
|
+
* @param {String} caseId Case identifier.
|
|
5618
5682
|
* @param {Object} opts Optional parameters
|
|
5619
|
-
* @param {Object} opts.expands
|
|
5683
|
+
* @param {Object} opts.expands Fields to expand.
|
|
5620
5684
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
5621
|
-
* getCasemanagementCase is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
5622
5685
|
*/},{key:"getCasemanagementCase",value:function getCasemanagementCase(caseId,opts){opts=opts||{};// verify the required parameter 'caseId' is set
|
|
5623
5686
|
if(caseId===undefined||caseId===null||caseId===''){throw'Missing the required parameter "caseId" when calling getCasemanagementCase';}return this.apiClient.callApi('/api/v2/casemanagement/cases/{caseId}','GET',{'caseId':caseId},{'expands':opts['expands']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
5624
5687
|
* Get a Case Association.
|
|
5625
5688
|
*
|
|
5626
|
-
* @param {String} caseId Case
|
|
5627
|
-
* @param {String} associationId Case
|
|
5689
|
+
* @param {String} caseId Case identifier.
|
|
5690
|
+
* @param {String} associationId Case association identifier.
|
|
5628
5691
|
* @param {Object} opts Optional parameters
|
|
5629
5692
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
5630
|
-
* getCasemanagementCaseAssociation is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
5631
5693
|
*/},{key:"getCasemanagementCaseAssociation",value:function getCasemanagementCaseAssociation(caseId,associationId,opts){opts=opts||{};// verify the required parameter 'caseId' is set
|
|
5632
5694
|
if(caseId===undefined||caseId===null||caseId===''){throw'Missing the required parameter "caseId" when calling getCasemanagementCaseAssociation';}// verify the required parameter 'associationId' is set
|
|
5633
5695
|
if(associationId===undefined||associationId===null||associationId===''){throw'Missing the required parameter "associationId" when calling getCasemanagementCaseAssociation';}return this.apiClient.callApi('/api/v2/casemanagement/cases/{caseId}/associations/{associationId}','GET',{'caseId':caseId,'associationId':associationId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
5634
|
-
* Get a list of
|
|
5696
|
+
* Get a list of Case associations for the Case.
|
|
5635
5697
|
*
|
|
5636
|
-
* @param {String} caseId Case
|
|
5698
|
+
* @param {String} caseId Case identifier.
|
|
5637
5699
|
* @param {Object} opts Optional parameters
|
|
5638
5700
|
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
5639
5701
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
5640
5702
|
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
5641
5703
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
5642
|
-
* getCasemanagementCaseAssociations is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
5643
5704
|
*/},{key:"getCasemanagementCaseAssociations",value:function getCasemanagementCaseAssociations(caseId,opts){opts=opts||{};// verify the required parameter 'caseId' is set
|
|
5644
5705
|
if(caseId===undefined||caseId===null||caseId===''){throw'Missing the required parameter "caseId" when calling getCasemanagementCaseAssociations';}return this.apiClient.callApi('/api/v2/casemanagement/cases/{caseId}/associations','GET',{'caseId':caseId},{'before':opts['before'],'after':opts['after'],'pageSize':opts['pageSize']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
5645
5706
|
* Get a Stage.
|
|
5646
5707
|
*
|
|
5647
|
-
* @param {String} caseId Case
|
|
5648
|
-
* @param {String} stageId Stage
|
|
5708
|
+
* @param {String} caseId Case identifier.
|
|
5709
|
+
* @param {String} stageId Stage identifier.
|
|
5649
5710
|
* @param {Object} opts Optional parameters
|
|
5650
5711
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
5651
|
-
* getCasemanagementCaseStage is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
5652
5712
|
*/},{key:"getCasemanagementCaseStage",value:function getCasemanagementCaseStage(caseId,stageId,opts){opts=opts||{};// verify the required parameter 'caseId' is set
|
|
5653
5713
|
if(caseId===undefined||caseId===null||caseId===''){throw'Missing the required parameter "caseId" when calling getCasemanagementCaseStage';}// verify the required parameter 'stageId' is set
|
|
5654
5714
|
if(stageId===undefined||stageId===null||stageId===''){throw'Missing the required parameter "stageId" when calling getCasemanagementCaseStage';}return this.apiClient.callApi('/api/v2/casemanagement/cases/{caseId}/stages/{stageId}','GET',{'caseId':caseId,'stageId':stageId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
5655
5715
|
* Get a Step.
|
|
5656
5716
|
*
|
|
5657
|
-
* @param {String} caseId Case
|
|
5658
|
-
* @param {String} stageId Stage
|
|
5659
|
-
* @param {String} stepId Step
|
|
5717
|
+
* @param {String} caseId Case identifier.
|
|
5718
|
+
* @param {String} stageId Stage identifier.
|
|
5719
|
+
* @param {String} stepId Step identifier.
|
|
5660
5720
|
* @param {Object} opts Optional parameters
|
|
5661
5721
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
5662
|
-
* getCasemanagementCaseStageStep is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
5663
5722
|
*/},{key:"getCasemanagementCaseStageStep",value:function getCasemanagementCaseStageStep(caseId,stageId,stepId,opts){opts=opts||{};// verify the required parameter 'caseId' is set
|
|
5664
5723
|
if(caseId===undefined||caseId===null||caseId===''){throw'Missing the required parameter "caseId" when calling getCasemanagementCaseStageStep';}// verify the required parameter 'stageId' is set
|
|
5665
5724
|
if(stageId===undefined||stageId===null||stageId===''){throw'Missing the required parameter "stageId" when calling getCasemanagementCaseStageStep';}// verify the required parameter 'stepId' is set
|
|
5666
5725
|
if(stepId===undefined||stepId===null||stepId===''){throw'Missing the required parameter "stepId" when calling getCasemanagementCaseStageStep';}return this.apiClient.callApi('/api/v2/casemanagement/cases/{caseId}/stages/{stageId}/steps/{stepId}','GET',{'caseId':caseId,'stageId':stageId,'stepId':stepId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
5667
5726
|
* Get a list of Steps.
|
|
5668
5727
|
*
|
|
5669
|
-
* @param {String} caseId Case
|
|
5670
|
-
* @param {String} stageId Stage
|
|
5728
|
+
* @param {String} caseId Case identifier.
|
|
5729
|
+
* @param {String} stageId Stage identifier.
|
|
5671
5730
|
* @param {Object} opts Optional parameters
|
|
5672
5731
|
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
5673
5732
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
5674
5733
|
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
5675
5734
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
5676
|
-
* getCasemanagementCaseStageSteps is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
5677
5735
|
*/},{key:"getCasemanagementCaseStageSteps",value:function getCasemanagementCaseStageSteps(caseId,stageId,opts){opts=opts||{};// verify the required parameter 'caseId' is set
|
|
5678
5736
|
if(caseId===undefined||caseId===null||caseId===''){throw'Missing the required parameter "caseId" when calling getCasemanagementCaseStageSteps';}// verify the required parameter 'stageId' is set
|
|
5679
5737
|
if(stageId===undefined||stageId===null||stageId===''){throw'Missing the required parameter "stageId" when calling getCasemanagementCaseStageSteps';}return this.apiClient.callApi('/api/v2/casemanagement/cases/{caseId}/stages/{stageId}/steps','GET',{'caseId':caseId,'stageId':stageId},{'before':opts['before'],'after':opts['after'],'pageSize':opts['pageSize']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
5680
5738
|
* Get a list of Stages.
|
|
5681
5739
|
*
|
|
5682
|
-
* @param {String} caseId Case
|
|
5740
|
+
* @param {String} caseId Case identifier.
|
|
5683
5741
|
* @param {Object} opts Optional parameters
|
|
5684
5742
|
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
5685
5743
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
5686
5744
|
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
5687
5745
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
5688
|
-
* getCasemanagementCaseStages is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
5689
5746
|
*/},{key:"getCasemanagementCaseStages",value:function getCasemanagementCaseStages(caseId,opts){opts=opts||{};// verify the required parameter 'caseId' is set
|
|
5690
5747
|
if(caseId===undefined||caseId===null||caseId===''){throw'Missing the required parameter "caseId" when calling getCasemanagementCaseStages';}return this.apiClient.callApi('/api/v2/casemanagement/cases/{caseId}/stages','GET',{'caseId':caseId},{'before':opts['before'],'after':opts['after'],'pageSize':opts['pageSize']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
5691
5748
|
* Get a Terminate Job for a Case.
|
|
5692
5749
|
*
|
|
5693
|
-
* @param {String} caseId Case
|
|
5694
|
-
* @param {String} jobId Job
|
|
5750
|
+
* @param {String} caseId Case identifier.
|
|
5751
|
+
* @param {String} jobId Terminate Job identifier.
|
|
5695
5752
|
* @param {Object} opts Optional parameters
|
|
5696
5753
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
5697
|
-
* getCasemanagementCaseTerminateJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
5698
5754
|
*/},{key:"getCasemanagementCaseTerminateJob",value:function getCasemanagementCaseTerminateJob(caseId,jobId,opts){opts=opts||{};// verify the required parameter 'caseId' is set
|
|
5699
5755
|
if(caseId===undefined||caseId===null||caseId===''){throw'Missing the required parameter "caseId" when calling getCasemanagementCaseTerminateJob';}// verify the required parameter 'jobId' is set
|
|
5700
5756
|
if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required parameter "jobId" when calling getCasemanagementCaseTerminateJob';}return this.apiClient.callApi('/api/v2/casemanagement/cases/{caseId}/terminate/jobs/{jobId}','GET',{'caseId':caseId,'jobId':jobId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
5701
5757
|
* Get a Caseplan.
|
|
5702
5758
|
*
|
|
5703
|
-
* @param {String} caseplanId Caseplan
|
|
5759
|
+
* @param {String} caseplanId Caseplan identifier.
|
|
5704
5760
|
* @param {Object} opts Optional parameters
|
|
5705
5761
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
5706
|
-
* getCasemanagementCaseplan is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
5707
5762
|
*/},{key:"getCasemanagementCaseplan",value:function getCasemanagementCaseplan(caseplanId,opts){opts=opts||{};// verify the required parameter 'caseplanId' is set
|
|
5708
5763
|
if(caseplanId===undefined||caseplanId===null||caseplanId===''){throw'Missing the required parameter "caseplanId" when calling getCasemanagementCaseplan';}return this.apiClient.callApi('/api/v2/casemanagement/caseplans/{caseplanId}','GET',{'caseplanId':caseplanId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
5709
5764
|
* Get a Caseplan version.
|
|
5710
5765
|
*
|
|
5711
|
-
* @param {String} caseplanId Caseplan
|
|
5712
|
-
* @param {String} versionId
|
|
5766
|
+
* @param {String} caseplanId Caseplan identifier.
|
|
5767
|
+
* @param {String} versionId Caseplan version identifier.
|
|
5713
5768
|
* @param {Object} opts Optional parameters
|
|
5714
5769
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
5715
|
-
* getCasemanagementCaseplanVersion is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
5716
5770
|
*/},{key:"getCasemanagementCaseplanVersion",value:function getCasemanagementCaseplanVersion(caseplanId,versionId,opts){opts=opts||{};// verify the required parameter 'caseplanId' is set
|
|
5717
5771
|
if(caseplanId===undefined||caseplanId===null||caseplanId===''){throw'Missing the required parameter "caseplanId" when calling getCasemanagementCaseplanVersion';}// verify the required parameter 'versionId' is set
|
|
5718
5772
|
if(versionId===undefined||versionId===null||versionId===''){throw'Missing the required parameter "versionId" when calling getCasemanagementCaseplanVersion';}return this.apiClient.callApi('/api/v2/casemanagement/caseplans/{caseplanId}/versions/{versionId}','GET',{'caseplanId':caseplanId,'versionId':versionId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
5719
|
-
* Get the
|
|
5773
|
+
* Get the data schemas for a Caseplan version.
|
|
5720
5774
|
*
|
|
5721
|
-
* @param {String} caseplanId Caseplan
|
|
5722
|
-
* @param {String} versionId
|
|
5775
|
+
* @param {String} caseplanId Caseplan identifier.
|
|
5776
|
+
* @param {String} versionId Caseplan version identifier.
|
|
5723
5777
|
* @param {Object} opts Optional parameters
|
|
5724
5778
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
5725
|
-
* getCasemanagementCaseplanVersionDataschemas is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
5726
5779
|
*/},{key:"getCasemanagementCaseplanVersionDataschemas",value:function getCasemanagementCaseplanVersionDataschemas(caseplanId,versionId,opts){opts=opts||{};// verify the required parameter 'caseplanId' is set
|
|
5727
5780
|
if(caseplanId===undefined||caseplanId===null||caseplanId===''){throw'Missing the required parameter "caseplanId" when calling getCasemanagementCaseplanVersionDataschemas';}// verify the required parameter 'versionId' is set
|
|
5728
5781
|
if(versionId===undefined||versionId===null||versionId===''){throw'Missing the required parameter "versionId" when calling getCasemanagementCaseplanVersionDataschemas';}return this.apiClient.callApi('/api/v2/casemanagement/caseplans/{caseplanId}/versions/{versionId}/dataschemas','GET',{'caseplanId':caseplanId,'versionId':versionId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
5729
5782
|
* Get the intake settings for a Caseplan version.
|
|
5730
5783
|
*
|
|
5731
|
-
* @param {String} caseplanId Caseplan
|
|
5732
|
-
* @param {String} versionId
|
|
5784
|
+
* @param {String} caseplanId Caseplan identifier.
|
|
5785
|
+
* @param {String} versionId Caseplan version identifier.
|
|
5733
5786
|
* @param {Object} opts Optional parameters
|
|
5734
5787
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
5735
|
-
* getCasemanagementCaseplanVersionIntakesettings is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
5736
5788
|
*/},{key:"getCasemanagementCaseplanVersionIntakesettings",value:function getCasemanagementCaseplanVersionIntakesettings(caseplanId,versionId,opts){opts=opts||{};// verify the required parameter 'caseplanId' is set
|
|
5737
5789
|
if(caseplanId===undefined||caseplanId===null||caseplanId===''){throw'Missing the required parameter "caseplanId" when calling getCasemanagementCaseplanVersionIntakesettings';}// verify the required parameter 'versionId' is set
|
|
5738
5790
|
if(versionId===undefined||versionId===null||versionId===''){throw'Missing the required parameter "versionId" when calling getCasemanagementCaseplanVersionIntakesettings';}return this.apiClient.callApi('/api/v2/casemanagement/caseplans/{caseplanId}/versions/{versionId}/intakesettings','GET',{'caseplanId':caseplanId,'versionId':versionId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
5739
5791
|
* Get a Stageplan.
|
|
5740
5792
|
*
|
|
5741
|
-
* @param {String} caseplanId Caseplan
|
|
5742
|
-
* @param {String} versionId
|
|
5743
|
-
* @param {String} stageplanId Stageplan
|
|
5793
|
+
* @param {String} caseplanId Caseplan identifier.
|
|
5794
|
+
* @param {String} versionId Caseplan version identifier.
|
|
5795
|
+
* @param {String} stageplanId Stageplan identifier.
|
|
5744
5796
|
* @param {Object} opts Optional parameters
|
|
5745
|
-
* @param {Array.<String>} opts.expands
|
|
5797
|
+
* @param {Array.<String>} opts.expands Fields to expand.
|
|
5746
5798
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
5747
|
-
* getCasemanagementCaseplanVersionStageplan is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
5748
5799
|
*/},{key:"getCasemanagementCaseplanVersionStageplan",value:function getCasemanagementCaseplanVersionStageplan(caseplanId,versionId,stageplanId,opts){opts=opts||{};// verify the required parameter 'caseplanId' is set
|
|
5749
5800
|
if(caseplanId===undefined||caseplanId===null||caseplanId===''){throw'Missing the required parameter "caseplanId" when calling getCasemanagementCaseplanVersionStageplan';}// verify the required parameter 'versionId' is set
|
|
5750
5801
|
if(versionId===undefined||versionId===null||versionId===''){throw'Missing the required parameter "versionId" when calling getCasemanagementCaseplanVersionStageplan';}// verify the required parameter 'stageplanId' is set
|
|
5751
5802
|
if(stageplanId===undefined||stageplanId===null||stageplanId===''){throw'Missing the required parameter "stageplanId" when calling getCasemanagementCaseplanVersionStageplan';}return this.apiClient.callApi('/api/v2/casemanagement/caseplans/{caseplanId}/versions/{versionId}/stageplans/{stageplanId}','GET',{'caseplanId':caseplanId,'versionId':versionId,'stageplanId':stageplanId},{'expands':this.apiClient.buildCollectionParam(opts['expands'],'multi')},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
5752
5803
|
* Get a Stepplan.
|
|
5753
5804
|
*
|
|
5754
|
-
* @param {String} caseplanId Caseplan
|
|
5755
|
-
* @param {String} versionId
|
|
5756
|
-
* @param {String} stageplanId Stageplan
|
|
5757
|
-
* @param {String} stepplanId Stepplan
|
|
5805
|
+
* @param {String} caseplanId Caseplan identifier.
|
|
5806
|
+
* @param {String} versionId Caseplan version identifier.
|
|
5807
|
+
* @param {String} stageplanId Stageplan identifier.
|
|
5808
|
+
* @param {String} stepplanId Stepplan identifier.
|
|
5758
5809
|
* @param {Object} opts Optional parameters
|
|
5759
|
-
* @param {Array.<String>} opts.expands
|
|
5810
|
+
* @param {Array.<String>} opts.expands Fields to expand.
|
|
5760
5811
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
5761
|
-
* getCasemanagementCaseplanVersionStageplanStepplan is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
5762
5812
|
*/},{key:"getCasemanagementCaseplanVersionStageplanStepplan",value:function getCasemanagementCaseplanVersionStageplanStepplan(caseplanId,versionId,stageplanId,stepplanId,opts){opts=opts||{};// verify the required parameter 'caseplanId' is set
|
|
5763
5813
|
if(caseplanId===undefined||caseplanId===null||caseplanId===''){throw'Missing the required parameter "caseplanId" when calling getCasemanagementCaseplanVersionStageplanStepplan';}// verify the required parameter 'versionId' is set
|
|
5764
5814
|
if(versionId===undefined||versionId===null||versionId===''){throw'Missing the required parameter "versionId" when calling getCasemanagementCaseplanVersionStageplanStepplan';}// verify the required parameter 'stageplanId' is set
|
|
@@ -5766,208 +5816,210 @@ if(stageplanId===undefined||stageplanId===null||stageplanId===''){throw'Missing
|
|
|
5766
5816
|
if(stepplanId===undefined||stepplanId===null||stepplanId===''){throw'Missing the required parameter "stepplanId" when calling getCasemanagementCaseplanVersionStageplanStepplan';}return this.apiClient.callApi('/api/v2/casemanagement/caseplans/{caseplanId}/versions/{versionId}/stageplans/{stageplanId}/stepplans/{stepplanId}','GET',{'caseplanId':caseplanId,'versionId':versionId,'stageplanId':stageplanId,'stepplanId':stepplanId},{'expands':this.apiClient.buildCollectionParam(opts['expands'],'multi')},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
5767
5817
|
* Get a list of Stepplans.
|
|
5768
5818
|
*
|
|
5769
|
-
* @param {String} caseplanId Caseplan
|
|
5770
|
-
* @param {String} versionId
|
|
5771
|
-
* @param {String} stageplanId Stageplan
|
|
5819
|
+
* @param {String} caseplanId Caseplan identifier.
|
|
5820
|
+
* @param {String} versionId Caseplan version identifier.
|
|
5821
|
+
* @param {String} stageplanId Stageplan identifier.
|
|
5772
5822
|
* @param {Object} opts Optional parameters
|
|
5773
5823
|
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
5774
5824
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
5775
5825
|
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
5776
|
-
* @param {Array.<String>} opts.expands
|
|
5826
|
+
* @param {Array.<String>} opts.expands Fields to expand.
|
|
5777
5827
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
5778
|
-
* getCasemanagementCaseplanVersionStageplanStepplans is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
5779
5828
|
*/},{key:"getCasemanagementCaseplanVersionStageplanStepplans",value:function getCasemanagementCaseplanVersionStageplanStepplans(caseplanId,versionId,stageplanId,opts){opts=opts||{};// verify the required parameter 'caseplanId' is set
|
|
5780
5829
|
if(caseplanId===undefined||caseplanId===null||caseplanId===''){throw'Missing the required parameter "caseplanId" when calling getCasemanagementCaseplanVersionStageplanStepplans';}// verify the required parameter 'versionId' is set
|
|
5781
5830
|
if(versionId===undefined||versionId===null||versionId===''){throw'Missing the required parameter "versionId" when calling getCasemanagementCaseplanVersionStageplanStepplans';}// verify the required parameter 'stageplanId' is set
|
|
5782
5831
|
if(stageplanId===undefined||stageplanId===null||stageplanId===''){throw'Missing the required parameter "stageplanId" when calling getCasemanagementCaseplanVersionStageplanStepplans';}return this.apiClient.callApi('/api/v2/casemanagement/caseplans/{caseplanId}/versions/{versionId}/stageplans/{stageplanId}/stepplans','GET',{'caseplanId':caseplanId,'versionId':versionId,'stageplanId':stageplanId},{'before':opts['before'],'after':opts['after'],'pageSize':opts['pageSize'],'expands':this.apiClient.buildCollectionParam(opts['expands'],'multi')},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
5783
5832
|
* Get a list of Stageplans.
|
|
5784
5833
|
*
|
|
5785
|
-
* @param {String} caseplanId Caseplan
|
|
5786
|
-
* @param {String} versionId
|
|
5834
|
+
* @param {String} caseplanId Caseplan identifier.
|
|
5835
|
+
* @param {String} versionId Caseplan version identifier.
|
|
5787
5836
|
* @param {Object} opts Optional parameters
|
|
5788
5837
|
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
5789
5838
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
5790
5839
|
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
5791
|
-
* @param {Array.<String>} opts.expands
|
|
5840
|
+
* @param {Array.<String>} opts.expands Fields to expand.
|
|
5792
5841
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
5793
|
-
* getCasemanagementCaseplanVersionStageplans is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
5794
5842
|
*/},{key:"getCasemanagementCaseplanVersionStageplans",value:function getCasemanagementCaseplanVersionStageplans(caseplanId,versionId,opts){opts=opts||{};// verify the required parameter 'caseplanId' is set
|
|
5795
5843
|
if(caseplanId===undefined||caseplanId===null||caseplanId===''){throw'Missing the required parameter "caseplanId" when calling getCasemanagementCaseplanVersionStageplans';}// verify the required parameter 'versionId' is set
|
|
5796
5844
|
if(versionId===undefined||versionId===null||versionId===''){throw'Missing the required parameter "versionId" when calling getCasemanagementCaseplanVersionStageplans';}return this.apiClient.callApi('/api/v2/casemanagement/caseplans/{caseplanId}/versions/{versionId}/stageplans','GET',{'caseplanId':caseplanId,'versionId':versionId},{'before':opts['before'],'after':opts['after'],'pageSize':opts['pageSize'],'expands':this.apiClient.buildCollectionParam(opts['expands'],'multi')},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
5797
5845
|
* Get a list of Caseplans.
|
|
5798
5846
|
*
|
|
5799
5847
|
* @param {Object} opts Optional parameters
|
|
5800
|
-
* @param {String} opts.after
|
|
5801
|
-
* @param {Number} opts.pageSize Number of
|
|
5802
|
-
* @param {String} opts.customerIntentId Filter by
|
|
5803
|
-
* @param {String} opts.divisionIds Filter by
|
|
5848
|
+
* @param {String} opts.after Cursor that points to the end of the previously returned set of Caseplans.
|
|
5849
|
+
* @param {Number} opts.pageSize Number of Caseplans to return. Maximum is 200.
|
|
5850
|
+
* @param {String} opts.customerIntentId Filter by customer intent.
|
|
5851
|
+
* @param {String} opts.divisionIds Filter by divisions.
|
|
5804
5852
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
5805
|
-
* getCasemanagementCaseplans is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
5806
5853
|
*/},{key:"getCasemanagementCaseplans",value:function getCasemanagementCaseplans(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/casemanagement/caseplans','GET',{},{'after':opts['after'],'pageSize':opts['pageSize'],'customerIntentId':opts['customerIntentId'],'divisionIds':opts['divisionIds']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
5807
|
-
* Get a list of
|
|
5854
|
+
* Get a list of Cases for an External Contact.
|
|
5808
5855
|
*
|
|
5809
|
-
* @param {String} externalContactId External
|
|
5856
|
+
* @param {String} externalContactId External contact identifier.
|
|
5810
5857
|
* @param {Object} opts Optional parameters
|
|
5811
|
-
* @param {String} opts.after
|
|
5812
|
-
* @param {Number} opts.pageSize Number of
|
|
5813
|
-
* @param {String} opts.divisionIds Filter by
|
|
5814
|
-
* @param {Array.<String>} opts.expands
|
|
5858
|
+
* @param {String} opts.after Cursor pointing to the end of the previously returned page of Cases.
|
|
5859
|
+
* @param {Number} opts.pageSize Number of Cases to return (maximum 200).
|
|
5860
|
+
* @param {String} opts.divisionIds Filter by divisions.
|
|
5861
|
+
* @param {Array.<String>} opts.expands Fields to expand.
|
|
5815
5862
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
5816
|
-
* getCasemanagementCasesExternalcontact is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
5817
5863
|
*/},{key:"getCasemanagementCasesExternalcontact",value:function getCasemanagementCasesExternalcontact(externalContactId,opts){opts=opts||{};// verify the required parameter 'externalContactId' is set
|
|
5818
5864
|
if(externalContactId===undefined||externalContactId===null||externalContactId===''){throw'Missing the required parameter "externalContactId" when calling getCasemanagementCasesExternalcontact';}return this.apiClient.callApi('/api/v2/casemanagement/cases/externalcontacts/{externalContactId}','GET',{'externalContactId':externalContactId},{'after':opts['after'],'pageSize':opts['pageSize'],'divisionIds':opts['divisionIds'],'expands':this.apiClient.buildCollectionParam(opts['expands'],'multi')},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
5819
5865
|
* Get a Case by reference.
|
|
5820
5866
|
*
|
|
5821
|
-
* @param {String} referenceId
|
|
5867
|
+
* @param {String} referenceId Case reference.
|
|
5822
5868
|
* @param {Object} opts Optional parameters
|
|
5823
|
-
* @param {Object} opts.expands
|
|
5869
|
+
* @param {Object} opts.expands Fields to expand.
|
|
5824
5870
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
5825
|
-
* getCasemanagementCasesReference is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
5826
5871
|
*/},{key:"getCasemanagementCasesReference",value:function getCasemanagementCasesReference(referenceId,opts){opts=opts||{};// verify the required parameter 'referenceId' is set
|
|
5827
5872
|
if(referenceId===undefined||referenceId===null||referenceId===''){throw'Missing the required parameter "referenceId" when calling getCasemanagementCasesReference';}return this.apiClient.callApi('/api/v2/casemanagement/cases/references/{referenceId}','GET',{'referenceId':referenceId},{'expands':opts['expands']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
5828
|
-
* Update
|
|
5873
|
+
* Update the due date of a Case.
|
|
5829
5874
|
*
|
|
5830
|
-
* @param {String} caseId Case
|
|
5831
|
-
* @param {Object} body
|
|
5875
|
+
* @param {String} caseId Case identifier.
|
|
5876
|
+
* @param {Object} body Due date update.
|
|
5832
5877
|
* @param {Object} opts Optional parameters
|
|
5833
5878
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
5834
|
-
* patchCasemanagementCaseDatedue is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
5835
5879
|
*/},{key:"patchCasemanagementCaseDatedue",value:function patchCasemanagementCaseDatedue(caseId,body,opts){opts=opts||{};// verify the required parameter 'caseId' is set
|
|
5836
5880
|
if(caseId===undefined||caseId===null||caseId===''){throw'Missing the required parameter "caseId" when calling patchCasemanagementCaseDatedue';}// verify the required parameter 'body' is set
|
|
5837
5881
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling patchCasemanagementCaseDatedue';}return this.apiClient.callApi('/api/v2/casemanagement/cases/{caseId}/datedue','PATCH',{'caseId':caseId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
5838
5882
|
* Update priority of a Case.
|
|
5839
5883
|
*
|
|
5840
|
-
* @param {String} caseId Case
|
|
5841
|
-
* @param {Object} body Priority
|
|
5884
|
+
* @param {String} caseId Case identifier.
|
|
5885
|
+
* @param {Object} body Priority update.
|
|
5842
5886
|
* @param {Object} opts Optional parameters
|
|
5843
5887
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
5844
|
-
* patchCasemanagementCasePriority is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
5845
5888
|
*/},{key:"patchCasemanagementCasePriority",value:function patchCasemanagementCasePriority(caseId,body,opts){opts=opts||{};// verify the required parameter 'caseId' is set
|
|
5846
5889
|
if(caseId===undefined||caseId===null||caseId===''){throw'Missing the required parameter "caseId" when calling patchCasemanagementCasePriority';}// verify the required parameter 'body' is set
|
|
5847
5890
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling patchCasemanagementCasePriority';}return this.apiClient.callApi('/api/v2/casemanagement/cases/{caseId}/priority','PATCH',{'caseId':caseId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
5848
5891
|
* Update summary of a Case.
|
|
5849
5892
|
*
|
|
5850
|
-
* @param {String} caseId Case
|
|
5851
|
-
* @param {Object} body Summary
|
|
5893
|
+
* @param {String} caseId Case identifier.
|
|
5894
|
+
* @param {Object} body Summary update.
|
|
5852
5895
|
* @param {Object} opts Optional parameters
|
|
5853
5896
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
5854
|
-
* patchCasemanagementCaseSummary is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
5855
5897
|
*/},{key:"patchCasemanagementCaseSummary",value:function patchCasemanagementCaseSummary(caseId,body,opts){opts=opts||{};// verify the required parameter 'caseId' is set
|
|
5856
5898
|
if(caseId===undefined||caseId===null||caseId===''){throw'Missing the required parameter "caseId" when calling patchCasemanagementCaseSummary';}// verify the required parameter 'body' is set
|
|
5857
5899
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling patchCasemanagementCaseSummary';}return this.apiClient.callApi('/api/v2/casemanagement/cases/{caseId}/summary','PATCH',{'caseId':caseId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
5858
5900
|
* Update the attributes of a Caseplan.
|
|
5859
5901
|
*
|
|
5860
|
-
* @param {String} caseplanId Caseplan
|
|
5861
|
-
* @param {Object} body Caseplan
|
|
5902
|
+
* @param {String} caseplanId Caseplan identifier.
|
|
5903
|
+
* @param {Object} body Caseplan update.
|
|
5862
5904
|
* @param {Object} opts Optional parameters
|
|
5863
5905
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
5864
|
-
* patchCasemanagementCaseplan is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
5865
5906
|
*/},{key:"patchCasemanagementCaseplan",value:function patchCasemanagementCaseplan(caseplanId,body,opts){opts=opts||{};// verify the required parameter 'caseplanId' is set
|
|
5866
5907
|
if(caseplanId===undefined||caseplanId===null||caseplanId===''){throw'Missing the required parameter "caseplanId" when calling patchCasemanagementCaseplan';}// verify the required parameter 'body' is set
|
|
5867
5908
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling patchCasemanagementCaseplan';}return this.apiClient.callApi('/api/v2/casemanagement/caseplans/{caseplanId}','PATCH',{'caseplanId':caseplanId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
5868
5909
|
* Update the attributes of a Stageplan.
|
|
5869
5910
|
*
|
|
5870
|
-
* @param {String} caseplanId Caseplan
|
|
5871
|
-
* @param {String} stageplanId Stageplan
|
|
5872
|
-
* @param {Object} body Stageplan
|
|
5911
|
+
* @param {String} caseplanId Caseplan identifier.
|
|
5912
|
+
* @param {String} stageplanId Stageplan identifier.
|
|
5913
|
+
* @param {Object} body Stageplan update.
|
|
5873
5914
|
* @param {Object} opts Optional parameters
|
|
5874
5915
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
5875
|
-
* patchCasemanagementCaseplanStageplan is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
5876
5916
|
*/},{key:"patchCasemanagementCaseplanStageplan",value:function patchCasemanagementCaseplanStageplan(caseplanId,stageplanId,body,opts){opts=opts||{};// verify the required parameter 'caseplanId' is set
|
|
5877
5917
|
if(caseplanId===undefined||caseplanId===null||caseplanId===''){throw'Missing the required parameter "caseplanId" when calling patchCasemanagementCaseplanStageplan';}// verify the required parameter 'stageplanId' is set
|
|
5878
5918
|
if(stageplanId===undefined||stageplanId===null||stageplanId===''){throw'Missing the required parameter "stageplanId" when calling patchCasemanagementCaseplanStageplan';}// verify the required parameter 'body' is set
|
|
5879
5919
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling patchCasemanagementCaseplanStageplan';}return this.apiClient.callApi('/api/v2/casemanagement/caseplans/{caseplanId}/stageplans/{stageplanId}','PATCH',{'caseplanId':caseplanId,'stageplanId':stageplanId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
5880
5920
|
* Update the attributes of a Stepplan.
|
|
5881
5921
|
*
|
|
5882
|
-
* @param {String} caseplanId Caseplan
|
|
5883
|
-
* @param {String} stageplanId Stageplan
|
|
5884
|
-
* @param {String} stepplanId Stepplan
|
|
5885
|
-
* @param {Object} body Stepplan
|
|
5922
|
+
* @param {String} caseplanId Caseplan identifier.
|
|
5923
|
+
* @param {String} stageplanId Stageplan identifier.
|
|
5924
|
+
* @param {String} stepplanId Stepplan identifier.
|
|
5925
|
+
* @param {Object} body Stepplan update.
|
|
5886
5926
|
* @param {Object} opts Optional parameters
|
|
5887
5927
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
5888
|
-
* patchCasemanagementCaseplanStageplanStepplan is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
5889
5928
|
*/},{key:"patchCasemanagementCaseplanStageplanStepplan",value:function patchCasemanagementCaseplanStageplanStepplan(caseplanId,stageplanId,stepplanId,body,opts){opts=opts||{};// verify the required parameter 'caseplanId' is set
|
|
5890
5929
|
if(caseplanId===undefined||caseplanId===null||caseplanId===''){throw'Missing the required parameter "caseplanId" when calling patchCasemanagementCaseplanStageplanStepplan';}// verify the required parameter 'stageplanId' is set
|
|
5891
5930
|
if(stageplanId===undefined||stageplanId===null||stageplanId===''){throw'Missing the required parameter "stageplanId" when calling patchCasemanagementCaseplanStageplanStepplan';}// verify the required parameter 'stepplanId' is set
|
|
5892
5931
|
if(stepplanId===undefined||stepplanId===null||stepplanId===''){throw'Missing the required parameter "stepplanId" when calling patchCasemanagementCaseplanStageplanStepplan';}// verify the required parameter 'body' is set
|
|
5893
5932
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling patchCasemanagementCaseplanStageplanStepplan';}return this.apiClient.callApi('/api/v2/casemanagement/caseplans/{caseplanId}/stageplans/{stageplanId}/stepplans/{stepplanId}','PATCH',{'caseplanId':caseplanId,'stageplanId':stageplanId,'stepplanId':stepplanId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
5894
|
-
* Create a
|
|
5933
|
+
* Create a Case association.
|
|
5895
5934
|
*
|
|
5896
|
-
* @param {String} caseId Case
|
|
5935
|
+
* @param {String} caseId Case identifier.
|
|
5936
|
+
* @param {Object} body Case association create request.
|
|
5897
5937
|
* @param {Object} opts Optional parameters
|
|
5898
|
-
* @param {Object} opts.body Case Association
|
|
5899
5938
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
5900
|
-
|
|
5901
|
-
|
|
5902
|
-
if(
|
|
5939
|
+
*/},{key:"postCasemanagementCaseAssociations",value:function postCasemanagementCaseAssociations(caseId,body,opts){opts=opts||{};// verify the required parameter 'caseId' is set
|
|
5940
|
+
if(caseId===undefined||caseId===null||caseId===''){throw'Missing the required parameter "caseId" when calling postCasemanagementCaseAssociations';}// verify the required parameter 'body' is set
|
|
5941
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postCasemanagementCaseAssociations';}return this.apiClient.callApi('/api/v2/casemanagement/cases/{caseId}/associations','POST',{'caseId':caseId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
5903
5942
|
* Create a Terminate Job for a Case.
|
|
5904
5943
|
*
|
|
5905
|
-
* @param {String} caseId Case
|
|
5944
|
+
* @param {String} caseId Case identifier.
|
|
5906
5945
|
* @param {Object} opts Optional parameters
|
|
5907
5946
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
5908
|
-
* postCasemanagementCaseTerminateJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
5909
5947
|
*/},{key:"postCasemanagementCaseTerminateJobs",value:function postCasemanagementCaseTerminateJobs(caseId,opts){opts=opts||{};// verify the required parameter 'caseId' is set
|
|
5910
5948
|
if(caseId===undefined||caseId===null||caseId===''){throw'Missing the required parameter "caseId" when calling postCasemanagementCaseTerminateJobs';}return this.apiClient.callApi('/api/v2/casemanagement/cases/{caseId}/terminate/jobs','POST',{'caseId':caseId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
5949
|
+
* Add a data schema to a draft Caseplan.
|
|
5950
|
+
*
|
|
5951
|
+
* @param {String} caseplanId Caseplan identifier.
|
|
5952
|
+
* @param {Object} body Data schema reference.
|
|
5953
|
+
* @param {Object} opts Optional parameters
|
|
5954
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
5955
|
+
*/},{key:"postCasemanagementCaseplanDataschemas",value:function postCasemanagementCaseplanDataschemas(caseplanId,body,opts){opts=opts||{};// verify the required parameter 'caseplanId' is set
|
|
5956
|
+
if(caseplanId===undefined||caseplanId===null||caseplanId===''){throw'Missing the required parameter "caseplanId" when calling postCasemanagementCaseplanDataschemas';}// verify the required parameter 'body' is set
|
|
5957
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postCasemanagementCaseplanDataschemas';}return this.apiClient.callApi('/api/v2/casemanagement/caseplans/{caseplanId}/dataschemas','POST',{'caseplanId':caseplanId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
5911
5958
|
* Publish Caseplan.
|
|
5912
5959
|
*
|
|
5913
|
-
* @param {String} caseplanId Caseplan
|
|
5960
|
+
* @param {String} caseplanId Caseplan identifier.
|
|
5914
5961
|
* @param {Object} opts Optional parameters
|
|
5915
5962
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
5916
|
-
* postCasemanagementCaseplanPublish is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
5917
5963
|
*/},{key:"postCasemanagementCaseplanPublish",value:function postCasemanagementCaseplanPublish(caseplanId,opts){opts=opts||{};// verify the required parameter 'caseplanId' is set
|
|
5918
5964
|
if(caseplanId===undefined||caseplanId===null||caseplanId===''){throw'Missing the required parameter "caseplanId" when calling postCasemanagementCaseplanPublish';}return this.apiClient.callApi('/api/v2/casemanagement/caseplans/{caseplanId}/publish','POST',{'caseplanId':caseplanId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
5919
5965
|
* Create Caseplan version.
|
|
5920
5966
|
*
|
|
5921
|
-
* @param {String} caseplanId Caseplan
|
|
5967
|
+
* @param {String} caseplanId Caseplan identifier.
|
|
5922
5968
|
* @param {Object} opts Optional parameters
|
|
5923
5969
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
5924
|
-
* postCasemanagementCaseplanVersions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
5925
5970
|
*/},{key:"postCasemanagementCaseplanVersions",value:function postCasemanagementCaseplanVersions(caseplanId,opts){opts=opts||{};// verify the required parameter 'caseplanId' is set
|
|
5926
5971
|
if(caseplanId===undefined||caseplanId===null||caseplanId===''){throw'Missing the required parameter "caseplanId" when calling postCasemanagementCaseplanVersions';}return this.apiClient.callApi('/api/v2/casemanagement/caseplans/{caseplanId}/versions','POST',{'caseplanId':caseplanId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
5927
5972
|
* Create a Caseplan.
|
|
5928
5973
|
*
|
|
5929
|
-
* @param {Object} body Caseplan
|
|
5974
|
+
* @param {Object} body Caseplan create request.
|
|
5930
5975
|
* @param {Object} opts Optional parameters
|
|
5931
5976
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
5932
|
-
* postCasemanagementCaseplans is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
5933
5977
|
*/},{key:"postCasemanagementCaseplans",value:function postCasemanagementCaseplans(body,opts){opts=opts||{};// verify the required parameter 'body' is set
|
|
5934
5978
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postCasemanagementCaseplans';}return this.apiClient.callApi('/api/v2/casemanagement/caseplans','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
5935
|
-
* Query for
|
|
5979
|
+
* Query for Caseplans.
|
|
5936
5980
|
*
|
|
5937
|
-
* @param {Object} body
|
|
5981
|
+
* @param {Object} body Caseplan query request.
|
|
5938
5982
|
* @param {Object} opts Optional parameters
|
|
5939
5983
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
5940
|
-
* postCasemanagementCaseplansQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
5941
5984
|
*/},{key:"postCasemanagementCaseplansQuery",value:function postCasemanagementCaseplansQuery(body,opts){opts=opts||{};// verify the required parameter 'body' is set
|
|
5942
5985
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postCasemanagementCaseplansQuery';}return this.apiClient.callApi('/api/v2/casemanagement/caseplans/query','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
5943
5986
|
* Create a Case.
|
|
5944
5987
|
*
|
|
5945
|
-
* @param {Object} body Case
|
|
5988
|
+
* @param {Object} body Case create request.
|
|
5946
5989
|
* @param {Object} opts Optional parameters
|
|
5947
5990
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
5948
|
-
* postCasemanagementCases is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
5949
5991
|
*/},{key:"postCasemanagementCases",value:function postCasemanagementCases(body,opts){opts=opts||{};// verify the required parameter 'body' is set
|
|
5950
5992
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postCasemanagementCases';}return this.apiClient.callApi('/api/v2/casemanagement/cases','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
5951
|
-
* Query for
|
|
5993
|
+
* Query for Case associations by interaction.
|
|
5994
|
+
*
|
|
5995
|
+
* @param {Object} body Case association query request.
|
|
5996
|
+
* @param {Object} opts Optional parameters
|
|
5997
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
5998
|
+
*/},{key:"postCasemanagementCasesAssociationsQuery",value:function postCasemanagementCasesAssociationsQuery(body,opts){opts=opts||{};// verify the required parameter 'body' is set
|
|
5999
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postCasemanagementCasesAssociationsQuery';}return this.apiClient.callApi('/api/v2/casemanagement/cases/associations/query','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
6000
|
+
* Update a data schema on a draft Caseplan.
|
|
5952
6001
|
*
|
|
6002
|
+
* @param {String} caseplanId Caseplan identifier.
|
|
6003
|
+
* @param {String} schemaKeyName Schema key (for example default).
|
|
6004
|
+
* @param {Object} body Data schema reference.
|
|
5953
6005
|
* @param {Object} opts Optional parameters
|
|
5954
|
-
* @param {Object} opts.body Case Association
|
|
5955
6006
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
5956
|
-
|
|
5957
|
-
|
|
6007
|
+
*/},{key:"putCasemanagementCaseplanDataschema",value:function putCasemanagementCaseplanDataschema(caseplanId,schemaKeyName,body,opts){opts=opts||{};// verify the required parameter 'caseplanId' is set
|
|
6008
|
+
if(caseplanId===undefined||caseplanId===null||caseplanId===''){throw'Missing the required parameter "caseplanId" when calling putCasemanagementCaseplanDataschema';}// verify the required parameter 'schemaKeyName' is set
|
|
6009
|
+
if(schemaKeyName===undefined||schemaKeyName===null||schemaKeyName===''){throw'Missing the required parameter "schemaKeyName" when calling putCasemanagementCaseplanDataschema';}// verify the required parameter 'body' is set
|
|
6010
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putCasemanagementCaseplanDataschema';}return this.apiClient.callApi('/api/v2/casemanagement/caseplans/{caseplanId}/dataschemas/{schemaKeyName}','PUT',{'caseplanId':caseplanId,'schemaKeyName':schemaKeyName},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
5958
6011
|
* Update the intake settings for a Caseplan.
|
|
5959
6012
|
*
|
|
5960
|
-
* @param {String} caseplanId Caseplan
|
|
5961
|
-
* @param {Object} body Intake
|
|
6013
|
+
* @param {String} caseplanId Caseplan identifier.
|
|
6014
|
+
* @param {Object} body Intake settings update.
|
|
5962
6015
|
* @param {Object} opts Optional parameters
|
|
5963
6016
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
5964
|
-
* putCasemanagementCaseplanIntakesettings is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
5965
6017
|
*/},{key:"putCasemanagementCaseplanIntakesettings",value:function putCasemanagementCaseplanIntakesettings(caseplanId,body,opts){opts=opts||{};// verify the required parameter 'caseplanId' is set
|
|
5966
6018
|
if(caseplanId===undefined||caseplanId===null||caseplanId===''){throw'Missing the required parameter "caseplanId" when calling putCasemanagementCaseplanIntakesettings';}// verify the required parameter 'body' is set
|
|
5967
6019
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putCasemanagementCaseplanIntakesettings';}return this.apiClient.callApi('/api/v2/casemanagement/caseplans/{caseplanId}/intakesettings','PUT',{'caseplanId':caseplanId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}}]);}();var ChatApi=/*#__PURE__*/function(){/**
|
|
5968
6020
|
* Chat service.
|
|
5969
6021
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
5970
|
-
* @version
|
|
6022
|
+
* @version 254.0.0
|
|
5971
6023
|
*//**
|
|
5972
6024
|
* Constructs a new ChatApi.
|
|
5973
6025
|
* @alias module:purecloud-platform-client-v2/api/ChatApi
|
|
@@ -6262,7 +6314,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
6262
6314
|
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'],opts['customHeaders']);}}]);}();var CoachingApi=/*#__PURE__*/function(){/**
|
|
6263
6315
|
* Coaching service.
|
|
6264
6316
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
6265
|
-
* @version
|
|
6317
|
+
* @version 254.0.0
|
|
6266
6318
|
*//**
|
|
6267
6319
|
* Constructs a new CoachingApi.
|
|
6268
6320
|
* @alias module:purecloud-platform-client-v2/api/CoachingApi
|
|
@@ -6461,7 +6513,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
6461
6513
|
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'],opts['customHeaders']);}}]);}();var ContentManagementApi=/*#__PURE__*/function(){/**
|
|
6462
6514
|
* ContentManagement service.
|
|
6463
6515
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
6464
|
-
* @version
|
|
6516
|
+
* @version 254.0.0
|
|
6465
6517
|
*//**
|
|
6466
6518
|
* Constructs a new ContentManagementApi.
|
|
6467
6519
|
* @alias module:purecloud-platform-client-v2/api/ContentManagementApi
|
|
@@ -6793,7 +6845,7 @@ if(tagId===undefined||tagId===null||tagId===''){throw'Missing the required param
|
|
|
6793
6845
|
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'],opts['customHeaders']);}}]);}();var ConversationsApi=/*#__PURE__*/function(){/**
|
|
6794
6846
|
* Conversations service.
|
|
6795
6847
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
6796
|
-
* @version
|
|
6848
|
+
* @version 254.0.0
|
|
6797
6849
|
*//**
|
|
6798
6850
|
* Constructs a new ConversationsApi.
|
|
6799
6851
|
* @alias module:purecloud-platform-client-v2/api/ConversationsApi
|
|
@@ -6806,7 +6858,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
6806
6858
|
* @param {String} jobId jobId
|
|
6807
6859
|
* @param {Object} opts Optional parameters
|
|
6808
6860
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
6809
|
-
* deleteAnalyticsConversationsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
6810
6861
|
*/return _createClass(ConversationsApi,[{key:"deleteAnalyticsConversationsAggregatesJob",value:function deleteAnalyticsConversationsAggregatesJob(jobId,opts){opts=opts||{};// verify the required parameter 'jobId' is set
|
|
6811
6862
|
if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required parameter "jobId" when calling deleteAnalyticsConversationsAggregatesJob';}return this.apiClient.callApi('/api/v2/analytics/conversations/aggregates/jobs/{jobId}','DELETE',{'jobId':jobId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
6812
6863
|
* Delete/cancel an async details job
|
|
@@ -6969,7 +7020,6 @@ if(conversationId===undefined||conversationId===null||conversationId===''){throw
|
|
|
6969
7020
|
* @param {String} jobId jobId
|
|
6970
7021
|
* @param {Object} opts Optional parameters
|
|
6971
7022
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
6972
|
-
* getAnalyticsConversationsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
6973
7023
|
*/},{key:"getAnalyticsConversationsAggregatesJob",value:function getAnalyticsConversationsAggregatesJob(jobId,opts){opts=opts||{};// verify the required parameter 'jobId' is set
|
|
6974
7024
|
if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required parameter "jobId" when calling getAnalyticsConversationsAggregatesJob';}return this.apiClient.callApi('/api/v2/analytics/conversations/aggregates/jobs/{jobId}','GET',{'jobId':jobId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
6975
7025
|
* Fetch a page of results for an async aggregates query
|
|
@@ -6978,7 +7028,6 @@ if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required param
|
|
|
6978
7028
|
* @param {Object} opts Optional parameters
|
|
6979
7029
|
* @param {String} opts.cursor Cursor token to retrieve next page
|
|
6980
7030
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
6981
|
-
* getAnalyticsConversationsAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
6982
7031
|
*/},{key:"getAnalyticsConversationsAggregatesJobResults",value:function getAnalyticsConversationsAggregatesJobResults(jobId,opts){opts=opts||{};// verify the required parameter 'jobId' is set
|
|
6983
7032
|
if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required parameter "jobId" when calling getAnalyticsConversationsAggregatesJobResults';}return this.apiClient.callApi('/api/v2/analytics/conversations/aggregates/jobs/{jobId}/results','GET',{'jobId':jobId},{'cursor':opts['cursor']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
6984
7033
|
* Gets multiple conversations by id
|
|
@@ -8526,7 +8575,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
8526
8575
|
* @param {Object} body query
|
|
8527
8576
|
* @param {Object} opts Optional parameters
|
|
8528
8577
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
8529
|
-
* postAnalyticsConversationsAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
8530
8578
|
*/},{key:"postAnalyticsConversationsAggregatesJobs",value:function postAnalyticsConversationsAggregatesJobs(body,opts){opts=opts||{};// verify the required parameter 'body' is set
|
|
8531
8579
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postAnalyticsConversationsAggregatesJobs';}return this.apiClient.callApi('/api/v2/analytics/conversations/aggregates/jobs','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
8532
8580
|
* Query for conversation aggregates
|
|
@@ -9325,7 +9373,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
9325
9373
|
*/},{key:"postConversationsMessages",value:function postConversationsMessages(body,opts){opts=opts||{};// verify the required parameter 'body' is set
|
|
9326
9374
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postConversationsMessages';}return this.apiClient.callApi('/api/v2/conversations/messages','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
9327
9375
|
* Send an agentless outbound message
|
|
9328
|
-
* Send an agentless (api participant) outbound message using a client credential grant. In order to call this endpoint you will need OAuth token generated using OAuth client credentials authorized with at least messaging scope. If there is already a connected conversation between the fromAddress and
|
|
9376
|
+
* Send an agentless (api participant) outbound message using a client credential grant. In order to call this endpoint you will need OAuth token generated using OAuth client credentials authorized with at least messaging scope. If there is already a connected conversation between the fromAddress and recipient specified, the useExistingActiveConversation param can be used to barge in to the ongoing conversation.
|
|
9329
9377
|
* @param {Object} body Create agentless outbound messaging request
|
|
9330
9378
|
* @param {Object} opts Optional parameters
|
|
9331
9379
|
* @param {Boolean} opts.useNormalizedMessage If true, response removes deprecated fields (textBody, messagingTemplate) (default to false)
|
|
@@ -9725,7 +9773,7 @@ if(conversationId===undefined||conversationId===null||conversationId===''){throw
|
|
|
9725
9773
|
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'],opts['customHeaders']);}}]);}();var DataExtensionsApi=/*#__PURE__*/function(){/**
|
|
9726
9774
|
* DataExtensions service.
|
|
9727
9775
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
9728
|
-
* @version
|
|
9776
|
+
* @version 254.0.0
|
|
9729
9777
|
*//**
|
|
9730
9778
|
* Constructs a new DataExtensionsApi.
|
|
9731
9779
|
* @alias module:purecloud-platform-client-v2/api/DataExtensionsApi
|
|
@@ -9752,7 +9800,7 @@ if(coretypeName===undefined||coretypeName===null||coretypeName===''){throw'Missi
|
|
|
9752
9800
|
*/},{key:"getDataextensionsLimits",value:function getDataextensionsLimits(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/dataextensions/limits','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}}]);}();var DataPrivacyApi=/*#__PURE__*/function(){/**
|
|
9753
9801
|
* DataPrivacy service.
|
|
9754
9802
|
* @module purecloud-platform-client-v2/api/DataPrivacyApi
|
|
9755
|
-
* @version
|
|
9803
|
+
* @version 254.0.0
|
|
9756
9804
|
*//**
|
|
9757
9805
|
* Constructs a new DataPrivacyApi.
|
|
9758
9806
|
* @alias module:purecloud-platform-client-v2/api/DataPrivacyApi
|
|
@@ -9803,7 +9851,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
9803
9851
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postDataprivacyMaskingrulesValidate';}return this.apiClient.callApi('/api/v2/dataprivacy/maskingrules/validate','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}}]);}();var DownloadsApi=/*#__PURE__*/function(){/**
|
|
9804
9852
|
* Downloads service.
|
|
9805
9853
|
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
9806
|
-
* @version
|
|
9854
|
+
* @version 254.0.0
|
|
9807
9855
|
*//**
|
|
9808
9856
|
* Constructs a new DownloadsApi.
|
|
9809
9857
|
* @alias module:purecloud-platform-client-v2/api/DownloadsApi
|
|
@@ -9823,7 +9871,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
9823
9871
|
if(downloadId===undefined||downloadId===null||downloadId===''){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'],opts['customHeaders']);}}]);}();var EmailsApi=/*#__PURE__*/function(){/**
|
|
9824
9872
|
* Emails service.
|
|
9825
9873
|
* @module purecloud-platform-client-v2/api/EmailsApi
|
|
9826
|
-
* @version
|
|
9874
|
+
* @version 254.0.0
|
|
9827
9875
|
*//**
|
|
9828
9876
|
* Constructs a new EmailsApi.
|
|
9829
9877
|
* @alias module:purecloud-platform-client-v2/api/EmailsApi
|
|
@@ -9860,7 +9908,7 @@ if(downloadId===undefined||downloadId===null||downloadId===''){throw'Missing the
|
|
|
9860
9908
|
*/},{key:"patchEmailsSettingsThreading",value:function patchEmailsSettingsThreading(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/emails/settings/threading','PATCH',{},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}}]);}();var EmployeeEngagementApi=/*#__PURE__*/function(){/**
|
|
9861
9909
|
* EmployeeEngagement service.
|
|
9862
9910
|
* @module purecloud-platform-client-v2/api/EmployeeEngagementApi
|
|
9863
|
-
* @version
|
|
9911
|
+
* @version 254.0.0
|
|
9864
9912
|
*//**
|
|
9865
9913
|
* Constructs a new EmployeeEngagementApi.
|
|
9866
9914
|
* @alias module:purecloud-platform-client-v2/api/EmployeeEngagementApi
|
|
@@ -9918,7 +9966,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
9918
9966
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postEmployeeengagementRecognitions';}return this.apiClient.callApi('/api/v2/employeeengagement/recognitions','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}}]);}();var EventsApi=/*#__PURE__*/function(){/**
|
|
9919
9967
|
* Events service.
|
|
9920
9968
|
* @module purecloud-platform-client-v2/api/EventsApi
|
|
9921
|
-
* @version
|
|
9969
|
+
* @version 254.0.0
|
|
9922
9970
|
*//**
|
|
9923
9971
|
* Constructs a new EventsApi.
|
|
9924
9972
|
* @alias module:purecloud-platform-client-v2/api/EventsApi
|
|
@@ -9957,7 +10005,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
9957
10005
|
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'],opts['customHeaders']);}}]);}();var ExternalContactsApi=/*#__PURE__*/function(){/**
|
|
9958
10006
|
* ExternalContacts service.
|
|
9959
10007
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
9960
|
-
* @version
|
|
10008
|
+
* @version 254.0.0
|
|
9961
10009
|
*//**
|
|
9962
10010
|
* Constructs a new ExternalContactsApi.
|
|
9963
10011
|
* @alias module:purecloud-platform-client-v2/api/ExternalContactsApi
|
|
@@ -10919,7 +10967,7 @@ if(relationshipId===undefined||relationshipId===null||relationshipId===''){throw
|
|
|
10919
10967
|
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'],opts['customHeaders']);}}]);}();var FaxApi=/*#__PURE__*/function(){/**
|
|
10920
10968
|
* Fax service.
|
|
10921
10969
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
10922
|
-
* @version
|
|
10970
|
+
* @version 254.0.0
|
|
10923
10971
|
*//**
|
|
10924
10972
|
* Constructs a new FaxApi.
|
|
10925
10973
|
* @alias module:purecloud-platform-client-v2/api/FaxApi
|
|
@@ -10982,7 +11030,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
10982
11030
|
*/},{key:"putFaxSettings",value:function putFaxSettings(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/fax/settings','PUT',{},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}}]);}();var FlowsApi=/*#__PURE__*/function(){/**
|
|
10983
11031
|
* Flows service.
|
|
10984
11032
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
10985
|
-
* @version
|
|
11033
|
+
* @version 254.0.0
|
|
10986
11034
|
*//**
|
|
10987
11035
|
* Constructs a new FlowsApi.
|
|
10988
11036
|
* @alias module:purecloud-platform-client-v2/api/FlowsApi
|
|
@@ -10995,7 +11043,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
10995
11043
|
* @param {String} jobId jobId
|
|
10996
11044
|
* @param {Object} opts Optional parameters
|
|
10997
11045
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
10998
|
-
* deleteAnalyticsFlowsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
10999
11046
|
*/return _createClass(FlowsApi,[{key:"deleteAnalyticsFlowsAggregatesJob",value:function deleteAnalyticsFlowsAggregatesJob(jobId,opts){opts=opts||{};// verify the required parameter 'jobId' is set
|
|
11000
11047
|
if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required parameter "jobId" when calling deleteAnalyticsFlowsAggregatesJob';}return this.apiClient.callApi('/api/v2/analytics/flows/aggregates/jobs/{jobId}','DELETE',{'jobId':jobId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
11001
11048
|
* Get status for async query for Flow aggregates
|
|
@@ -11003,7 +11050,6 @@ if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required param
|
|
|
11003
11050
|
* @param {String} jobId jobId
|
|
11004
11051
|
* @param {Object} opts Optional parameters
|
|
11005
11052
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
11006
|
-
* getAnalyticsFlowsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
11007
11053
|
*/},{key:"getAnalyticsFlowsAggregatesJob",value:function getAnalyticsFlowsAggregatesJob(jobId,opts){opts=opts||{};// verify the required parameter 'jobId' is set
|
|
11008
11054
|
if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required parameter "jobId" when calling getAnalyticsFlowsAggregatesJob';}return this.apiClient.callApi('/api/v2/analytics/flows/aggregates/jobs/{jobId}','GET',{'jobId':jobId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
11009
11055
|
* Fetch a page of results for an async aggregates query
|
|
@@ -11012,7 +11058,6 @@ if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required param
|
|
|
11012
11058
|
* @param {Object} opts Optional parameters
|
|
11013
11059
|
* @param {String} opts.cursor Cursor token to retrieve next page
|
|
11014
11060
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
11015
|
-
* getAnalyticsFlowsAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
11016
11061
|
*/},{key:"getAnalyticsFlowsAggregatesJobResults",value:function getAnalyticsFlowsAggregatesJobResults(jobId,opts){opts=opts||{};// verify the required parameter 'jobId' is set
|
|
11017
11062
|
if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required parameter "jobId" when calling getAnalyticsFlowsAggregatesJobResults';}return this.apiClient.callApi('/api/v2/analytics/flows/aggregates/jobs/{jobId}/results','GET',{'jobId':jobId},{'cursor':opts['cursor']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
11018
11063
|
* Query for flow activity observations
|
|
@@ -11029,7 +11074,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
11029
11074
|
* @param {Object} body query
|
|
11030
11075
|
* @param {Object} opts Optional parameters
|
|
11031
11076
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
11032
|
-
* postAnalyticsFlowsAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
11033
11077
|
*/},{key:"postAnalyticsFlowsAggregatesJobs",value:function postAnalyticsFlowsAggregatesJobs(body,opts){opts=opts||{};// verify the required parameter 'body' is set
|
|
11034
11078
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postAnalyticsFlowsAggregatesJobs';}return this.apiClient.callApi('/api/v2/analytics/flows/aggregates/jobs','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
11035
11079
|
* Query for flow aggregates
|
|
@@ -11048,7 +11092,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
11048
11092
|
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'],opts['customHeaders']);}}]);}();var GamificationApi=/*#__PURE__*/function(){/**
|
|
11049
11093
|
* Gamification service.
|
|
11050
11094
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
11051
|
-
* @version
|
|
11095
|
+
* @version 254.0.0
|
|
11052
11096
|
*//**
|
|
11053
11097
|
* Constructs a new GamificationApi.
|
|
11054
11098
|
* @alias module:purecloud-platform-client-v2/api/GamificationApi
|
|
@@ -11843,7 +11887,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
11843
11887
|
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'],opts['customHeaders']);}}]);}();var GeneralDataProtectionRegulationApi=/*#__PURE__*/function(){/**
|
|
11844
11888
|
* GeneralDataProtectionRegulation service.
|
|
11845
11889
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
11846
|
-
* @version
|
|
11890
|
+
* @version 254.0.0
|
|
11847
11891
|
*//**
|
|
11848
11892
|
* Constructs a new GeneralDataProtectionRegulationApi.
|
|
11849
11893
|
* @alias module:purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
@@ -11884,7 +11928,7 @@ if(searchValue===undefined||searchValue===null){throw'Missing the required param
|
|
|
11884
11928
|
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'],opts['customHeaders']);}}]);}();var GeolocationApi=/*#__PURE__*/function(){/**
|
|
11885
11929
|
* Geolocation service.
|
|
11886
11930
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
11887
|
-
* @version
|
|
11931
|
+
* @version 254.0.0
|
|
11888
11932
|
*//**
|
|
11889
11933
|
* Constructs a new GeolocationApi.
|
|
11890
11934
|
* @alias module:purecloud-platform-client-v2/api/GeolocationApi
|
|
@@ -11926,7 +11970,7 @@ if(clientId===undefined||clientId===null||clientId===''){throw'Missing the requi
|
|
|
11926
11970
|
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'],opts['customHeaders']);}}]);}();var GreetingsApi=/*#__PURE__*/function(){/**
|
|
11927
11971
|
* Greetings service.
|
|
11928
11972
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
11929
|
-
* @version
|
|
11973
|
+
* @version 254.0.0
|
|
11930
11974
|
*//**
|
|
11931
11975
|
* Constructs a new GreetingsApi.
|
|
11932
11976
|
* @alias module:purecloud-platform-client-v2/api/GreetingsApi
|
|
@@ -12085,7 +12129,7 @@ if(userId===undefined||userId===null||userId===''){throw'Missing the required pa
|
|
|
12085
12129
|
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'],opts['customHeaders']);}}]);}();var GroupsApi=/*#__PURE__*/function(){/**
|
|
12086
12130
|
* Groups service.
|
|
12087
12131
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
12088
|
-
* @version
|
|
12132
|
+
* @version 254.0.0
|
|
12089
12133
|
*//**
|
|
12090
12134
|
* Constructs a new GroupsApi.
|
|
12091
12135
|
* @alias module:purecloud-platform-client-v2/api/GroupsApi
|
|
@@ -12248,7 +12292,7 @@ if(groupId===undefined||groupId===null||groupId===''){throw'Missing the required
|
|
|
12248
12292
|
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'],opts['customHeaders']);}}]);}();var IdentityProviderApi=/*#__PURE__*/function(){/**
|
|
12249
12293
|
* IdentityProvider service.
|
|
12250
12294
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
12251
|
-
* @version
|
|
12295
|
+
* @version 254.0.0
|
|
12252
12296
|
*//**
|
|
12253
12297
|
* Constructs a new IdentityProviderApi.
|
|
12254
12298
|
* @alias module:purecloud-platform-client-v2/api/IdentityProviderApi
|
|
@@ -12480,7 +12524,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
12480
12524
|
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'],opts['customHeaders']);}}]);}();var InfrastructureAsCodeApi=/*#__PURE__*/function(){/**
|
|
12481
12525
|
* InfrastructureAsCode service.
|
|
12482
12526
|
* @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
12483
|
-
* @version
|
|
12527
|
+
* @version 254.0.0
|
|
12484
12528
|
*//**
|
|
12485
12529
|
* Constructs a new InfrastructureAsCodeApi.
|
|
12486
12530
|
* @alias module:purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
@@ -12540,7 +12584,7 @@ if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required param
|
|
|
12540
12584
|
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'],opts['customHeaders']);}}]);}();var IntegrationsApi=/*#__PURE__*/function(){/**
|
|
12541
12585
|
* Integrations service.
|
|
12542
12586
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
12543
|
-
* @version
|
|
12587
|
+
* @version 254.0.0
|
|
12544
12588
|
*//**
|
|
12545
12589
|
* Constructs a new IntegrationsApi.
|
|
12546
12590
|
* @alias module:purecloud-platform-client-v2/api/IntegrationsApi
|
|
@@ -13370,7 +13414,7 @@ if(ucIntegrationId===undefined||ucIntegrationId===null||ucIntegrationId===''){th
|
|
|
13370
13414
|
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'],opts['customHeaders']);}}]);}();var IntentsApi=/*#__PURE__*/function(){/**
|
|
13371
13415
|
* Intents service.
|
|
13372
13416
|
* @module purecloud-platform-client-v2/api/IntentsApi
|
|
13373
|
-
* @version
|
|
13417
|
+
* @version 254.0.0
|
|
13374
13418
|
*//**
|
|
13375
13419
|
* Constructs a new IntentsApi.
|
|
13376
13420
|
* @alias module:purecloud-platform-client-v2/api/IntentsApi
|
|
@@ -13514,7 +13558,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
13514
13558
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postIntentsCustomerintents';}return this.apiClient.callApi('/api/v2/intents/customerintents','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}}]);}();var JourneyApi=/*#__PURE__*/function(){/**
|
|
13515
13559
|
* Journey service.
|
|
13516
13560
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
13517
|
-
* @version
|
|
13561
|
+
* @version 254.0.0
|
|
13518
13562
|
*//**
|
|
13519
13563
|
* Constructs a new JourneyApi.
|
|
13520
13564
|
* @alias module:purecloud-platform-client-v2/api/JourneyApi
|
|
@@ -13527,7 +13571,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
13527
13571
|
* @param {String} jobId jobId
|
|
13528
13572
|
* @param {Object} opts Optional parameters
|
|
13529
13573
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
13530
|
-
* deleteAnalyticsJourneysAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
13531
13574
|
*/return _createClass(JourneyApi,[{key:"deleteAnalyticsJourneysAggregatesJob",value:function deleteAnalyticsJourneysAggregatesJob(jobId,opts){opts=opts||{};// verify the required parameter 'jobId' is set
|
|
13532
13575
|
if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required parameter "jobId" when calling deleteAnalyticsJourneysAggregatesJob';}return this.apiClient.callApi('/api/v2/analytics/journeys/aggregates/jobs/{jobId}','DELETE',{'jobId':jobId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
13533
13576
|
* Delete single action map.
|
|
@@ -13601,7 +13644,6 @@ if(viewId===undefined||viewId===null||viewId===''){throw'Missing the required pa
|
|
|
13601
13644
|
* @param {String} jobId jobId
|
|
13602
13645
|
* @param {Object} opts Optional parameters
|
|
13603
13646
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
13604
|
-
* getAnalyticsJourneysAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
13605
13647
|
*/},{key:"getAnalyticsJourneysAggregatesJob",value:function getAnalyticsJourneysAggregatesJob(jobId,opts){opts=opts||{};// verify the required parameter 'jobId' is set
|
|
13606
13648
|
if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required parameter "jobId" when calling getAnalyticsJourneysAggregatesJob';}return this.apiClient.callApi('/api/v2/analytics/journeys/aggregates/jobs/{jobId}','GET',{'jobId':jobId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
13607
13649
|
* Fetch a page of results for an async aggregates query
|
|
@@ -13610,7 +13652,6 @@ if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required param
|
|
|
13610
13652
|
* @param {Object} opts Optional parameters
|
|
13611
13653
|
* @param {String} opts.cursor Cursor token to retrieve next page
|
|
13612
13654
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
13613
|
-
* getAnalyticsJourneysAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
13614
13655
|
*/},{key:"getAnalyticsJourneysAggregatesJobResults",value:function getAnalyticsJourneysAggregatesJobResults(jobId,opts){opts=opts||{};// verify the required parameter 'jobId' is set
|
|
13615
13656
|
if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required parameter "jobId" when calling getAnalyticsJourneysAggregatesJobResults';}return this.apiClient.callApi('/api/v2/analytics/journeys/aggregates/jobs/{jobId}/results','GET',{'jobId':jobId},{'cursor':opts['cursor']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
13616
13657
|
* Retrieve segment assignments by external contact ID.
|
|
@@ -13668,19 +13709,21 @@ if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required param
|
|
|
13668
13709
|
* @deprecated
|
|
13669
13710
|
*/},{key:"getJourneyActionmapsEstimatesJobResults",value:function getJourneyActionmapsEstimatesJobResults(jobId,opts){opts=opts||{};// verify the required parameter 'jobId' is set
|
|
13670
13711
|
if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required parameter "jobId" when calling getJourneyActionmapsEstimatesJobResults';}return this.apiClient.callApi('/api/v2/journey/actionmaps/estimates/jobs/{jobId}/results','GET',{'jobId':jobId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
13671
|
-
* Retrieve a single action target.
|
|
13672
|
-
*
|
|
13712
|
+
* Deprecated. Retrieve a single action target.
|
|
13713
|
+
* ACD Chat v2.0 in Genesys Predictive Engagement is deprecated and being removed. See https://community.genesys.com/discussion/deprecation-acd-chat-v20-support-in-genesys-predictive-engagement
|
|
13673
13714
|
* @param {String} actionTargetId ID of the action target.
|
|
13674
13715
|
* @param {Object} opts Optional parameters
|
|
13675
13716
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
13717
|
+
* @deprecated
|
|
13676
13718
|
*/},{key:"getJourneyActiontarget",value:function getJourneyActiontarget(actionTargetId,opts){opts=opts||{};// verify the required parameter 'actionTargetId' is set
|
|
13677
13719
|
if(actionTargetId===undefined||actionTargetId===null||actionTargetId===''){throw'Missing the required parameter "actionTargetId" when calling getJourneyActiontarget';}return this.apiClient.callApi('/api/v2/journey/actiontargets/{actionTargetId}','GET',{'actionTargetId':actionTargetId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
13678
|
-
* Retrieve all action targets.
|
|
13679
|
-
*
|
|
13720
|
+
* Deprecated. Retrieve all action targets.
|
|
13721
|
+
* ACD Chat v2.0 in Genesys Predictive Engagement is deprecated and being removed. See https://community.genesys.com/discussion/deprecation-acd-chat-v20-support-in-genesys-predictive-engagement
|
|
13680
13722
|
* @param {Object} opts Optional parameters
|
|
13681
13723
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
13682
13724
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
13683
13725
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
13726
|
+
* @deprecated
|
|
13684
13727
|
*/},{key:"getJourneyActiontargets",value:function getJourneyActiontargets(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/journey/actiontargets','GET',{},{'pageNumber':opts['pageNumber'],'pageSize':opts['pageSize']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
13685
13728
|
* Retrieve a single action template.
|
|
13686
13729
|
*
|
|
@@ -13988,6 +14031,16 @@ if(eventDefinitionId===undefined||eventDefinitionId===null||eventDefinitionId===
|
|
|
13988
14031
|
* @param {Object} opts Optional parameters
|
|
13989
14032
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
13990
14033
|
*/},{key:"getJourneyViewsEventdefinitions",value:function getJourneyViewsEventdefinitions(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/journey/views/eventdefinitions','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
14034
|
+
* Get external events for journey views
|
|
14035
|
+
*
|
|
14036
|
+
* @param {Object} opts Optional parameters
|
|
14037
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
14038
|
+
*/},{key:"getJourneyViewsEventdefinitionsExternal",value:function getJourneyViewsEventdefinitionsExternal(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/journey/views/eventdefinitions/external','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
14039
|
+
* Get changes in external event definitions
|
|
14040
|
+
*
|
|
14041
|
+
* @param {Object} opts Optional parameters
|
|
14042
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
14043
|
+
*/},{key:"getJourneyViewsEventdefinitionsExternalChanges",value:function getJourneyViewsEventdefinitionsExternalChanges(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/journey/views/eventdefinitions/external/changes','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
13991
14044
|
* Get the jobs for an organization.
|
|
13992
14045
|
*
|
|
13993
14046
|
* @param {Object} opts Optional parameters
|
|
@@ -14021,12 +14074,13 @@ if(eventDefinitionId===undefined||eventDefinitionId===null||eventDefinitionId===
|
|
|
14021
14074
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
14022
14075
|
*/},{key:"patchJourneyActionmap",value:function patchJourneyActionmap(actionMapId,opts){opts=opts||{};// verify the required parameter 'actionMapId' is set
|
|
14023
14076
|
if(actionMapId===undefined||actionMapId===null||actionMapId===''){throw'Missing the required parameter "actionMapId" when calling patchJourneyActionmap';}return this.apiClient.callApi('/api/v2/journey/actionmaps/{actionMapId}','PATCH',{'actionMapId':actionMapId},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
14024
|
-
* Update a single action target.
|
|
14025
|
-
*
|
|
14077
|
+
* Deprecated. Update a single action target.
|
|
14078
|
+
* ACD Chat v2.0 in Genesys Predictive Engagement is deprecated and being removed. See https://community.genesys.com/discussion/deprecation-acd-chat-v20-support-in-genesys-predictive-engagement
|
|
14026
14079
|
* @param {String} actionTargetId ID of the action target.
|
|
14027
14080
|
* @param {Object} opts Optional parameters
|
|
14028
14081
|
* @param {Object} opts.body
|
|
14029
14082
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
14083
|
+
* @deprecated
|
|
14030
14084
|
*/},{key:"patchJourneyActiontarget",value:function patchJourneyActiontarget(actionTargetId,opts){opts=opts||{};// verify the required parameter 'actionTargetId' is set
|
|
14031
14085
|
if(actionTargetId===undefined||actionTargetId===null||actionTargetId===''){throw'Missing the required parameter "actionTargetId" when calling patchJourneyActiontarget';}return this.apiClient.callApi('/api/v2/journey/actiontargets/{actionTargetId}','PATCH',{'actionTargetId':actionTargetId},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
14032
14086
|
* Update a single action template.
|
|
@@ -14080,7 +14134,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
14080
14134
|
* @param {Object} body query
|
|
14081
14135
|
* @param {Object} opts Optional parameters
|
|
14082
14136
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
14083
|
-
* postAnalyticsJourneysAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
14084
14137
|
*/},{key:"postAnalyticsJourneysAggregatesJobs",value:function postAnalyticsJourneysAggregatesJobs(body,opts){opts=opts||{};// verify the required parameter 'body' is set
|
|
14085
14138
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postAnalyticsJourneysAggregatesJobs';}return this.apiClient.callApi('/api/v2/analytics/journeys/aggregates/jobs','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
14086
14139
|
* Query for journey aggregates
|
|
@@ -14266,10 +14319,26 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
14266
14319
|
*/},{key:"putJourneyViewVersion",value:function putJourneyViewVersion(viewId,versionId,body,opts){opts=opts||{};// verify the required parameter 'viewId' is set
|
|
14267
14320
|
if(viewId===undefined||viewId===null||viewId===''){throw'Missing the required parameter "viewId" when calling putJourneyViewVersion';}// verify the required parameter 'versionId' is set
|
|
14268
14321
|
if(versionId===undefined||versionId===null||versionId===''){throw'Missing the required parameter "versionId" when calling putJourneyViewVersion';}// verify the required parameter 'body' is set
|
|
14269
|
-
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putJourneyViewVersion';}return this.apiClient.callApi('/api/v2/journey/views/{viewId}/versions/{versionId}','PUT',{'viewId':viewId,'versionId':versionId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}
|
|
14322
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putJourneyViewVersion';}return this.apiClient.callApi('/api/v2/journey/views/{viewId}/versions/{versionId}','PUT',{'viewId':viewId,'versionId':versionId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
14323
|
+
* Update external event for journey views
|
|
14324
|
+
*
|
|
14325
|
+
* @param {String} eventDefinitionId Event Definition ID
|
|
14326
|
+
* @param {Object} opts Optional parameters
|
|
14327
|
+
* @param {Object} opts.body
|
|
14328
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
14329
|
+
*/},{key:"putJourneyViewsEventdefinition",value:function putJourneyViewsEventdefinition(eventDefinitionId,opts){opts=opts||{};// verify the required parameter 'eventDefinitionId' is set
|
|
14330
|
+
if(eventDefinitionId===undefined||eventDefinitionId===null||eventDefinitionId===''){throw'Missing the required parameter "eventDefinitionId" when calling putJourneyViewsEventdefinition';}return this.apiClient.callApi('/api/v2/journey/views/eventdefinitions/{eventDefinitionId}','PUT',{'eventDefinitionId':eventDefinitionId},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
14331
|
+
* Activate external event for journey views
|
|
14332
|
+
*
|
|
14333
|
+
* @param {String} eventDefinitionId Event Definition ID
|
|
14334
|
+
* @param {Object} opts Optional parameters
|
|
14335
|
+
* @param {Object} opts.body
|
|
14336
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
14337
|
+
*/},{key:"putJourneyViewsEventdefinitionActivate",value:function putJourneyViewsEventdefinitionActivate(eventDefinitionId,opts){opts=opts||{};// verify the required parameter 'eventDefinitionId' is set
|
|
14338
|
+
if(eventDefinitionId===undefined||eventDefinitionId===null||eventDefinitionId===''){throw'Missing the required parameter "eventDefinitionId" when calling putJourneyViewsEventdefinitionActivate';}return this.apiClient.callApi('/api/v2/journey/views/eventdefinitions/{eventDefinitionId}/activate','PUT',{'eventDefinitionId':eventDefinitionId},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}}]);}();var KnowledgeApi=/*#__PURE__*/function(){/**
|
|
14270
14339
|
* Knowledge service.
|
|
14271
14340
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
14272
|
-
* @version
|
|
14341
|
+
* @version 254.0.0
|
|
14273
14342
|
*//**
|
|
14274
14343
|
* Constructs a new KnowledgeApi.
|
|
14275
14344
|
* @alias module:purecloud-platform-client-v2/api/KnowledgeApi
|
|
@@ -14624,6 +14693,24 @@ if(documentId===undefined||documentId===null||documentId===''){throw'Missing the
|
|
|
14624
14693
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
14625
14694
|
*/},{key:"getKnowledgeKnowledgebaseDocuments",value:function getKnowledgeKnowledgebaseDocuments(knowledgeBaseId,opts){opts=opts||{};// verify the required parameter 'knowledgeBaseId' is set
|
|
14626
14695
|
if(knowledgeBaseId===undefined||knowledgeBaseId===null||knowledgeBaseId===''){throw'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseDocuments';}return this.apiClient.callApi('/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents','GET',{'knowledgeBaseId':knowledgeBaseId},{'before':opts['before'],'after':opts['after'],'pageSize':opts['pageSize'],'interval':opts['interval'],'documentId':this.apiClient.buildCollectionParam(opts['documentId'],'multi'),'categoryId':this.apiClient.buildCollectionParam(opts['categoryId'],'multi'),'includeSubcategories':opts['includeSubcategories'],'includeDrafts':opts['includeDrafts'],'labelIds':this.apiClient.buildCollectionParam(opts['labelIds'],'multi'),'expand':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'externalIds':this.apiClient.buildCollectionParam(opts['externalIds'],'multi')},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
14696
|
+
* Get a list of feedback records given on documents in a knowledge base
|
|
14697
|
+
*
|
|
14698
|
+
* @param {String} knowledgeBaseId Knowledge base ID.
|
|
14699
|
+
* @param {Object} opts Optional parameters
|
|
14700
|
+
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
14701
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
14702
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
14703
|
+
* @param {Boolean} opts.onlyCommented If true, only feedback records that have comment are returned. If false, feedback records with and without comment are returned. Default: false.
|
|
14704
|
+
* @param {String} opts.documentVersionId Document version ID to filter by. Supported only if onlyCommented=true is set.
|
|
14705
|
+
* @param {String} opts.documentVariationId Document variation ID to filter by. Supported only if onlyCommented=true is set.
|
|
14706
|
+
* @param {Object} opts.appType Application type to filter by. Supported only if onlyCommented=true is set.
|
|
14707
|
+
* @param {Object} opts.queryType Query type to filter by. Supported only if onlyCommented=true is set.
|
|
14708
|
+
* @param {String} opts.userId The ID of the user, who created the feedback, to filter by. Supported only if onlyCommented=true is set.
|
|
14709
|
+
* @param {String} opts.queueId Queue ID to filter by. Supported only if onlyCommented=true is set.
|
|
14710
|
+
* @param {Object} opts.state State to filter by. Supported only if onlyCommented=true is set. Default: Final
|
|
14711
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
14712
|
+
*/},{key:"getKnowledgeKnowledgebaseDocumentsFeedback",value:function getKnowledgeKnowledgebaseDocumentsFeedback(knowledgeBaseId,opts){opts=opts||{};// verify the required parameter 'knowledgeBaseId' is set
|
|
14713
|
+
if(knowledgeBaseId===undefined||knowledgeBaseId===null||knowledgeBaseId===''){throw'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseDocumentsFeedback';}return this.apiClient.callApi('/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/feedback','GET',{'knowledgeBaseId':knowledgeBaseId},{'before':opts['before'],'after':opts['after'],'pageSize':opts['pageSize'],'onlyCommented':opts['onlyCommented'],'documentVersionId':opts['documentVersionId'],'documentVariationId':opts['documentVariationId'],'appType':opts['appType'],'queryType':opts['queryType'],'userId':opts['userId'],'queueId':opts['queueId'],'state':opts['state']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
14627
14714
|
* Get export job report
|
|
14628
14715
|
*
|
|
14629
14716
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
@@ -15446,7 +15533,7 @@ if(sourceId===undefined||sourceId===null||sourceId===''){throw'Missing the requi
|
|
|
15446
15533
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putKnowledgeSource';}return this.apiClient.callApi('/api/v2/knowledge/sources/{sourceId}','PUT',{'sourceId':sourceId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}}]);}();var LanguageUnderstandingApi=/*#__PURE__*/function(){/**
|
|
15447
15534
|
* LanguageUnderstanding service.
|
|
15448
15535
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
15449
|
-
* @version
|
|
15536
|
+
* @version 254.0.0
|
|
15450
15537
|
*//**
|
|
15451
15538
|
* Constructs a new LanguageUnderstandingApi.
|
|
15452
15539
|
* @alias module:purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
@@ -15820,7 +15907,7 @@ if(domainVersionId===undefined||domainVersionId===null||domainVersionId===''){th
|
|
|
15820
15907
|
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'],opts['customHeaders']);}}]);}();var LanguagesApi=/*#__PURE__*/function(){/**
|
|
15821
15908
|
* Languages service.
|
|
15822
15909
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
15823
|
-
* @version
|
|
15910
|
+
* @version 254.0.0
|
|
15824
15911
|
*//**
|
|
15825
15912
|
* Constructs a new LanguagesApi.
|
|
15826
15913
|
* @alias module:purecloud-platform-client-v2/api/LanguagesApi
|
|
@@ -15890,7 +15977,7 @@ if(userId===undefined||userId===null||userId===''){throw'Missing the required pa
|
|
|
15890
15977
|
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'],opts['customHeaders']);}}]);}();var LearningApi=/*#__PURE__*/function(){/**
|
|
15891
15978
|
* Learning service.
|
|
15892
15979
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
15893
|
-
* @version
|
|
15980
|
+
* @version 254.0.0
|
|
15894
15981
|
*//**
|
|
15895
15982
|
* Constructs a new LearningApi.
|
|
15896
15983
|
* @alias module:purecloud-platform-client-v2/api/LearningApi
|
|
@@ -16238,7 +16325,7 @@ if(moduleId===undefined||moduleId===null||moduleId===''){throw'Missing the requi
|
|
|
16238
16325
|
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},{'assign':opts['assign']},{},{},body,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}}]);}();var LicenseApi=/*#__PURE__*/function(){/**
|
|
16239
16326
|
* License service.
|
|
16240
16327
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
16241
|
-
* @version
|
|
16328
|
+
* @version 254.0.0
|
|
16242
16329
|
*//**
|
|
16243
16330
|
* Constructs a new LicenseApi.
|
|
16244
16331
|
* @alias module:purecloud-platform-client-v2/api/LicenseApi
|
|
@@ -16313,7 +16400,7 @@ if(featureName===undefined||featureName===null||featureName===''){throw'Missing
|
|
|
16313
16400
|
*/},{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'],opts['customHeaders']);}}]);}();var LocationsApi=/*#__PURE__*/function(){/**
|
|
16314
16401
|
* Locations service.
|
|
16315
16402
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
16316
|
-
* @version
|
|
16403
|
+
* @version 254.0.0
|
|
16317
16404
|
*//**
|
|
16318
16405
|
* Constructs a new LocationsApi.
|
|
16319
16406
|
* @alias module:purecloud-platform-client-v2/api/LocationsApi
|
|
@@ -16385,7 +16472,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
16385
16472
|
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'],opts['customHeaders']);}}]);}();var LogCaptureApi=/*#__PURE__*/function(){/**
|
|
16386
16473
|
* LogCapture service.
|
|
16387
16474
|
* @module purecloud-platform-client-v2/api/LogCaptureApi
|
|
16388
|
-
* @version
|
|
16475
|
+
* @version 254.0.0
|
|
16389
16476
|
*//**
|
|
16390
16477
|
* Constructs a new LogCaptureApi.
|
|
16391
16478
|
* @alias module:purecloud-platform-client-v2/api/LogCaptureApi
|
|
@@ -16444,7 +16531,7 @@ if(userId===undefined||userId===null||userId===''){throw'Missing the required pa
|
|
|
16444
16531
|
if(userId===undefined||userId===null||userId===''){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'],opts['customHeaders']);}}]);}();var MessagingApi=/*#__PURE__*/function(){/**
|
|
16445
16532
|
* Messaging service.
|
|
16446
16533
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
16447
|
-
* @version
|
|
16534
|
+
* @version 254.0.0
|
|
16448
16535
|
*//**
|
|
16449
16536
|
* Constructs a new MessagingApi.
|
|
16450
16537
|
* @alias module:purecloud-platform-client-v2/api/MessagingApi
|
|
@@ -16558,7 +16645,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
16558
16645
|
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'],opts['customHeaders']);}}]);}();var MobileDevicesApi=/*#__PURE__*/function(){/**
|
|
16559
16646
|
* MobileDevices service.
|
|
16560
16647
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
16561
|
-
* @version
|
|
16648
|
+
* @version 254.0.0
|
|
16562
16649
|
*//**
|
|
16563
16650
|
* Constructs a new MobileDevicesApi.
|
|
16564
16651
|
* @alias module:purecloud-platform-client-v2/api/MobileDevicesApi
|
|
@@ -16605,7 +16692,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
16605
16692
|
if(deviceId===undefined||deviceId===null||deviceId===''){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'],opts['customHeaders']);}}]);}();var NotificationsApi=/*#__PURE__*/function(){/**
|
|
16606
16693
|
* Notifications service.
|
|
16607
16694
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
16608
|
-
* @version
|
|
16695
|
+
* @version 254.0.0
|
|
16609
16696
|
*//**
|
|
16610
16697
|
* Constructs a new NotificationsApi.
|
|
16611
16698
|
* @alias module:purecloud-platform-client-v2/api/NotificationsApi
|
|
@@ -16674,7 +16761,7 @@ if(channelId===undefined||channelId===null||channelId===''){throw'Missing the re
|
|
|
16674
16761
|
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'],opts['customHeaders']);}}]);}();var OAuthApi=/*#__PURE__*/function(){/**
|
|
16675
16762
|
* OAuth service.
|
|
16676
16763
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
16677
|
-
* @version
|
|
16764
|
+
* @version 254.0.0
|
|
16678
16765
|
*//**
|
|
16679
16766
|
* Constructs a new OAuthApi.
|
|
16680
16767
|
* @alias module:purecloud-platform-client-v2/api/OAuthApi
|
|
@@ -16780,7 +16867,7 @@ if(clientId===undefined||clientId===null||clientId===''){throw'Missing the requi
|
|
|
16780
16867
|
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'],opts['customHeaders']);}}]);}();var ObjectsApi=/*#__PURE__*/function(){/**
|
|
16781
16868
|
* Objects service.
|
|
16782
16869
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
16783
|
-
* @version
|
|
16870
|
+
* @version 254.0.0
|
|
16784
16871
|
*//**
|
|
16785
16872
|
* Constructs a new ObjectsApi.
|
|
16786
16873
|
* @alias module:purecloud-platform-client-v2/api/ObjectsApi
|
|
@@ -16883,7 +16970,7 @@ if(divisionId===undefined||divisionId===null||divisionId===''){throw'Missing the
|
|
|
16883
16970
|
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'],opts['customHeaders']);}}]);}();var OperationalEventsApi=/*#__PURE__*/function(){/**
|
|
16884
16971
|
* OperationalEvents service.
|
|
16885
16972
|
* @module purecloud-platform-client-v2/api/OperationalEventsApi
|
|
16886
|
-
* @version
|
|
16973
|
+
* @version 254.0.0
|
|
16887
16974
|
*//**
|
|
16888
16975
|
* Constructs a new OperationalEventsApi.
|
|
16889
16976
|
* @alias module:purecloud-platform-client-v2/api/OperationalEventsApi
|
|
@@ -16920,7 +17007,7 @@ if(eventDefinitionId===undefined||eventDefinitionId===null||eventDefinitionId===
|
|
|
16920
17007
|
*/},{key:"postUsageEventsQuery",value:function postUsageEventsQuery(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/usage/events/query','POST',{},{'before':opts['before'],'after':opts['after'],'pageSize':opts['pageSize']},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}}]);}();var OrganizationApi=/*#__PURE__*/function(){/**
|
|
16921
17008
|
* Organization service.
|
|
16922
17009
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
16923
|
-
* @version
|
|
17010
|
+
* @version 254.0.0
|
|
16924
17011
|
*//**
|
|
16925
17012
|
* Constructs a new OrganizationApi.
|
|
16926
17013
|
* @alias module:purecloud-platform-client-v2/api/OrganizationApi
|
|
@@ -17060,7 +17147,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
17060
17147
|
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'],opts['customHeaders']);}}]);}();var OrganizationAuthorizationApi=/*#__PURE__*/function(){/**
|
|
17061
17148
|
* OrganizationAuthorization service.
|
|
17062
17149
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
17063
|
-
* @version
|
|
17150
|
+
* @version 254.0.0
|
|
17064
17151
|
*//**
|
|
17065
17152
|
* Constructs a new OrganizationAuthorizationApi.
|
|
17066
17153
|
* @alias module:purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
@@ -17480,7 +17567,7 @@ if(trustorOrgId===undefined||trustorOrgId===null||trustorOrgId===''){throw'Missi
|
|
|
17480
17567
|
if(trusteeUserId===undefined||trusteeUserId===null||trusteeUserId===''){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'],opts['customHeaders']);}}]);}();var OutboundApi=/*#__PURE__*/function(){/**
|
|
17481
17568
|
* Outbound service.
|
|
17482
17569
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
17483
|
-
* @version
|
|
17570
|
+
* @version 254.0.0
|
|
17484
17571
|
*//**
|
|
17485
17572
|
* Constructs a new OutboundApi.
|
|
17486
17573
|
* @alias module:purecloud-platform-client-v2/api/OutboundApi
|
|
@@ -18966,7 +19053,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
18966
19053
|
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'],opts['customHeaders']);}}]);}();var PresenceApi=/*#__PURE__*/function(){/**
|
|
18967
19054
|
* Presence service.
|
|
18968
19055
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
18969
|
-
* @version
|
|
19056
|
+
* @version 254.0.0
|
|
18970
19057
|
*//**
|
|
18971
19058
|
* Constructs a new PresenceApi.
|
|
18972
19059
|
* @alias module:purecloud-platform-client-v2/api/PresenceApi
|
|
@@ -19186,7 +19273,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
19186
19273
|
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'],opts['customHeaders']);}}]);}();var ProcessAutomationApi=/*#__PURE__*/function(){/**
|
|
19187
19274
|
* ProcessAutomation service.
|
|
19188
19275
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
19189
|
-
* @version
|
|
19276
|
+
* @version 254.0.0
|
|
19190
19277
|
*//**
|
|
19191
19278
|
* Constructs a new ProcessAutomationApi.
|
|
19192
19279
|
* @alias module:purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
@@ -19300,7 +19387,7 @@ if(triggerId===undefined||triggerId===null||triggerId===''){throw'Missing the re
|
|
|
19300
19387
|
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'],opts['customHeaders']);}}]);}();var QualityApi=/*#__PURE__*/function(){/**
|
|
19301
19388
|
* Quality service.
|
|
19302
19389
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
19303
|
-
* @version
|
|
19390
|
+
* @version 254.0.0
|
|
19304
19391
|
*//**
|
|
19305
19392
|
* Constructs a new QualityApi.
|
|
19306
19393
|
* @alias module:purecloud-platform-client-v2/api/QualityApi
|
|
@@ -19313,7 +19400,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
19313
19400
|
* @param {String} jobId jobId
|
|
19314
19401
|
* @param {Object} opts Optional parameters
|
|
19315
19402
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
19316
|
-
* deleteAnalyticsEvaluationsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
19317
19403
|
*/return _createClass(QualityApi,[{key:"deleteAnalyticsEvaluationsAggregatesJob",value:function deleteAnalyticsEvaluationsAggregatesJob(jobId,opts){opts=opts||{};// verify the required parameter 'jobId' is set
|
|
19318
19404
|
if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required parameter "jobId" when calling deleteAnalyticsEvaluationsAggregatesJob';}return this.apiClient.callApi('/api/v2/analytics/evaluations/aggregates/jobs/{jobId}','DELETE',{'jobId':jobId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
19319
19405
|
* Delete/cancel an async request for survey aggregates
|
|
@@ -19321,7 +19407,6 @@ if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required param
|
|
|
19321
19407
|
* @param {String} jobId jobId
|
|
19322
19408
|
* @param {Object} opts Optional parameters
|
|
19323
19409
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
19324
|
-
* deleteAnalyticsSurveysAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
19325
19410
|
*/},{key:"deleteAnalyticsSurveysAggregatesJob",value:function deleteAnalyticsSurveysAggregatesJob(jobId,opts){opts=opts||{};// verify the required parameter 'jobId' is set
|
|
19326
19411
|
if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required parameter "jobId" when calling deleteAnalyticsSurveysAggregatesJob';}return this.apiClient.callApi('/api/v2/analytics/surveys/aggregates/jobs/{jobId}','DELETE',{'jobId':jobId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
19327
19412
|
* Delete a calibration by id.
|
|
@@ -19379,7 +19464,6 @@ if(ruleId===undefined||ruleId===null||ruleId===''){throw'Missing the required pa
|
|
|
19379
19464
|
* @param {String} jobId jobId
|
|
19380
19465
|
* @param {Object} opts Optional parameters
|
|
19381
19466
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
19382
|
-
* getAnalyticsEvaluationsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
19383
19467
|
*/},{key:"getAnalyticsEvaluationsAggregatesJob",value:function getAnalyticsEvaluationsAggregatesJob(jobId,opts){opts=opts||{};// verify the required parameter 'jobId' is set
|
|
19384
19468
|
if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required parameter "jobId" when calling getAnalyticsEvaluationsAggregatesJob';}return this.apiClient.callApi('/api/v2/analytics/evaluations/aggregates/jobs/{jobId}','GET',{'jobId':jobId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
19385
19469
|
* Fetch a page of results for an async aggregates query
|
|
@@ -19388,7 +19472,6 @@ if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required param
|
|
|
19388
19472
|
* @param {Object} opts Optional parameters
|
|
19389
19473
|
* @param {String} opts.cursor Cursor token to retrieve next page
|
|
19390
19474
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
19391
|
-
* getAnalyticsEvaluationsAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
19392
19475
|
*/},{key:"getAnalyticsEvaluationsAggregatesJobResults",value:function getAnalyticsEvaluationsAggregatesJobResults(jobId,opts){opts=opts||{};// verify the required parameter 'jobId' is set
|
|
19393
19476
|
if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required parameter "jobId" when calling getAnalyticsEvaluationsAggregatesJobResults';}return this.apiClient.callApi('/api/v2/analytics/evaluations/aggregates/jobs/{jobId}/results','GET',{'jobId':jobId},{'cursor':opts['cursor']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
19394
19477
|
* Get status for async query for survey aggregates
|
|
@@ -19396,7 +19479,6 @@ if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required param
|
|
|
19396
19479
|
* @param {String} jobId jobId
|
|
19397
19480
|
* @param {Object} opts Optional parameters
|
|
19398
19481
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
19399
|
-
* getAnalyticsSurveysAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
19400
19482
|
*/},{key:"getAnalyticsSurveysAggregatesJob",value:function getAnalyticsSurveysAggregatesJob(jobId,opts){opts=opts||{};// verify the required parameter 'jobId' is set
|
|
19401
19483
|
if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required parameter "jobId" when calling getAnalyticsSurveysAggregatesJob';}return this.apiClient.callApi('/api/v2/analytics/surveys/aggregates/jobs/{jobId}','GET',{'jobId':jobId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
19402
19484
|
* Fetch a page of results for an async aggregates query
|
|
@@ -19405,7 +19487,6 @@ if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required param
|
|
|
19405
19487
|
* @param {Object} opts Optional parameters
|
|
19406
19488
|
* @param {String} opts.cursor Cursor token to retrieve next page
|
|
19407
19489
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
19408
|
-
* getAnalyticsSurveysAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
19409
19490
|
*/},{key:"getAnalyticsSurveysAggregatesJobResults",value:function getAnalyticsSurveysAggregatesJobResults(jobId,opts){opts=opts||{};// verify the required parameter 'jobId' is set
|
|
19410
19491
|
if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required parameter "jobId" when calling getAnalyticsSurveysAggregatesJobResults';}return this.apiClient.callApi('/api/v2/analytics/surveys/aggregates/jobs/{jobId}/results','GET',{'jobId':jobId},{'cursor':opts['cursor']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
19411
19492
|
* Gets a list of Agent Activities
|
|
@@ -19745,7 +19826,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
19745
19826
|
* @param {Object} body query
|
|
19746
19827
|
* @param {Object} opts Optional parameters
|
|
19747
19828
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
19748
|
-
* postAnalyticsEvaluationsAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
19749
19829
|
*/},{key:"postAnalyticsEvaluationsAggregatesJobs",value:function postAnalyticsEvaluationsAggregatesJobs(body,opts){opts=opts||{};// verify the required parameter 'body' is set
|
|
19750
19830
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postAnalyticsEvaluationsAggregatesJobs';}return this.apiClient.callApi('/api/v2/analytics/evaluations/aggregates/jobs','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
19751
19831
|
* Query for evaluation aggregates
|
|
@@ -19760,7 +19840,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
19760
19840
|
* @param {Object} body query
|
|
19761
19841
|
* @param {Object} opts Optional parameters
|
|
19762
19842
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
19763
|
-
* postAnalyticsSurveysAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
19764
19843
|
*/},{key:"postAnalyticsSurveysAggregatesJobs",value:function postAnalyticsSurveysAggregatesJobs(body,opts){opts=opts||{};// verify the required parameter 'body' is set
|
|
19765
19844
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postAnalyticsSurveysAggregatesJobs';}return this.apiClient.callApi('/api/v2/analytics/surveys/aggregates/jobs','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
19766
19845
|
* Query for survey aggregates
|
|
@@ -19964,7 +20043,7 @@ if(customerSurveyUrl===undefined||customerSurveyUrl===null){throw'Missing the re
|
|
|
19964
20043
|
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'],opts['customHeaders']);}}]);}();var RecordingApi=/*#__PURE__*/function(){/**
|
|
19965
20044
|
* Recording service.
|
|
19966
20045
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
19967
|
-
* @version
|
|
20046
|
+
* @version 254.0.0
|
|
19968
20047
|
*//**
|
|
19969
20048
|
* Constructs a new RecordingApi.
|
|
19970
20049
|
* @alias module:purecloud-platform-client-v2/api/RecordingApi
|
|
@@ -20463,7 +20542,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
20463
20542
|
*/},{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'],opts['customHeaders']);}}]);}();var ResponseManagementApi=/*#__PURE__*/function(){/**
|
|
20464
20543
|
* ResponseManagement service.
|
|
20465
20544
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
20466
|
-
* @version
|
|
20545
|
+
* @version 254.0.0
|
|
20467
20546
|
*//**
|
|
20468
20547
|
* Constructs a new ResponseManagementApi.
|
|
20469
20548
|
* @alias module:purecloud-platform-client-v2/api/ResponseManagementApi
|
|
@@ -20630,7 +20709,7 @@ if(responseAssetId===undefined||responseAssetId===null||responseAssetId===''){th
|
|
|
20630
20709
|
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'],opts['customHeaders']);}}]);}();var RoutingApi=/*#__PURE__*/function(){/**
|
|
20631
20710
|
* Routing service.
|
|
20632
20711
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
20633
|
-
* @version
|
|
20712
|
+
* @version 254.0.0
|
|
20634
20713
|
*//**
|
|
20635
20714
|
* Constructs a new RoutingApi.
|
|
20636
20715
|
* @alias module:purecloud-platform-client-v2/api/RoutingApi
|
|
@@ -20673,6 +20752,13 @@ if(routeId===undefined||routeId===null||routeId===''){throw'Missing the required
|
|
|
20673
20752
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
20674
20753
|
*/},{key:"deleteRoutingEmailOutboundDomain",value:function deleteRoutingEmailOutboundDomain(domainId,opts){opts=opts||{};// verify the required parameter 'domainId' is set
|
|
20675
20754
|
if(domainId===undefined||domainId===null||domainId===''){throw'Missing the required parameter "domainId" when calling deleteRoutingEmailOutboundDomain';}return this.apiClient.callApi('/api/v2/routing/email/outbound/domains/{domainId}','DELETE',{'domainId':domainId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
20755
|
+
* Delete an email setting. Removes the email setting and its associated settings
|
|
20756
|
+
*
|
|
20757
|
+
* @param {String} emailSettingId Email Setting ID
|
|
20758
|
+
* @param {Object} opts Optional parameters
|
|
20759
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
20760
|
+
*/},{key:"deleteRoutingEmailSettingEmailSettingId",value:function deleteRoutingEmailSettingEmailSettingId(emailSettingId,opts){opts=opts||{};// verify the required parameter 'emailSettingId' is set
|
|
20761
|
+
if(emailSettingId===undefined||emailSettingId===null||emailSettingId===''){throw'Missing the required parameter "emailSettingId" when calling deleteRoutingEmailSettingEmailSettingId';}return this.apiClient.callApi('/api/v2/routing/email/setting/{emailSettingId}','DELETE',{'emailSettingId':emailSettingId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
20676
20762
|
* Delete a routing language
|
|
20677
20763
|
*
|
|
20678
20764
|
* @param {String} languageId Language ID
|
|
@@ -20743,6 +20829,19 @@ if(codeId===undefined||codeId===null||codeId===''){throw'Missing the required pa
|
|
|
20743
20829
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
20744
20830
|
*/},{key:"deleteRoutingSkill",value:function deleteRoutingSkill(skillId,opts){opts=opts||{};// verify the required parameter 'skillId' is set
|
|
20745
20831
|
if(skillId===undefined||skillId===null||skillId===''){throw'Missing the required parameter "skillId" when calling deleteRoutingSkill';}return this.apiClient.callApi('/api/v2/routing/skills/{skillId}','DELETE',{'skillId':skillId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
20832
|
+
* Archive a skill expression to remove it from the set of active expressions
|
|
20833
|
+
*
|
|
20834
|
+
* @param {String} expressionId Expression ID
|
|
20835
|
+
* @param {Object} opts Optional parameters
|
|
20836
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
20837
|
+
*/},{key:"deleteRoutingSkillexpression",value:function deleteRoutingSkillexpression(expressionId,opts){opts=opts||{};// verify the required parameter 'expressionId' is set
|
|
20838
|
+
if(expressionId===undefined||expressionId===null||expressionId===''){throw'Missing the required parameter "expressionId" when calling deleteRoutingSkillexpression';}return this.apiClient.callApi('/api/v2/routing/skillexpressions/{expressionId}','DELETE',{'expressionId':expressionId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
20839
|
+
* Archive a set of skill expressions to remove them from the set of active expressions
|
|
20840
|
+
*
|
|
20841
|
+
* @param {Object} opts Optional parameters
|
|
20842
|
+
* @param {Array.<String>} opts.id Expression ID(s) to filter. Repeat for multiple or use comma-separated list.
|
|
20843
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
20844
|
+
*/},{key:"deleteRoutingSkillexpressions",value:function deleteRoutingSkillexpressions(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/routing/skillexpressions','DELETE',{},{'id':this.apiClient.buildCollectionParam(opts['id'],'multi')},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
20746
20845
|
* Remove skill group definition
|
|
20747
20846
|
*
|
|
20748
20847
|
* @param {String} skillGroupId Skill Group ID
|
|
@@ -20791,15 +20890,6 @@ if(userId===undefined||userId===null||userId===''){throw'Missing the required pa
|
|
|
20791
20890
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
20792
20891
|
*/},{key:"deleteRoutingUtilizationLabel",value:function deleteRoutingUtilizationLabel(labelId,opts){opts=opts||{};// verify the required parameter 'labelId' is set
|
|
20793
20892
|
if(labelId===undefined||labelId===null||labelId===''){throw'Missing the required parameter "labelId" when calling deleteRoutingUtilizationLabel';}return this.apiClient.callApi('/api/v2/routing/utilization/labels/{labelId}','DELETE',{'labelId':labelId},{'forceDelete':opts['forceDelete']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
20794
|
-
* Delete an utilization tag
|
|
20795
|
-
*
|
|
20796
|
-
* @param {String} tagId Utilization Tag ID
|
|
20797
|
-
* @param {Object} opts Optional parameters
|
|
20798
|
-
* @param {Boolean} opts.forceDelete Remove all tag usages (if found) without warning (default to false)
|
|
20799
|
-
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
20800
|
-
* deleteRoutingUtilizationTag is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
20801
|
-
*/},{key:"deleteRoutingUtilizationTag",value:function deleteRoutingUtilizationTag(tagId,opts){opts=opts||{};// verify the required parameter 'tagId' is set
|
|
20802
|
-
if(tagId===undefined||tagId===null||tagId===''){throw'Missing the required parameter "tagId" when calling deleteRoutingUtilizationTag';}return this.apiClient.callApi('/api/v2/routing/utilization/tags/{tagId}','DELETE',{'tagId':tagId},{'forceDelete':opts['forceDelete']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
20803
20893
|
* Delete wrap-up code
|
|
20804
20894
|
*
|
|
20805
20895
|
* @param {String} codeId Wrapup Code ID
|
|
@@ -20958,6 +21048,20 @@ if(domainId===undefined||domainId===null||domainId===''){throw'Missing the requi
|
|
|
20958
21048
|
* @param {Object} opts.expand Expand options. Valid values: settings
|
|
20959
21049
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
20960
21050
|
*/},{key:"getRoutingEmailOutboundDomains",value:function getRoutingEmailOutboundDomains(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/routing/email/outbound/domains','GET',{},{'pageSize':opts['pageSize'],'pageNumber':opts['pageNumber'],'filter':opts['filter'],'expand':opts['expand']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
21051
|
+
* Get a paged list of email routing settings.
|
|
21052
|
+
*
|
|
21053
|
+
* @param {Object} opts Optional parameters
|
|
21054
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
21055
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
21056
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
21057
|
+
*/},{key:"getRoutingEmailSetting",value:function getRoutingEmailSetting(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/routing/email/setting','GET',{},{'pageSize':opts['pageSize'],'pageNumber':opts['pageNumber']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
21058
|
+
* Get email setting. Returns the specified email setting that defines settings for email
|
|
21059
|
+
*
|
|
21060
|
+
* @param {String} emailSettingId Email Setting ID
|
|
21061
|
+
* @param {Object} opts Optional parameters
|
|
21062
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
21063
|
+
*/},{key:"getRoutingEmailSettingEmailSettingId",value:function getRoutingEmailSettingEmailSettingId(emailSettingId,opts){opts=opts||{};// verify the required parameter 'emailSettingId' is set
|
|
21064
|
+
if(emailSettingId===undefined||emailSettingId===null||emailSettingId===''){throw'Missing the required parameter "emailSettingId" when calling getRoutingEmailSettingEmailSettingId';}return this.apiClient.callApi('/api/v2/routing/email/setting/{emailSettingId}','GET',{'emailSettingId':emailSettingId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
20961
21065
|
* Get email setup
|
|
20962
21066
|
*
|
|
20963
21067
|
* @param {Object} opts Optional parameters
|
|
@@ -21184,7 +21288,7 @@ if(queueId===undefined||queueId===null||queueId===''){throw'Missing the required
|
|
|
21184
21288
|
* @param {Object} opts.sortOrder Sort order (default to asc)
|
|
21185
21289
|
* @param {String} opts.name Name
|
|
21186
21290
|
* @param {Array.<String>} opts.id Queue ID(s)
|
|
21187
|
-
* @param {Array.<String>} opts.divisionId Division ID(s)
|
|
21291
|
+
* @param {Array.<String>} opts.divisionId Division ID(s). Including '*' will query for all divisions
|
|
21188
21292
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
21189
21293
|
*/},{key:"getRoutingQueuesDivisionviews",value:function getRoutingQueuesDivisionviews(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/routing/queues/divisionviews','GET',{},{'pageSize':opts['pageSize'],'pageNumber':opts['pageNumber'],'sortBy':opts['sortBy'],'sortOrder':opts['sortOrder'],'name':opts['name'],'id':this.apiClient.buildCollectionParam(opts['id'],'multi'),'divisionId':this.apiClient.buildCollectionParam(opts['divisionId'],'multi')},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
21190
21294
|
* Get a paged listing of simplified queue objects, sorted by name. Can be used to get a digest of all queues in an organization.
|
|
@@ -21226,6 +21330,32 @@ if(queueId===undefined||queueId===null||queueId===''){throw'Missing the required
|
|
|
21226
21330
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
21227
21331
|
*/},{key:"getRoutingSkill",value:function getRoutingSkill(skillId,opts){opts=opts||{};// verify the required parameter 'skillId' is set
|
|
21228
21332
|
if(skillId===undefined||skillId===null||skillId===''){throw'Missing the required parameter "skillId" when calling getRoutingSkill';}return this.apiClient.callApi('/api/v2/routing/skills/{skillId}','GET',{'skillId':skillId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
21333
|
+
* Get a skill expression by ID
|
|
21334
|
+
*
|
|
21335
|
+
* @param {String} expressionId Expression ID
|
|
21336
|
+
* @param {Object} opts Optional parameters
|
|
21337
|
+
* @param {Boolean} opts.includeArchived Include archived (default to false)
|
|
21338
|
+
* @param {Object} opts.format Response format: raw expression or normalized (default to Raw)
|
|
21339
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
21340
|
+
*/},{key:"getRoutingSkillexpression",value:function getRoutingSkillexpression(expressionId,opts){opts=opts||{};// verify the required parameter 'expressionId' is set
|
|
21341
|
+
if(expressionId===undefined||expressionId===null||expressionId===''){throw'Missing the required parameter "expressionId" when calling getRoutingSkillexpression';}return this.apiClient.callApi('/api/v2/routing/skillexpressions/{expressionId}','GET',{'expressionId':expressionId},{'includeArchived':opts['includeArchived'],'format':opts['format']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
21342
|
+
* Get skill expressions
|
|
21343
|
+
*
|
|
21344
|
+
* @param {Object} opts Optional parameters
|
|
21345
|
+
* @param {Object} opts.format Response format: raw expression or normalized (default to Raw)
|
|
21346
|
+
* @param {Boolean} opts.includeArchived Include archived (default to false)
|
|
21347
|
+
* @param {Array.<String>} opts.id Expression ID(s) to filter. Repeat for multiple or use comma-separated list.
|
|
21348
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
21349
|
+
*/},{key:"getRoutingSkillexpressions",value:function getRoutingSkillexpressions(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/routing/skillexpressions','GET',{},{'format':opts['format'],'includeArchived':opts['includeArchived'],'id':this.apiClient.buildCollectionParam(opts['id'],'multi')},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
21350
|
+
* Get skill expressions associated with a queue
|
|
21351
|
+
*
|
|
21352
|
+
* @param {String} queueId Queue ID
|
|
21353
|
+
* @param {Object} opts Optional parameters
|
|
21354
|
+
* @param {Object} opts.format Response format: raw expression or normalized (default to Raw)
|
|
21355
|
+
* @param {Boolean} opts.includeArchived Include archived (default to false)
|
|
21356
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
21357
|
+
*/},{key:"getRoutingSkillexpressionsQueueQueueId",value:function getRoutingSkillexpressionsQueueQueueId(queueId,opts){opts=opts||{};// verify the required parameter 'queueId' is set
|
|
21358
|
+
if(queueId===undefined||queueId===null||queueId===''){throw'Missing the required parameter "queueId" when calling getRoutingSkillexpressionsQueueQueueId';}return this.apiClient.callApi('/api/v2/routing/skillexpressions/queue/{queueId}','GET',{'queueId':queueId},{'format':opts['format'],'includeArchived':opts['includeArchived']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
21229
21359
|
* Get skill group
|
|
21230
21360
|
*
|
|
21231
21361
|
* @param {String} skillGroupId Skill Group ID
|
|
@@ -21261,7 +21391,7 @@ if(skillGroupId===undefined||skillGroupId===null||skillGroupId===''){throw'Missi
|
|
|
21261
21391
|
* @param {String} opts.before The cursor that points to the previous item
|
|
21262
21392
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
21263
21393
|
*/},{key:"getRoutingSkillgroups",value:function getRoutingSkillgroups(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/routing/skillgroups','GET',{},{'pageSize':opts['pageSize'],'name':opts['name'],'after':opts['after'],'before':opts['before']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
21264
|
-
* Get the list of routing skills.
|
|
21394
|
+
* Get the list of routing skills. View permission enforcement only applies to skills assigned to a division.
|
|
21265
21395
|
*
|
|
21266
21396
|
* @param {Object} opts Optional parameters
|
|
21267
21397
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
@@ -21372,32 +21502,6 @@ if(labelId===undefined||labelId===null||labelId===''){throw'Missing the required
|
|
|
21372
21502
|
* @param {String} opts.name Utilization label's name (Wildcard is supported, e.g., 'label1*', '*label*'
|
|
21373
21503
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
21374
21504
|
*/},{key:"getRoutingUtilizationLabels",value:function getRoutingUtilizationLabels(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/routing/utilization/labels','GET',{},{'pageSize':opts['pageSize'],'pageNumber':opts['pageNumber'],'sortOrder':opts['sortOrder'],'name':opts['name']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
21375
|
-
* Get details about this utilization tag
|
|
21376
|
-
*
|
|
21377
|
-
* @param {String} tagId Utilization Tag ID
|
|
21378
|
-
* @param {Object} opts Optional parameters
|
|
21379
|
-
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
21380
|
-
* getRoutingUtilizationTag is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
21381
|
-
*/},{key:"getRoutingUtilizationTag",value:function getRoutingUtilizationTag(tagId,opts){opts=opts||{};// verify the required parameter 'tagId' is set
|
|
21382
|
-
if(tagId===undefined||tagId===null||tagId===''){throw'Missing the required parameter "tagId" when calling getRoutingUtilizationTag';}return this.apiClient.callApi('/api/v2/routing/utilization/tags/{tagId}','GET',{'tagId':tagId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
21383
|
-
* Get list of agent ids associated with a utilization tag
|
|
21384
|
-
*
|
|
21385
|
-
* @param {String} tagId Utilization Tag ID
|
|
21386
|
-
* @param {Object} opts Optional parameters
|
|
21387
|
-
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
21388
|
-
* getRoutingUtilizationTagAgents is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
21389
|
-
*/},{key:"getRoutingUtilizationTagAgents",value:function getRoutingUtilizationTagAgents(tagId,opts){opts=opts||{};// verify the required parameter 'tagId' is set
|
|
21390
|
-
if(tagId===undefined||tagId===null||tagId===''){throw'Missing the required parameter "tagId" when calling getRoutingUtilizationTagAgents';}return this.apiClient.callApi('/api/v2/routing/utilization/tags/{tagId}/agents','GET',{'tagId':tagId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
21391
|
-
* Get list of utilization tags
|
|
21392
|
-
*
|
|
21393
|
-
* @param {Object} opts Optional parameters
|
|
21394
|
-
* @param {Number} opts.pageSize Page size (default to 25)
|
|
21395
|
-
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
21396
|
-
* @param {Object} opts.sortOrder Sort order by name (default to ascending)
|
|
21397
|
-
* @param {String} opts.name Utilization tag's name (Wildcard is supported, e.g., 'tag1*')
|
|
21398
|
-
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
21399
|
-
* getRoutingUtilizationTags is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
21400
|
-
*/},{key:"getRoutingUtilizationTags",value:function getRoutingUtilizationTags(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/routing/utilization/tags','GET',{},{'pageSize':opts['pageSize'],'pageNumber':opts['pageNumber'],'sortOrder':opts['sortOrder'],'name':opts['name']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
21401
21505
|
* Get details about this wrap-up code.
|
|
21402
21506
|
*
|
|
21403
21507
|
* @param {String} codeId Wrapup Code ID
|
|
@@ -21512,6 +21616,15 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
21512
21616
|
*/},{key:"patchRoutingEmailOutboundDomain",value:function patchRoutingEmailOutboundDomain(domainId,body,opts){opts=opts||{};// verify the required parameter 'domainId' is set
|
|
21513
21617
|
if(domainId===undefined||domainId===null||domainId===''){throw'Missing the required parameter "domainId" when calling patchRoutingEmailOutboundDomain';}// verify the required parameter 'body' is set
|
|
21514
21618
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling patchRoutingEmailOutboundDomain';}return this.apiClient.callApi('/api/v2/routing/email/outbound/domains/{domainId}','PATCH',{'domainId':domainId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
21619
|
+
* Update an email setting. Modifies the settings for email setting
|
|
21620
|
+
*
|
|
21621
|
+
* @param {String} emailSettingId Email Setting ID
|
|
21622
|
+
* @param {Object} body EmailSetting
|
|
21623
|
+
* @param {Object} opts Optional parameters
|
|
21624
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
21625
|
+
*/},{key:"patchRoutingEmailSettingEmailSettingId",value:function patchRoutingEmailSettingEmailSettingId(emailSettingId,body,opts){opts=opts||{};// verify the required parameter 'emailSettingId' is set
|
|
21626
|
+
if(emailSettingId===undefined||emailSettingId===null||emailSettingId===''){throw'Missing the required parameter "emailSettingId" when calling patchRoutingEmailSettingEmailSettingId';}// verify the required parameter 'body' is set
|
|
21627
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling patchRoutingEmailSettingEmailSettingId';}return this.apiClient.callApi('/api/v2/routing/email/setting/{emailSettingId}','PATCH',{'emailSettingId':emailSettingId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
21515
21628
|
* Update single predictor.
|
|
21516
21629
|
*
|
|
21517
21630
|
* @param {String} predictorId Predictor ID
|
|
@@ -21759,6 +21872,13 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
21759
21872
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
21760
21873
|
*/},{key:"postRoutingEmailOutboundDomainsSimulated",value:function postRoutingEmailOutboundDomainsSimulated(body,opts){opts=opts||{};// verify the required parameter 'body' is set
|
|
21761
21874
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postRoutingEmailOutboundDomainsSimulated';}return this.apiClient.callApi('/api/v2/routing/email/outbound/domains/simulated','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
21875
|
+
* Create a new email setting. Used to define various settings, that can then be associated with email domains
|
|
21876
|
+
*
|
|
21877
|
+
* @param {Object} body EmailSetting
|
|
21878
|
+
* @param {Object} opts Optional parameters
|
|
21879
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
21880
|
+
*/},{key:"postRoutingEmailSetting",value:function postRoutingEmailSetting(body,opts){opts=opts||{};// verify the required parameter 'body' is set
|
|
21881
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postRoutingEmailSetting';}return this.apiClient.callApi('/api/v2/routing/email/setting','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
21762
21882
|
* Create Language
|
|
21763
21883
|
*
|
|
21764
21884
|
* @param {Object} body Language
|
|
@@ -21817,6 +21937,13 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
21817
21937
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
21818
21938
|
*/},{key:"postRoutingQueues",value:function postRoutingQueues(body,opts){opts=opts||{};// verify the required parameter 'body' is set
|
|
21819
21939
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postRoutingQueues';}return this.apiClient.callApi('/api/v2/routing/queues','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
21940
|
+
* Validate and normalize a skill expression
|
|
21941
|
+
*
|
|
21942
|
+
* @param {Object} body Skill expression data to validate
|
|
21943
|
+
* @param {Object} opts Optional parameters
|
|
21944
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
21945
|
+
*/},{key:"postRoutingSkillexpressionsValidate",value:function postRoutingSkillexpressionsValidate(body,opts){opts=opts||{};// verify the required parameter 'body' is set
|
|
21946
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postRoutingSkillexpressionsValidate';}return this.apiClient.callApi('/api/v2/routing/skillexpressions/validate','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
21820
21947
|
* Add or remove member divisions for this skill group.
|
|
21821
21948
|
*
|
|
21822
21949
|
* @param {String} skillGroupId Skill Group ID
|
|
@@ -21875,14 +22002,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
21875
22002
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
21876
22003
|
*/},{key:"postRoutingUtilizationLabels",value:function postRoutingUtilizationLabels(body,opts){opts=opts||{};// verify the required parameter 'body' is set
|
|
21877
22004
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postRoutingUtilizationLabels';}return this.apiClient.callApi('/api/v2/routing/utilization/labels','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
21878
|
-
* Create an utilization tag
|
|
21879
|
-
*
|
|
21880
|
-
* @param {Object} body UtilizationTag
|
|
21881
|
-
* @param {Object} opts Optional parameters
|
|
21882
|
-
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
21883
|
-
* postRoutingUtilizationTags is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
21884
|
-
*/},{key:"postRoutingUtilizationTags",value:function postRoutingUtilizationTags(body,opts){opts=opts||{};// verify the required parameter 'body' is set
|
|
21885
|
-
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postRoutingUtilizationTags';}return this.apiClient.callApi('/api/v2/routing/utilization/tags','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
21886
22005
|
* Create a wrap-up code
|
|
21887
22006
|
*
|
|
21888
22007
|
* @param {Object} body WrapupCode
|
|
@@ -22059,7 +22178,7 @@ if(userId===undefined||userId===null||userId===''){throw'Missing the required pa
|
|
|
22059
22178
|
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'],opts['customHeaders']);}}]);}();var SCIMApi=/*#__PURE__*/function(){/**
|
|
22060
22179
|
* SCIM service.
|
|
22061
22180
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
22062
|
-
* @version
|
|
22181
|
+
* @version 254.0.0
|
|
22063
22182
|
*//**
|
|
22064
22183
|
* Constructs a new SCIMApi.
|
|
22065
22184
|
* @alias module:purecloud-platform-client-v2/api/SCIMApi
|
|
@@ -22322,7 +22441,7 @@ if(userId===undefined||userId===null||userId===''){throw'Missing the required pa
|
|
|
22322
22441
|
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'],opts['customHeaders']);}}]);}();var ScriptsApi=/*#__PURE__*/function(){/**
|
|
22323
22442
|
* Scripts service.
|
|
22324
22443
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
22325
|
-
* @version
|
|
22444
|
+
* @version 254.0.0
|
|
22326
22445
|
*//**
|
|
22327
22446
|
* Constructs a new ScriptsApi.
|
|
22328
22447
|
* @alias module:purecloud-platform-client-v2/api/ScriptsApi
|
|
@@ -22484,7 +22603,7 @@ if(scriptId===undefined||scriptId===null||scriptId===''){throw'Missing the requi
|
|
|
22484
22603
|
*/},{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'],opts['customHeaders']);}}]);}();var SearchApi=/*#__PURE__*/function(){/**
|
|
22485
22604
|
* Search service.
|
|
22486
22605
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
22487
|
-
* @version
|
|
22606
|
+
* @version 254.0.0
|
|
22488
22607
|
*//**
|
|
22489
22608
|
* Constructs a new SearchApi.
|
|
22490
22609
|
* @alias module:purecloud-platform-client-v2/api/SearchApi
|
|
@@ -22691,7 +22810,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
22691
22810
|
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'],opts['customHeaders']);}}]);}();var SettingsApi=/*#__PURE__*/function(){/**
|
|
22692
22811
|
* Settings service.
|
|
22693
22812
|
* @module purecloud-platform-client-v2/api/SettingsApi
|
|
22694
|
-
* @version
|
|
22813
|
+
* @version 254.0.0
|
|
22695
22814
|
*//**
|
|
22696
22815
|
* Constructs a new SettingsApi.
|
|
22697
22816
|
* @alias module:purecloud-platform-client-v2/api/SettingsApi
|
|
@@ -22788,7 +22907,7 @@ if(agentId===undefined||agentId===null||agentId===''){throw'Missing the required
|
|
|
22788
22907
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putUsersAgentuiAgentsAutoanswerAgentIdSettings';}return this.apiClient.callApi('/api/v2/users/agentui/agents/autoanswer/{agentId}/settings','PUT',{'agentId':agentId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}}]);}();var SocialMediaApi=/*#__PURE__*/function(){/**
|
|
22789
22908
|
* SocialMedia service.
|
|
22790
22909
|
* @module purecloud-platform-client-v2/api/SocialMediaApi
|
|
22791
|
-
* @version
|
|
22910
|
+
* @version 254.0.0
|
|
22792
22911
|
*//**
|
|
22793
22912
|
* Constructs a new SocialMediaApi.
|
|
22794
22913
|
* @alias module:purecloud-platform-client-v2/api/SocialMediaApi
|
|
@@ -23343,7 +23462,7 @@ if(topicId===undefined||topicId===null||topicId===''){throw'Missing the required
|
|
|
23343
23462
|
if(twitterIngestionRuleId===undefined||twitterIngestionRuleId===null||twitterIngestionRuleId===''){throw'Missing the required parameter "twitterIngestionRuleId" when calling putSocialmediaTopicDataingestionrulesTwitterTwitterIngestionRuleId';}return this.apiClient.callApi('/api/v2/socialmedia/topics/{topicId}/dataingestionrules/twitter/{twitterIngestionRuleId}','PUT',{'topicId':topicId,'twitterIngestionRuleId':twitterIngestionRuleId},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}}]);}();var SpeechTextAnalyticsApi=/*#__PURE__*/function(){/**
|
|
23344
23463
|
* SpeechTextAnalytics service.
|
|
23345
23464
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
23346
|
-
* @version
|
|
23465
|
+
* @version 254.0.0
|
|
23347
23466
|
*//**
|
|
23348
23467
|
* Constructs a new SpeechTextAnalyticsApi.
|
|
23349
23468
|
* @alias module:purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
@@ -23836,7 +23955,7 @@ if(topicId===undefined||topicId===null||topicId===''){throw'Missing the required
|
|
|
23836
23955
|
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'],opts['customHeaders']);}}]);}();var StationsApi=/*#__PURE__*/function(){/**
|
|
23837
23956
|
* Stations service.
|
|
23838
23957
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
23839
|
-
* @version
|
|
23958
|
+
* @version 254.0.0
|
|
23840
23959
|
*//**
|
|
23841
23960
|
* Constructs a new StationsApi.
|
|
23842
23961
|
* @alias module:purecloud-platform-client-v2/api/StationsApi
|
|
@@ -23873,7 +23992,7 @@ if(stationId===undefined||stationId===null||stationId===''){throw'Missing the re
|
|
|
23873
23992
|
*/},{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'],opts['customHeaders']);}}]);}();var SuggestApi=/*#__PURE__*/function(){/**
|
|
23874
23993
|
* Suggest service.
|
|
23875
23994
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
23876
|
-
* @version
|
|
23995
|
+
* @version 254.0.0
|
|
23877
23996
|
*//**
|
|
23878
23997
|
* Constructs a new SuggestApi.
|
|
23879
23998
|
* @alias module:purecloud-platform-client-v2/api/SuggestApi
|
|
@@ -23917,7 +24036,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
23917
24036
|
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'],opts['customHeaders']);}}]);}();var TaskManagementApi=/*#__PURE__*/function(){/**
|
|
23918
24037
|
* TaskManagement service.
|
|
23919
24038
|
* @module purecloud-platform-client-v2/api/TaskManagementApi
|
|
23920
|
-
* @version
|
|
24039
|
+
* @version 254.0.0
|
|
23921
24040
|
*//**
|
|
23922
24041
|
* Constructs a new TaskManagementApi.
|
|
23923
24042
|
* @alias module:purecloud-platform-client-v2/api/TaskManagementApi
|
|
@@ -24561,7 +24680,7 @@ if(schemaId===undefined||schemaId===null||schemaId===''){throw'Missing the requi
|
|
|
24561
24680
|
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'],opts['customHeaders']);}}]);}();var TeamsApi=/*#__PURE__*/function(){/**
|
|
24562
24681
|
* Teams service.
|
|
24563
24682
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
24564
|
-
* @version
|
|
24683
|
+
* @version 254.0.0
|
|
24565
24684
|
*//**
|
|
24566
24685
|
* Constructs a new TeamsApi.
|
|
24567
24686
|
* @alias module:purecloud-platform-client-v2/api/TeamsApi
|
|
@@ -24657,7 +24776,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
24657
24776
|
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'],opts['customHeaders']);}}]);}();var TelephonyApi=/*#__PURE__*/function(){/**
|
|
24658
24777
|
* Telephony service.
|
|
24659
24778
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
24660
|
-
* @version
|
|
24779
|
+
* @version 254.0.0
|
|
24661
24780
|
*//**
|
|
24662
24781
|
* Constructs a new TelephonyApi.
|
|
24663
24782
|
* @alias module:purecloud-platform-client-v2/api/TelephonyApi
|
|
@@ -24665,12 +24784,19 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
24665
24784
|
* @param {module:purecloud-platform-client-v2/ApiClient} apiClient Optional API client implementation to use,
|
|
24666
24785
|
* default to {@link module:purecloud-platform-client-v2/ApiClient#instance} if unspecified.
|
|
24667
24786
|
*/function TelephonyApi(apiClient){_classCallCheck(this,TelephonyApi);this.apiClient=apiClient||ApiClient.instance;}/**
|
|
24787
|
+
* Delete a link
|
|
24788
|
+
*
|
|
24789
|
+
* @param {String} targetOrganizationId targetOrganizationId
|
|
24790
|
+
* @param {Object} opts Optional parameters
|
|
24791
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
24792
|
+
*/return _createClass(TelephonyApi,[{key:"deleteTelephonyOrganizationLinkTargetOrganizationId",value:function deleteTelephonyOrganizationLinkTargetOrganizationId(targetOrganizationId,opts){opts=opts||{};// verify the required parameter 'targetOrganizationId' is set
|
|
24793
|
+
if(targetOrganizationId===undefined||targetOrganizationId===null||targetOrganizationId===''){throw'Missing the required parameter "targetOrganizationId" when calling deleteTelephonyOrganizationLinkTargetOrganizationId';}return this.apiClient.callApi('/api/v2/telephony/organization/link/{targetOrganizationId}','DELETE',{'targetOrganizationId':targetOrganizationId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
24668
24794
|
* Get an agent's greetings.
|
|
24669
24795
|
*
|
|
24670
24796
|
* @param {String} agentId User ID
|
|
24671
24797
|
* @param {Object} opts Optional parameters
|
|
24672
24798
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
24673
|
-
*/
|
|
24799
|
+
*/},{key:"getTelephonyAgentGreetings",value:function getTelephonyAgentGreetings(agentId,opts){opts=opts||{};// verify the required parameter 'agentId' is set
|
|
24674
24800
|
if(agentId===undefined||agentId===null||agentId===''){throw'Missing the required parameter "agentId" when calling getTelephonyAgentGreetings';}return this.apiClient.callApi('/api/v2/telephony/agents/{agentId}/greetings','GET',{'agentId':agentId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
24675
24801
|
* Get the agent's own greetings.
|
|
24676
24802
|
*
|
|
@@ -24688,6 +24814,28 @@ if(agentId===undefined||agentId===null||agentId===''){throw'Missing the required
|
|
|
24688
24814
|
* @param {Object} opts Optional parameters
|
|
24689
24815
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
24690
24816
|
*/},{key:"getTelephonyMediaregions",value:function getTelephonyMediaregions(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/telephony/mediaregions','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
24817
|
+
* Get Number Routings by organizationId
|
|
24818
|
+
*
|
|
24819
|
+
* @param {Object} opts Optional parameters
|
|
24820
|
+
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
24821
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
24822
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
24823
|
+
* @param {String} opts.numberId numberId
|
|
24824
|
+
* @param {String} opts.activeRoutingOrganizationId activeRoutingOrganizationId
|
|
24825
|
+
* @param {String} opts.ownerOrganizationId ownerOrganizationId
|
|
24826
|
+
* @param {Object} opts.status status
|
|
24827
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
24828
|
+
*/},{key:"getTelephonyNumbersRouting",value:function getTelephonyNumbersRouting(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/telephony/numbers/routing','GET',{},{'before':opts['before'],'after':opts['after'],'pageSize':opts['pageSize'],'numberId':opts['numberId'],'activeRoutingOrganizationId':opts['activeRoutingOrganizationId'],'ownerOrganizationId':opts['ownerOrganizationId'],'status':opts['status']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
24829
|
+
* Get organization links
|
|
24830
|
+
*
|
|
24831
|
+
* @param {Object} opts Optional parameters
|
|
24832
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
24833
|
+
*/},{key:"getTelephonyOrganizationLink",value:function getTelephonyOrganizationLink(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/telephony/organization/link','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
24834
|
+
* Get all the replica regions by primary region
|
|
24835
|
+
*
|
|
24836
|
+
* @param {Object} opts Optional parameters
|
|
24837
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
24838
|
+
*/},{key:"getTelephonyOrganizationLinkRegions",value:function getTelephonyOrganizationLinkRegions(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/telephony/organization/link/regions','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
24691
24839
|
* Get the global telephony configuration.
|
|
24692
24840
|
*
|
|
24693
24841
|
* @param {Object} opts Optional parameters
|
|
@@ -24728,6 +24876,43 @@ if(dateEnd===undefined||dateEnd===null){throw'Missing the required parameter "da
|
|
|
24728
24876
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
24729
24877
|
*/},{key:"getTelephonySiptracesDownloadDownloadId",value:function getTelephonySiptracesDownloadDownloadId(downloadId,opts){opts=opts||{};// verify the required parameter 'downloadId' is set
|
|
24730
24878
|
if(downloadId===undefined||downloadId===null||downloadId===''){throw'Missing the required parameter "downloadId" when calling getTelephonySiptracesDownloadDownloadId';}return this.apiClient.callApi('/api/v2/telephony/siptraces/download/{downloadId}','GET',{'downloadId':downloadId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
24879
|
+
* Approving a requested link
|
|
24880
|
+
*
|
|
24881
|
+
* @param {String} requestingOrganizationId requestingOrganizationId
|
|
24882
|
+
* @param {Object} body Approval request body
|
|
24883
|
+
* @param {Object} opts Optional parameters
|
|
24884
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
24885
|
+
*/},{key:"patchTelephonyOrganizationLinkApproveRequestingOrganizationId",value:function patchTelephonyOrganizationLinkApproveRequestingOrganizationId(requestingOrganizationId,body,opts){opts=opts||{};// verify the required parameter 'requestingOrganizationId' is set
|
|
24886
|
+
if(requestingOrganizationId===undefined||requestingOrganizationId===null||requestingOrganizationId===''){throw'Missing the required parameter "requestingOrganizationId" when calling patchTelephonyOrganizationLinkApproveRequestingOrganizationId';}// verify the required parameter 'body' is set
|
|
24887
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling patchTelephonyOrganizationLinkApproveRequestingOrganizationId';}return this.apiClient.callApi('/api/v2/telephony/organization/link/approve/{requestingOrganizationId}','PATCH',{'requestingOrganizationId':requestingOrganizationId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
24888
|
+
* Update the routing of numbers for one or multiple organizations
|
|
24889
|
+
*
|
|
24890
|
+
* @param {Array.<Object>} body drRoutingList
|
|
24891
|
+
* @param {Object} opts Optional parameters
|
|
24892
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
24893
|
+
*/},{key:"postTelephonyNumbersRouting",value:function postTelephonyNumbersRouting(body,opts){opts=opts||{};// verify the required parameter 'body' is set
|
|
24894
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postTelephonyNumbersRouting';}return this.apiClient.callApi('/api/v2/telephony/numbers/routing','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
24895
|
+
* Re-route all numbers on an organization
|
|
24896
|
+
*
|
|
24897
|
+
* @param {Object} body Value for all routing request body
|
|
24898
|
+
* @param {Object} opts Optional parameters
|
|
24899
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
24900
|
+
*/},{key:"postTelephonyNumbersRoutingAll",value:function postTelephonyNumbersRoutingAll(body,opts){opts=opts||{};// verify the required parameter 'body' is set
|
|
24901
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postTelephonyNumbersRoutingAll';}return this.apiClient.callApi('/api/v2/telephony/numbers/routing/all','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
24902
|
+
* Reset routing for organization
|
|
24903
|
+
*
|
|
24904
|
+
* @param {Object} body Value for bulk routing request body
|
|
24905
|
+
* @param {Object} opts Optional parameters
|
|
24906
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
24907
|
+
*/},{key:"postTelephonyNumbersRoutingReset",value:function postTelephonyNumbersRoutingReset(body,opts){opts=opts||{};// verify the required parameter 'body' is set
|
|
24908
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postTelephonyNumbersRoutingReset';}return this.apiClient.callApi('/api/v2/telephony/numbers/routing/reset','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
24909
|
+
* Create a link with an organization
|
|
24910
|
+
*
|
|
24911
|
+
* @param {Object} body CreateLinkOrg body
|
|
24912
|
+
* @param {Object} opts Optional parameters
|
|
24913
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
24914
|
+
*/},{key:"postTelephonyOrganizationLink",value:function postTelephonyOrganizationLink(body,opts){opts=opts||{};// verify the required parameter 'body' is set
|
|
24915
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postTelephonyOrganizationLink';}return this.apiClient.callApi('/api/v2/telephony/organization/link','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
24731
24916
|
* Request a download of a pcap file to S3
|
|
24732
24917
|
*
|
|
24733
24918
|
* @param {Object} sIPSearchPublicRequest
|
|
@@ -24760,7 +24945,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
24760
24945
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putTelephonySettings';}return this.apiClient.callApi('/api/v2/telephony/settings','PUT',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}}]);}();var TelephonyProvidersEdgeApi=/*#__PURE__*/function(){/**
|
|
24761
24946
|
* TelephonyProvidersEdge service.
|
|
24762
24947
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
24763
|
-
* @version
|
|
24948
|
+
* @version 254.0.0
|
|
24764
24949
|
*//**
|
|
24765
24950
|
* Constructs a new TelephonyProvidersEdgeApi.
|
|
24766
24951
|
* @alias module:purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
@@ -25614,20 +25799,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
25614
25799
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
25615
25800
|
*/},{key:"postTelephonyProvidersEdgesExtensionpools",value:function postTelephonyProvidersEdgesExtensionpools(body,opts){opts=opts||{};// verify the required parameter 'body' is set
|
|
25616
25801
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postTelephonyProvidersEdgesExtensionpools';}return this.apiClient.callApi('/api/v2/telephony/providers/edges/extensionpools','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
25617
|
-
* Post media endpoint statistics event.
|
|
25618
|
-
*
|
|
25619
|
-
* @param {String} conversationId Identifier of the conversation
|
|
25620
|
-
* @param {String} communicationId Identifier of the media session
|
|
25621
|
-
* @param {String} mediaResourceId Identifier of the media resource of the endpoint
|
|
25622
|
-
* @param {Object} body MediaStatisticsPostRequest
|
|
25623
|
-
* @param {Object} opts Optional parameters
|
|
25624
|
-
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
25625
|
-
* postTelephonyProvidersEdgesMediastatisticsConversationCommunicationMediaresource is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
25626
|
-
*/},{key:"postTelephonyProvidersEdgesMediastatisticsConversationCommunicationMediaresource",value:function postTelephonyProvidersEdgesMediastatisticsConversationCommunicationMediaresource(conversationId,communicationId,mediaResourceId,body,opts){opts=opts||{};// verify the required parameter 'conversationId' is set
|
|
25627
|
-
if(conversationId===undefined||conversationId===null||conversationId===''){throw'Missing the required parameter "conversationId" when calling postTelephonyProvidersEdgesMediastatisticsConversationCommunicationMediaresource';}// verify the required parameter 'communicationId' is set
|
|
25628
|
-
if(communicationId===undefined||communicationId===null||communicationId===''){throw'Missing the required parameter "communicationId" when calling postTelephonyProvidersEdgesMediastatisticsConversationCommunicationMediaresource';}// verify the required parameter 'mediaResourceId' is set
|
|
25629
|
-
if(mediaResourceId===undefined||mediaResourceId===null||mediaResourceId===''){throw'Missing the required parameter "mediaResourceId" when calling postTelephonyProvidersEdgesMediastatisticsConversationCommunicationMediaresource';}// verify the required parameter 'body' is set
|
|
25630
|
-
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postTelephonyProvidersEdgesMediastatisticsConversationCommunicationMediaresource';}return this.apiClient.callApi('/api/v2/telephony/providers/edges/mediastatistics/conversations/{conversationId}/communications/{communicationId}/mediaresources/{mediaResourceId}','POST',{'conversationId':conversationId,'communicationId':communicationId,'mediaResourceId':mediaResourceId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
25631
25802
|
* Reboot a Phone
|
|
25632
25803
|
*
|
|
25633
25804
|
* @param {String} phoneId Phone Id
|
|
@@ -25827,7 +25998,7 @@ if(trunkBaseSettingsId===undefined||trunkBaseSettingsId===null||trunkBaseSetting
|
|
|
25827
25998
|
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'],opts['customHeaders']);}}]);}();var TextbotsApi=/*#__PURE__*/function(){/**
|
|
25828
25999
|
* Textbots service.
|
|
25829
26000
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
25830
|
-
* @version
|
|
26001
|
+
* @version 254.0.0
|
|
25831
26002
|
*//**
|
|
25832
26003
|
* Constructs a new TextbotsApi.
|
|
25833
26004
|
* @alias module:purecloud-platform-client-v2/api/TextbotsApi
|
|
@@ -25870,7 +26041,7 @@ if(launchRequest===undefined||launchRequest===null){throw'Missing the required p
|
|
|
25870
26041
|
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'],opts['customHeaders']);}}]);}();var TokensApi=/*#__PURE__*/function(){/**
|
|
25871
26042
|
* Tokens service.
|
|
25872
26043
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
25873
|
-
* @version
|
|
26044
|
+
* @version 254.0.0
|
|
25874
26045
|
*//**
|
|
25875
26046
|
* Constructs a new TokensApi.
|
|
25876
26047
|
* @alias module:purecloud-platform-client-v2/api/TokensApi
|
|
@@ -25914,7 +26085,7 @@ if(userId===undefined||userId===null||userId===''){throw'Missing the required pa
|
|
|
25914
26085
|
*/},{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'],opts['customHeaders']);}}]);}();var UploadsApi=/*#__PURE__*/function(){/**
|
|
25915
26086
|
* Uploads service.
|
|
25916
26087
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
25917
|
-
* @version
|
|
26088
|
+
* @version 254.0.0
|
|
25918
26089
|
*//**
|
|
25919
26090
|
* Constructs a new UploadsApi.
|
|
25920
26091
|
* @alias module:purecloud-platform-client-v2/api/UploadsApi
|
|
@@ -26009,7 +26180,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
26009
26180
|
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'],opts['customHeaders']);}}]);}();var UsageApi=/*#__PURE__*/function(){/**
|
|
26010
26181
|
* Usage service.
|
|
26011
26182
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
26012
|
-
* @version
|
|
26183
|
+
* @version 254.0.0
|
|
26013
26184
|
*//**
|
|
26014
26185
|
* Constructs a new UsageApi.
|
|
26015
26186
|
* @alias module:purecloud-platform-client-v2/api/UsageApi
|
|
@@ -26111,7 +26282,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
26111
26282
|
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'],opts['customHeaders']);}}]);}();var UserRecordingsApi=/*#__PURE__*/function(){/**
|
|
26112
26283
|
* UserRecordings service.
|
|
26113
26284
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
26114
|
-
* @version
|
|
26285
|
+
* @version 254.0.0
|
|
26115
26286
|
*//**
|
|
26116
26287
|
* Constructs a new UserRecordingsApi.
|
|
26117
26288
|
* @alias module:purecloud-platform-client-v2/api/UserRecordingsApi
|
|
@@ -26167,7 +26338,7 @@ if(recordingId===undefined||recordingId===null||recordingId===''){throw'Missing
|
|
|
26167
26338
|
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'],opts['customHeaders']);}}]);}();var UsersApi=/*#__PURE__*/function(){/**
|
|
26168
26339
|
* Users service.
|
|
26169
26340
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
26170
|
-
* @version
|
|
26341
|
+
* @version 254.0.0
|
|
26171
26342
|
*//**
|
|
26172
26343
|
* Constructs a new UsersApi.
|
|
26173
26344
|
* @alias module:purecloud-platform-client-v2/api/UsersApi
|
|
@@ -26180,7 +26351,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
26180
26351
|
* @param {String} jobId jobId
|
|
26181
26352
|
* @param {Object} opts Optional parameters
|
|
26182
26353
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
26183
|
-
* deleteAnalyticsUsersAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
26184
26354
|
*/return _createClass(UsersApi,[{key:"deleteAnalyticsUsersAggregatesJob",value:function deleteAnalyticsUsersAggregatesJob(jobId,opts){opts=opts||{};// verify the required parameter 'jobId' is set
|
|
26185
26355
|
if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required parameter "jobId" when calling deleteAnalyticsUsersAggregatesJob';}return this.apiClient.callApi('/api/v2/analytics/users/aggregates/jobs/{jobId}','DELETE',{'jobId':jobId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
26186
26356
|
* Delete/cancel an async request
|
|
@@ -26305,7 +26475,6 @@ if(schemaId===undefined||schemaId===null||schemaId===''){throw'Missing the requi
|
|
|
26305
26475
|
* @param {String} jobId jobId
|
|
26306
26476
|
* @param {Object} opts Optional parameters
|
|
26307
26477
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
26308
|
-
* getAnalyticsUsersAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
26309
26478
|
*/},{key:"getAnalyticsUsersAggregatesJob",value:function getAnalyticsUsersAggregatesJob(jobId,opts){opts=opts||{};// verify the required parameter 'jobId' is set
|
|
26310
26479
|
if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required parameter "jobId" when calling getAnalyticsUsersAggregatesJob';}return this.apiClient.callApi('/api/v2/analytics/users/aggregates/jobs/{jobId}','GET',{'jobId':jobId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
26311
26480
|
* Fetch a page of results for an async aggregates query
|
|
@@ -26314,7 +26483,6 @@ if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required param
|
|
|
26314
26483
|
* @param {Object} opts Optional parameters
|
|
26315
26484
|
* @param {String} opts.cursor Cursor token to retrieve next page
|
|
26316
26485
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
26317
|
-
* getAnalyticsUsersAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
26318
26486
|
*/},{key:"getAnalyticsUsersAggregatesJobResults",value:function getAnalyticsUsersAggregatesJobResults(jobId,opts){opts=opts||{};// verify the required parameter 'jobId' is set
|
|
26319
26487
|
if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required parameter "jobId" when calling getAnalyticsUsersAggregatesJobResults';}return this.apiClient.callApi('/api/v2/analytics/users/aggregates/jobs/{jobId}/results','GET',{'jobId':jobId},{'cursor':opts['cursor']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
26320
26488
|
* Get status for async query for user details
|
|
@@ -26900,7 +27068,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
26900
27068
|
* @param {Object} body query
|
|
26901
27069
|
* @param {Object} opts Optional parameters
|
|
26902
27070
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
26903
|
-
* postAnalyticsUsersAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
26904
27071
|
*/},{key:"postAnalyticsUsersAggregatesJobs",value:function postAnalyticsUsersAggregatesJobs(body,opts){opts=opts||{};// verify the required parameter 'body' is set
|
|
26905
27072
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postAnalyticsUsersAggregatesJobs';}return this.apiClient.callApi('/api/v2/analytics/users/aggregates/jobs','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
26906
27073
|
* Query for user aggregates
|
|
@@ -27229,7 +27396,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
27229
27396
|
if(stationId===undefined||stationId===null||stationId===''){throw'Missing the required parameter "stationId" when calling putUsersStationsMeAssociatedstationStationId';}return this.apiClient.callApi('/api/v2/users/stations/me/associatedstation/{stationId}','PUT',{'stationId':stationId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}}]);}();var UsersRulesApi=/*#__PURE__*/function(){/**
|
|
27230
27397
|
* UsersRules service.
|
|
27231
27398
|
* @module purecloud-platform-client-v2/api/UsersRulesApi
|
|
27232
|
-
* @version
|
|
27399
|
+
* @version 254.0.0
|
|
27233
27400
|
*//**
|
|
27234
27401
|
* Constructs a new UsersRulesApi.
|
|
27235
27402
|
* @alias module:purecloud-platform-client-v2/api/UsersRulesApi
|
|
@@ -27319,7 +27486,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
27319
27486
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postUsersRulesQuery';}return this.apiClient.callApi('/api/v2/users/rules/query','POST',{},{'pageNumber':opts['pageNumber'],'pageSize':opts['pageSize']},{},{},body,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}}]);}();var UtilitiesApi=/*#__PURE__*/function(){/**
|
|
27320
27487
|
* Utilities service.
|
|
27321
27488
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
27322
|
-
* @version
|
|
27489
|
+
* @version 254.0.0
|
|
27323
27490
|
*//**
|
|
27324
27491
|
* Constructs a new UtilitiesApi.
|
|
27325
27492
|
* @alias module:purecloud-platform-client-v2/api/UtilitiesApi
|
|
@@ -27353,7 +27520,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
27353
27520
|
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'],opts['customHeaders']);}}]);}();var VoicemailApi=/*#__PURE__*/function(){/**
|
|
27354
27521
|
* Voicemail service.
|
|
27355
27522
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
27356
|
-
* @version
|
|
27523
|
+
* @version 254.0.0
|
|
27357
27524
|
*//**
|
|
27358
27525
|
* Constructs a new VoicemailApi.
|
|
27359
27526
|
* @alias module:purecloud-platform-client-v2/api/VoicemailApi
|
|
@@ -27560,7 +27727,7 @@ if(userId===undefined||userId===null||userId===''){throw'Missing the required pa
|
|
|
27560
27727
|
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'],opts['customHeaders']);}}]);}();var WebChatApi=/*#__PURE__*/function(){/**
|
|
27561
27728
|
* WebChat service.
|
|
27562
27729
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
27563
|
-
* @version
|
|
27730
|
+
* @version 254.0.0
|
|
27564
27731
|
*//**
|
|
27565
27732
|
* Constructs a new WebChatApi.
|
|
27566
27733
|
* @alias module:purecloud-platform-client-v2/api/WebChatApi
|
|
@@ -27743,7 +27910,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
27743
27910
|
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'],opts['customHeaders']);}}]);}();var WebDeploymentsApi=/*#__PURE__*/function(){/**
|
|
27744
27911
|
* WebDeployments service.
|
|
27745
27912
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
27746
|
-
* @version
|
|
27913
|
+
* @version 254.0.0
|
|
27747
27914
|
*//**
|
|
27748
27915
|
* Constructs a new WebDeploymentsApi.
|
|
27749
27916
|
* @alias module:purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
@@ -27921,7 +28088,7 @@ if(deploymentId===undefined||deploymentId===null||deploymentId===''){throw'Missi
|
|
|
27921
28088
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putWebdeploymentsDeploymentIdentityresolution';}return this.apiClient.callApi('/api/v2/webdeployments/deployments/{deploymentId}/identityresolution','PUT',{'deploymentId':deploymentId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}}]);}();var WebMessagingApi=/*#__PURE__*/function(){/**
|
|
27922
28089
|
* WebMessaging service.
|
|
27923
28090
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
27924
|
-
* @version
|
|
28091
|
+
* @version 254.0.0
|
|
27925
28092
|
*//**
|
|
27926
28093
|
* Constructs a new WebMessagingApi.
|
|
27927
28094
|
* @alias module:purecloud-platform-client-v2/api/WebMessagingApi
|
|
@@ -27969,7 +28136,7 @@ if(tokenId===undefined||tokenId===null||tokenId===''){throw'Missing the required
|
|
|
27969
28136
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postWebmessagingDeploymentPushdevice';}return this.apiClient.callApi('/api/v2/webmessaging/deployments/{deploymentId}/pushdevices/{tokenId}','POST',{'deploymentId':deploymentId,'tokenId':tokenId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}}]);}();var WidgetsApi=/*#__PURE__*/function(){/**
|
|
27970
28137
|
* Widgets service.
|
|
27971
28138
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
27972
|
-
* @version
|
|
28139
|
+
* @version 254.0.0
|
|
27973
28140
|
*//**
|
|
27974
28141
|
* Constructs a new WidgetsApi.
|
|
27975
28142
|
* @alias module:purecloud-platform-client-v2/api/WidgetsApi
|
|
@@ -28019,7 +28186,7 @@ if(deploymentId===undefined||deploymentId===null||deploymentId===''){throw'Missi
|
|
|
28019
28186
|
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'],opts['customHeaders']);}}]);}();var WorkforceManagementApi=/*#__PURE__*/function(){/**
|
|
28020
28187
|
* WorkforceManagement service.
|
|
28021
28188
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
28022
|
-
* @version
|
|
28189
|
+
* @version 254.0.0
|
|
28023
28190
|
*//**
|
|
28024
28191
|
* Constructs a new WorkforceManagementApi.
|
|
28025
28192
|
* @alias module:purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
@@ -28494,6 +28661,16 @@ if(businessUnitId===undefined||businessUnitId===null||businessUnitId===''){throw
|
|
|
28494
28661
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
28495
28662
|
*/},{key:"getWorkforcemanagementBusinessunitMinimumstaffingSettings",value:function getWorkforcemanagementBusinessunitMinimumstaffingSettings(businessUnitId,opts){opts=opts||{};// verify the required parameter 'businessUnitId' is set
|
|
28496
28663
|
if(businessUnitId===undefined||businessUnitId===null||businessUnitId===''){throw'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitMinimumstaffingSettings';}return this.apiClient.callApi('/api/v2/workforcemanagement/businessunits/{businessUnitId}/minimumstaffing/settings','GET',{'businessUnitId':businessUnitId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
28664
|
+
* Get opportunity details
|
|
28665
|
+
*
|
|
28666
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
28667
|
+
* @param {String} opportunityId The ID of the opportunity
|
|
28668
|
+
* @param {Object} opts Optional parameters
|
|
28669
|
+
* @param {Object} opts.expand List of resources to expand
|
|
28670
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
28671
|
+
*/},{key:"getWorkforcemanagementBusinessunitOpportunity",value:function getWorkforcemanagementBusinessunitOpportunity(businessUnitId,opportunityId,opts){opts=opts||{};// verify the required parameter 'businessUnitId' is set
|
|
28672
|
+
if(businessUnitId===undefined||businessUnitId===null||businessUnitId===''){throw'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitOpportunity';}// verify the required parameter 'opportunityId' is set
|
|
28673
|
+
if(opportunityId===undefined||opportunityId===null||opportunityId===''){throw'Missing the required parameter "opportunityId" when calling getWorkforcemanagementBusinessunitOpportunity';}return this.apiClient.callApi('/api/v2/workforcemanagement/businessunits/{businessUnitId}/opportunities/{opportunityId}','GET',{'businessUnitId':businessUnitId,'opportunityId':opportunityId},{'expand':opts['expand']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
28497
28674
|
* Get a planning group
|
|
28498
28675
|
*
|
|
28499
28676
|
* @param {String} businessUnitId The ID of the business unit.
|
|
@@ -28659,9 +28836,10 @@ if(timeOffPlanId===undefined||timeOffPlanId===null||timeOffPlanId===''){throw'Mi
|
|
|
28659
28836
|
* @param {Object} opts Optional parameters
|
|
28660
28837
|
* @param {String} opts.managementUnitId The ID of the management unit to get management unit specific staffing groups
|
|
28661
28838
|
* @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
|
|
28839
|
+
* @param {Array.<String>} opts.expand Include to access additional data for the time-off plans
|
|
28662
28840
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
28663
28841
|
*/},{key:"getWorkforcemanagementBusinessunitTimeoffplans",value:function getWorkforcemanagementBusinessunitTimeoffplans(businessUnitId,opts){opts=opts||{};// verify the required parameter 'businessUnitId' is set
|
|
28664
|
-
if(businessUnitId===undefined||businessUnitId===null||businessUnitId===''){throw'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitTimeoffplans';}return this.apiClient.callApi('/api/v2/workforcemanagement/businessunits/{businessUnitId}/timeoffplans','GET',{'businessUnitId':businessUnitId},{'managementUnitId':opts['managementUnitId'],'forceDownloadService':opts['forceDownloadService']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
28842
|
+
if(businessUnitId===undefined||businessUnitId===null||businessUnitId===''){throw'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitTimeoffplans';}return this.apiClient.callApi('/api/v2/workforcemanagement/businessunits/{businessUnitId}/timeoffplans','GET',{'businessUnitId':businessUnitId},{'managementUnitId':opts['managementUnitId'],'forceDownloadService':opts['forceDownloadService'],'expand':this.apiClient.buildCollectionParam(opts['expand'],'multi')},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
28665
28843
|
* Get users in the business unit
|
|
28666
28844
|
*
|
|
28667
28845
|
* @param {String} businessUnitId The ID of the business unit
|
|
@@ -28747,12 +28925,14 @@ if(recalculationId===undefined||recalculationId===null||recalculationId===''){th
|
|
|
28747
28925
|
* @param {String} businessUnitId The ID of the business unit
|
|
28748
28926
|
* @param {String} weekId First day of schedule week in yyyy-MM-dd format, or 'recent' (without quotes) to get recent schedules
|
|
28749
28927
|
* @param {Object} opts Optional parameters
|
|
28928
|
+
* @param {String} opts.earliestWeekDate If weekId == 'recent', specify the earliest schedule start week date (inclusive) to include in the 'recent' range, in yyyy-MM-dd format. Ignored if weekId != 'recent'. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
28929
|
+
* @param {String} opts.latestWeekDate If weekId == 'recent', specify the latest schedule start week date (inclusive) to include in the 'recent' range, in yyyy-MM-dd format. Ignored if weekId != 'recent'. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
28750
28930
|
* @param {Boolean} opts.includeOnlyPublished includeOnlyPublished
|
|
28751
28931
|
* @param {Object} opts.expand expand
|
|
28752
28932
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
28753
28933
|
*/},{key:"getWorkforcemanagementBusinessunitWeekSchedules",value:function getWorkforcemanagementBusinessunitWeekSchedules(businessUnitId,weekId,opts){opts=opts||{};// verify the required parameter 'businessUnitId' is set
|
|
28754
28934
|
if(businessUnitId===undefined||businessUnitId===null||businessUnitId===''){throw'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitWeekSchedules';}// verify the required parameter 'weekId' is set
|
|
28755
|
-
if(weekId===undefined||weekId===null||weekId===''){throw'Missing the required parameter "weekId" when calling getWorkforcemanagementBusinessunitWeekSchedules';}return this.apiClient.callApi('/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules','GET',{'businessUnitId':businessUnitId,'weekId':weekId},{'includeOnlyPublished':opts['includeOnlyPublished'],'expand':opts['expand']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
28935
|
+
if(weekId===undefined||weekId===null||weekId===''){throw'Missing the required parameter "weekId" when calling getWorkforcemanagementBusinessunitWeekSchedules';}return this.apiClient.callApi('/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules','GET',{'businessUnitId':businessUnitId,'weekId':weekId},{'earliestWeekDate':opts['earliestWeekDate'],'latestWeekDate':opts['latestWeekDate'],'includeOnlyPublished':opts['includeOnlyPublished'],'expand':opts['expand']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
28756
28936
|
* Get a short term forecast
|
|
28757
28937
|
*
|
|
28758
28938
|
* @param {String} businessUnitId The ID of the business unit to which the forecast belongs
|
|
@@ -28978,19 +29158,21 @@ if(managementUnitId===undefined||managementUnitId===null||managementUnitId==='')
|
|
|
28978
29158
|
if(managementUnitId===undefined||managementUnitId===null||managementUnitId===''){throw'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitAgent';}// verify the required parameter 'agentId' is set
|
|
28979
29159
|
if(agentId===undefined||agentId===null||agentId===''){throw'Missing the required parameter "agentId" when calling getWorkforcemanagementManagementunitAgent';}return this.apiClient.callApi('/api/v2/workforcemanagement/managementunits/{managementUnitId}/agents/{agentId}','GET',{'managementUnitId':managementUnitId,'agentId':agentId},{'excludeCapabilities':opts['excludeCapabilities'],'expand':this.apiClient.buildCollectionParam(opts['expand'],'multi')},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
28980
29160
|
* Gets all the shift trades for a given agent
|
|
28981
|
-
*
|
|
29161
|
+
* Deprecated. Use new route instead (/businessunits/{businessUnitId}/shifttrading/trades/query/jobs)
|
|
28982
29162
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
28983
29163
|
* @param {String} agentId The agent id
|
|
28984
29164
|
* @param {Object} opts Optional parameters
|
|
28985
29165
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
29166
|
+
* @deprecated
|
|
28986
29167
|
*/},{key:"getWorkforcemanagementManagementunitAgentShifttrades",value:function getWorkforcemanagementManagementunitAgentShifttrades(managementUnitId,agentId,opts){opts=opts||{};// verify the required parameter 'managementUnitId' is set
|
|
28987
29168
|
if(managementUnitId===undefined||managementUnitId===null||managementUnitId===''){throw'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitAgentShifttrades';}// verify the required parameter 'agentId' is set
|
|
28988
29169
|
if(agentId===undefined||agentId===null||agentId===''){throw'Missing the required parameter "agentId" when calling getWorkforcemanagementManagementunitAgentShifttrades';}return this.apiClient.callApi('/api/v2/workforcemanagement/managementunits/{managementUnitId}/agents/{agentId}/shifttrades','GET',{'managementUnitId':managementUnitId,'agentId':agentId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
28989
29170
|
* Gets a summary of all shift trades in the matched state
|
|
28990
|
-
*
|
|
29171
|
+
* Deprecated. Use new route instead (/businessunits/{businessUnitId}/shifttrading/weeks/summary/jobs)
|
|
28991
29172
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
28992
29173
|
* @param {Object} opts Optional parameters
|
|
28993
29174
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
29175
|
+
* @deprecated
|
|
28994
29176
|
*/},{key:"getWorkforcemanagementManagementunitShifttradesMatched",value:function getWorkforcemanagementManagementunitShifttradesMatched(managementUnitId,opts){opts=opts||{};// verify the required parameter 'managementUnitId' is set
|
|
28995
29177
|
if(managementUnitId===undefined||managementUnitId===null||managementUnitId===''){throw'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitShifttradesMatched';}return this.apiClient.callApi('/api/v2/workforcemanagement/managementunits/{managementUnitId}/shifttrades/matched','GET',{'managementUnitId':managementUnitId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
28996
29178
|
* Gets list of users available for whom you can send direct shift trade requests
|
|
@@ -29098,7 +29280,7 @@ if(scheduleId===undefined||scheduleId===null||scheduleId===''){throw'Missing the
|
|
|
29098
29280
|
if(managementUnitId===undefined||managementUnitId===null||managementUnitId===''){throw'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitWeekSchedules';}// verify the required parameter 'weekId' is set
|
|
29099
29281
|
if(weekId===undefined||weekId===null||weekId===''){throw'Missing the required parameter "weekId" when calling getWorkforcemanagementManagementunitWeekSchedules';}return this.apiClient.callApi('/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekId}/schedules','GET',{'managementUnitId':managementUnitId,'weekId':weekId},{'includeOnlyPublished':opts['includeOnlyPublished'],'earliestWeekDate':opts['earliestWeekDate'],'latestWeekDate':opts['latestWeekDate']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
29100
29282
|
* Gets all the shift trades for a given week
|
|
29101
|
-
*
|
|
29283
|
+
* Deprecated. Use new route instead (/businessunits/{businessUnitId}/shifttrading/trades/evaluate/jobs)
|
|
29102
29284
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
29103
29285
|
* @param {String} weekDateId The start week date of the initiating shift in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
29104
29286
|
* @param {Object} opts Optional parameters
|
|
@@ -29106,6 +29288,7 @@ if(weekId===undefined||weekId===null||weekId===''){throw'Missing the required pa
|
|
|
29106
29288
|
* @param {Boolean} opts.includeCrossWeekShifts Whether to include all shift trades with either the initiating shift or the receiving shift in the week (default to false)
|
|
29107
29289
|
* @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
|
|
29108
29290
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
29291
|
+
* @deprecated
|
|
29109
29292
|
*/},{key:"getWorkforcemanagementManagementunitWeekShifttrades",value:function getWorkforcemanagementManagementunitWeekShifttrades(managementUnitId,weekDateId,opts){opts=opts||{};// verify the required parameter 'managementUnitId' is set
|
|
29110
29293
|
if(managementUnitId===undefined||managementUnitId===null||managementUnitId===''){throw'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitWeekShifttrades';}// verify the required parameter 'weekDateId' is set
|
|
29111
29294
|
if(weekDateId===undefined||weekDateId===null){throw'Missing the required parameter "weekDateId" when calling getWorkforcemanagementManagementunitWeekShifttrades';}return this.apiClient.callApi('/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shifttrades','GET',{'managementUnitId':managementUnitId,'weekDateId':weekDateId},{'evaluateMatches':opts['evaluateMatches'],'includeCrossWeekShifts':opts['includeCrossWeekShifts'],'forceDownloadService':opts['forceDownloadService']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
@@ -29174,9 +29357,10 @@ if(managementUnitId===undefined||managementUnitId===null||managementUnitId==='')
|
|
|
29174
29357
|
*/},{key:"getWorkforcemanagementSchedulingjob",value:function getWorkforcemanagementSchedulingjob(jobId,opts){opts=opts||{};// verify the required parameter 'jobId' is set
|
|
29175
29358
|
if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required parameter "jobId" when calling getWorkforcemanagementSchedulingjob';}return this.apiClient.callApi('/api/v2/workforcemanagement/schedulingjobs/{jobId}','GET',{'jobId':jobId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
29176
29359
|
* Gets all of my shift trades
|
|
29177
|
-
*
|
|
29360
|
+
* Deprecated. Use new route instead (/shifttrading/trades/mine/query/jobs)
|
|
29178
29361
|
* @param {Object} opts Optional parameters
|
|
29179
29362
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
29363
|
+
* @deprecated
|
|
29180
29364
|
*/},{key:"getWorkforcemanagementShifttrades",value:function getWorkforcemanagementShifttrades(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/workforcemanagement/shifttrades','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
29181
29365
|
* View result of update trade operation. Only the user who started the operation can query the status
|
|
29182
29366
|
* Job details are only retained if the initial request returned a 202 ACCEPTED response
|
|
@@ -29385,8 +29569,19 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
29385
29569
|
*/},{key:"patchWorkforcemanagementBusinessunitMinimumstaffingSettings",value:function patchWorkforcemanagementBusinessunitMinimumstaffingSettings(businessUnitId,body,opts){opts=opts||{};// verify the required parameter 'businessUnitId' is set
|
|
29386
29570
|
if(businessUnitId===undefined||businessUnitId===null||businessUnitId===''){throw'Missing the required parameter "businessUnitId" when calling patchWorkforcemanagementBusinessunitMinimumstaffingSettings';}// verify the required parameter 'body' is set
|
|
29387
29571
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling patchWorkforcemanagementBusinessunitMinimumstaffingSettings';}return this.apiClient.callApi('/api/v2/workforcemanagement/businessunits/{businessUnitId}/minimumstaffing/settings','PATCH',{'businessUnitId':businessUnitId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
29572
|
+
* Update the opportunity
|
|
29573
|
+
* Only opportunities with Draft status can be updated.
|
|
29574
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
29575
|
+
* @param {String} opportunityId The ID of the opportunity
|
|
29576
|
+
* @param {Object} body body
|
|
29577
|
+
* @param {Object} opts Optional parameters
|
|
29578
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
29579
|
+
*/},{key:"patchWorkforcemanagementBusinessunitOpportunity",value:function patchWorkforcemanagementBusinessunitOpportunity(businessUnitId,opportunityId,body,opts){opts=opts||{};// verify the required parameter 'businessUnitId' is set
|
|
29580
|
+
if(businessUnitId===undefined||businessUnitId===null||businessUnitId===''){throw'Missing the required parameter "businessUnitId" when calling patchWorkforcemanagementBusinessunitOpportunity';}// verify the required parameter 'opportunityId' is set
|
|
29581
|
+
if(opportunityId===undefined||opportunityId===null||opportunityId===''){throw'Missing the required parameter "opportunityId" when calling patchWorkforcemanagementBusinessunitOpportunity';}// verify the required parameter 'body' is set
|
|
29582
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling patchWorkforcemanagementBusinessunitOpportunity';}return this.apiClient.callApi('/api/v2/workforcemanagement/businessunits/{businessUnitId}/opportunities/{opportunityId}','PATCH',{'businessUnitId':businessUnitId,'opportunityId':opportunityId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
29388
29583
|
* Updates the planning group
|
|
29389
|
-
*
|
|
29584
|
+
* If the request body contains queue references in route paths, routing:queue:view is required in each referenced queues division.
|
|
29390
29585
|
* @param {String} businessUnitId The ID of the business unit.
|
|
29391
29586
|
* @param {String} planningGroupId The ID of a planning group to update
|
|
29392
29587
|
* @param {Object} body body
|
|
@@ -29571,13 +29766,14 @@ if(userId===undefined||userId===null||userId===''){throw'Missing the required pa
|
|
|
29571
29766
|
if(timeOffRequestId===undefined||timeOffRequestId===null||timeOffRequestId===''){throw'Missing the required parameter "timeOffRequestId" when calling patchWorkforcemanagementManagementunitUserTimeoffrequest';}// verify the required parameter 'body' is set
|
|
29572
29767
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling patchWorkforcemanagementManagementunitUserTimeoffrequest';}return this.apiClient.callApi('/api/v2/workforcemanagement/managementunits/{managementUnitId}/users/{userId}/timeoffrequests/{timeOffRequestId}','PATCH',{'managementUnitId':managementUnitId,'userId':userId,'timeOffRequestId':timeOffRequestId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
29573
29768
|
* Updates a shift trade. This route can only be called by the initiating agent
|
|
29574
|
-
*
|
|
29769
|
+
* Deprecated. Use new route instead (/shifttrading/trades/{tradeId}/jobs)
|
|
29575
29770
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
29576
29771
|
* @param {String} weekDateId The start week date of the initiating shift in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
29577
29772
|
* @param {String} tradeId The ID of the shift trade to update
|
|
29578
29773
|
* @param {Object} body body
|
|
29579
29774
|
* @param {Object} opts Optional parameters
|
|
29580
29775
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
29776
|
+
* @deprecated
|
|
29581
29777
|
*/},{key:"patchWorkforcemanagementManagementunitWeekShifttrade",value:function patchWorkforcemanagementManagementunitWeekShifttrade(managementUnitId,weekDateId,tradeId,body,opts){opts=opts||{};// verify the required parameter 'managementUnitId' is set
|
|
29582
29778
|
if(managementUnitId===undefined||managementUnitId===null||managementUnitId===''){throw'Missing the required parameter "managementUnitId" when calling patchWorkforcemanagementManagementunitWeekShifttrade';}// verify the required parameter 'weekDateId' is set
|
|
29583
29779
|
if(weekDateId===undefined||weekDateId===null){throw'Missing the required parameter "weekDateId" when calling patchWorkforcemanagementManagementunitWeekShifttrade';}// verify the required parameter 'tradeId' is set
|
|
@@ -29663,13 +29859,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
29663
29859
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
29664
29860
|
*/},{key:"postWorkforcemanagementAdherenceExplanationsQuery",value:function postWorkforcemanagementAdherenceExplanationsQuery(body,opts){opts=opts||{};// verify the required parameter 'body' is set
|
|
29665
29861
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postWorkforcemanagementAdherenceExplanationsQuery';}return this.apiClient.callApi('/api/v2/workforcemanagement/adherence/explanations/query','POST',{},{'forceAsync':opts['forceAsync'],'forceDownloadService':opts['forceDownloadService']},{},{},body,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
29666
|
-
* Deprecated. Use bulk routes instead (/adherence/historical/bulk)
|
|
29667
|
-
*
|
|
29668
|
-
* @param {Object} opts Optional parameters
|
|
29669
|
-
* @param {Object} opts.body body
|
|
29670
|
-
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
29671
|
-
* @deprecated
|
|
29672
|
-
*/},{key:"postWorkforcemanagementAdherenceHistorical",value:function postWorkforcemanagementAdherenceHistorical(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/workforcemanagement/adherence/historical','POST',{},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
29673
29862
|
* Request a historical adherence report in bulk
|
|
29674
29863
|
*
|
|
29675
29864
|
* @param {Object} body body
|
|
@@ -29734,6 +29923,29 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
29734
29923
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
29735
29924
|
*/},{key:"postWorkforcemanagementAgentsMePossibleworkshifts",value:function postWorkforcemanagementAgentsMePossibleworkshifts(body,opts){opts=opts||{};// verify the required parameter 'body' is set
|
|
29736
29925
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postWorkforcemanagementAgentsMePossibleworkshifts';}return this.apiClient.callApi('/api/v2/workforcemanagement/agents/me/possibleworkshifts','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
29926
|
+
* Bulk add enrollments to opportunities for the authenticated agent
|
|
29927
|
+
* Allows an agent to enroll in opportunities. This endpoint can return partial success.
|
|
29928
|
+
* @param {Object} body body
|
|
29929
|
+
* @param {Object} opts Optional parameters
|
|
29930
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
29931
|
+
*/},{key:"postWorkforcemanagementAgentsOpportunitiesEnrollmentsBulkAdd",value:function postWorkforcemanagementAgentsOpportunitiesEnrollmentsBulkAdd(body,opts){opts=opts||{};// verify the required parameter 'body' is set
|
|
29932
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postWorkforcemanagementAgentsOpportunitiesEnrollmentsBulkAdd';}return this.apiClient.callApi('/api/v2/workforcemanagement/agents/opportunities/enrollments/bulk/add','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
29933
|
+
* Bulk update enrollment status for the authenticated agent
|
|
29934
|
+
* Allows an agent to update the status of their enrollments (e.g. withdraw). Returns partial success if some enrollments cannot be updated.
|
|
29935
|
+
* @param {Object} body body
|
|
29936
|
+
* @param {Object} opts Optional parameters
|
|
29937
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
29938
|
+
*/},{key:"postWorkforcemanagementAgentsOpportunitiesEnrollmentsBulkStatusesUpdate",value:function postWorkforcemanagementAgentsOpportunitiesEnrollmentsBulkStatusesUpdate(body,opts){opts=opts||{};// verify the required parameter 'body' is set
|
|
29939
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postWorkforcemanagementAgentsOpportunitiesEnrollmentsBulkStatusesUpdate';}return this.apiClient.callApi('/api/v2/workforcemanagement/agents/opportunities/enrollments/bulk/statuses/update','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
29940
|
+
* Query opportunities for the authenticated agent
|
|
29941
|
+
* Queries within the specified date range. Each opportunity includes the agents enrollment details if they have enrolled.
|
|
29942
|
+
* @param {Object} body body
|
|
29943
|
+
* @param {Object} opts Optional parameters
|
|
29944
|
+
* @param {Object} opts.expand List of resources to expand
|
|
29945
|
+
* @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
|
|
29946
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
29947
|
+
*/},{key:"postWorkforcemanagementAgentsOpportunitiesQuery",value:function postWorkforcemanagementAgentsOpportunitiesQuery(body,opts){opts=opts||{};// verify the required parameter 'body' is set
|
|
29948
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postWorkforcemanagementAgentsOpportunitiesQuery';}return this.apiClient.callApi('/api/v2/workforcemanagement/agents/opportunities/query','POST',{},{'expand':opts['expand'],'forceDownloadService':opts['forceDownloadService']},{},{},body,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
29737
29949
|
* Fetch agent schedules for the logged in user's management unit
|
|
29738
29950
|
*
|
|
29739
29951
|
* @param {Object} body body
|
|
@@ -29911,8 +30123,83 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
29911
30123
|
*/},{key:"postWorkforcemanagementBusinessunitIntraday",value:function postWorkforcemanagementBusinessunitIntraday(businessUnitId,body,opts){opts=opts||{};// verify the required parameter 'businessUnitId' is set
|
|
29912
30124
|
if(businessUnitId===undefined||businessUnitId===null||businessUnitId===''){throw'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitIntraday';}// verify the required parameter 'body' is set
|
|
29913
30125
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitIntraday';}return this.apiClient.callApi('/api/v2/workforcemanagement/businessunits/{businessUnitId}/intraday','POST',{'businessUnitId':businessUnitId},{'forceAsync':opts['forceAsync']},{},{},body,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
29914
|
-
*
|
|
30126
|
+
* Bulk add opportunities
|
|
30127
|
+
*
|
|
30128
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
30129
|
+
* @param {Object} body body
|
|
30130
|
+
* @param {Object} opts Optional parameters
|
|
30131
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
30132
|
+
*/},{key:"postWorkforcemanagementBusinessunitOpportunitiesBulkAdd",value:function postWorkforcemanagementBusinessunitOpportunitiesBulkAdd(businessUnitId,body,opts){opts=opts||{};// verify the required parameter 'businessUnitId' is set
|
|
30133
|
+
if(businessUnitId===undefined||businessUnitId===null||businessUnitId===''){throw'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitOpportunitiesBulkAdd';}// verify the required parameter 'body' is set
|
|
30134
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitOpportunitiesBulkAdd';}return this.apiClient.callApi('/api/v2/workforcemanagement/businessunits/{businessUnitId}/opportunities/bulk/add','POST',{'businessUnitId':businessUnitId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
30135
|
+
* Bulk publish opportunities
|
|
30136
|
+
* Published opportunities become available for agent enrollment when they open. Returns partial success if some opportunities cannot be published.
|
|
30137
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
30138
|
+
* @param {Object} body body
|
|
30139
|
+
* @param {Object} opts Optional parameters
|
|
30140
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
30141
|
+
*/},{key:"postWorkforcemanagementBusinessunitOpportunitiesBulkPublish",value:function postWorkforcemanagementBusinessunitOpportunitiesBulkPublish(businessUnitId,body,opts){opts=opts||{};// verify the required parameter 'businessUnitId' is set
|
|
30142
|
+
if(businessUnitId===undefined||businessUnitId===null||businessUnitId===''){throw'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitOpportunitiesBulkPublish';}// verify the required parameter 'body' is set
|
|
30143
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitOpportunitiesBulkPublish';}return this.apiClient.callApi('/api/v2/workforcemanagement/businessunits/{businessUnitId}/opportunities/bulk/publish','POST',{'businessUnitId':businessUnitId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
30144
|
+
* Bulk remove opportunities
|
|
30145
|
+
* This operation is permanent and cannot be undone. Returns partial success if some opportunities cannot be removed.
|
|
30146
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
30147
|
+
* @param {Object} body body
|
|
30148
|
+
* @param {Object} opts Optional parameters
|
|
30149
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
30150
|
+
*/},{key:"postWorkforcemanagementBusinessunitOpportunitiesBulkRemove",value:function postWorkforcemanagementBusinessunitOpportunitiesBulkRemove(businessUnitId,body,opts){opts=opts||{};// verify the required parameter 'businessUnitId' is set
|
|
30151
|
+
if(businessUnitId===undefined||businessUnitId===null||businessUnitId===''){throw'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitOpportunitiesBulkRemove';}// verify the required parameter 'body' is set
|
|
30152
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitOpportunitiesBulkRemove';}return this.apiClient.callApi('/api/v2/workforcemanagement/businessunits/{businessUnitId}/opportunities/bulk/remove','POST',{'businessUnitId':businessUnitId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
30153
|
+
* Bulk update opportunities status
|
|
30154
|
+
* If status is Closed, pending enrollments are automatically denied; approved enrollments remain in schedules. Returns partial success if some opportunities cannot be updated.
|
|
30155
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
30156
|
+
* @param {Object} body body
|
|
30157
|
+
* @param {Object} opts Optional parameters
|
|
30158
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
30159
|
+
*/},{key:"postWorkforcemanagementBusinessunitOpportunitiesBulkStatusesUpdate",value:function postWorkforcemanagementBusinessunitOpportunitiesBulkStatusesUpdate(businessUnitId,body,opts){opts=opts||{};// verify the required parameter 'businessUnitId' is set
|
|
30160
|
+
if(businessUnitId===undefined||businessUnitId===null||businessUnitId===''){throw'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitOpportunitiesBulkStatusesUpdate';}// verify the required parameter 'body' is set
|
|
30161
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitOpportunitiesBulkStatusesUpdate';}return this.apiClient.callApi('/api/v2/workforcemanagement/businessunits/{businessUnitId}/opportunities/bulk/statuses/update','POST',{'businessUnitId':businessUnitId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
30162
|
+
* Bulk update enrollment status
|
|
30163
|
+
* Updates the status of enrollments (approve/deny). Returns partial success if some enrollments cannot be updated.
|
|
30164
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
30165
|
+
* @param {Object} body body
|
|
30166
|
+
* @param {Object} opts Optional parameters
|
|
30167
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
30168
|
+
*/},{key:"postWorkforcemanagementBusinessunitOpportunitiesEnrollmentsBulkStatusesUpdate",value:function postWorkforcemanagementBusinessunitOpportunitiesEnrollmentsBulkStatusesUpdate(businessUnitId,body,opts){opts=opts||{};// verify the required parameter 'businessUnitId' is set
|
|
30169
|
+
if(businessUnitId===undefined||businessUnitId===null||businessUnitId===''){throw'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitOpportunitiesEnrollmentsBulkStatusesUpdate';}// verify the required parameter 'body' is set
|
|
30170
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitOpportunitiesEnrollmentsBulkStatusesUpdate';}return this.apiClient.callApi('/api/v2/workforcemanagement/businessunits/{businessUnitId}/opportunities/enrollments/bulk/statuses/update','POST',{'businessUnitId':businessUnitId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
30171
|
+
* Query enrollments
|
|
30172
|
+
* For more information about opportunities, use the expand parameter.
|
|
30173
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
30174
|
+
* @param {Object} body body
|
|
30175
|
+
* @param {Object} opts Optional parameters
|
|
30176
|
+
* @param {Object} opts.expand List of resources to expand
|
|
30177
|
+
* @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
|
|
30178
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
30179
|
+
*/},{key:"postWorkforcemanagementBusinessunitOpportunitiesEnrollmentsQuery",value:function postWorkforcemanagementBusinessunitOpportunitiesEnrollmentsQuery(businessUnitId,body,opts){opts=opts||{};// verify the required parameter 'businessUnitId' is set
|
|
30180
|
+
if(businessUnitId===undefined||businessUnitId===null||businessUnitId===''){throw'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitOpportunitiesEnrollmentsQuery';}// verify the required parameter 'body' is set
|
|
30181
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitOpportunitiesEnrollmentsQuery';}return this.apiClient.callApi('/api/v2/workforcemanagement/businessunits/{businessUnitId}/opportunities/enrollments/query','POST',{'businessUnitId':businessUnitId},{'expand':opts['expand'],'forceDownloadService':opts['forceDownloadService']},{},{},body,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
30182
|
+
* Query opportunities by external activity IDs
|
|
29915
30183
|
*
|
|
30184
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
30185
|
+
* @param {Object} body body
|
|
30186
|
+
* @param {Object} opts Optional parameters
|
|
30187
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
30188
|
+
*/},{key:"postWorkforcemanagementBusinessunitOpportunitiesExternalactivitiesQuery",value:function postWorkforcemanagementBusinessunitOpportunitiesExternalactivitiesQuery(businessUnitId,body,opts){opts=opts||{};// verify the required parameter 'businessUnitId' is set
|
|
30189
|
+
if(businessUnitId===undefined||businessUnitId===null||businessUnitId===''){throw'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitOpportunitiesExternalactivitiesQuery';}// verify the required parameter 'body' is set
|
|
30190
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitOpportunitiesExternalactivitiesQuery';}return this.apiClient.callApi('/api/v2/workforcemanagement/businessunits/{businessUnitId}/opportunities/externalactivities/query','POST',{'businessUnitId':businessUnitId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
30191
|
+
* Query opportunities within the specified date range
|
|
30192
|
+
*
|
|
30193
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
30194
|
+
* @param {Object} body body
|
|
30195
|
+
* @param {Object} opts Optional parameters
|
|
30196
|
+
* @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
|
|
30197
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
30198
|
+
*/},{key:"postWorkforcemanagementBusinessunitOpportunitiesQuery",value:function postWorkforcemanagementBusinessunitOpportunitiesQuery(businessUnitId,body,opts){opts=opts||{};// verify the required parameter 'businessUnitId' is set
|
|
30199
|
+
if(businessUnitId===undefined||businessUnitId===null||businessUnitId===''){throw'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitOpportunitiesQuery';}// verify the required parameter 'body' is set
|
|
30200
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitOpportunitiesQuery';}return this.apiClient.callApi('/api/v2/workforcemanagement/businessunits/{businessUnitId}/opportunities/query','POST',{'businessUnitId':businessUnitId},{'forceDownloadService':opts['forceDownloadService']},{},{},body,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
30201
|
+
* Adds a new planning group
|
|
30202
|
+
* If the request body contains queue references in route paths, routing:queue:view is required in each referenced queues division.
|
|
29916
30203
|
* @param {String} businessUnitId The ID of the business unit.
|
|
29917
30204
|
* @param {Object} body body
|
|
29918
30205
|
* @param {Object} opts Optional parameters
|
|
@@ -30457,55 +30744,60 @@ if(timeOffRequestId===undefined||timeOffRequestId===null||timeOffRequestId==='')
|
|
|
30457
30744
|
* @param {String} userId The id of the user for whom the time off request estimate is requested
|
|
30458
30745
|
* @param {Object} body body
|
|
30459
30746
|
* @param {Object} opts Optional parameters
|
|
30747
|
+
* @param {Object} opts.includeOnly Limit response to the specified field
|
|
30460
30748
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
30461
30749
|
*/},{key:"postWorkforcemanagementManagementunitUserTimeoffrequestsEstimate",value:function postWorkforcemanagementManagementunitUserTimeoffrequestsEstimate(managementUnitId,userId,body,opts){opts=opts||{};// verify the required parameter 'managementUnitId' is set
|
|
30462
30750
|
if(managementUnitId===undefined||managementUnitId===null||managementUnitId===''){throw'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitUserTimeoffrequestsEstimate';}// verify the required parameter 'userId' is set
|
|
30463
30751
|
if(userId===undefined||userId===null||userId===''){throw'Missing the required parameter "userId" when calling postWorkforcemanagementManagementunitUserTimeoffrequestsEstimate';}// verify the required parameter 'body' is set
|
|
30464
|
-
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postWorkforcemanagementManagementunitUserTimeoffrequestsEstimate';}return this.apiClient.callApi('/api/v2/workforcemanagement/managementunits/{managementUnitId}/users/{userId}/timeoffrequests/estimate','POST',{'managementUnitId':managementUnitId,'userId':userId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
30752
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postWorkforcemanagementManagementunitUserTimeoffrequestsEstimate';}return this.apiClient.callApi('/api/v2/workforcemanagement/managementunits/{managementUnitId}/users/{userId}/timeoffrequests/estimate','POST',{'managementUnitId':managementUnitId,'userId':userId},{'includeOnly':opts['includeOnly']},{},{},body,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
30465
30753
|
* Matches a shift trade. This route can only be called by the receiving agent
|
|
30466
|
-
*
|
|
30754
|
+
* Deprecated. Use new route instead (/shifttrading/trades/{tradeId}/match/jobs)
|
|
30467
30755
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
30468
30756
|
* @param {String} weekDateId The start week date of the initiating shift in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
30469
30757
|
* @param {String} tradeId The ID of the shift trade to update
|
|
30470
30758
|
* @param {Object} body body
|
|
30471
30759
|
* @param {Object} opts Optional parameters
|
|
30472
30760
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
30761
|
+
* @deprecated
|
|
30473
30762
|
*/},{key:"postWorkforcemanagementManagementunitWeekShifttradeMatch",value:function postWorkforcemanagementManagementunitWeekShifttradeMatch(managementUnitId,weekDateId,tradeId,body,opts){opts=opts||{};// verify the required parameter 'managementUnitId' is set
|
|
30474
30763
|
if(managementUnitId===undefined||managementUnitId===null||managementUnitId===''){throw'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitWeekShifttradeMatch';}// verify the required parameter 'weekDateId' is set
|
|
30475
30764
|
if(weekDateId===undefined||weekDateId===null){throw'Missing the required parameter "weekDateId" when calling postWorkforcemanagementManagementunitWeekShifttradeMatch';}// verify the required parameter 'tradeId' is set
|
|
30476
30765
|
if(tradeId===undefined||tradeId===null||tradeId===''){throw'Missing the required parameter "tradeId" when calling postWorkforcemanagementManagementunitWeekShifttradeMatch';}// verify the required parameter 'body' is set
|
|
30477
30766
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postWorkforcemanagementManagementunitWeekShifttradeMatch';}return this.apiClient.callApi('/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shifttrades/{tradeId}/match','POST',{'managementUnitId':managementUnitId,'weekDateId':weekDateId,'tradeId':tradeId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
30478
30767
|
* Adds a shift trade
|
|
30479
|
-
*
|
|
30768
|
+
* Deprecated. Use new route instead (/shifttrading/trades/jobs)
|
|
30480
30769
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
30481
30770
|
* @param {String} weekDateId The start week date of the initiating shift in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
30482
30771
|
* @param {Object} body body
|
|
30483
30772
|
* @param {Object} opts Optional parameters
|
|
30484
30773
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
30774
|
+
* @deprecated
|
|
30485
30775
|
*/},{key:"postWorkforcemanagementManagementunitWeekShifttrades",value:function postWorkforcemanagementManagementunitWeekShifttrades(managementUnitId,weekDateId,body,opts){opts=opts||{};// verify the required parameter 'managementUnitId' is set
|
|
30486
30776
|
if(managementUnitId===undefined||managementUnitId===null||managementUnitId===''){throw'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitWeekShifttrades';}// verify the required parameter 'weekDateId' is set
|
|
30487
30777
|
if(weekDateId===undefined||weekDateId===null){throw'Missing the required parameter "weekDateId" when calling postWorkforcemanagementManagementunitWeekShifttrades';}// verify the required parameter 'body' is set
|
|
30488
30778
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postWorkforcemanagementManagementunitWeekShifttrades';}return this.apiClient.callApi('/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shifttrades','POST',{'managementUnitId':managementUnitId,'weekDateId':weekDateId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
30489
30779
|
* Searches for potential shift trade matches for the current agent
|
|
30490
|
-
*
|
|
30780
|
+
* Deprecated. Use new route instead (/businessunits/{businessUnitId}/shifttrading/unmatched/search/jobs)
|
|
30491
30781
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
30492
30782
|
* @param {String} weekDateId The start week date of the initiating shift in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
30493
30783
|
* @param {Object} body body
|
|
30494
30784
|
* @param {Object} opts Optional parameters
|
|
30495
30785
|
* @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
|
|
30496
30786
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
30787
|
+
* @deprecated
|
|
30497
30788
|
*/},{key:"postWorkforcemanagementManagementunitWeekShifttradesSearch",value:function postWorkforcemanagementManagementunitWeekShifttradesSearch(managementUnitId,weekDateId,body,opts){opts=opts||{};// verify the required parameter 'managementUnitId' is set
|
|
30498
30789
|
if(managementUnitId===undefined||managementUnitId===null||managementUnitId===''){throw'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitWeekShifttradesSearch';}// verify the required parameter 'weekDateId' is set
|
|
30499
30790
|
if(weekDateId===undefined||weekDateId===null){throw'Missing the required parameter "weekDateId" when calling postWorkforcemanagementManagementunitWeekShifttradesSearch';}// verify the required parameter 'body' is set
|
|
30500
30791
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postWorkforcemanagementManagementunitWeekShifttradesSearch';}return this.apiClient.callApi('/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shifttrades/search','POST',{'managementUnitId':managementUnitId,'weekDateId':weekDateId},{'forceDownloadService':opts['forceDownloadService']},{},{},body,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
30501
30792
|
* Updates the state of a batch of shift trades
|
|
30502
|
-
* Admin functionality is not supported with "mine".
|
|
30793
|
+
* Admin functionality is not supported with "mine". Deprecated. Use new route instead (/businessunits/{buId}/shifttrading/trades/state/bulk/jobs)
|
|
30503
30794
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
30504
30795
|
* @param {String} weekDateId The start week date of the initiating shift in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
30505
30796
|
* @param {Object} body body
|
|
30506
30797
|
* @param {Object} opts Optional parameters
|
|
30507
30798
|
* @param {Boolean} opts.forceAsync Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes
|
|
30508
30799
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
30800
|
+
* @deprecated
|
|
30509
30801
|
*/},{key:"postWorkforcemanagementManagementunitWeekShifttradesStateBulk",value:function postWorkforcemanagementManagementunitWeekShifttradesStateBulk(managementUnitId,weekDateId,body,opts){opts=opts||{};// verify the required parameter 'managementUnitId' is set
|
|
30510
30802
|
if(managementUnitId===undefined||managementUnitId===null||managementUnitId===''){throw'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitWeekShifttradesStateBulk';}// verify the required parameter 'weekDateId' is set
|
|
30511
30803
|
if(weekDateId===undefined||weekDateId===null){throw'Missing the required parameter "weekDateId" when calling postWorkforcemanagementManagementunitWeekShifttradesStateBulk';}// verify the required parameter 'body' is set
|
|
@@ -30674,9 +30966,10 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
30674
30966
|
*
|
|
30675
30967
|
* @param {Object} body body
|
|
30676
30968
|
* @param {Object} opts Optional parameters
|
|
30969
|
+
* @param {Object} opts.includeOnly Limit response to the specified field
|
|
30677
30970
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
30678
30971
|
*/},{key:"postWorkforcemanagementTimeoffrequestsEstimate",value:function postWorkforcemanagementTimeoffrequestsEstimate(body,opts){opts=opts||{};// verify the required parameter 'body' is set
|
|
30679
|
-
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postWorkforcemanagementTimeoffrequestsEstimate';}return this.apiClient.callApi('/api/v2/workforcemanagement/timeoffrequests/estimate','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
30972
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postWorkforcemanagementTimeoffrequestsEstimate';}return this.apiClient.callApi('/api/v2/workforcemanagement/timeoffrequests/estimate','POST',{},{'includeOnly':opts['includeOnly']},{},{},body,['PureCloud OAuth'],['application/json'],['application/json'],opts['customHeaders']);}/**
|
|
30680
30973
|
* Retrieves integration statuses for a list of current user time off requests
|
|
30681
30974
|
*
|
|
30682
30975
|
* @param {Object} body body
|
|
@@ -30757,7 +31050,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
30757
31050
|
* </pre>
|
|
30758
31051
|
* </p>
|
|
30759
31052
|
* @module purecloud-platform-client-v2/index
|
|
30760
|
-
* @version
|
|
31053
|
+
* @version 254.0.0
|
|
30761
31054
|
*/var platformClient=/*#__PURE__*/_createClass(function platformClient(){_classCallCheck(this,platformClient);/**
|
|
30762
31055
|
* The ApiClient constructor.
|
|
30763
31056
|
* @property {module:purecloud-platform-client-v2/ApiClient}
|