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
|
@@ -6765,7 +6765,7 @@ if(env)this.environment=env;else this.environment=this.host?this.host:'mypureclo
|
|
|
6765
6765
|
this.environment=this.environment.replace(/\/+$/,'');// Strip protocol and subdomain
|
|
6766
6766
|
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];}}}]);}();/**
|
|
6767
6767
|
* @module purecloud-platform-client-v2/ApiClient
|
|
6768
|
-
* @version
|
|
6768
|
+
* @version 254.0.0
|
|
6769
6769
|
*/var ApiClient=/*#__PURE__*/function(){/**
|
|
6770
6770
|
* Manages low level client-server communications, parameter marshalling, etc. There should not be any need for an
|
|
6771
6771
|
* application to use this class directly - the *Api and model classes provide the public API for the service. The
|
|
@@ -7134,7 +7134,7 @@ resolve(data);})["catch"](function(error){var data=error;if(error.response&&erro
|
|
|
7134
7134
|
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(){/**
|
|
7135
7135
|
* AIStudio service.
|
|
7136
7136
|
* @module purecloud-platform-client-v2/api/AIStudioApi
|
|
7137
|
-
* @version
|
|
7137
|
+
* @version 254.0.0
|
|
7138
7138
|
*//**
|
|
7139
7139
|
* Constructs a new AIStudioApi.
|
|
7140
7140
|
* @alias module:purecloud-platform-client-v2/api/AIStudioApi
|
|
@@ -7166,14 +7166,14 @@ if(summarySettingId===undefined||summarySettingId===null||summarySettingId==='')
|
|
|
7166
7166
|
* Get all summary settings.
|
|
7167
7167
|
*
|
|
7168
7168
|
* @param {Object} opts Optional parameters
|
|
7169
|
-
* @param {String} opts.language Filter by matching language - case insensitive.
|
|
7170
|
-
* @param {String} opts.name Filter by partially matching name - case insensitive.
|
|
7171
|
-
* @param {Object} opts.sortBy Sort by. Default value dateModified. (default to dateModified)
|
|
7172
|
-
* @param {Object} opts.sortOrder Sort Order. Default value desc. (default to desc)
|
|
7173
7169
|
* @param {Number} opts.pageNumber Page number. (default to 1)
|
|
7174
7170
|
* @param {Number} opts.pageSize Page size. The maximum page size is 100. (default to 25)
|
|
7171
|
+
* @param {String} opts.name Filter by partially matching name - case insensitive.
|
|
7172
|
+
* @param {Object} opts.sortOrder Sort Order. Default value desc. (default to desc)
|
|
7173
|
+
* @param {String} opts.language Filter by matching language - case insensitive.
|
|
7174
|
+
* @param {Object} opts.sortBy Sort by. Default value dateModified. (default to dateModified)
|
|
7175
7175
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
7176
|
-
*/},{key:"getConversationsSummariesSettings",value:function getConversationsSummariesSettings(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/conversations/summaries/settings','GET',{},{'
|
|
7176
|
+
*/},{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']);}/**
|
|
7177
7177
|
* Get guide.
|
|
7178
7178
|
*
|
|
7179
7179
|
* @param {String} guideId Guide ID
|
|
@@ -7325,7 +7325,7 @@ if(summarySettingId===undefined||summarySettingId===null||summarySettingId==='')
|
|
|
7325
7325
|
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(){/**
|
|
7326
7326
|
* AgentAssistants service.
|
|
7327
7327
|
* @module purecloud-platform-client-v2/api/AgentAssistantsApi
|
|
7328
|
-
* @version
|
|
7328
|
+
* @version 254.0.0
|
|
7329
7329
|
*//**
|
|
7330
7330
|
* Constructs a new AgentAssistantsApi.
|
|
7331
7331
|
* @alias module:purecloud-platform-client-v2/api/AgentAssistantsApi
|
|
@@ -7434,8 +7434,9 @@ if(agentChecklistId===undefined||agentChecklistId===null||agentChecklistId==='')
|
|
|
7434
7434
|
* @param {String} opts.language The agent checklist language filter applied to the listing.
|
|
7435
7435
|
* @param {Object} opts.sortOrder The sort order for the listing
|
|
7436
7436
|
* @param {Object} opts.sortBy The field to sort by for the listing.
|
|
7437
|
+
* @param {Array.<String>} opts.agentChecklistIds Agent checklist IDs (repeat param or comma-separated). Do not use with other optional filters.
|
|
7437
7438
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
7438
|
-
*/},{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']);}/**
|
|
7439
|
+
*/},{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']);}/**
|
|
7439
7440
|
* Get the list of supported languages
|
|
7440
7441
|
*
|
|
7441
7442
|
* @param {Object} opts Optional parameters
|
|
@@ -7550,7 +7551,7 @@ if(agentChecklistId===undefined||agentChecklistId===null||agentChecklistId==='')
|
|
|
7550
7551
|
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(){/**
|
|
7551
7552
|
* AgentCopilot service.
|
|
7552
7553
|
* @module purecloud-platform-client-v2/api/AgentCopilotApi
|
|
7553
|
-
* @version
|
|
7554
|
+
* @version 254.0.0
|
|
7554
7555
|
*//**
|
|
7555
7556
|
* Constructs a new AgentCopilotApi.
|
|
7556
7557
|
* @alias module:purecloud-platform-client-v2/api/AgentCopilotApi
|
|
@@ -7582,7 +7583,7 @@ if(assistantId===undefined||assistantId===null||assistantId===''){throw'Missing
|
|
|
7582
7583
|
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(){/**
|
|
7583
7584
|
* AgentUI service.
|
|
7584
7585
|
* @module purecloud-platform-client-v2/api/AgentUIApi
|
|
7585
|
-
* @version
|
|
7586
|
+
* @version 254.0.0
|
|
7586
7587
|
*//**
|
|
7587
7588
|
* Constructs a new AgentUIApi.
|
|
7588
7589
|
* @alias module:purecloud-platform-client-v2/api/AgentUIApi
|
|
@@ -7624,7 +7625,7 @@ if(agentId===undefined||agentId===null||agentId===''){throw'Missing the required
|
|
|
7624
7625
|
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(){/**
|
|
7625
7626
|
* Alerting service.
|
|
7626
7627
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
7627
|
-
* @version
|
|
7628
|
+
* @version 254.0.0
|
|
7628
7629
|
*//**
|
|
7629
7630
|
* Constructs a new AlertingApi.
|
|
7630
7631
|
* @alias module:purecloud-platform-client-v2/api/AlertingApi
|
|
@@ -7738,7 +7739,7 @@ if(ruleId===undefined||ruleId===null||ruleId===''){throw'Missing the required pa
|
|
|
7738
7739
|
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(){/**
|
|
7739
7740
|
* Analytics service.
|
|
7740
7741
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
7741
|
-
* @version
|
|
7742
|
+
* @version 254.0.0
|
|
7742
7743
|
*//**
|
|
7743
7744
|
* Constructs a new AnalyticsApi.
|
|
7744
7745
|
* @alias module:purecloud-platform-client-v2/api/AnalyticsApi
|
|
@@ -7751,7 +7752,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
7751
7752
|
* @param {String} jobId jobId
|
|
7752
7753
|
* @param {Object} opts Optional parameters
|
|
7753
7754
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
7754
|
-
* deleteAnalyticsActionsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
7755
7755
|
*/return _createClass(AnalyticsApi,[{key:"deleteAnalyticsActionsAggregatesJob",value:function deleteAnalyticsActionsAggregatesJob(jobId,opts){opts=opts||{};// verify the required parameter 'jobId' is set
|
|
7756
7756
|
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']);}/**
|
|
7757
7757
|
* Delete/cancel an async request for agent copilot aggregates
|
|
@@ -7775,7 +7775,6 @@ if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required param
|
|
|
7775
7775
|
* @param {String} jobId jobId
|
|
7776
7776
|
* @param {Object} opts Optional parameters
|
|
7777
7777
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
7778
|
-
* deleteAnalyticsBotsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
7779
7778
|
*/},{key:"deleteAnalyticsBotsAggregatesJob",value:function deleteAnalyticsBotsAggregatesJob(jobId,opts){opts=opts||{};// verify the required parameter 'jobId' is set
|
|
7780
7779
|
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']);}/**
|
|
7781
7780
|
* Delete/cancel an async request for case management aggregates
|
|
@@ -7783,7 +7782,6 @@ if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required param
|
|
|
7783
7782
|
* @param {String} jobId jobId
|
|
7784
7783
|
* @param {Object} opts Optional parameters
|
|
7785
7784
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
7786
|
-
* deleteAnalyticsCasemanagementAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
7787
7785
|
*/},{key:"deleteAnalyticsCasemanagementAggregatesJob",value:function deleteAnalyticsCasemanagementAggregatesJob(jobId,opts){opts=opts||{};// verify the required parameter 'jobId' is set
|
|
7788
7786
|
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']);}/**
|
|
7789
7787
|
* Delete/cancel an async request for conversation aggregates
|
|
@@ -7791,7 +7789,6 @@ if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required param
|
|
|
7791
7789
|
* @param {String} jobId jobId
|
|
7792
7790
|
* @param {Object} opts Optional parameters
|
|
7793
7791
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
7794
|
-
* deleteAnalyticsConversationsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
7795
7792
|
*/},{key:"deleteAnalyticsConversationsAggregatesJob",value:function deleteAnalyticsConversationsAggregatesJob(jobId,opts){opts=opts||{};// verify the required parameter 'jobId' is set
|
|
7796
7793
|
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']);}/**
|
|
7797
7794
|
* Delete/cancel an async details job
|
|
@@ -7814,7 +7811,6 @@ if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required param
|
|
|
7814
7811
|
* @param {String} jobId jobId
|
|
7815
7812
|
* @param {Object} opts Optional parameters
|
|
7816
7813
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
7817
|
-
* deleteAnalyticsEvaluationsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
7818
7814
|
*/},{key:"deleteAnalyticsEvaluationsAggregatesJob",value:function deleteAnalyticsEvaluationsAggregatesJob(jobId,opts){opts=opts||{};// verify the required parameter 'jobId' is set
|
|
7819
7815
|
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']);}/**
|
|
7820
7816
|
* Delete/cancel an async request for flow execution aggregates
|
|
@@ -7822,7 +7818,6 @@ if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required param
|
|
|
7822
7818
|
* @param {String} jobId jobId
|
|
7823
7819
|
* @param {Object} opts Optional parameters
|
|
7824
7820
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
7825
|
-
* deleteAnalyticsFlowexecutionsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
7826
7821
|
*/},{key:"deleteAnalyticsFlowexecutionsAggregatesJob",value:function deleteAnalyticsFlowexecutionsAggregatesJob(jobId,opts){opts=opts||{};// verify the required parameter 'jobId' is set
|
|
7827
7822
|
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']);}/**
|
|
7828
7823
|
* Delete/cancel an async request for flow aggregates
|
|
@@ -7830,7 +7825,6 @@ if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required param
|
|
|
7830
7825
|
* @param {String} jobId jobId
|
|
7831
7826
|
* @param {Object} opts Optional parameters
|
|
7832
7827
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
7833
|
-
* deleteAnalyticsFlowsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
7834
7828
|
*/},{key:"deleteAnalyticsFlowsAggregatesJob",value:function deleteAnalyticsFlowsAggregatesJob(jobId,opts){opts=opts||{};// verify the required parameter 'jobId' is set
|
|
7835
7829
|
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']);}/**
|
|
7836
7830
|
* Delete/cancel an async request for journey aggregates
|
|
@@ -7838,7 +7832,6 @@ if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required param
|
|
|
7838
7832
|
* @param {String} jobId jobId
|
|
7839
7833
|
* @param {Object} opts Optional parameters
|
|
7840
7834
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
7841
|
-
* deleteAnalyticsJourneysAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
7842
7835
|
*/},{key:"deleteAnalyticsJourneysAggregatesJob",value:function deleteAnalyticsJourneysAggregatesJob(jobId,opts){opts=opts||{};// verify the required parameter 'jobId' is set
|
|
7843
7836
|
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']);}/**
|
|
7844
7837
|
* Delete/cancel an async request for knowledge aggregates
|
|
@@ -7846,7 +7839,6 @@ if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required param
|
|
|
7846
7839
|
* @param {String} jobId jobId
|
|
7847
7840
|
* @param {Object} opts Optional parameters
|
|
7848
7841
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
7849
|
-
* deleteAnalyticsKnowledgeAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
7850
7842
|
*/},{key:"deleteAnalyticsKnowledgeAggregatesJob",value:function deleteAnalyticsKnowledgeAggregatesJob(jobId,opts){opts=opts||{};// verify the required parameter 'jobId' is set
|
|
7851
7843
|
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']);}/**
|
|
7852
7844
|
* Delete/cancel an async request for resolution aggregates
|
|
@@ -7854,7 +7846,6 @@ if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required param
|
|
|
7854
7846
|
* @param {String} jobId jobId
|
|
7855
7847
|
* @param {Object} opts Optional parameters
|
|
7856
7848
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
7857
|
-
* deleteAnalyticsResolutionsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
7858
7849
|
*/},{key:"deleteAnalyticsResolutionsAggregatesJob",value:function deleteAnalyticsResolutionsAggregatesJob(jobId,opts){opts=opts||{};// verify the required parameter 'jobId' is set
|
|
7859
7850
|
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']);}/**
|
|
7860
7851
|
* Delete/cancel an async request for summary aggregates
|
|
@@ -7862,7 +7853,6 @@ if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required param
|
|
|
7862
7853
|
* @param {String} jobId jobId
|
|
7863
7854
|
* @param {Object} opts Optional parameters
|
|
7864
7855
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
7865
|
-
* deleteAnalyticsSummariesAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
7866
7856
|
*/},{key:"deleteAnalyticsSummariesAggregatesJob",value:function deleteAnalyticsSummariesAggregatesJob(jobId,opts){opts=opts||{};// verify the required parameter 'jobId' is set
|
|
7867
7857
|
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']);}/**
|
|
7868
7858
|
* Delete/cancel an async request for survey aggregates
|
|
@@ -7870,7 +7860,6 @@ if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required param
|
|
|
7870
7860
|
* @param {String} jobId jobId
|
|
7871
7861
|
* @param {Object} opts Optional parameters
|
|
7872
7862
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
7873
|
-
* deleteAnalyticsSurveysAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
7874
7863
|
*/},{key:"deleteAnalyticsSurveysAggregatesJob",value:function deleteAnalyticsSurveysAggregatesJob(jobId,opts){opts=opts||{};// verify the required parameter 'jobId' is set
|
|
7875
7864
|
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']);}/**
|
|
7876
7865
|
* Delete/cancel an async request for task management aggregates
|
|
@@ -7878,7 +7867,6 @@ if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required param
|
|
|
7878
7867
|
* @param {String} jobId jobId
|
|
7879
7868
|
* @param {Object} opts Optional parameters
|
|
7880
7869
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
7881
|
-
* deleteAnalyticsTaskmanagementAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
7882
7870
|
*/},{key:"deleteAnalyticsTaskmanagementAggregatesJob",value:function deleteAnalyticsTaskmanagementAggregatesJob(jobId,opts){opts=opts||{};// verify the required parameter 'jobId' is set
|
|
7883
7871
|
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']);}/**
|
|
7884
7872
|
* Delete/cancel an async request for transcript aggregates
|
|
@@ -7886,7 +7874,6 @@ if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required param
|
|
|
7886
7874
|
* @param {String} jobId jobId
|
|
7887
7875
|
* @param {Object} opts Optional parameters
|
|
7888
7876
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
7889
|
-
* deleteAnalyticsTranscriptsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
7890
7877
|
*/},{key:"deleteAnalyticsTranscriptsAggregatesJob",value:function deleteAnalyticsTranscriptsAggregatesJob(jobId,opts){opts=opts||{};// verify the required parameter 'jobId' is set
|
|
7891
7878
|
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']);}/**
|
|
7892
7879
|
* Delete/cancel an async request for user aggregates
|
|
@@ -7894,7 +7881,6 @@ if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required param
|
|
|
7894
7881
|
* @param {String} jobId jobId
|
|
7895
7882
|
* @param {Object} opts Optional parameters
|
|
7896
7883
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
7897
|
-
* deleteAnalyticsUsersAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
7898
7884
|
*/},{key:"deleteAnalyticsUsersAggregatesJob",value:function deleteAnalyticsUsersAggregatesJob(jobId,opts){opts=opts||{};// verify the required parameter 'jobId' is set
|
|
7899
7885
|
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']);}/**
|
|
7900
7886
|
* Delete/cancel an async request
|
|
@@ -7909,7 +7895,6 @@ if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required param
|
|
|
7909
7895
|
* @param {String} jobId jobId
|
|
7910
7896
|
* @param {Object} opts Optional parameters
|
|
7911
7897
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
7912
|
-
* getAnalyticsActionsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
7913
7898
|
*/},{key:"getAnalyticsActionsAggregatesJob",value:function getAnalyticsActionsAggregatesJob(jobId,opts){opts=opts||{};// verify the required parameter 'jobId' is set
|
|
7914
7899
|
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']);}/**
|
|
7915
7900
|
* Fetch a page of results for an async aggregates query
|
|
@@ -7918,7 +7903,6 @@ if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required param
|
|
|
7918
7903
|
* @param {Object} opts Optional parameters
|
|
7919
7904
|
* @param {String} opts.cursor Cursor token to retrieve next page
|
|
7920
7905
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
7921
|
-
* getAnalyticsActionsAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
7922
7906
|
*/},{key:"getAnalyticsActionsAggregatesJobResults",value:function getAnalyticsActionsAggregatesJobResults(jobId,opts){opts=opts||{};// verify the required parameter 'jobId' is set
|
|
7923
7907
|
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']);}/**
|
|
7924
7908
|
* Get an agent and their active sessions by user ID
|
|
@@ -8008,7 +7992,6 @@ if(botFlowId===undefined||botFlowId===null||botFlowId===''){throw'Missing the re
|
|
|
8008
7992
|
* @param {String} jobId jobId
|
|
8009
7993
|
* @param {Object} opts Optional parameters
|
|
8010
7994
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
8011
|
-
* getAnalyticsBotsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
8012
7995
|
*/},{key:"getAnalyticsBotsAggregatesJob",value:function getAnalyticsBotsAggregatesJob(jobId,opts){opts=opts||{};// verify the required parameter 'jobId' is set
|
|
8013
7996
|
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']);}/**
|
|
8014
7997
|
* Fetch a page of results for an async aggregates query
|
|
@@ -8017,7 +8000,6 @@ if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required param
|
|
|
8017
8000
|
* @param {Object} opts Optional parameters
|
|
8018
8001
|
* @param {String} opts.cursor Cursor token to retrieve next page
|
|
8019
8002
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
8020
|
-
* getAnalyticsBotsAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
8021
8003
|
*/},{key:"getAnalyticsBotsAggregatesJobResults",value:function getAnalyticsBotsAggregatesJobResults(jobId,opts){opts=opts||{};// verify the required parameter 'jobId' is set
|
|
8022
8004
|
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']);}/**
|
|
8023
8005
|
* Get status for async query for case management aggregates
|
|
@@ -8025,7 +8007,6 @@ if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required param
|
|
|
8025
8007
|
* @param {String} jobId jobId
|
|
8026
8008
|
* @param {Object} opts Optional parameters
|
|
8027
8009
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
8028
|
-
* getAnalyticsCasemanagementAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
8029
8010
|
*/},{key:"getAnalyticsCasemanagementAggregatesJob",value:function getAnalyticsCasemanagementAggregatesJob(jobId,opts){opts=opts||{};// verify the required parameter 'jobId' is set
|
|
8030
8011
|
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']);}/**
|
|
8031
8012
|
* Fetch a page of results for an async case management query
|
|
@@ -8034,7 +8015,6 @@ if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required param
|
|
|
8034
8015
|
* @param {Object} opts Optional parameters
|
|
8035
8016
|
* @param {String} opts.cursor Cursor token to retrieve next page
|
|
8036
8017
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
8037
|
-
* getAnalyticsCasemanagementAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
8038
8018
|
*/},{key:"getAnalyticsCasemanagementAggregatesJobResults",value:function getAnalyticsCasemanagementAggregatesJobResults(jobId,opts){opts=opts||{};// verify the required parameter 'jobId' is set
|
|
8039
8019
|
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']);}/**
|
|
8040
8020
|
* Get a conversation by id
|
|
@@ -8049,7 +8029,6 @@ if(conversationId===undefined||conversationId===null||conversationId===''){throw
|
|
|
8049
8029
|
* @param {String} jobId jobId
|
|
8050
8030
|
* @param {Object} opts Optional parameters
|
|
8051
8031
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
8052
|
-
* getAnalyticsConversationsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
8053
8032
|
*/},{key:"getAnalyticsConversationsAggregatesJob",value:function getAnalyticsConversationsAggregatesJob(jobId,opts){opts=opts||{};// verify the required parameter 'jobId' is set
|
|
8054
8033
|
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']);}/**
|
|
8055
8034
|
* Fetch a page of results for an async aggregates query
|
|
@@ -8058,7 +8037,6 @@ if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required param
|
|
|
8058
8037
|
* @param {Object} opts Optional parameters
|
|
8059
8038
|
* @param {String} opts.cursor Cursor token to retrieve next page
|
|
8060
8039
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
8061
|
-
* getAnalyticsConversationsAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
8062
8040
|
*/},{key:"getAnalyticsConversationsAggregatesJobResults",value:function getAnalyticsConversationsAggregatesJobResults(jobId,opts){opts=opts||{};// verify the required parameter 'jobId' is set
|
|
8063
8041
|
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']);}/**
|
|
8064
8042
|
* Gets multiple conversations by id
|
|
@@ -8135,7 +8113,6 @@ if(downloadId===undefined||downloadId===null||downloadId===''){throw'Missing the
|
|
|
8135
8113
|
* @param {String} jobId jobId
|
|
8136
8114
|
* @param {Object} opts Optional parameters
|
|
8137
8115
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
8138
|
-
* getAnalyticsEvaluationsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
8139
8116
|
*/},{key:"getAnalyticsEvaluationsAggregatesJob",value:function getAnalyticsEvaluationsAggregatesJob(jobId,opts){opts=opts||{};// verify the required parameter 'jobId' is set
|
|
8140
8117
|
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']);}/**
|
|
8141
8118
|
* Fetch a page of results for an async aggregates query
|
|
@@ -8144,7 +8121,6 @@ if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required param
|
|
|
8144
8121
|
* @param {Object} opts Optional parameters
|
|
8145
8122
|
* @param {String} opts.cursor Cursor token to retrieve next page
|
|
8146
8123
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
8147
|
-
* getAnalyticsEvaluationsAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
8148
8124
|
*/},{key:"getAnalyticsEvaluationsAggregatesJobResults",value:function getAnalyticsEvaluationsAggregatesJobResults(jobId,opts){opts=opts||{};// verify the required parameter 'jobId' is set
|
|
8149
8125
|
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']);}/**
|
|
8150
8126
|
* Get status for async query for flow execution aggregates
|
|
@@ -8152,7 +8128,6 @@ if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required param
|
|
|
8152
8128
|
* @param {String} jobId jobId
|
|
8153
8129
|
* @param {Object} opts Optional parameters
|
|
8154
8130
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
8155
|
-
* getAnalyticsFlowexecutionsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
8156
8131
|
*/},{key:"getAnalyticsFlowexecutionsAggregatesJob",value:function getAnalyticsFlowexecutionsAggregatesJob(jobId,opts){opts=opts||{};// verify the required parameter 'jobId' is set
|
|
8157
8132
|
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']);}/**
|
|
8158
8133
|
* Fetch a page of results for an async aggregates query
|
|
@@ -8161,7 +8136,6 @@ if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required param
|
|
|
8161
8136
|
* @param {Object} opts Optional parameters
|
|
8162
8137
|
* @param {String} opts.cursor Cursor token to retrieve next page
|
|
8163
8138
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
8164
|
-
* getAnalyticsFlowexecutionsAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
8165
8139
|
*/},{key:"getAnalyticsFlowexecutionsAggregatesJobResults",value:function getAnalyticsFlowexecutionsAggregatesJobResults(jobId,opts){opts=opts||{};// verify the required parameter 'jobId' is set
|
|
8166
8140
|
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']);}/**
|
|
8167
8141
|
* Get status for async query for Flow aggregates
|
|
@@ -8169,7 +8143,6 @@ if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required param
|
|
|
8169
8143
|
* @param {String} jobId jobId
|
|
8170
8144
|
* @param {Object} opts Optional parameters
|
|
8171
8145
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
8172
|
-
* getAnalyticsFlowsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
8173
8146
|
*/},{key:"getAnalyticsFlowsAggregatesJob",value:function getAnalyticsFlowsAggregatesJob(jobId,opts){opts=opts||{};// verify the required parameter 'jobId' is set
|
|
8174
8147
|
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']);}/**
|
|
8175
8148
|
* Fetch a page of results for an async aggregates query
|
|
@@ -8178,7 +8151,6 @@ if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required param
|
|
|
8178
8151
|
* @param {Object} opts Optional parameters
|
|
8179
8152
|
* @param {String} opts.cursor Cursor token to retrieve next page
|
|
8180
8153
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
8181
|
-
* getAnalyticsFlowsAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
8182
8154
|
*/},{key:"getAnalyticsFlowsAggregatesJobResults",value:function getAnalyticsFlowsAggregatesJobResults(jobId,opts){opts=opts||{};// verify the required parameter 'jobId' is set
|
|
8183
8155
|
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']);}/**
|
|
8184
8156
|
* Get status for async query for journey aggregates
|
|
@@ -8186,7 +8158,6 @@ if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required param
|
|
|
8186
8158
|
* @param {String} jobId jobId
|
|
8187
8159
|
* @param {Object} opts Optional parameters
|
|
8188
8160
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
8189
|
-
* getAnalyticsJourneysAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
8190
8161
|
*/},{key:"getAnalyticsJourneysAggregatesJob",value:function getAnalyticsJourneysAggregatesJob(jobId,opts){opts=opts||{};// verify the required parameter 'jobId' is set
|
|
8191
8162
|
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']);}/**
|
|
8192
8163
|
* Fetch a page of results for an async aggregates query
|
|
@@ -8195,7 +8166,6 @@ if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required param
|
|
|
8195
8166
|
* @param {Object} opts Optional parameters
|
|
8196
8167
|
* @param {String} opts.cursor Cursor token to retrieve next page
|
|
8197
8168
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
8198
|
-
* getAnalyticsJourneysAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
8199
8169
|
*/},{key:"getAnalyticsJourneysAggregatesJobResults",value:function getAnalyticsJourneysAggregatesJobResults(jobId,opts){opts=opts||{};// verify the required parameter 'jobId' is set
|
|
8200
8170
|
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']);}/**
|
|
8201
8171
|
* Get status for async query for knowledge aggregates
|
|
@@ -8203,7 +8173,6 @@ if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required param
|
|
|
8203
8173
|
* @param {String} jobId jobId
|
|
8204
8174
|
* @param {Object} opts Optional parameters
|
|
8205
8175
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
8206
|
-
* getAnalyticsKnowledgeAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
8207
8176
|
*/},{key:"getAnalyticsKnowledgeAggregatesJob",value:function getAnalyticsKnowledgeAggregatesJob(jobId,opts){opts=opts||{};// verify the required parameter 'jobId' is set
|
|
8208
8177
|
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']);}/**
|
|
8209
8178
|
* Fetch a page of results for an async aggregates query
|
|
@@ -8212,7 +8181,6 @@ if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required param
|
|
|
8212
8181
|
* @param {Object} opts Optional parameters
|
|
8213
8182
|
* @param {String} opts.cursor Cursor token to retrieve next page
|
|
8214
8183
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
8215
|
-
* getAnalyticsKnowledgeAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
8216
8184
|
*/},{key:"getAnalyticsKnowledgeAggregatesJobResults",value:function getAnalyticsKnowledgeAggregatesJobResults(jobId,opts){opts=opts||{};// verify the required parameter 'jobId' is set
|
|
8217
8185
|
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']);}/**
|
|
8218
8186
|
* Get dashboards summary for a user
|
|
@@ -8283,7 +8251,6 @@ if(userId===undefined||userId===null||userId===''){throw'Missing the required pa
|
|
|
8283
8251
|
* @param {String} jobId jobId
|
|
8284
8252
|
* @param {Object} opts Optional parameters
|
|
8285
8253
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
8286
|
-
* getAnalyticsResolutionsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
8287
8254
|
*/},{key:"getAnalyticsResolutionsAggregatesJob",value:function getAnalyticsResolutionsAggregatesJob(jobId,opts){opts=opts||{};// verify the required parameter 'jobId' is set
|
|
8288
8255
|
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']);}/**
|
|
8289
8256
|
* Fetch a page of results for an async aggregates query
|
|
@@ -8292,7 +8259,6 @@ if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required param
|
|
|
8292
8259
|
* @param {Object} opts Optional parameters
|
|
8293
8260
|
* @param {String} opts.cursor Cursor token to retrieve next page
|
|
8294
8261
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
8295
|
-
* getAnalyticsResolutionsAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
8296
8262
|
*/},{key:"getAnalyticsResolutionsAggregatesJobResults",value:function getAnalyticsResolutionsAggregatesJobResults(jobId,opts){opts=opts||{};// verify the required parameter 'jobId' is set
|
|
8297
8263
|
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']);}/**
|
|
8298
8264
|
* Get status for async query for summary aggregates
|
|
@@ -8300,7 +8266,6 @@ if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required param
|
|
|
8300
8266
|
* @param {String} jobId jobId
|
|
8301
8267
|
* @param {Object} opts Optional parameters
|
|
8302
8268
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
8303
|
-
* getAnalyticsSummariesAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
8304
8269
|
*/},{key:"getAnalyticsSummariesAggregatesJob",value:function getAnalyticsSummariesAggregatesJob(jobId,opts){opts=opts||{};// verify the required parameter 'jobId' is set
|
|
8305
8270
|
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']);}/**
|
|
8306
8271
|
* Fetch a page of results for an async aggregates query
|
|
@@ -8309,7 +8274,6 @@ if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required param
|
|
|
8309
8274
|
* @param {Object} opts Optional parameters
|
|
8310
8275
|
* @param {String} opts.cursor Cursor token to retrieve next page
|
|
8311
8276
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
8312
|
-
* getAnalyticsSummariesAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
8313
8277
|
*/},{key:"getAnalyticsSummariesAggregatesJobResults",value:function getAnalyticsSummariesAggregatesJobResults(jobId,opts){opts=opts||{};// verify the required parameter 'jobId' is set
|
|
8314
8278
|
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']);}/**
|
|
8315
8279
|
* Get status for async query for survey aggregates
|
|
@@ -8317,7 +8281,6 @@ if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required param
|
|
|
8317
8281
|
* @param {String} jobId jobId
|
|
8318
8282
|
* @param {Object} opts Optional parameters
|
|
8319
8283
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
8320
|
-
* getAnalyticsSurveysAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
8321
8284
|
*/},{key:"getAnalyticsSurveysAggregatesJob",value:function getAnalyticsSurveysAggregatesJob(jobId,opts){opts=opts||{};// verify the required parameter 'jobId' is set
|
|
8322
8285
|
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']);}/**
|
|
8323
8286
|
* Fetch a page of results for an async aggregates query
|
|
@@ -8326,7 +8289,6 @@ if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required param
|
|
|
8326
8289
|
* @param {Object} opts Optional parameters
|
|
8327
8290
|
* @param {String} opts.cursor Cursor token to retrieve next page
|
|
8328
8291
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
8329
|
-
* getAnalyticsSurveysAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
8330
8292
|
*/},{key:"getAnalyticsSurveysAggregatesJobResults",value:function getAnalyticsSurveysAggregatesJobResults(jobId,opts){opts=opts||{};// verify the required parameter 'jobId' is set
|
|
8331
8293
|
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']);}/**
|
|
8332
8294
|
* Get status for async query for task management aggregates
|
|
@@ -8334,7 +8296,6 @@ if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required param
|
|
|
8334
8296
|
* @param {String} jobId jobId
|
|
8335
8297
|
* @param {Object} opts Optional parameters
|
|
8336
8298
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
8337
|
-
* getAnalyticsTaskmanagementAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
8338
8299
|
*/},{key:"getAnalyticsTaskmanagementAggregatesJob",value:function getAnalyticsTaskmanagementAggregatesJob(jobId,opts){opts=opts||{};// verify the required parameter 'jobId' is set
|
|
8339
8300
|
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']);}/**
|
|
8340
8301
|
* Fetch a page of results for an async task management query
|
|
@@ -8343,7 +8304,6 @@ if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required param
|
|
|
8343
8304
|
* @param {Object} opts Optional parameters
|
|
8344
8305
|
* @param {String} opts.cursor Cursor token to retrieve next page
|
|
8345
8306
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
8346
|
-
* getAnalyticsTaskmanagementAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
8347
8307
|
*/},{key:"getAnalyticsTaskmanagementAggregatesJobResults",value:function getAnalyticsTaskmanagementAggregatesJobResults(jobId,opts){opts=opts||{};// verify the required parameter 'jobId' is set
|
|
8348
8308
|
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']);}/**
|
|
8349
8309
|
* Get status for async query for transcript aggregates
|
|
@@ -8351,7 +8311,6 @@ if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required param
|
|
|
8351
8311
|
* @param {String} jobId jobId
|
|
8352
8312
|
* @param {Object} opts Optional parameters
|
|
8353
8313
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
8354
|
-
* getAnalyticsTranscriptsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
8355
8314
|
*/},{key:"getAnalyticsTranscriptsAggregatesJob",value:function getAnalyticsTranscriptsAggregatesJob(jobId,opts){opts=opts||{};// verify the required parameter 'jobId' is set
|
|
8356
8315
|
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']);}/**
|
|
8357
8316
|
* Fetch a page of results for an async aggregates query
|
|
@@ -8360,7 +8319,6 @@ if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required param
|
|
|
8360
8319
|
* @param {Object} opts Optional parameters
|
|
8361
8320
|
* @param {String} opts.cursor Cursor token to retrieve next page
|
|
8362
8321
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
8363
|
-
* getAnalyticsTranscriptsAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
8364
8322
|
*/},{key:"getAnalyticsTranscriptsAggregatesJobResults",value:function getAnalyticsTranscriptsAggregatesJobResults(jobId,opts){opts=opts||{};// verify the required parameter 'jobId' is set
|
|
8365
8323
|
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']);}/**
|
|
8366
8324
|
* Get status for async query for user aggregates
|
|
@@ -8368,7 +8326,6 @@ if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required param
|
|
|
8368
8326
|
* @param {String} jobId jobId
|
|
8369
8327
|
* @param {Object} opts Optional parameters
|
|
8370
8328
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
8371
|
-
* getAnalyticsUsersAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
8372
8329
|
*/},{key:"getAnalyticsUsersAggregatesJob",value:function getAnalyticsUsersAggregatesJob(jobId,opts){opts=opts||{};// verify the required parameter 'jobId' is set
|
|
8373
8330
|
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']);}/**
|
|
8374
8331
|
* Fetch a page of results for an async aggregates query
|
|
@@ -8377,7 +8334,6 @@ if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required param
|
|
|
8377
8334
|
* @param {Object} opts Optional parameters
|
|
8378
8335
|
* @param {String} opts.cursor Cursor token to retrieve next page
|
|
8379
8336
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
8380
|
-
* getAnalyticsUsersAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
8381
8337
|
*/},{key:"getAnalyticsUsersAggregatesJobResults",value:function getAnalyticsUsersAggregatesJobResults(jobId,opts){opts=opts||{};// verify the required parameter 'jobId' is set
|
|
8382
8338
|
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']);}/**
|
|
8383
8339
|
* Get status for async query for user details
|
|
@@ -8413,7 +8369,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
8413
8369
|
* @param {Object} body query
|
|
8414
8370
|
* @param {Object} opts Optional parameters
|
|
8415
8371
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
8416
|
-
* postAnalyticsActionsAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
8417
8372
|
*/},{key:"postAnalyticsActionsAggregatesJobs",value:function postAnalyticsActionsAggregatesJobs(body,opts){opts=opts||{};// verify the required parameter 'body' is set
|
|
8418
8373
|
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']);}/**
|
|
8419
8374
|
* Query for action aggregates
|
|
@@ -8474,7 +8429,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
8474
8429
|
* @param {Object} body query
|
|
8475
8430
|
* @param {Object} opts Optional parameters
|
|
8476
8431
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
8477
|
-
* postAnalyticsBotsAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
8478
8432
|
*/},{key:"postAnalyticsBotsAggregatesJobs",value:function postAnalyticsBotsAggregatesJobs(body,opts){opts=opts||{};// verify the required parameter 'body' is set
|
|
8479
8433
|
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']);}/**
|
|
8480
8434
|
* Query for bot aggregates
|
|
@@ -8489,7 +8443,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
8489
8443
|
* @param {Object} body query
|
|
8490
8444
|
* @param {Object} opts Optional parameters
|
|
8491
8445
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
8492
|
-
* postAnalyticsCasemanagementAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
8493
8446
|
*/},{key:"postAnalyticsCasemanagementAggregatesJobs",value:function postAnalyticsCasemanagementAggregatesJobs(body,opts){opts=opts||{};// verify the required parameter 'body' is set
|
|
8494
8447
|
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']);}/**
|
|
8495
8448
|
* Query for case management aggregates
|
|
@@ -8497,7 +8450,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
8497
8450
|
* @param {Object} body query
|
|
8498
8451
|
* @param {Object} opts Optional parameters
|
|
8499
8452
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
8500
|
-
* postAnalyticsCasemanagementAggregatesQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
8501
8453
|
*/},{key:"postAnalyticsCasemanagementAggregatesQuery",value:function postAnalyticsCasemanagementAggregatesQuery(body,opts){opts=opts||{};// verify the required parameter 'body' is set
|
|
8502
8454
|
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']);}/**
|
|
8503
8455
|
* Index conversation properties
|
|
@@ -8523,7 +8475,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
8523
8475
|
* @param {Object} body query
|
|
8524
8476
|
* @param {Object} opts Optional parameters
|
|
8525
8477
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
8526
|
-
* postAnalyticsConversationsAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
8527
8478
|
*/},{key:"postAnalyticsConversationsAggregatesJobs",value:function postAnalyticsConversationsAggregatesJobs(body,opts){opts=opts||{};// verify the required parameter 'body' is set
|
|
8528
8479
|
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']);}/**
|
|
8529
8480
|
* Query for conversation aggregates
|
|
@@ -8576,7 +8527,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
8576
8527
|
* @param {Object} body query
|
|
8577
8528
|
* @param {Object} opts Optional parameters
|
|
8578
8529
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
8579
|
-
* postAnalyticsEvaluationsAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
8580
8530
|
*/},{key:"postAnalyticsEvaluationsAggregatesJobs",value:function postAnalyticsEvaluationsAggregatesJobs(body,opts){opts=opts||{};// verify the required parameter 'body' is set
|
|
8581
8531
|
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']);}/**
|
|
8582
8532
|
* Query for evaluation aggregates
|
|
@@ -8591,7 +8541,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
8591
8541
|
* @param {Object} body query
|
|
8592
8542
|
* @param {Object} opts Optional parameters
|
|
8593
8543
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
8594
|
-
* postAnalyticsFlowexecutionsAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
8595
8544
|
*/},{key:"postAnalyticsFlowexecutionsAggregatesJobs",value:function postAnalyticsFlowexecutionsAggregatesJobs(body,opts){opts=opts||{};// verify the required parameter 'body' is set
|
|
8596
8545
|
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']);}/**
|
|
8597
8546
|
* Query for flow execution aggregates
|
|
@@ -8615,7 +8564,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
8615
8564
|
* @param {Object} body query
|
|
8616
8565
|
* @param {Object} opts Optional parameters
|
|
8617
8566
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
8618
|
-
* postAnalyticsFlowsAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
8619
8567
|
*/},{key:"postAnalyticsFlowsAggregatesJobs",value:function postAnalyticsFlowsAggregatesJobs(body,opts){opts=opts||{};// verify the required parameter 'body' is set
|
|
8620
8568
|
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']);}/**
|
|
8621
8569
|
* Query for flow aggregates
|
|
@@ -8637,7 +8585,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
8637
8585
|
* @param {Object} body query
|
|
8638
8586
|
* @param {Object} opts Optional parameters
|
|
8639
8587
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
8640
|
-
* postAnalyticsJourneysAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
8641
8588
|
*/},{key:"postAnalyticsJourneysAggregatesJobs",value:function postAnalyticsJourneysAggregatesJobs(body,opts){opts=opts||{};// verify the required parameter 'body' is set
|
|
8642
8589
|
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']);}/**
|
|
8643
8590
|
* Query for journey aggregates
|
|
@@ -8652,7 +8599,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
8652
8599
|
* @param {Object} body query
|
|
8653
8600
|
* @param {Object} opts Optional parameters
|
|
8654
8601
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
8655
|
-
* postAnalyticsKnowledgeAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
8656
8602
|
*/},{key:"postAnalyticsKnowledgeAggregatesJobs",value:function postAnalyticsKnowledgeAggregatesJobs(body,opts){opts=opts||{};// verify the required parameter 'body' is set
|
|
8657
8603
|
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']);}/**
|
|
8658
8604
|
* Query for knowledge aggregates
|
|
@@ -8709,7 +8655,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
8709
8655
|
* @param {Object} body query
|
|
8710
8656
|
* @param {Object} opts Optional parameters
|
|
8711
8657
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
8712
|
-
* postAnalyticsResolutionsAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
8713
8658
|
*/},{key:"postAnalyticsResolutionsAggregatesJobs",value:function postAnalyticsResolutionsAggregatesJobs(body,opts){opts=opts||{};// verify the required parameter 'body' is set
|
|
8714
8659
|
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']);}/**
|
|
8715
8660
|
* Query for resolution aggregates
|
|
@@ -8733,7 +8678,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
8733
8678
|
* @param {Object} body query
|
|
8734
8679
|
* @param {Object} opts Optional parameters
|
|
8735
8680
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
8736
|
-
* postAnalyticsSummariesAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
8737
8681
|
*/},{key:"postAnalyticsSummariesAggregatesJobs",value:function postAnalyticsSummariesAggregatesJobs(body,opts){opts=opts||{};// verify the required parameter 'body' is set
|
|
8738
8682
|
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']);}/**
|
|
8739
8683
|
* Query for summary aggregates
|
|
@@ -8748,7 +8692,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
8748
8692
|
* @param {Object} body query
|
|
8749
8693
|
* @param {Object} opts Optional parameters
|
|
8750
8694
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
8751
|
-
* postAnalyticsSurveysAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
8752
8695
|
*/},{key:"postAnalyticsSurveysAggregatesJobs",value:function postAnalyticsSurveysAggregatesJobs(body,opts){opts=opts||{};// verify the required parameter 'body' is set
|
|
8753
8696
|
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']);}/**
|
|
8754
8697
|
* Query for survey aggregates
|
|
@@ -8763,7 +8706,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
8763
8706
|
* @param {Object} body query
|
|
8764
8707
|
* @param {Object} opts Optional parameters
|
|
8765
8708
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
8766
|
-
* postAnalyticsTaskmanagementAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
8767
8709
|
*/},{key:"postAnalyticsTaskmanagementAggregatesJobs",value:function postAnalyticsTaskmanagementAggregatesJobs(body,opts){opts=opts||{};// verify the required parameter 'body' is set
|
|
8768
8710
|
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']);}/**
|
|
8769
8711
|
* Query for task management aggregates
|
|
@@ -8796,7 +8738,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
8796
8738
|
* @param {Object} body query
|
|
8797
8739
|
* @param {Object} opts Optional parameters
|
|
8798
8740
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
8799
|
-
* postAnalyticsTranscriptsAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
8800
8741
|
*/},{key:"postAnalyticsTranscriptsAggregatesJobs",value:function postAnalyticsTranscriptsAggregatesJobs(body,opts){opts=opts||{};// verify the required parameter 'body' is set
|
|
8801
8742
|
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']);}/**
|
|
8802
8743
|
* Query for transcript aggregates
|
|
@@ -8820,7 +8761,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
8820
8761
|
* @param {Object} body query
|
|
8821
8762
|
* @param {Object} opts Optional parameters
|
|
8822
8763
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
8823
|
-
* postAnalyticsUsersAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
8824
8764
|
*/},{key:"postAnalyticsUsersAggregatesJobs",value:function postAnalyticsUsersAggregatesJobs(body,opts){opts=opts||{};// verify the required parameter 'body' is set
|
|
8825
8765
|
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']);}/**
|
|
8826
8766
|
* Query for user aggregates
|
|
@@ -8860,7 +8800,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
8860
8800
|
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(){/**
|
|
8861
8801
|
* Architect service.
|
|
8862
8802
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
8863
|
-
* @version
|
|
8803
|
+
* @version 254.0.0
|
|
8864
8804
|
*//**
|
|
8865
8805
|
* Constructs a new ArchitectApi.
|
|
8866
8806
|
* @alias module:purecloud-platform-client-v2/api/ArchitectApi
|
|
@@ -10074,8 +10014,9 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
10074
10014
|
* 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.
|
|
10075
10015
|
*
|
|
10076
10016
|
* @param {Object} opts Optional parameters
|
|
10017
|
+
* @param {Object} opts.body
|
|
10077
10018
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
10078
|
-
*/},{key:"postFlowsJobs",value:function postFlowsJobs(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/flows/jobs','POST',{},{},{},{},
|
|
10019
|
+
*/},{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']);}/**
|
|
10079
10020
|
* Create a flow milestone
|
|
10080
10021
|
*
|
|
10081
10022
|
* @param {Object} opts Optional parameters
|
|
@@ -10229,7 +10170,7 @@ if(milestoneId===undefined||milestoneId===null||milestoneId===''){throw'Missing
|
|
|
10229
10170
|
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(){/**
|
|
10230
10171
|
* AssistantCopilotVariations service.
|
|
10231
10172
|
* @module purecloud-platform-client-v2/api/AssistantCopilotVariationsApi
|
|
10232
|
-
* @version
|
|
10173
|
+
* @version 254.0.0
|
|
10233
10174
|
*//**
|
|
10234
10175
|
* Constructs a new AssistantCopilotVariationsApi.
|
|
10235
10176
|
* @alias module:purecloud-platform-client-v2/api/AssistantCopilotVariationsApi
|
|
@@ -10284,7 +10225,7 @@ if(variationId===undefined||variationId===null||variationId===''){throw'Missing
|
|
|
10284
10225
|
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(){/**
|
|
10285
10226
|
* Audit service.
|
|
10286
10227
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
10287
|
-
* @version
|
|
10228
|
+
* @version 254.0.0
|
|
10288
10229
|
*//**
|
|
10289
10230
|
* Constructs a new AuditApi.
|
|
10290
10231
|
* @alias module:purecloud-platform-client-v2/api/AuditApi
|
|
@@ -10345,7 +10286,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
10345
10286
|
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(){/**
|
|
10346
10287
|
* Authorization service.
|
|
10347
10288
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
10348
|
-
* @version
|
|
10289
|
+
* @version 254.0.0
|
|
10349
10290
|
*//**
|
|
10350
10291
|
* Constructs a new AuthorizationApi.
|
|
10351
10292
|
* @alias module:purecloud-platform-client-v2/api/AuthorizationApi
|
|
@@ -10863,7 +10804,7 @@ if(subjectId===undefined||subjectId===null||subjectId===''){throw'Missing the re
|
|
|
10863
10804
|
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(){/**
|
|
10864
10805
|
* BackgroundAssistant service.
|
|
10865
10806
|
* @module purecloud-platform-client-v2/api/BackgroundAssistantApi
|
|
10866
|
-
* @version
|
|
10807
|
+
* @version 254.0.0
|
|
10867
10808
|
*//**
|
|
10868
10809
|
* Constructs a new BackgroundAssistantApi.
|
|
10869
10810
|
* @alias module:purecloud-platform-client-v2/api/BackgroundAssistantApi
|
|
@@ -10886,7 +10827,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
10886
10827
|
*/},{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(){/**
|
|
10887
10828
|
* Billing service.
|
|
10888
10829
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
10889
|
-
* @version
|
|
10830
|
+
* @version 254.0.0
|
|
10890
10831
|
*//**
|
|
10891
10832
|
* Constructs a new BillingApi.
|
|
10892
10833
|
* @alias module:purecloud-platform-client-v2/api/BillingApi
|
|
@@ -10975,7 +10916,7 @@ if(endDate===undefined||endDate===null){throw'Missing the required parameter "en
|
|
|
10975
10916
|
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(){/**
|
|
10976
10917
|
* BusinessRules service.
|
|
10977
10918
|
* @module purecloud-platform-client-v2/api/BusinessRulesApi
|
|
10978
|
-
* @version
|
|
10919
|
+
* @version 254.0.0
|
|
10979
10920
|
*//**
|
|
10980
10921
|
* Constructs a new BusinessRulesApi.
|
|
10981
10922
|
* @alias module:purecloud-platform-client-v2/api/BusinessRulesApi
|
|
@@ -10991,6 +10932,24 @@ if(trustorOrgId===undefined||trustorOrgId===null||trustorOrgId===''){throw'Missi
|
|
|
10991
10932
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
10992
10933
|
*/return _createClass(BusinessRulesApi,[{key:"deleteBusinessrulesDecisiontable",value:function deleteBusinessrulesDecisiontable(tableId,opts){opts=opts||{};// verify the required parameter 'tableId' is set
|
|
10993
10934
|
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']);}/**
|
|
10935
|
+
* Delete an export job for a decision table
|
|
10936
|
+
*
|
|
10937
|
+
* @param {String} tableId Table ID
|
|
10938
|
+
* @param {String} exportJobId Export Job ID
|
|
10939
|
+
* @param {Object} opts Optional parameters
|
|
10940
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
10941
|
+
*/},{key:"deleteBusinessrulesDecisiontableExport",value:function deleteBusinessrulesDecisiontableExport(tableId,exportJobId,opts){opts=opts||{};// verify the required parameter 'tableId' is set
|
|
10942
|
+
if(tableId===undefined||tableId===null||tableId===''){throw'Missing the required parameter "tableId" when calling deleteBusinessrulesDecisiontableExport';}// verify the required parameter 'exportJobId' is set
|
|
10943
|
+
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']);}/**
|
|
10944
|
+
* Delete decision table row import job
|
|
10945
|
+
*
|
|
10946
|
+
* @param {String} tableId Table ID
|
|
10947
|
+
* @param {String} importJobId Import job ID
|
|
10948
|
+
* @param {Object} opts Optional parameters
|
|
10949
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
10950
|
+
*/},{key:"deleteBusinessrulesDecisiontableImport",value:function deleteBusinessrulesDecisiontableImport(tableId,importJobId,opts){opts=opts||{};// verify the required parameter 'tableId' is set
|
|
10951
|
+
if(tableId===undefined||tableId===null||tableId===''){throw'Missing the required parameter "tableId" when calling deleteBusinessrulesDecisiontableImport';}// verify the required parameter 'importJobId' is set
|
|
10952
|
+
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']);}/**
|
|
10994
10953
|
* Delete a decision table version
|
|
10995
10954
|
*
|
|
10996
10955
|
* @param {String} tableId Table ID
|
|
@@ -11025,6 +10984,42 @@ if(schemaId===undefined||schemaId===null||schemaId===''){throw'Missing the requi
|
|
|
11025
10984
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
11026
10985
|
*/},{key:"getBusinessrulesDecisiontable",value:function getBusinessrulesDecisiontable(tableId,opts){opts=opts||{};// verify the required parameter 'tableId' is set
|
|
11027
10986
|
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']);}/**
|
|
10987
|
+
* Get an export job for a decision table
|
|
10988
|
+
*
|
|
10989
|
+
* @param {String} tableId Table ID
|
|
10990
|
+
* @param {String} exportJobId Export Job ID
|
|
10991
|
+
* @param {Object} opts Optional parameters
|
|
10992
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
10993
|
+
*/},{key:"getBusinessrulesDecisiontableExport",value:function getBusinessrulesDecisiontableExport(tableId,exportJobId,opts){opts=opts||{};// verify the required parameter 'tableId' is set
|
|
10994
|
+
if(tableId===undefined||tableId===null||tableId===''){throw'Missing the required parameter "tableId" when calling getBusinessrulesDecisiontableExport';}// verify the required parameter 'exportJobId' is set
|
|
10995
|
+
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']);}/**
|
|
10996
|
+
* List export jobs for a decision table
|
|
10997
|
+
*
|
|
10998
|
+
* @param {String} tableId Table ID
|
|
10999
|
+
* @param {Object} opts Optional parameters
|
|
11000
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
11001
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 100.
|
|
11002
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
11003
|
+
*/},{key:"getBusinessrulesDecisiontableExports",value:function getBusinessrulesDecisiontableExports(tableId,opts){opts=opts||{};// verify the required parameter 'tableId' is set
|
|
11004
|
+
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']);}/**
|
|
11005
|
+
* Get decision table row import job
|
|
11006
|
+
*
|
|
11007
|
+
* @param {String} tableId Table ID
|
|
11008
|
+
* @param {String} importJobId Import job ID
|
|
11009
|
+
* @param {Object} opts Optional parameters
|
|
11010
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
11011
|
+
*/},{key:"getBusinessrulesDecisiontableImport",value:function getBusinessrulesDecisiontableImport(tableId,importJobId,opts){opts=opts||{};// verify the required parameter 'tableId' is set
|
|
11012
|
+
if(tableId===undefined||tableId===null||tableId===''){throw'Missing the required parameter "tableId" when calling getBusinessrulesDecisiontableImport';}// verify the required parameter 'importJobId' is set
|
|
11013
|
+
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']);}/**
|
|
11014
|
+
* List decision table row import jobs
|
|
11015
|
+
*
|
|
11016
|
+
* @param {String} tableId Table ID
|
|
11017
|
+
* @param {Object} opts Optional parameters
|
|
11018
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
11019
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 100.
|
|
11020
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
11021
|
+
*/},{key:"getBusinessrulesDecisiontableImports",value:function getBusinessrulesDecisiontableImports(tableId,opts){opts=opts||{};// verify the required parameter 'tableId' is set
|
|
11022
|
+
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']);}/**
|
|
11028
11023
|
* Get a decision table version
|
|
11029
11024
|
*
|
|
11030
11025
|
* @param {String} tableId Table ID
|
|
@@ -11119,6 +11114,17 @@ if(coreTypeName===undefined||coreTypeName===null||coreTypeName===''){throw'Missi
|
|
|
11119
11114
|
*/},{key:"patchBusinessrulesDecisiontable",value:function patchBusinessrulesDecisiontable(tableId,body,opts){opts=opts||{};// verify the required parameter 'tableId' is set
|
|
11120
11115
|
if(tableId===undefined||tableId===null||tableId===''){throw'Missing the required parameter "tableId" when calling patchBusinessrulesDecisiontable';}// verify the required parameter 'body' is set
|
|
11121
11116
|
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']);}/**
|
|
11117
|
+
* Update decision table row import job
|
|
11118
|
+
*
|
|
11119
|
+
* @param {String} tableId Table ID
|
|
11120
|
+
* @param {String} importJobId Import job ID
|
|
11121
|
+
* @param {Object} body Import job update request
|
|
11122
|
+
* @param {Object} opts Optional parameters
|
|
11123
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
11124
|
+
*/},{key:"patchBusinessrulesDecisiontableImport",value:function patchBusinessrulesDecisiontableImport(tableId,importJobId,body,opts){opts=opts||{};// verify the required parameter 'tableId' is set
|
|
11125
|
+
if(tableId===undefined||tableId===null||tableId===''){throw'Missing the required parameter "tableId" when calling patchBusinessrulesDecisiontableImport';}// verify the required parameter 'importJobId' is set
|
|
11126
|
+
if(importJobId===undefined||importJobId===null||importJobId===''){throw'Missing the required parameter "importJobId" when calling patchBusinessrulesDecisiontableImport';}// verify the required parameter 'body' is set
|
|
11127
|
+
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']);}/**
|
|
11122
11128
|
* Update a decision table version
|
|
11123
11129
|
*
|
|
11124
11130
|
* @param {String} tableId Table ID
|
|
@@ -11139,6 +11145,24 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
11139
11145
|
*/},{key:"postBusinessrulesDecisiontableExecute",value:function postBusinessrulesDecisiontableExecute(tableId,body,opts){opts=opts||{};// verify the required parameter 'tableId' is set
|
|
11140
11146
|
if(tableId===undefined||tableId===null||tableId===''){throw'Missing the required parameter "tableId" when calling postBusinessrulesDecisiontableExecute';}// verify the required parameter 'body' is set
|
|
11141
11147
|
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']);}/**
|
|
11148
|
+
* Create an export job for a decision table version
|
|
11149
|
+
*
|
|
11150
|
+
* @param {String} tableId Table ID
|
|
11151
|
+
* @param {Object} body Export job request
|
|
11152
|
+
* @param {Object} opts Optional parameters
|
|
11153
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
11154
|
+
*/},{key:"postBusinessrulesDecisiontableExports",value:function postBusinessrulesDecisiontableExports(tableId,body,opts){opts=opts||{};// verify the required parameter 'tableId' is set
|
|
11155
|
+
if(tableId===undefined||tableId===null||tableId===''){throw'Missing the required parameter "tableId" when calling postBusinessrulesDecisiontableExports';}// verify the required parameter 'body' is set
|
|
11156
|
+
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']);}/**
|
|
11157
|
+
* Create a decision table row import job
|
|
11158
|
+
*
|
|
11159
|
+
* @param {String} tableId Table ID
|
|
11160
|
+
* @param {Object} body Import job create request
|
|
11161
|
+
* @param {Object} opts Optional parameters
|
|
11162
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
11163
|
+
*/},{key:"postBusinessrulesDecisiontableImports",value:function postBusinessrulesDecisiontableImports(tableId,body,opts){opts=opts||{};// verify the required parameter 'tableId' is set
|
|
11164
|
+
if(tableId===undefined||tableId===null||tableId===''){throw'Missing the required parameter "tableId" when calling postBusinessrulesDecisiontableImports';}// verify the required parameter 'body' is set
|
|
11165
|
+
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']);}/**
|
|
11142
11166
|
* Copy a decision table version
|
|
11143
11167
|
*
|
|
11144
11168
|
* @param {String} tableId Table ID
|
|
@@ -11172,6 +11196,39 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
11172
11196
|
if(tableId===undefined||tableId===null||tableId===''){throw'Missing the required parameter "tableId" when calling postBusinessrulesDecisiontableVersionRows';}// verify the required parameter 'tableVersion' is set
|
|
11173
11197
|
if(tableVersion===undefined||tableVersion===null){throw'Missing the required parameter "tableVersion" when calling postBusinessrulesDecisiontableVersionRows';}// verify the required parameter 'body' is set
|
|
11174
11198
|
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']);}/**
|
|
11199
|
+
* Bulk add decision table rows
|
|
11200
|
+
* 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.
|
|
11201
|
+
* @param {String} tableId Table ID
|
|
11202
|
+
* @param {Number} tableVersion Table Version
|
|
11203
|
+
* @param {Object} body Bulk add decision table rows request
|
|
11204
|
+
* @param {Object} opts Optional parameters
|
|
11205
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
11206
|
+
*/},{key:"postBusinessrulesDecisiontableVersionRowsBulkAdd",value:function postBusinessrulesDecisiontableVersionRowsBulkAdd(tableId,tableVersion,body,opts){opts=opts||{};// verify the required parameter 'tableId' is set
|
|
11207
|
+
if(tableId===undefined||tableId===null||tableId===''){throw'Missing the required parameter "tableId" when calling postBusinessrulesDecisiontableVersionRowsBulkAdd';}// verify the required parameter 'tableVersion' is set
|
|
11208
|
+
if(tableVersion===undefined||tableVersion===null){throw'Missing the required parameter "tableVersion" when calling postBusinessrulesDecisiontableVersionRowsBulkAdd';}// verify the required parameter 'body' is set
|
|
11209
|
+
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']);}/**
|
|
11210
|
+
* Bulk delete decision table rows
|
|
11211
|
+
* 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.
|
|
11212
|
+
* @param {String} tableId Table ID
|
|
11213
|
+
* @param {Number} tableVersion Table Version
|
|
11214
|
+
* @param {Object} body
|
|
11215
|
+
* @param {Object} opts Optional parameters
|
|
11216
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
11217
|
+
*/},{key:"postBusinessrulesDecisiontableVersionRowsBulkRemove",value:function postBusinessrulesDecisiontableVersionRowsBulkRemove(tableId,tableVersion,body,opts){opts=opts||{};// verify the required parameter 'tableId' is set
|
|
11218
|
+
if(tableId===undefined||tableId===null||tableId===''){throw'Missing the required parameter "tableId" when calling postBusinessrulesDecisiontableVersionRowsBulkRemove';}// verify the required parameter 'tableVersion' is set
|
|
11219
|
+
if(tableVersion===undefined||tableVersion===null){throw'Missing the required parameter "tableVersion" when calling postBusinessrulesDecisiontableVersionRowsBulkRemove';}// verify the required parameter 'body' is set
|
|
11220
|
+
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']);}/**
|
|
11221
|
+
* Bulk update decision table rows
|
|
11222
|
+
* 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.
|
|
11223
|
+
* @param {String} tableId Table ID
|
|
11224
|
+
* @param {Number} tableVersion Table Version
|
|
11225
|
+
* @param {Object} body Bulk update decision table rows request
|
|
11226
|
+
* @param {Object} opts Optional parameters
|
|
11227
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
11228
|
+
*/},{key:"postBusinessrulesDecisiontableVersionRowsBulkUpdate",value:function postBusinessrulesDecisiontableVersionRowsBulkUpdate(tableId,tableVersion,body,opts){opts=opts||{};// verify the required parameter 'tableId' is set
|
|
11229
|
+
if(tableId===undefined||tableId===null||tableId===''){throw'Missing the required parameter "tableId" when calling postBusinessrulesDecisiontableVersionRowsBulkUpdate';}// verify the required parameter 'tableVersion' is set
|
|
11230
|
+
if(tableVersion===undefined||tableVersion===null){throw'Missing the required parameter "tableVersion" when calling postBusinessrulesDecisiontableVersionRowsBulkUpdate';}// verify the required parameter 'body' is set
|
|
11231
|
+
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']);}/**
|
|
11175
11232
|
* Search for decision table rows
|
|
11176
11233
|
*
|
|
11177
11234
|
* @param {String} tableId Table ID
|
|
@@ -11248,7 +11305,7 @@ if(schemaId===undefined||schemaId===null||schemaId===''){throw'Missing the requi
|
|
|
11248
11305
|
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(){/**
|
|
11249
11306
|
* CarrierServices service.
|
|
11250
11307
|
* @module purecloud-platform-client-v2/api/CarrierServicesApi
|
|
11251
|
-
* @version
|
|
11308
|
+
* @version 254.0.0
|
|
11252
11309
|
*//**
|
|
11253
11310
|
* Constructs a new CarrierServicesApi.
|
|
11254
11311
|
* @alias module:purecloud-platform-client-v2/api/CarrierServicesApi
|
|
@@ -11271,7 +11328,7 @@ if(phoneNumber===undefined||phoneNumber===null){throw'Missing the required param
|
|
|
11271
11328
|
*/},{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(){/**
|
|
11272
11329
|
* CaseManagement service.
|
|
11273
11330
|
* @module purecloud-platform-client-v2/api/CaseManagementApi
|
|
11274
|
-
* @version
|
|
11331
|
+
* @version 254.0.0
|
|
11275
11332
|
*//**
|
|
11276
11333
|
* Constructs a new CaseManagementApi.
|
|
11277
11334
|
* @alias module:purecloud-platform-client-v2/api/CaseManagementApi
|
|
@@ -11281,167 +11338,160 @@ if(phoneNumber===undefined||phoneNumber===null){throw'Missing the required param
|
|
|
11281
11338
|
*/function CaseManagementApi(apiClient){_classCallCheck(this,CaseManagementApi);this.apiClient=apiClient||ApiClient.instance;}/**
|
|
11282
11339
|
* Delete a Case.
|
|
11283
11340
|
*
|
|
11284
|
-
* @param {String} caseId Case
|
|
11341
|
+
* @param {String} caseId Case identifier.
|
|
11285
11342
|
* @param {Object} opts Optional parameters
|
|
11286
11343
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
11287
|
-
* deleteCasemanagementCase is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
11288
11344
|
*/return _createClass(CaseManagementApi,[{key:"deleteCasemanagementCase",value:function deleteCasemanagementCase(caseId,opts){opts=opts||{};// verify the required parameter 'caseId' is set
|
|
11289
11345
|
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']);}/**
|
|
11290
11346
|
* Delete a Caseplan.
|
|
11291
11347
|
*
|
|
11292
|
-
* @param {String} caseplanId Caseplan
|
|
11348
|
+
* @param {String} caseplanId Caseplan identifier.
|
|
11293
11349
|
* @param {Object} opts Optional parameters
|
|
11294
11350
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
11295
|
-
* deleteCasemanagementCaseplan is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
11296
11351
|
*/},{key:"deleteCasemanagementCaseplan",value:function deleteCasemanagementCaseplan(caseplanId,opts){opts=opts||{};// verify the required parameter 'caseplanId' is set
|
|
11297
11352
|
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']);}/**
|
|
11353
|
+
* Remove a data schema from a draft Caseplan.
|
|
11354
|
+
*
|
|
11355
|
+
* @param {String} caseplanId Caseplan identifier.
|
|
11356
|
+
* @param {String} schemaKeyName Schema key (for example default).
|
|
11357
|
+
* @param {Object} opts Optional parameters
|
|
11358
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
11359
|
+
*/},{key:"deleteCasemanagementCaseplanDataschema",value:function deleteCasemanagementCaseplanDataschema(caseplanId,schemaKeyName,opts){opts=opts||{};// verify the required parameter 'caseplanId' is set
|
|
11360
|
+
if(caseplanId===undefined||caseplanId===null||caseplanId===''){throw'Missing the required parameter "caseplanId" when calling deleteCasemanagementCaseplanDataschema';}// verify the required parameter 'schemaKeyName' is set
|
|
11361
|
+
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']);}/**
|
|
11298
11362
|
* Get a Case.
|
|
11299
11363
|
*
|
|
11300
|
-
* @param {String} caseId Case
|
|
11364
|
+
* @param {String} caseId Case identifier.
|
|
11301
11365
|
* @param {Object} opts Optional parameters
|
|
11302
|
-
* @param {Object} opts.expands
|
|
11366
|
+
* @param {Object} opts.expands Fields to expand.
|
|
11303
11367
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
11304
|
-
* getCasemanagementCase is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
11305
11368
|
*/},{key:"getCasemanagementCase",value:function getCasemanagementCase(caseId,opts){opts=opts||{};// verify the required parameter 'caseId' is set
|
|
11306
11369
|
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']);}/**
|
|
11307
11370
|
* Get a Case Association.
|
|
11308
11371
|
*
|
|
11309
|
-
* @param {String} caseId Case
|
|
11310
|
-
* @param {String} associationId Case
|
|
11372
|
+
* @param {String} caseId Case identifier.
|
|
11373
|
+
* @param {String} associationId Case association identifier.
|
|
11311
11374
|
* @param {Object} opts Optional parameters
|
|
11312
11375
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
11313
|
-
* getCasemanagementCaseAssociation is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
11314
11376
|
*/},{key:"getCasemanagementCaseAssociation",value:function getCasemanagementCaseAssociation(caseId,associationId,opts){opts=opts||{};// verify the required parameter 'caseId' is set
|
|
11315
11377
|
if(caseId===undefined||caseId===null||caseId===''){throw'Missing the required parameter "caseId" when calling getCasemanagementCaseAssociation';}// verify the required parameter 'associationId' is set
|
|
11316
11378
|
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']);}/**
|
|
11317
|
-
* Get a list of
|
|
11379
|
+
* Get a list of Case associations for the Case.
|
|
11318
11380
|
*
|
|
11319
|
-
* @param {String} caseId Case
|
|
11381
|
+
* @param {String} caseId Case identifier.
|
|
11320
11382
|
* @param {Object} opts Optional parameters
|
|
11321
11383
|
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
11322
11384
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
11323
11385
|
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
11324
11386
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
11325
|
-
* getCasemanagementCaseAssociations is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
11326
11387
|
*/},{key:"getCasemanagementCaseAssociations",value:function getCasemanagementCaseAssociations(caseId,opts){opts=opts||{};// verify the required parameter 'caseId' is set
|
|
11327
11388
|
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']);}/**
|
|
11328
11389
|
* Get a Stage.
|
|
11329
11390
|
*
|
|
11330
|
-
* @param {String} caseId Case
|
|
11331
|
-
* @param {String} stageId Stage
|
|
11391
|
+
* @param {String} caseId Case identifier.
|
|
11392
|
+
* @param {String} stageId Stage identifier.
|
|
11332
11393
|
* @param {Object} opts Optional parameters
|
|
11333
11394
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
11334
|
-
* getCasemanagementCaseStage is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
11335
11395
|
*/},{key:"getCasemanagementCaseStage",value:function getCasemanagementCaseStage(caseId,stageId,opts){opts=opts||{};// verify the required parameter 'caseId' is set
|
|
11336
11396
|
if(caseId===undefined||caseId===null||caseId===''){throw'Missing the required parameter "caseId" when calling getCasemanagementCaseStage';}// verify the required parameter 'stageId' is set
|
|
11337
11397
|
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']);}/**
|
|
11338
11398
|
* Get a Step.
|
|
11339
11399
|
*
|
|
11340
|
-
* @param {String} caseId Case
|
|
11341
|
-
* @param {String} stageId Stage
|
|
11342
|
-
* @param {String} stepId Step
|
|
11400
|
+
* @param {String} caseId Case identifier.
|
|
11401
|
+
* @param {String} stageId Stage identifier.
|
|
11402
|
+
* @param {String} stepId Step identifier.
|
|
11343
11403
|
* @param {Object} opts Optional parameters
|
|
11344
11404
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
11345
|
-
* getCasemanagementCaseStageStep is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
11346
11405
|
*/},{key:"getCasemanagementCaseStageStep",value:function getCasemanagementCaseStageStep(caseId,stageId,stepId,opts){opts=opts||{};// verify the required parameter 'caseId' is set
|
|
11347
11406
|
if(caseId===undefined||caseId===null||caseId===''){throw'Missing the required parameter "caseId" when calling getCasemanagementCaseStageStep';}// verify the required parameter 'stageId' is set
|
|
11348
11407
|
if(stageId===undefined||stageId===null||stageId===''){throw'Missing the required parameter "stageId" when calling getCasemanagementCaseStageStep';}// verify the required parameter 'stepId' is set
|
|
11349
11408
|
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']);}/**
|
|
11350
11409
|
* Get a list of Steps.
|
|
11351
11410
|
*
|
|
11352
|
-
* @param {String} caseId Case
|
|
11353
|
-
* @param {String} stageId Stage
|
|
11411
|
+
* @param {String} caseId Case identifier.
|
|
11412
|
+
* @param {String} stageId Stage identifier.
|
|
11354
11413
|
* @param {Object} opts Optional parameters
|
|
11355
11414
|
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
11356
11415
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
11357
11416
|
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
11358
11417
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
11359
|
-
* getCasemanagementCaseStageSteps is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
11360
11418
|
*/},{key:"getCasemanagementCaseStageSteps",value:function getCasemanagementCaseStageSteps(caseId,stageId,opts){opts=opts||{};// verify the required parameter 'caseId' is set
|
|
11361
11419
|
if(caseId===undefined||caseId===null||caseId===''){throw'Missing the required parameter "caseId" when calling getCasemanagementCaseStageSteps';}// verify the required parameter 'stageId' is set
|
|
11362
11420
|
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']);}/**
|
|
11363
11421
|
* Get a list of Stages.
|
|
11364
11422
|
*
|
|
11365
|
-
* @param {String} caseId Case
|
|
11423
|
+
* @param {String} caseId Case identifier.
|
|
11366
11424
|
* @param {Object} opts Optional parameters
|
|
11367
11425
|
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
11368
11426
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
11369
11427
|
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
11370
11428
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
11371
|
-
* getCasemanagementCaseStages is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
11372
11429
|
*/},{key:"getCasemanagementCaseStages",value:function getCasemanagementCaseStages(caseId,opts){opts=opts||{};// verify the required parameter 'caseId' is set
|
|
11373
11430
|
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']);}/**
|
|
11374
11431
|
* Get a Terminate Job for a Case.
|
|
11375
11432
|
*
|
|
11376
|
-
* @param {String} caseId Case
|
|
11377
|
-
* @param {String} jobId Job
|
|
11433
|
+
* @param {String} caseId Case identifier.
|
|
11434
|
+
* @param {String} jobId Terminate Job identifier.
|
|
11378
11435
|
* @param {Object} opts Optional parameters
|
|
11379
11436
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
11380
|
-
* getCasemanagementCaseTerminateJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
11381
11437
|
*/},{key:"getCasemanagementCaseTerminateJob",value:function getCasemanagementCaseTerminateJob(caseId,jobId,opts){opts=opts||{};// verify the required parameter 'caseId' is set
|
|
11382
11438
|
if(caseId===undefined||caseId===null||caseId===''){throw'Missing the required parameter "caseId" when calling getCasemanagementCaseTerminateJob';}// verify the required parameter 'jobId' is set
|
|
11383
11439
|
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']);}/**
|
|
11384
11440
|
* Get a Caseplan.
|
|
11385
11441
|
*
|
|
11386
|
-
* @param {String} caseplanId Caseplan
|
|
11442
|
+
* @param {String} caseplanId Caseplan identifier.
|
|
11387
11443
|
* @param {Object} opts Optional parameters
|
|
11388
11444
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
11389
|
-
* getCasemanagementCaseplan is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
11390
11445
|
*/},{key:"getCasemanagementCaseplan",value:function getCasemanagementCaseplan(caseplanId,opts){opts=opts||{};// verify the required parameter 'caseplanId' is set
|
|
11391
11446
|
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']);}/**
|
|
11392
11447
|
* Get a Caseplan version.
|
|
11393
11448
|
*
|
|
11394
|
-
* @param {String} caseplanId Caseplan
|
|
11395
|
-
* @param {String} versionId
|
|
11449
|
+
* @param {String} caseplanId Caseplan identifier.
|
|
11450
|
+
* @param {String} versionId Caseplan version identifier.
|
|
11396
11451
|
* @param {Object} opts Optional parameters
|
|
11397
11452
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
11398
|
-
* getCasemanagementCaseplanVersion is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
11399
11453
|
*/},{key:"getCasemanagementCaseplanVersion",value:function getCasemanagementCaseplanVersion(caseplanId,versionId,opts){opts=opts||{};// verify the required parameter 'caseplanId' is set
|
|
11400
11454
|
if(caseplanId===undefined||caseplanId===null||caseplanId===''){throw'Missing the required parameter "caseplanId" when calling getCasemanagementCaseplanVersion';}// verify the required parameter 'versionId' is set
|
|
11401
11455
|
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']);}/**
|
|
11402
|
-
* Get the
|
|
11456
|
+
* Get the data schemas for a Caseplan version.
|
|
11403
11457
|
*
|
|
11404
|
-
* @param {String} caseplanId Caseplan
|
|
11405
|
-
* @param {String} versionId
|
|
11458
|
+
* @param {String} caseplanId Caseplan identifier.
|
|
11459
|
+
* @param {String} versionId Caseplan version identifier.
|
|
11406
11460
|
* @param {Object} opts Optional parameters
|
|
11407
11461
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
11408
|
-
* getCasemanagementCaseplanVersionDataschemas is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
11409
11462
|
*/},{key:"getCasemanagementCaseplanVersionDataschemas",value:function getCasemanagementCaseplanVersionDataschemas(caseplanId,versionId,opts){opts=opts||{};// verify the required parameter 'caseplanId' is set
|
|
11410
11463
|
if(caseplanId===undefined||caseplanId===null||caseplanId===''){throw'Missing the required parameter "caseplanId" when calling getCasemanagementCaseplanVersionDataschemas';}// verify the required parameter 'versionId' is set
|
|
11411
11464
|
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']);}/**
|
|
11412
11465
|
* Get the intake settings for a Caseplan version.
|
|
11413
11466
|
*
|
|
11414
|
-
* @param {String} caseplanId Caseplan
|
|
11415
|
-
* @param {String} versionId
|
|
11467
|
+
* @param {String} caseplanId Caseplan identifier.
|
|
11468
|
+
* @param {String} versionId Caseplan version identifier.
|
|
11416
11469
|
* @param {Object} opts Optional parameters
|
|
11417
11470
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
11418
|
-
* getCasemanagementCaseplanVersionIntakesettings is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
11419
11471
|
*/},{key:"getCasemanagementCaseplanVersionIntakesettings",value:function getCasemanagementCaseplanVersionIntakesettings(caseplanId,versionId,opts){opts=opts||{};// verify the required parameter 'caseplanId' is set
|
|
11420
11472
|
if(caseplanId===undefined||caseplanId===null||caseplanId===''){throw'Missing the required parameter "caseplanId" when calling getCasemanagementCaseplanVersionIntakesettings';}// verify the required parameter 'versionId' is set
|
|
11421
11473
|
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']);}/**
|
|
11422
11474
|
* Get a Stageplan.
|
|
11423
11475
|
*
|
|
11424
|
-
* @param {String} caseplanId Caseplan
|
|
11425
|
-
* @param {String} versionId
|
|
11426
|
-
* @param {String} stageplanId Stageplan
|
|
11476
|
+
* @param {String} caseplanId Caseplan identifier.
|
|
11477
|
+
* @param {String} versionId Caseplan version identifier.
|
|
11478
|
+
* @param {String} stageplanId Stageplan identifier.
|
|
11427
11479
|
* @param {Object} opts Optional parameters
|
|
11428
|
-
* @param {Array.<String>} opts.expands
|
|
11480
|
+
* @param {Array.<String>} opts.expands Fields to expand.
|
|
11429
11481
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
11430
|
-
* getCasemanagementCaseplanVersionStageplan is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
11431
11482
|
*/},{key:"getCasemanagementCaseplanVersionStageplan",value:function getCasemanagementCaseplanVersionStageplan(caseplanId,versionId,stageplanId,opts){opts=opts||{};// verify the required parameter 'caseplanId' is set
|
|
11432
11483
|
if(caseplanId===undefined||caseplanId===null||caseplanId===''){throw'Missing the required parameter "caseplanId" when calling getCasemanagementCaseplanVersionStageplan';}// verify the required parameter 'versionId' is set
|
|
11433
11484
|
if(versionId===undefined||versionId===null||versionId===''){throw'Missing the required parameter "versionId" when calling getCasemanagementCaseplanVersionStageplan';}// verify the required parameter 'stageplanId' is set
|
|
11434
11485
|
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']);}/**
|
|
11435
11486
|
* Get a Stepplan.
|
|
11436
11487
|
*
|
|
11437
|
-
* @param {String} caseplanId Caseplan
|
|
11438
|
-
* @param {String} versionId
|
|
11439
|
-
* @param {String} stageplanId Stageplan
|
|
11440
|
-
* @param {String} stepplanId Stepplan
|
|
11488
|
+
* @param {String} caseplanId Caseplan identifier.
|
|
11489
|
+
* @param {String} versionId Caseplan version identifier.
|
|
11490
|
+
* @param {String} stageplanId Stageplan identifier.
|
|
11491
|
+
* @param {String} stepplanId Stepplan identifier.
|
|
11441
11492
|
* @param {Object} opts Optional parameters
|
|
11442
|
-
* @param {Array.<String>} opts.expands
|
|
11493
|
+
* @param {Array.<String>} opts.expands Fields to expand.
|
|
11443
11494
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
11444
|
-
* getCasemanagementCaseplanVersionStageplanStepplan is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
11445
11495
|
*/},{key:"getCasemanagementCaseplanVersionStageplanStepplan",value:function getCasemanagementCaseplanVersionStageplanStepplan(caseplanId,versionId,stageplanId,stepplanId,opts){opts=opts||{};// verify the required parameter 'caseplanId' is set
|
|
11446
11496
|
if(caseplanId===undefined||caseplanId===null||caseplanId===''){throw'Missing the required parameter "caseplanId" when calling getCasemanagementCaseplanVersionStageplanStepplan';}// verify the required parameter 'versionId' is set
|
|
11447
11497
|
if(versionId===undefined||versionId===null||versionId===''){throw'Missing the required parameter "versionId" when calling getCasemanagementCaseplanVersionStageplanStepplan';}// verify the required parameter 'stageplanId' is set
|
|
@@ -11449,208 +11499,210 @@ if(stageplanId===undefined||stageplanId===null||stageplanId===''){throw'Missing
|
|
|
11449
11499
|
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']);}/**
|
|
11450
11500
|
* Get a list of Stepplans.
|
|
11451
11501
|
*
|
|
11452
|
-
* @param {String} caseplanId Caseplan
|
|
11453
|
-
* @param {String} versionId
|
|
11454
|
-
* @param {String} stageplanId Stageplan
|
|
11502
|
+
* @param {String} caseplanId Caseplan identifier.
|
|
11503
|
+
* @param {String} versionId Caseplan version identifier.
|
|
11504
|
+
* @param {String} stageplanId Stageplan identifier.
|
|
11455
11505
|
* @param {Object} opts Optional parameters
|
|
11456
11506
|
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
11457
11507
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
11458
11508
|
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
11459
|
-
* @param {Array.<String>} opts.expands
|
|
11509
|
+
* @param {Array.<String>} opts.expands Fields to expand.
|
|
11460
11510
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
11461
|
-
* getCasemanagementCaseplanVersionStageplanStepplans is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
11462
11511
|
*/},{key:"getCasemanagementCaseplanVersionStageplanStepplans",value:function getCasemanagementCaseplanVersionStageplanStepplans(caseplanId,versionId,stageplanId,opts){opts=opts||{};// verify the required parameter 'caseplanId' is set
|
|
11463
11512
|
if(caseplanId===undefined||caseplanId===null||caseplanId===''){throw'Missing the required parameter "caseplanId" when calling getCasemanagementCaseplanVersionStageplanStepplans';}// verify the required parameter 'versionId' is set
|
|
11464
11513
|
if(versionId===undefined||versionId===null||versionId===''){throw'Missing the required parameter "versionId" when calling getCasemanagementCaseplanVersionStageplanStepplans';}// verify the required parameter 'stageplanId' is set
|
|
11465
11514
|
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']);}/**
|
|
11466
11515
|
* Get a list of Stageplans.
|
|
11467
11516
|
*
|
|
11468
|
-
* @param {String} caseplanId Caseplan
|
|
11469
|
-
* @param {String} versionId
|
|
11517
|
+
* @param {String} caseplanId Caseplan identifier.
|
|
11518
|
+
* @param {String} versionId Caseplan version identifier.
|
|
11470
11519
|
* @param {Object} opts Optional parameters
|
|
11471
11520
|
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
11472
11521
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
11473
11522
|
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
11474
|
-
* @param {Array.<String>} opts.expands
|
|
11523
|
+
* @param {Array.<String>} opts.expands Fields to expand.
|
|
11475
11524
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
11476
|
-
* getCasemanagementCaseplanVersionStageplans is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
11477
11525
|
*/},{key:"getCasemanagementCaseplanVersionStageplans",value:function getCasemanagementCaseplanVersionStageplans(caseplanId,versionId,opts){opts=opts||{};// verify the required parameter 'caseplanId' is set
|
|
11478
11526
|
if(caseplanId===undefined||caseplanId===null||caseplanId===''){throw'Missing the required parameter "caseplanId" when calling getCasemanagementCaseplanVersionStageplans';}// verify the required parameter 'versionId' is set
|
|
11479
11527
|
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']);}/**
|
|
11480
11528
|
* Get a list of Caseplans.
|
|
11481
11529
|
*
|
|
11482
11530
|
* @param {Object} opts Optional parameters
|
|
11483
|
-
* @param {String} opts.after
|
|
11484
|
-
* @param {Number} opts.pageSize Number of
|
|
11485
|
-
* @param {String} opts.customerIntentId Filter by
|
|
11486
|
-
* @param {String} opts.divisionIds Filter by
|
|
11531
|
+
* @param {String} opts.after Cursor that points to the end of the previously returned set of Caseplans.
|
|
11532
|
+
* @param {Number} opts.pageSize Number of Caseplans to return. Maximum is 200.
|
|
11533
|
+
* @param {String} opts.customerIntentId Filter by customer intent.
|
|
11534
|
+
* @param {String} opts.divisionIds Filter by divisions.
|
|
11487
11535
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
11488
|
-
* getCasemanagementCaseplans is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
11489
11536
|
*/},{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']);}/**
|
|
11490
|
-
* Get a list of
|
|
11537
|
+
* Get a list of Cases for an External Contact.
|
|
11491
11538
|
*
|
|
11492
|
-
* @param {String} externalContactId External
|
|
11539
|
+
* @param {String} externalContactId External contact identifier.
|
|
11493
11540
|
* @param {Object} opts Optional parameters
|
|
11494
|
-
* @param {String} opts.after
|
|
11495
|
-
* @param {Number} opts.pageSize Number of
|
|
11496
|
-
* @param {String} opts.divisionIds Filter by
|
|
11497
|
-
* @param {Array.<String>} opts.expands
|
|
11541
|
+
* @param {String} opts.after Cursor pointing to the end of the previously returned page of Cases.
|
|
11542
|
+
* @param {Number} opts.pageSize Number of Cases to return (maximum 200).
|
|
11543
|
+
* @param {String} opts.divisionIds Filter by divisions.
|
|
11544
|
+
* @param {Array.<String>} opts.expands Fields to expand.
|
|
11498
11545
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
11499
|
-
* getCasemanagementCasesExternalcontact is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
11500
11546
|
*/},{key:"getCasemanagementCasesExternalcontact",value:function getCasemanagementCasesExternalcontact(externalContactId,opts){opts=opts||{};// verify the required parameter 'externalContactId' is set
|
|
11501
11547
|
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']);}/**
|
|
11502
11548
|
* Get a Case by reference.
|
|
11503
11549
|
*
|
|
11504
|
-
* @param {String} referenceId
|
|
11550
|
+
* @param {String} referenceId Case reference.
|
|
11505
11551
|
* @param {Object} opts Optional parameters
|
|
11506
|
-
* @param {Object} opts.expands
|
|
11552
|
+
* @param {Object} opts.expands Fields to expand.
|
|
11507
11553
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
11508
|
-
* getCasemanagementCasesReference is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
11509
11554
|
*/},{key:"getCasemanagementCasesReference",value:function getCasemanagementCasesReference(referenceId,opts){opts=opts||{};// verify the required parameter 'referenceId' is set
|
|
11510
11555
|
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']);}/**
|
|
11511
|
-
* Update
|
|
11556
|
+
* Update the due date of a Case.
|
|
11512
11557
|
*
|
|
11513
|
-
* @param {String} caseId Case
|
|
11514
|
-
* @param {Object} body
|
|
11558
|
+
* @param {String} caseId Case identifier.
|
|
11559
|
+
* @param {Object} body Due date update.
|
|
11515
11560
|
* @param {Object} opts Optional parameters
|
|
11516
11561
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
11517
|
-
* patchCasemanagementCaseDatedue is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
11518
11562
|
*/},{key:"patchCasemanagementCaseDatedue",value:function patchCasemanagementCaseDatedue(caseId,body,opts){opts=opts||{};// verify the required parameter 'caseId' is set
|
|
11519
11563
|
if(caseId===undefined||caseId===null||caseId===''){throw'Missing the required parameter "caseId" when calling patchCasemanagementCaseDatedue';}// verify the required parameter 'body' is set
|
|
11520
11564
|
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']);}/**
|
|
11521
11565
|
* Update priority of a Case.
|
|
11522
11566
|
*
|
|
11523
|
-
* @param {String} caseId Case
|
|
11524
|
-
* @param {Object} body Priority
|
|
11567
|
+
* @param {String} caseId Case identifier.
|
|
11568
|
+
* @param {Object} body Priority update.
|
|
11525
11569
|
* @param {Object} opts Optional parameters
|
|
11526
11570
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
11527
|
-
* patchCasemanagementCasePriority is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
11528
11571
|
*/},{key:"patchCasemanagementCasePriority",value:function patchCasemanagementCasePriority(caseId,body,opts){opts=opts||{};// verify the required parameter 'caseId' is set
|
|
11529
11572
|
if(caseId===undefined||caseId===null||caseId===''){throw'Missing the required parameter "caseId" when calling patchCasemanagementCasePriority';}// verify the required parameter 'body' is set
|
|
11530
11573
|
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']);}/**
|
|
11531
11574
|
* Update summary of a Case.
|
|
11532
11575
|
*
|
|
11533
|
-
* @param {String} caseId Case
|
|
11534
|
-
* @param {Object} body Summary
|
|
11576
|
+
* @param {String} caseId Case identifier.
|
|
11577
|
+
* @param {Object} body Summary update.
|
|
11535
11578
|
* @param {Object} opts Optional parameters
|
|
11536
11579
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
11537
|
-
* patchCasemanagementCaseSummary is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
11538
11580
|
*/},{key:"patchCasemanagementCaseSummary",value:function patchCasemanagementCaseSummary(caseId,body,opts){opts=opts||{};// verify the required parameter 'caseId' is set
|
|
11539
11581
|
if(caseId===undefined||caseId===null||caseId===''){throw'Missing the required parameter "caseId" when calling patchCasemanagementCaseSummary';}// verify the required parameter 'body' is set
|
|
11540
11582
|
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']);}/**
|
|
11541
11583
|
* Update the attributes of a Caseplan.
|
|
11542
11584
|
*
|
|
11543
|
-
* @param {String} caseplanId Caseplan
|
|
11544
|
-
* @param {Object} body Caseplan
|
|
11585
|
+
* @param {String} caseplanId Caseplan identifier.
|
|
11586
|
+
* @param {Object} body Caseplan update.
|
|
11545
11587
|
* @param {Object} opts Optional parameters
|
|
11546
11588
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
11547
|
-
* patchCasemanagementCaseplan is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
11548
11589
|
*/},{key:"patchCasemanagementCaseplan",value:function patchCasemanagementCaseplan(caseplanId,body,opts){opts=opts||{};// verify the required parameter 'caseplanId' is set
|
|
11549
11590
|
if(caseplanId===undefined||caseplanId===null||caseplanId===''){throw'Missing the required parameter "caseplanId" when calling patchCasemanagementCaseplan';}// verify the required parameter 'body' is set
|
|
11550
11591
|
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']);}/**
|
|
11551
11592
|
* Update the attributes of a Stageplan.
|
|
11552
11593
|
*
|
|
11553
|
-
* @param {String} caseplanId Caseplan
|
|
11554
|
-
* @param {String} stageplanId Stageplan
|
|
11555
|
-
* @param {Object} body Stageplan
|
|
11594
|
+
* @param {String} caseplanId Caseplan identifier.
|
|
11595
|
+
* @param {String} stageplanId Stageplan identifier.
|
|
11596
|
+
* @param {Object} body Stageplan update.
|
|
11556
11597
|
* @param {Object} opts Optional parameters
|
|
11557
11598
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
11558
|
-
* patchCasemanagementCaseplanStageplan is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
11559
11599
|
*/},{key:"patchCasemanagementCaseplanStageplan",value:function patchCasemanagementCaseplanStageplan(caseplanId,stageplanId,body,opts){opts=opts||{};// verify the required parameter 'caseplanId' is set
|
|
11560
11600
|
if(caseplanId===undefined||caseplanId===null||caseplanId===''){throw'Missing the required parameter "caseplanId" when calling patchCasemanagementCaseplanStageplan';}// verify the required parameter 'stageplanId' is set
|
|
11561
11601
|
if(stageplanId===undefined||stageplanId===null||stageplanId===''){throw'Missing the required parameter "stageplanId" when calling patchCasemanagementCaseplanStageplan';}// verify the required parameter 'body' is set
|
|
11562
11602
|
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']);}/**
|
|
11563
11603
|
* Update the attributes of a Stepplan.
|
|
11564
11604
|
*
|
|
11565
|
-
* @param {String} caseplanId Caseplan
|
|
11566
|
-
* @param {String} stageplanId Stageplan
|
|
11567
|
-
* @param {String} stepplanId Stepplan
|
|
11568
|
-
* @param {Object} body Stepplan
|
|
11605
|
+
* @param {String} caseplanId Caseplan identifier.
|
|
11606
|
+
* @param {String} stageplanId Stageplan identifier.
|
|
11607
|
+
* @param {String} stepplanId Stepplan identifier.
|
|
11608
|
+
* @param {Object} body Stepplan update.
|
|
11569
11609
|
* @param {Object} opts Optional parameters
|
|
11570
11610
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
11571
|
-
* patchCasemanagementCaseplanStageplanStepplan is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
11572
11611
|
*/},{key:"patchCasemanagementCaseplanStageplanStepplan",value:function patchCasemanagementCaseplanStageplanStepplan(caseplanId,stageplanId,stepplanId,body,opts){opts=opts||{};// verify the required parameter 'caseplanId' is set
|
|
11573
11612
|
if(caseplanId===undefined||caseplanId===null||caseplanId===''){throw'Missing the required parameter "caseplanId" when calling patchCasemanagementCaseplanStageplanStepplan';}// verify the required parameter 'stageplanId' is set
|
|
11574
11613
|
if(stageplanId===undefined||stageplanId===null||stageplanId===''){throw'Missing the required parameter "stageplanId" when calling patchCasemanagementCaseplanStageplanStepplan';}// verify the required parameter 'stepplanId' is set
|
|
11575
11614
|
if(stepplanId===undefined||stepplanId===null||stepplanId===''){throw'Missing the required parameter "stepplanId" when calling patchCasemanagementCaseplanStageplanStepplan';}// verify the required parameter 'body' is set
|
|
11576
11615
|
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']);}/**
|
|
11577
|
-
* Create a
|
|
11616
|
+
* Create a Case association.
|
|
11578
11617
|
*
|
|
11579
|
-
* @param {String} caseId Case
|
|
11618
|
+
* @param {String} caseId Case identifier.
|
|
11619
|
+
* @param {Object} body Case association create request.
|
|
11580
11620
|
* @param {Object} opts Optional parameters
|
|
11581
|
-
* @param {Object} opts.body Case Association
|
|
11582
11621
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
11583
|
-
|
|
11584
|
-
|
|
11585
|
-
if(
|
|
11622
|
+
*/},{key:"postCasemanagementCaseAssociations",value:function postCasemanagementCaseAssociations(caseId,body,opts){opts=opts||{};// verify the required parameter 'caseId' is set
|
|
11623
|
+
if(caseId===undefined||caseId===null||caseId===''){throw'Missing the required parameter "caseId" when calling postCasemanagementCaseAssociations';}// verify the required parameter 'body' is set
|
|
11624
|
+
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']);}/**
|
|
11586
11625
|
* Create a Terminate Job for a Case.
|
|
11587
11626
|
*
|
|
11588
|
-
* @param {String} caseId Case
|
|
11627
|
+
* @param {String} caseId Case identifier.
|
|
11589
11628
|
* @param {Object} opts Optional parameters
|
|
11590
11629
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
11591
|
-
* postCasemanagementCaseTerminateJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
11592
11630
|
*/},{key:"postCasemanagementCaseTerminateJobs",value:function postCasemanagementCaseTerminateJobs(caseId,opts){opts=opts||{};// verify the required parameter 'caseId' is set
|
|
11593
11631
|
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']);}/**
|
|
11632
|
+
* Add a data schema to a draft Caseplan.
|
|
11633
|
+
*
|
|
11634
|
+
* @param {String} caseplanId Caseplan identifier.
|
|
11635
|
+
* @param {Object} body Data schema reference.
|
|
11636
|
+
* @param {Object} opts Optional parameters
|
|
11637
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
11638
|
+
*/},{key:"postCasemanagementCaseplanDataschemas",value:function postCasemanagementCaseplanDataschemas(caseplanId,body,opts){opts=opts||{};// verify the required parameter 'caseplanId' is set
|
|
11639
|
+
if(caseplanId===undefined||caseplanId===null||caseplanId===''){throw'Missing the required parameter "caseplanId" when calling postCasemanagementCaseplanDataschemas';}// verify the required parameter 'body' is set
|
|
11640
|
+
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']);}/**
|
|
11594
11641
|
* Publish Caseplan.
|
|
11595
11642
|
*
|
|
11596
|
-
* @param {String} caseplanId Caseplan
|
|
11643
|
+
* @param {String} caseplanId Caseplan identifier.
|
|
11597
11644
|
* @param {Object} opts Optional parameters
|
|
11598
11645
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
11599
|
-
* postCasemanagementCaseplanPublish is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
11600
11646
|
*/},{key:"postCasemanagementCaseplanPublish",value:function postCasemanagementCaseplanPublish(caseplanId,opts){opts=opts||{};// verify the required parameter 'caseplanId' is set
|
|
11601
11647
|
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']);}/**
|
|
11602
11648
|
* Create Caseplan version.
|
|
11603
11649
|
*
|
|
11604
|
-
* @param {String} caseplanId Caseplan
|
|
11650
|
+
* @param {String} caseplanId Caseplan identifier.
|
|
11605
11651
|
* @param {Object} opts Optional parameters
|
|
11606
11652
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
11607
|
-
* postCasemanagementCaseplanVersions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
11608
11653
|
*/},{key:"postCasemanagementCaseplanVersions",value:function postCasemanagementCaseplanVersions(caseplanId,opts){opts=opts||{};// verify the required parameter 'caseplanId' is set
|
|
11609
11654
|
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']);}/**
|
|
11610
11655
|
* Create a Caseplan.
|
|
11611
11656
|
*
|
|
11612
|
-
* @param {Object} body Caseplan
|
|
11657
|
+
* @param {Object} body Caseplan create request.
|
|
11613
11658
|
* @param {Object} opts Optional parameters
|
|
11614
11659
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
11615
|
-
* postCasemanagementCaseplans is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
11616
11660
|
*/},{key:"postCasemanagementCaseplans",value:function postCasemanagementCaseplans(body,opts){opts=opts||{};// verify the required parameter 'body' is set
|
|
11617
11661
|
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']);}/**
|
|
11618
|
-
* Query for
|
|
11662
|
+
* Query for Caseplans.
|
|
11619
11663
|
*
|
|
11620
|
-
* @param {Object} body
|
|
11664
|
+
* @param {Object} body Caseplan query request.
|
|
11621
11665
|
* @param {Object} opts Optional parameters
|
|
11622
11666
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
11623
|
-
* postCasemanagementCaseplansQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
11624
11667
|
*/},{key:"postCasemanagementCaseplansQuery",value:function postCasemanagementCaseplansQuery(body,opts){opts=opts||{};// verify the required parameter 'body' is set
|
|
11625
11668
|
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']);}/**
|
|
11626
11669
|
* Create a Case.
|
|
11627
11670
|
*
|
|
11628
|
-
* @param {Object} body Case
|
|
11671
|
+
* @param {Object} body Case create request.
|
|
11629
11672
|
* @param {Object} opts Optional parameters
|
|
11630
11673
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
11631
|
-
* postCasemanagementCases is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
11632
11674
|
*/},{key:"postCasemanagementCases",value:function postCasemanagementCases(body,opts){opts=opts||{};// verify the required parameter 'body' is set
|
|
11633
11675
|
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']);}/**
|
|
11634
|
-
* Query for
|
|
11676
|
+
* Query for Case associations by interaction.
|
|
11677
|
+
*
|
|
11678
|
+
* @param {Object} body Case association query request.
|
|
11679
|
+
* @param {Object} opts Optional parameters
|
|
11680
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
11681
|
+
*/},{key:"postCasemanagementCasesAssociationsQuery",value:function postCasemanagementCasesAssociationsQuery(body,opts){opts=opts||{};// verify the required parameter 'body' is set
|
|
11682
|
+
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']);}/**
|
|
11683
|
+
* Update a data schema on a draft Caseplan.
|
|
11635
11684
|
*
|
|
11685
|
+
* @param {String} caseplanId Caseplan identifier.
|
|
11686
|
+
* @param {String} schemaKeyName Schema key (for example default).
|
|
11687
|
+
* @param {Object} body Data schema reference.
|
|
11636
11688
|
* @param {Object} opts Optional parameters
|
|
11637
|
-
* @param {Object} opts.body Case Association
|
|
11638
11689
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
11639
|
-
|
|
11640
|
-
|
|
11690
|
+
*/},{key:"putCasemanagementCaseplanDataschema",value:function putCasemanagementCaseplanDataschema(caseplanId,schemaKeyName,body,opts){opts=opts||{};// verify the required parameter 'caseplanId' is set
|
|
11691
|
+
if(caseplanId===undefined||caseplanId===null||caseplanId===''){throw'Missing the required parameter "caseplanId" when calling putCasemanagementCaseplanDataschema';}// verify the required parameter 'schemaKeyName' is set
|
|
11692
|
+
if(schemaKeyName===undefined||schemaKeyName===null||schemaKeyName===''){throw'Missing the required parameter "schemaKeyName" when calling putCasemanagementCaseplanDataschema';}// verify the required parameter 'body' is set
|
|
11693
|
+
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']);}/**
|
|
11641
11694
|
* Update the intake settings for a Caseplan.
|
|
11642
11695
|
*
|
|
11643
|
-
* @param {String} caseplanId Caseplan
|
|
11644
|
-
* @param {Object} body Intake
|
|
11696
|
+
* @param {String} caseplanId Caseplan identifier.
|
|
11697
|
+
* @param {Object} body Intake settings update.
|
|
11645
11698
|
* @param {Object} opts Optional parameters
|
|
11646
11699
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
11647
|
-
* putCasemanagementCaseplanIntakesettings is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
11648
11700
|
*/},{key:"putCasemanagementCaseplanIntakesettings",value:function putCasemanagementCaseplanIntakesettings(caseplanId,body,opts){opts=opts||{};// verify the required parameter 'caseplanId' is set
|
|
11649
11701
|
if(caseplanId===undefined||caseplanId===null||caseplanId===''){throw'Missing the required parameter "caseplanId" when calling putCasemanagementCaseplanIntakesettings';}// verify the required parameter 'body' is set
|
|
11650
11702
|
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(){/**
|
|
11651
11703
|
* Chat service.
|
|
11652
11704
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
11653
|
-
* @version
|
|
11705
|
+
* @version 254.0.0
|
|
11654
11706
|
*//**
|
|
11655
11707
|
* Constructs a new ChatApi.
|
|
11656
11708
|
* @alias module:purecloud-platform-client-v2/api/ChatApi
|
|
@@ -11945,7 +11997,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
11945
11997
|
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(){/**
|
|
11946
11998
|
* Coaching service.
|
|
11947
11999
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
11948
|
-
* @version
|
|
12000
|
+
* @version 254.0.0
|
|
11949
12001
|
*//**
|
|
11950
12002
|
* Constructs a new CoachingApi.
|
|
11951
12003
|
* @alias module:purecloud-platform-client-v2/api/CoachingApi
|
|
@@ -12144,7 +12196,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
12144
12196
|
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(){/**
|
|
12145
12197
|
* ContentManagement service.
|
|
12146
12198
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
12147
|
-
* @version
|
|
12199
|
+
* @version 254.0.0
|
|
12148
12200
|
*//**
|
|
12149
12201
|
* Constructs a new ContentManagementApi.
|
|
12150
12202
|
* @alias module:purecloud-platform-client-v2/api/ContentManagementApi
|
|
@@ -12476,7 +12528,7 @@ if(tagId===undefined||tagId===null||tagId===''){throw'Missing the required param
|
|
|
12476
12528
|
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(){/**
|
|
12477
12529
|
* Conversations service.
|
|
12478
12530
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
12479
|
-
* @version
|
|
12531
|
+
* @version 254.0.0
|
|
12480
12532
|
*//**
|
|
12481
12533
|
* Constructs a new ConversationsApi.
|
|
12482
12534
|
* @alias module:purecloud-platform-client-v2/api/ConversationsApi
|
|
@@ -12489,7 +12541,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
12489
12541
|
* @param {String} jobId jobId
|
|
12490
12542
|
* @param {Object} opts Optional parameters
|
|
12491
12543
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
12492
|
-
* deleteAnalyticsConversationsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
12493
12544
|
*/return _createClass(ConversationsApi,[{key:"deleteAnalyticsConversationsAggregatesJob",value:function deleteAnalyticsConversationsAggregatesJob(jobId,opts){opts=opts||{};// verify the required parameter 'jobId' is set
|
|
12494
12545
|
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']);}/**
|
|
12495
12546
|
* Delete/cancel an async details job
|
|
@@ -12652,7 +12703,6 @@ if(conversationId===undefined||conversationId===null||conversationId===''){throw
|
|
|
12652
12703
|
* @param {String} jobId jobId
|
|
12653
12704
|
* @param {Object} opts Optional parameters
|
|
12654
12705
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
12655
|
-
* getAnalyticsConversationsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
12656
12706
|
*/},{key:"getAnalyticsConversationsAggregatesJob",value:function getAnalyticsConversationsAggregatesJob(jobId,opts){opts=opts||{};// verify the required parameter 'jobId' is set
|
|
12657
12707
|
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']);}/**
|
|
12658
12708
|
* Fetch a page of results for an async aggregates query
|
|
@@ -12661,7 +12711,6 @@ if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required param
|
|
|
12661
12711
|
* @param {Object} opts Optional parameters
|
|
12662
12712
|
* @param {String} opts.cursor Cursor token to retrieve next page
|
|
12663
12713
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
12664
|
-
* getAnalyticsConversationsAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
12665
12714
|
*/},{key:"getAnalyticsConversationsAggregatesJobResults",value:function getAnalyticsConversationsAggregatesJobResults(jobId,opts){opts=opts||{};// verify the required parameter 'jobId' is set
|
|
12666
12715
|
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']);}/**
|
|
12667
12716
|
* Gets multiple conversations by id
|
|
@@ -14209,7 +14258,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
14209
14258
|
* @param {Object} body query
|
|
14210
14259
|
* @param {Object} opts Optional parameters
|
|
14211
14260
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
14212
|
-
* postAnalyticsConversationsAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
14213
14261
|
*/},{key:"postAnalyticsConversationsAggregatesJobs",value:function postAnalyticsConversationsAggregatesJobs(body,opts){opts=opts||{};// verify the required parameter 'body' is set
|
|
14214
14262
|
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']);}/**
|
|
14215
14263
|
* Query for conversation aggregates
|
|
@@ -15008,7 +15056,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
15008
15056
|
*/},{key:"postConversationsMessages",value:function postConversationsMessages(body,opts){opts=opts||{};// verify the required parameter 'body' is set
|
|
15009
15057
|
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']);}/**
|
|
15010
15058
|
* Send an agentless outbound message
|
|
15011
|
-
* 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
|
|
15059
|
+
* 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.
|
|
15012
15060
|
* @param {Object} body Create agentless outbound messaging request
|
|
15013
15061
|
* @param {Object} opts Optional parameters
|
|
15014
15062
|
* @param {Boolean} opts.useNormalizedMessage If true, response removes deprecated fields (textBody, messagingTemplate) (default to false)
|
|
@@ -15408,7 +15456,7 @@ if(conversationId===undefined||conversationId===null||conversationId===''){throw
|
|
|
15408
15456
|
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(){/**
|
|
15409
15457
|
* DataExtensions service.
|
|
15410
15458
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
15411
|
-
* @version
|
|
15459
|
+
* @version 254.0.0
|
|
15412
15460
|
*//**
|
|
15413
15461
|
* Constructs a new DataExtensionsApi.
|
|
15414
15462
|
* @alias module:purecloud-platform-client-v2/api/DataExtensionsApi
|
|
@@ -15435,7 +15483,7 @@ if(coretypeName===undefined||coretypeName===null||coretypeName===''){throw'Missi
|
|
|
15435
15483
|
*/},{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(){/**
|
|
15436
15484
|
* DataPrivacy service.
|
|
15437
15485
|
* @module purecloud-platform-client-v2/api/DataPrivacyApi
|
|
15438
|
-
* @version
|
|
15486
|
+
* @version 254.0.0
|
|
15439
15487
|
*//**
|
|
15440
15488
|
* Constructs a new DataPrivacyApi.
|
|
15441
15489
|
* @alias module:purecloud-platform-client-v2/api/DataPrivacyApi
|
|
@@ -15486,7 +15534,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
15486
15534
|
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(){/**
|
|
15487
15535
|
* Downloads service.
|
|
15488
15536
|
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
15489
|
-
* @version
|
|
15537
|
+
* @version 254.0.0
|
|
15490
15538
|
*//**
|
|
15491
15539
|
* Constructs a new DownloadsApi.
|
|
15492
15540
|
* @alias module:purecloud-platform-client-v2/api/DownloadsApi
|
|
@@ -15506,7 +15554,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
15506
15554
|
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(){/**
|
|
15507
15555
|
* Emails service.
|
|
15508
15556
|
* @module purecloud-platform-client-v2/api/EmailsApi
|
|
15509
|
-
* @version
|
|
15557
|
+
* @version 254.0.0
|
|
15510
15558
|
*//**
|
|
15511
15559
|
* Constructs a new EmailsApi.
|
|
15512
15560
|
* @alias module:purecloud-platform-client-v2/api/EmailsApi
|
|
@@ -15543,7 +15591,7 @@ if(downloadId===undefined||downloadId===null||downloadId===''){throw'Missing the
|
|
|
15543
15591
|
*/},{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(){/**
|
|
15544
15592
|
* EmployeeEngagement service.
|
|
15545
15593
|
* @module purecloud-platform-client-v2/api/EmployeeEngagementApi
|
|
15546
|
-
* @version
|
|
15594
|
+
* @version 254.0.0
|
|
15547
15595
|
*//**
|
|
15548
15596
|
* Constructs a new EmployeeEngagementApi.
|
|
15549
15597
|
* @alias module:purecloud-platform-client-v2/api/EmployeeEngagementApi
|
|
@@ -15601,7 +15649,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
15601
15649
|
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(){/**
|
|
15602
15650
|
* Events service.
|
|
15603
15651
|
* @module purecloud-platform-client-v2/api/EventsApi
|
|
15604
|
-
* @version
|
|
15652
|
+
* @version 254.0.0
|
|
15605
15653
|
*//**
|
|
15606
15654
|
* Constructs a new EventsApi.
|
|
15607
15655
|
* @alias module:purecloud-platform-client-v2/api/EventsApi
|
|
@@ -15640,7 +15688,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
15640
15688
|
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(){/**
|
|
15641
15689
|
* ExternalContacts service.
|
|
15642
15690
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
15643
|
-
* @version
|
|
15691
|
+
* @version 254.0.0
|
|
15644
15692
|
*//**
|
|
15645
15693
|
* Constructs a new ExternalContactsApi.
|
|
15646
15694
|
* @alias module:purecloud-platform-client-v2/api/ExternalContactsApi
|
|
@@ -16602,7 +16650,7 @@ if(relationshipId===undefined||relationshipId===null||relationshipId===''){throw
|
|
|
16602
16650
|
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(){/**
|
|
16603
16651
|
* Fax service.
|
|
16604
16652
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
16605
|
-
* @version
|
|
16653
|
+
* @version 254.0.0
|
|
16606
16654
|
*//**
|
|
16607
16655
|
* Constructs a new FaxApi.
|
|
16608
16656
|
* @alias module:purecloud-platform-client-v2/api/FaxApi
|
|
@@ -16665,7 +16713,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
16665
16713
|
*/},{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(){/**
|
|
16666
16714
|
* Flows service.
|
|
16667
16715
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
16668
|
-
* @version
|
|
16716
|
+
* @version 254.0.0
|
|
16669
16717
|
*//**
|
|
16670
16718
|
* Constructs a new FlowsApi.
|
|
16671
16719
|
* @alias module:purecloud-platform-client-v2/api/FlowsApi
|
|
@@ -16678,7 +16726,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
16678
16726
|
* @param {String} jobId jobId
|
|
16679
16727
|
* @param {Object} opts Optional parameters
|
|
16680
16728
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
16681
|
-
* deleteAnalyticsFlowsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
16682
16729
|
*/return _createClass(FlowsApi,[{key:"deleteAnalyticsFlowsAggregatesJob",value:function deleteAnalyticsFlowsAggregatesJob(jobId,opts){opts=opts||{};// verify the required parameter 'jobId' is set
|
|
16683
16730
|
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']);}/**
|
|
16684
16731
|
* Get status for async query for Flow aggregates
|
|
@@ -16686,7 +16733,6 @@ if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required param
|
|
|
16686
16733
|
* @param {String} jobId jobId
|
|
16687
16734
|
* @param {Object} opts Optional parameters
|
|
16688
16735
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
16689
|
-
* getAnalyticsFlowsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
16690
16736
|
*/},{key:"getAnalyticsFlowsAggregatesJob",value:function getAnalyticsFlowsAggregatesJob(jobId,opts){opts=opts||{};// verify the required parameter 'jobId' is set
|
|
16691
16737
|
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']);}/**
|
|
16692
16738
|
* Fetch a page of results for an async aggregates query
|
|
@@ -16695,7 +16741,6 @@ if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required param
|
|
|
16695
16741
|
* @param {Object} opts Optional parameters
|
|
16696
16742
|
* @param {String} opts.cursor Cursor token to retrieve next page
|
|
16697
16743
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
16698
|
-
* getAnalyticsFlowsAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
16699
16744
|
*/},{key:"getAnalyticsFlowsAggregatesJobResults",value:function getAnalyticsFlowsAggregatesJobResults(jobId,opts){opts=opts||{};// verify the required parameter 'jobId' is set
|
|
16700
16745
|
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']);}/**
|
|
16701
16746
|
* Query for flow activity observations
|
|
@@ -16712,7 +16757,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
16712
16757
|
* @param {Object} body query
|
|
16713
16758
|
* @param {Object} opts Optional parameters
|
|
16714
16759
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
16715
|
-
* postAnalyticsFlowsAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
16716
16760
|
*/},{key:"postAnalyticsFlowsAggregatesJobs",value:function postAnalyticsFlowsAggregatesJobs(body,opts){opts=opts||{};// verify the required parameter 'body' is set
|
|
16717
16761
|
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']);}/**
|
|
16718
16762
|
* Query for flow aggregates
|
|
@@ -16731,7 +16775,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
16731
16775
|
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(){/**
|
|
16732
16776
|
* Gamification service.
|
|
16733
16777
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
16734
|
-
* @version
|
|
16778
|
+
* @version 254.0.0
|
|
16735
16779
|
*//**
|
|
16736
16780
|
* Constructs a new GamificationApi.
|
|
16737
16781
|
* @alias module:purecloud-platform-client-v2/api/GamificationApi
|
|
@@ -17526,7 +17570,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
17526
17570
|
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(){/**
|
|
17527
17571
|
* GeneralDataProtectionRegulation service.
|
|
17528
17572
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
17529
|
-
* @version
|
|
17573
|
+
* @version 254.0.0
|
|
17530
17574
|
*//**
|
|
17531
17575
|
* Constructs a new GeneralDataProtectionRegulationApi.
|
|
17532
17576
|
* @alias module:purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
@@ -17567,7 +17611,7 @@ if(searchValue===undefined||searchValue===null){throw'Missing the required param
|
|
|
17567
17611
|
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(){/**
|
|
17568
17612
|
* Geolocation service.
|
|
17569
17613
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
17570
|
-
* @version
|
|
17614
|
+
* @version 254.0.0
|
|
17571
17615
|
*//**
|
|
17572
17616
|
* Constructs a new GeolocationApi.
|
|
17573
17617
|
* @alias module:purecloud-platform-client-v2/api/GeolocationApi
|
|
@@ -17609,7 +17653,7 @@ if(clientId===undefined||clientId===null||clientId===''){throw'Missing the requi
|
|
|
17609
17653
|
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(){/**
|
|
17610
17654
|
* Greetings service.
|
|
17611
17655
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
17612
|
-
* @version
|
|
17656
|
+
* @version 254.0.0
|
|
17613
17657
|
*//**
|
|
17614
17658
|
* Constructs a new GreetingsApi.
|
|
17615
17659
|
* @alias module:purecloud-platform-client-v2/api/GreetingsApi
|
|
@@ -17768,7 +17812,7 @@ if(userId===undefined||userId===null||userId===''){throw'Missing the required pa
|
|
|
17768
17812
|
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(){/**
|
|
17769
17813
|
* Groups service.
|
|
17770
17814
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
17771
|
-
* @version
|
|
17815
|
+
* @version 254.0.0
|
|
17772
17816
|
*//**
|
|
17773
17817
|
* Constructs a new GroupsApi.
|
|
17774
17818
|
* @alias module:purecloud-platform-client-v2/api/GroupsApi
|
|
@@ -17931,7 +17975,7 @@ if(groupId===undefined||groupId===null||groupId===''){throw'Missing the required
|
|
|
17931
17975
|
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(){/**
|
|
17932
17976
|
* IdentityProvider service.
|
|
17933
17977
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
17934
|
-
* @version
|
|
17978
|
+
* @version 254.0.0
|
|
17935
17979
|
*//**
|
|
17936
17980
|
* Constructs a new IdentityProviderApi.
|
|
17937
17981
|
* @alias module:purecloud-platform-client-v2/api/IdentityProviderApi
|
|
@@ -18163,7 +18207,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
18163
18207
|
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(){/**
|
|
18164
18208
|
* InfrastructureAsCode service.
|
|
18165
18209
|
* @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
18166
|
-
* @version
|
|
18210
|
+
* @version 254.0.0
|
|
18167
18211
|
*//**
|
|
18168
18212
|
* Constructs a new InfrastructureAsCodeApi.
|
|
18169
18213
|
* @alias module:purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
@@ -18223,7 +18267,7 @@ if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required param
|
|
|
18223
18267
|
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(){/**
|
|
18224
18268
|
* Integrations service.
|
|
18225
18269
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
18226
|
-
* @version
|
|
18270
|
+
* @version 254.0.0
|
|
18227
18271
|
*//**
|
|
18228
18272
|
* Constructs a new IntegrationsApi.
|
|
18229
18273
|
* @alias module:purecloud-platform-client-v2/api/IntegrationsApi
|
|
@@ -19053,7 +19097,7 @@ if(ucIntegrationId===undefined||ucIntegrationId===null||ucIntegrationId===''){th
|
|
|
19053
19097
|
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(){/**
|
|
19054
19098
|
* Intents service.
|
|
19055
19099
|
* @module purecloud-platform-client-v2/api/IntentsApi
|
|
19056
|
-
* @version
|
|
19100
|
+
* @version 254.0.0
|
|
19057
19101
|
*//**
|
|
19058
19102
|
* Constructs a new IntentsApi.
|
|
19059
19103
|
* @alias module:purecloud-platform-client-v2/api/IntentsApi
|
|
@@ -19197,7 +19241,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
19197
19241
|
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(){/**
|
|
19198
19242
|
* Journey service.
|
|
19199
19243
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
19200
|
-
* @version
|
|
19244
|
+
* @version 254.0.0
|
|
19201
19245
|
*//**
|
|
19202
19246
|
* Constructs a new JourneyApi.
|
|
19203
19247
|
* @alias module:purecloud-platform-client-v2/api/JourneyApi
|
|
@@ -19210,7 +19254,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
19210
19254
|
* @param {String} jobId jobId
|
|
19211
19255
|
* @param {Object} opts Optional parameters
|
|
19212
19256
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
19213
|
-
* deleteAnalyticsJourneysAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
19214
19257
|
*/return _createClass(JourneyApi,[{key:"deleteAnalyticsJourneysAggregatesJob",value:function deleteAnalyticsJourneysAggregatesJob(jobId,opts){opts=opts||{};// verify the required parameter 'jobId' is set
|
|
19215
19258
|
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']);}/**
|
|
19216
19259
|
* Delete single action map.
|
|
@@ -19284,7 +19327,6 @@ if(viewId===undefined||viewId===null||viewId===''){throw'Missing the required pa
|
|
|
19284
19327
|
* @param {String} jobId jobId
|
|
19285
19328
|
* @param {Object} opts Optional parameters
|
|
19286
19329
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
19287
|
-
* getAnalyticsJourneysAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
19288
19330
|
*/},{key:"getAnalyticsJourneysAggregatesJob",value:function getAnalyticsJourneysAggregatesJob(jobId,opts){opts=opts||{};// verify the required parameter 'jobId' is set
|
|
19289
19331
|
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']);}/**
|
|
19290
19332
|
* Fetch a page of results for an async aggregates query
|
|
@@ -19293,7 +19335,6 @@ if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required param
|
|
|
19293
19335
|
* @param {Object} opts Optional parameters
|
|
19294
19336
|
* @param {String} opts.cursor Cursor token to retrieve next page
|
|
19295
19337
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
19296
|
-
* getAnalyticsJourneysAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
19297
19338
|
*/},{key:"getAnalyticsJourneysAggregatesJobResults",value:function getAnalyticsJourneysAggregatesJobResults(jobId,opts){opts=opts||{};// verify the required parameter 'jobId' is set
|
|
19298
19339
|
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']);}/**
|
|
19299
19340
|
* Retrieve segment assignments by external contact ID.
|
|
@@ -19351,19 +19392,21 @@ if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required param
|
|
|
19351
19392
|
* @deprecated
|
|
19352
19393
|
*/},{key:"getJourneyActionmapsEstimatesJobResults",value:function getJourneyActionmapsEstimatesJobResults(jobId,opts){opts=opts||{};// verify the required parameter 'jobId' is set
|
|
19353
19394
|
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']);}/**
|
|
19354
|
-
* Retrieve a single action target.
|
|
19355
|
-
*
|
|
19395
|
+
* Deprecated. Retrieve a single action target.
|
|
19396
|
+
* 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
|
|
19356
19397
|
* @param {String} actionTargetId ID of the action target.
|
|
19357
19398
|
* @param {Object} opts Optional parameters
|
|
19358
19399
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
19400
|
+
* @deprecated
|
|
19359
19401
|
*/},{key:"getJourneyActiontarget",value:function getJourneyActiontarget(actionTargetId,opts){opts=opts||{};// verify the required parameter 'actionTargetId' is set
|
|
19360
19402
|
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']);}/**
|
|
19361
|
-
* Retrieve all action targets.
|
|
19362
|
-
*
|
|
19403
|
+
* Deprecated. Retrieve all action targets.
|
|
19404
|
+
* 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
|
|
19363
19405
|
* @param {Object} opts Optional parameters
|
|
19364
19406
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
19365
19407
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
19366
19408
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
19409
|
+
* @deprecated
|
|
19367
19410
|
*/},{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']);}/**
|
|
19368
19411
|
* Retrieve a single action template.
|
|
19369
19412
|
*
|
|
@@ -19671,6 +19714,16 @@ if(eventDefinitionId===undefined||eventDefinitionId===null||eventDefinitionId===
|
|
|
19671
19714
|
* @param {Object} opts Optional parameters
|
|
19672
19715
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
19673
19716
|
*/},{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']);}/**
|
|
19717
|
+
* Get external events for journey views
|
|
19718
|
+
*
|
|
19719
|
+
* @param {Object} opts Optional parameters
|
|
19720
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
19721
|
+
*/},{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']);}/**
|
|
19722
|
+
* Get changes in external event definitions
|
|
19723
|
+
*
|
|
19724
|
+
* @param {Object} opts Optional parameters
|
|
19725
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
19726
|
+
*/},{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']);}/**
|
|
19674
19727
|
* Get the jobs for an organization.
|
|
19675
19728
|
*
|
|
19676
19729
|
* @param {Object} opts Optional parameters
|
|
@@ -19704,12 +19757,13 @@ if(eventDefinitionId===undefined||eventDefinitionId===null||eventDefinitionId===
|
|
|
19704
19757
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
19705
19758
|
*/},{key:"patchJourneyActionmap",value:function patchJourneyActionmap(actionMapId,opts){opts=opts||{};// verify the required parameter 'actionMapId' is set
|
|
19706
19759
|
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']);}/**
|
|
19707
|
-
* Update a single action target.
|
|
19708
|
-
*
|
|
19760
|
+
* Deprecated. Update a single action target.
|
|
19761
|
+
* 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
|
|
19709
19762
|
* @param {String} actionTargetId ID of the action target.
|
|
19710
19763
|
* @param {Object} opts Optional parameters
|
|
19711
19764
|
* @param {Object} opts.body
|
|
19712
19765
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
19766
|
+
* @deprecated
|
|
19713
19767
|
*/},{key:"patchJourneyActiontarget",value:function patchJourneyActiontarget(actionTargetId,opts){opts=opts||{};// verify the required parameter 'actionTargetId' is set
|
|
19714
19768
|
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']);}/**
|
|
19715
19769
|
* Update a single action template.
|
|
@@ -19763,7 +19817,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
19763
19817
|
* @param {Object} body query
|
|
19764
19818
|
* @param {Object} opts Optional parameters
|
|
19765
19819
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
19766
|
-
* postAnalyticsJourneysAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
19767
19820
|
*/},{key:"postAnalyticsJourneysAggregatesJobs",value:function postAnalyticsJourneysAggregatesJobs(body,opts){opts=opts||{};// verify the required parameter 'body' is set
|
|
19768
19821
|
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']);}/**
|
|
19769
19822
|
* Query for journey aggregates
|
|
@@ -19949,10 +20002,26 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
19949
20002
|
*/},{key:"putJourneyViewVersion",value:function putJourneyViewVersion(viewId,versionId,body,opts){opts=opts||{};// verify the required parameter 'viewId' is set
|
|
19950
20003
|
if(viewId===undefined||viewId===null||viewId===''){throw'Missing the required parameter "viewId" when calling putJourneyViewVersion';}// verify the required parameter 'versionId' is set
|
|
19951
20004
|
if(versionId===undefined||versionId===null||versionId===''){throw'Missing the required parameter "versionId" when calling putJourneyViewVersion';}// verify the required parameter 'body' is set
|
|
19952
|
-
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']);}
|
|
20005
|
+
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']);}/**
|
|
20006
|
+
* Update external event for journey views
|
|
20007
|
+
*
|
|
20008
|
+
* @param {String} eventDefinitionId Event Definition ID
|
|
20009
|
+
* @param {Object} opts Optional parameters
|
|
20010
|
+
* @param {Object} opts.body
|
|
20011
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
20012
|
+
*/},{key:"putJourneyViewsEventdefinition",value:function putJourneyViewsEventdefinition(eventDefinitionId,opts){opts=opts||{};// verify the required parameter 'eventDefinitionId' is set
|
|
20013
|
+
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']);}/**
|
|
20014
|
+
* Activate external event for journey views
|
|
20015
|
+
*
|
|
20016
|
+
* @param {String} eventDefinitionId Event Definition ID
|
|
20017
|
+
* @param {Object} opts Optional parameters
|
|
20018
|
+
* @param {Object} opts.body
|
|
20019
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
20020
|
+
*/},{key:"putJourneyViewsEventdefinitionActivate",value:function putJourneyViewsEventdefinitionActivate(eventDefinitionId,opts){opts=opts||{};// verify the required parameter 'eventDefinitionId' is set
|
|
20021
|
+
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(){/**
|
|
19953
20022
|
* Knowledge service.
|
|
19954
20023
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
19955
|
-
* @version
|
|
20024
|
+
* @version 254.0.0
|
|
19956
20025
|
*//**
|
|
19957
20026
|
* Constructs a new KnowledgeApi.
|
|
19958
20027
|
* @alias module:purecloud-platform-client-v2/api/KnowledgeApi
|
|
@@ -20307,6 +20376,24 @@ if(documentId===undefined||documentId===null||documentId===''){throw'Missing the
|
|
|
20307
20376
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
20308
20377
|
*/},{key:"getKnowledgeKnowledgebaseDocuments",value:function getKnowledgeKnowledgebaseDocuments(knowledgeBaseId,opts){opts=opts||{};// verify the required parameter 'knowledgeBaseId' is set
|
|
20309
20378
|
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']);}/**
|
|
20379
|
+
* Get a list of feedback records given on documents in a knowledge base
|
|
20380
|
+
*
|
|
20381
|
+
* @param {String} knowledgeBaseId Knowledge base ID.
|
|
20382
|
+
* @param {Object} opts Optional parameters
|
|
20383
|
+
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
20384
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
20385
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
20386
|
+
* @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.
|
|
20387
|
+
* @param {String} opts.documentVersionId Document version ID to filter by. Supported only if onlyCommented=true is set.
|
|
20388
|
+
* @param {String} opts.documentVariationId Document variation ID to filter by. Supported only if onlyCommented=true is set.
|
|
20389
|
+
* @param {Object} opts.appType Application type to filter by. Supported only if onlyCommented=true is set.
|
|
20390
|
+
* @param {Object} opts.queryType Query type to filter by. Supported only if onlyCommented=true is set.
|
|
20391
|
+
* @param {String} opts.userId The ID of the user, who created the feedback, to filter by. Supported only if onlyCommented=true is set.
|
|
20392
|
+
* @param {String} opts.queueId Queue ID to filter by. Supported only if onlyCommented=true is set.
|
|
20393
|
+
* @param {Object} opts.state State to filter by. Supported only if onlyCommented=true is set. Default: Final
|
|
20394
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
20395
|
+
*/},{key:"getKnowledgeKnowledgebaseDocumentsFeedback",value:function getKnowledgeKnowledgebaseDocumentsFeedback(knowledgeBaseId,opts){opts=opts||{};// verify the required parameter 'knowledgeBaseId' is set
|
|
20396
|
+
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']);}/**
|
|
20310
20397
|
* Get export job report
|
|
20311
20398
|
*
|
|
20312
20399
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
@@ -21129,7 +21216,7 @@ if(sourceId===undefined||sourceId===null||sourceId===''){throw'Missing the requi
|
|
|
21129
21216
|
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(){/**
|
|
21130
21217
|
* LanguageUnderstanding service.
|
|
21131
21218
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
21132
|
-
* @version
|
|
21219
|
+
* @version 254.0.0
|
|
21133
21220
|
*//**
|
|
21134
21221
|
* Constructs a new LanguageUnderstandingApi.
|
|
21135
21222
|
* @alias module:purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
@@ -21503,7 +21590,7 @@ if(domainVersionId===undefined||domainVersionId===null||domainVersionId===''){th
|
|
|
21503
21590
|
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(){/**
|
|
21504
21591
|
* Languages service.
|
|
21505
21592
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
21506
|
-
* @version
|
|
21593
|
+
* @version 254.0.0
|
|
21507
21594
|
*//**
|
|
21508
21595
|
* Constructs a new LanguagesApi.
|
|
21509
21596
|
* @alias module:purecloud-platform-client-v2/api/LanguagesApi
|
|
@@ -21573,7 +21660,7 @@ if(userId===undefined||userId===null||userId===''){throw'Missing the required pa
|
|
|
21573
21660
|
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(){/**
|
|
21574
21661
|
* Learning service.
|
|
21575
21662
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
21576
|
-
* @version
|
|
21663
|
+
* @version 254.0.0
|
|
21577
21664
|
*//**
|
|
21578
21665
|
* Constructs a new LearningApi.
|
|
21579
21666
|
* @alias module:purecloud-platform-client-v2/api/LearningApi
|
|
@@ -21921,7 +22008,7 @@ if(moduleId===undefined||moduleId===null||moduleId===''){throw'Missing the requi
|
|
|
21921
22008
|
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(){/**
|
|
21922
22009
|
* License service.
|
|
21923
22010
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
21924
|
-
* @version
|
|
22011
|
+
* @version 254.0.0
|
|
21925
22012
|
*//**
|
|
21926
22013
|
* Constructs a new LicenseApi.
|
|
21927
22014
|
* @alias module:purecloud-platform-client-v2/api/LicenseApi
|
|
@@ -21996,7 +22083,7 @@ if(featureName===undefined||featureName===null||featureName===''){throw'Missing
|
|
|
21996
22083
|
*/},{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(){/**
|
|
21997
22084
|
* Locations service.
|
|
21998
22085
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
21999
|
-
* @version
|
|
22086
|
+
* @version 254.0.0
|
|
22000
22087
|
*//**
|
|
22001
22088
|
* Constructs a new LocationsApi.
|
|
22002
22089
|
* @alias module:purecloud-platform-client-v2/api/LocationsApi
|
|
@@ -22068,7 +22155,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
22068
22155
|
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(){/**
|
|
22069
22156
|
* LogCapture service.
|
|
22070
22157
|
* @module purecloud-platform-client-v2/api/LogCaptureApi
|
|
22071
|
-
* @version
|
|
22158
|
+
* @version 254.0.0
|
|
22072
22159
|
*//**
|
|
22073
22160
|
* Constructs a new LogCaptureApi.
|
|
22074
22161
|
* @alias module:purecloud-platform-client-v2/api/LogCaptureApi
|
|
@@ -22127,7 +22214,7 @@ if(userId===undefined||userId===null||userId===''){throw'Missing the required pa
|
|
|
22127
22214
|
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(){/**
|
|
22128
22215
|
* Messaging service.
|
|
22129
22216
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
22130
|
-
* @version
|
|
22217
|
+
* @version 254.0.0
|
|
22131
22218
|
*//**
|
|
22132
22219
|
* Constructs a new MessagingApi.
|
|
22133
22220
|
* @alias module:purecloud-platform-client-v2/api/MessagingApi
|
|
@@ -22241,7 +22328,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
22241
22328
|
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(){/**
|
|
22242
22329
|
* MobileDevices service.
|
|
22243
22330
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
22244
|
-
* @version
|
|
22331
|
+
* @version 254.0.0
|
|
22245
22332
|
*//**
|
|
22246
22333
|
* Constructs a new MobileDevicesApi.
|
|
22247
22334
|
* @alias module:purecloud-platform-client-v2/api/MobileDevicesApi
|
|
@@ -22288,7 +22375,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
22288
22375
|
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(){/**
|
|
22289
22376
|
* Notifications service.
|
|
22290
22377
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
22291
|
-
* @version
|
|
22378
|
+
* @version 254.0.0
|
|
22292
22379
|
*//**
|
|
22293
22380
|
* Constructs a new NotificationsApi.
|
|
22294
22381
|
* @alias module:purecloud-platform-client-v2/api/NotificationsApi
|
|
@@ -22357,7 +22444,7 @@ if(channelId===undefined||channelId===null||channelId===''){throw'Missing the re
|
|
|
22357
22444
|
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(){/**
|
|
22358
22445
|
* OAuth service.
|
|
22359
22446
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
22360
|
-
* @version
|
|
22447
|
+
* @version 254.0.0
|
|
22361
22448
|
*//**
|
|
22362
22449
|
* Constructs a new OAuthApi.
|
|
22363
22450
|
* @alias module:purecloud-platform-client-v2/api/OAuthApi
|
|
@@ -22463,7 +22550,7 @@ if(clientId===undefined||clientId===null||clientId===''){throw'Missing the requi
|
|
|
22463
22550
|
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(){/**
|
|
22464
22551
|
* Objects service.
|
|
22465
22552
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
22466
|
-
* @version
|
|
22553
|
+
* @version 254.0.0
|
|
22467
22554
|
*//**
|
|
22468
22555
|
* Constructs a new ObjectsApi.
|
|
22469
22556
|
* @alias module:purecloud-platform-client-v2/api/ObjectsApi
|
|
@@ -22566,7 +22653,7 @@ if(divisionId===undefined||divisionId===null||divisionId===''){throw'Missing the
|
|
|
22566
22653
|
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(){/**
|
|
22567
22654
|
* OperationalEvents service.
|
|
22568
22655
|
* @module purecloud-platform-client-v2/api/OperationalEventsApi
|
|
22569
|
-
* @version
|
|
22656
|
+
* @version 254.0.0
|
|
22570
22657
|
*//**
|
|
22571
22658
|
* Constructs a new OperationalEventsApi.
|
|
22572
22659
|
* @alias module:purecloud-platform-client-v2/api/OperationalEventsApi
|
|
@@ -22603,7 +22690,7 @@ if(eventDefinitionId===undefined||eventDefinitionId===null||eventDefinitionId===
|
|
|
22603
22690
|
*/},{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(){/**
|
|
22604
22691
|
* Organization service.
|
|
22605
22692
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
22606
|
-
* @version
|
|
22693
|
+
* @version 254.0.0
|
|
22607
22694
|
*//**
|
|
22608
22695
|
* Constructs a new OrganizationApi.
|
|
22609
22696
|
* @alias module:purecloud-platform-client-v2/api/OrganizationApi
|
|
@@ -22743,7 +22830,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
22743
22830
|
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(){/**
|
|
22744
22831
|
* OrganizationAuthorization service.
|
|
22745
22832
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
22746
|
-
* @version
|
|
22833
|
+
* @version 254.0.0
|
|
22747
22834
|
*//**
|
|
22748
22835
|
* Constructs a new OrganizationAuthorizationApi.
|
|
22749
22836
|
* @alias module:purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
@@ -23163,7 +23250,7 @@ if(trustorOrgId===undefined||trustorOrgId===null||trustorOrgId===''){throw'Missi
|
|
|
23163
23250
|
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(){/**
|
|
23164
23251
|
* Outbound service.
|
|
23165
23252
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
23166
|
-
* @version
|
|
23253
|
+
* @version 254.0.0
|
|
23167
23254
|
*//**
|
|
23168
23255
|
* Constructs a new OutboundApi.
|
|
23169
23256
|
* @alias module:purecloud-platform-client-v2/api/OutboundApi
|
|
@@ -24649,7 +24736,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
24649
24736
|
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(){/**
|
|
24650
24737
|
* Presence service.
|
|
24651
24738
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
24652
|
-
* @version
|
|
24739
|
+
* @version 254.0.0
|
|
24653
24740
|
*//**
|
|
24654
24741
|
* Constructs a new PresenceApi.
|
|
24655
24742
|
* @alias module:purecloud-platform-client-v2/api/PresenceApi
|
|
@@ -24869,7 +24956,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
24869
24956
|
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(){/**
|
|
24870
24957
|
* ProcessAutomation service.
|
|
24871
24958
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
24872
|
-
* @version
|
|
24959
|
+
* @version 254.0.0
|
|
24873
24960
|
*//**
|
|
24874
24961
|
* Constructs a new ProcessAutomationApi.
|
|
24875
24962
|
* @alias module:purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
@@ -24983,7 +25070,7 @@ if(triggerId===undefined||triggerId===null||triggerId===''){throw'Missing the re
|
|
|
24983
25070
|
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(){/**
|
|
24984
25071
|
* Quality service.
|
|
24985
25072
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
24986
|
-
* @version
|
|
25073
|
+
* @version 254.0.0
|
|
24987
25074
|
*//**
|
|
24988
25075
|
* Constructs a new QualityApi.
|
|
24989
25076
|
* @alias module:purecloud-platform-client-v2/api/QualityApi
|
|
@@ -24996,7 +25083,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
24996
25083
|
* @param {String} jobId jobId
|
|
24997
25084
|
* @param {Object} opts Optional parameters
|
|
24998
25085
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
24999
|
-
* deleteAnalyticsEvaluationsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
25000
25086
|
*/return _createClass(QualityApi,[{key:"deleteAnalyticsEvaluationsAggregatesJob",value:function deleteAnalyticsEvaluationsAggregatesJob(jobId,opts){opts=opts||{};// verify the required parameter 'jobId' is set
|
|
25001
25087
|
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']);}/**
|
|
25002
25088
|
* Delete/cancel an async request for survey aggregates
|
|
@@ -25004,7 +25090,6 @@ if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required param
|
|
|
25004
25090
|
* @param {String} jobId jobId
|
|
25005
25091
|
* @param {Object} opts Optional parameters
|
|
25006
25092
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
25007
|
-
* deleteAnalyticsSurveysAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
25008
25093
|
*/},{key:"deleteAnalyticsSurveysAggregatesJob",value:function deleteAnalyticsSurveysAggregatesJob(jobId,opts){opts=opts||{};// verify the required parameter 'jobId' is set
|
|
25009
25094
|
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']);}/**
|
|
25010
25095
|
* Delete a calibration by id.
|
|
@@ -25062,7 +25147,6 @@ if(ruleId===undefined||ruleId===null||ruleId===''){throw'Missing the required pa
|
|
|
25062
25147
|
* @param {String} jobId jobId
|
|
25063
25148
|
* @param {Object} opts Optional parameters
|
|
25064
25149
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
25065
|
-
* getAnalyticsEvaluationsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
25066
25150
|
*/},{key:"getAnalyticsEvaluationsAggregatesJob",value:function getAnalyticsEvaluationsAggregatesJob(jobId,opts){opts=opts||{};// verify the required parameter 'jobId' is set
|
|
25067
25151
|
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']);}/**
|
|
25068
25152
|
* Fetch a page of results for an async aggregates query
|
|
@@ -25071,7 +25155,6 @@ if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required param
|
|
|
25071
25155
|
* @param {Object} opts Optional parameters
|
|
25072
25156
|
* @param {String} opts.cursor Cursor token to retrieve next page
|
|
25073
25157
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
25074
|
-
* getAnalyticsEvaluationsAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
25075
25158
|
*/},{key:"getAnalyticsEvaluationsAggregatesJobResults",value:function getAnalyticsEvaluationsAggregatesJobResults(jobId,opts){opts=opts||{};// verify the required parameter 'jobId' is set
|
|
25076
25159
|
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']);}/**
|
|
25077
25160
|
* Get status for async query for survey aggregates
|
|
@@ -25079,7 +25162,6 @@ if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required param
|
|
|
25079
25162
|
* @param {String} jobId jobId
|
|
25080
25163
|
* @param {Object} opts Optional parameters
|
|
25081
25164
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
25082
|
-
* getAnalyticsSurveysAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
25083
25165
|
*/},{key:"getAnalyticsSurveysAggregatesJob",value:function getAnalyticsSurveysAggregatesJob(jobId,opts){opts=opts||{};// verify the required parameter 'jobId' is set
|
|
25084
25166
|
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']);}/**
|
|
25085
25167
|
* Fetch a page of results for an async aggregates query
|
|
@@ -25088,7 +25170,6 @@ if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required param
|
|
|
25088
25170
|
* @param {Object} opts Optional parameters
|
|
25089
25171
|
* @param {String} opts.cursor Cursor token to retrieve next page
|
|
25090
25172
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
25091
|
-
* getAnalyticsSurveysAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
25092
25173
|
*/},{key:"getAnalyticsSurveysAggregatesJobResults",value:function getAnalyticsSurveysAggregatesJobResults(jobId,opts){opts=opts||{};// verify the required parameter 'jobId' is set
|
|
25093
25174
|
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']);}/**
|
|
25094
25175
|
* Gets a list of Agent Activities
|
|
@@ -25428,7 +25509,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
25428
25509
|
* @param {Object} body query
|
|
25429
25510
|
* @param {Object} opts Optional parameters
|
|
25430
25511
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
25431
|
-
* postAnalyticsEvaluationsAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
25432
25512
|
*/},{key:"postAnalyticsEvaluationsAggregatesJobs",value:function postAnalyticsEvaluationsAggregatesJobs(body,opts){opts=opts||{};// verify the required parameter 'body' is set
|
|
25433
25513
|
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']);}/**
|
|
25434
25514
|
* Query for evaluation aggregates
|
|
@@ -25443,7 +25523,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
25443
25523
|
* @param {Object} body query
|
|
25444
25524
|
* @param {Object} opts Optional parameters
|
|
25445
25525
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
25446
|
-
* postAnalyticsSurveysAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
25447
25526
|
*/},{key:"postAnalyticsSurveysAggregatesJobs",value:function postAnalyticsSurveysAggregatesJobs(body,opts){opts=opts||{};// verify the required parameter 'body' is set
|
|
25448
25527
|
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']);}/**
|
|
25449
25528
|
* Query for survey aggregates
|
|
@@ -25647,7 +25726,7 @@ if(customerSurveyUrl===undefined||customerSurveyUrl===null){throw'Missing the re
|
|
|
25647
25726
|
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(){/**
|
|
25648
25727
|
* Recording service.
|
|
25649
25728
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
25650
|
-
* @version
|
|
25729
|
+
* @version 254.0.0
|
|
25651
25730
|
*//**
|
|
25652
25731
|
* Constructs a new RecordingApi.
|
|
25653
25732
|
* @alias module:purecloud-platform-client-v2/api/RecordingApi
|
|
@@ -26146,7 +26225,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
26146
26225
|
*/},{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(){/**
|
|
26147
26226
|
* ResponseManagement service.
|
|
26148
26227
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
26149
|
-
* @version
|
|
26228
|
+
* @version 254.0.0
|
|
26150
26229
|
*//**
|
|
26151
26230
|
* Constructs a new ResponseManagementApi.
|
|
26152
26231
|
* @alias module:purecloud-platform-client-v2/api/ResponseManagementApi
|
|
@@ -26313,7 +26392,7 @@ if(responseAssetId===undefined||responseAssetId===null||responseAssetId===''){th
|
|
|
26313
26392
|
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(){/**
|
|
26314
26393
|
* Routing service.
|
|
26315
26394
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
26316
|
-
* @version
|
|
26395
|
+
* @version 254.0.0
|
|
26317
26396
|
*//**
|
|
26318
26397
|
* Constructs a new RoutingApi.
|
|
26319
26398
|
* @alias module:purecloud-platform-client-v2/api/RoutingApi
|
|
@@ -26356,6 +26435,13 @@ if(routeId===undefined||routeId===null||routeId===''){throw'Missing the required
|
|
|
26356
26435
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
26357
26436
|
*/},{key:"deleteRoutingEmailOutboundDomain",value:function deleteRoutingEmailOutboundDomain(domainId,opts){opts=opts||{};// verify the required parameter 'domainId' is set
|
|
26358
26437
|
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']);}/**
|
|
26438
|
+
* Delete an email setting. Removes the email setting and its associated settings
|
|
26439
|
+
*
|
|
26440
|
+
* @param {String} emailSettingId Email Setting ID
|
|
26441
|
+
* @param {Object} opts Optional parameters
|
|
26442
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
26443
|
+
*/},{key:"deleteRoutingEmailSettingEmailSettingId",value:function deleteRoutingEmailSettingEmailSettingId(emailSettingId,opts){opts=opts||{};// verify the required parameter 'emailSettingId' is set
|
|
26444
|
+
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']);}/**
|
|
26359
26445
|
* Delete a routing language
|
|
26360
26446
|
*
|
|
26361
26447
|
* @param {String} languageId Language ID
|
|
@@ -26426,6 +26512,19 @@ if(codeId===undefined||codeId===null||codeId===''){throw'Missing the required pa
|
|
|
26426
26512
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
26427
26513
|
*/},{key:"deleteRoutingSkill",value:function deleteRoutingSkill(skillId,opts){opts=opts||{};// verify the required parameter 'skillId' is set
|
|
26428
26514
|
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']);}/**
|
|
26515
|
+
* Archive a skill expression to remove it from the set of active expressions
|
|
26516
|
+
*
|
|
26517
|
+
* @param {String} expressionId Expression ID
|
|
26518
|
+
* @param {Object} opts Optional parameters
|
|
26519
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
26520
|
+
*/},{key:"deleteRoutingSkillexpression",value:function deleteRoutingSkillexpression(expressionId,opts){opts=opts||{};// verify the required parameter 'expressionId' is set
|
|
26521
|
+
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']);}/**
|
|
26522
|
+
* Archive a set of skill expressions to remove them from the set of active expressions
|
|
26523
|
+
*
|
|
26524
|
+
* @param {Object} opts Optional parameters
|
|
26525
|
+
* @param {Array.<String>} opts.id Expression ID(s) to filter. Repeat for multiple or use comma-separated list.
|
|
26526
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
26527
|
+
*/},{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']);}/**
|
|
26429
26528
|
* Remove skill group definition
|
|
26430
26529
|
*
|
|
26431
26530
|
* @param {String} skillGroupId Skill Group ID
|
|
@@ -26474,15 +26573,6 @@ if(userId===undefined||userId===null||userId===''){throw'Missing the required pa
|
|
|
26474
26573
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
26475
26574
|
*/},{key:"deleteRoutingUtilizationLabel",value:function deleteRoutingUtilizationLabel(labelId,opts){opts=opts||{};// verify the required parameter 'labelId' is set
|
|
26476
26575
|
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']);}/**
|
|
26477
|
-
* Delete an utilization tag
|
|
26478
|
-
*
|
|
26479
|
-
* @param {String} tagId Utilization Tag ID
|
|
26480
|
-
* @param {Object} opts Optional parameters
|
|
26481
|
-
* @param {Boolean} opts.forceDelete Remove all tag usages (if found) without warning (default to false)
|
|
26482
|
-
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
26483
|
-
* deleteRoutingUtilizationTag is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
26484
|
-
*/},{key:"deleteRoutingUtilizationTag",value:function deleteRoutingUtilizationTag(tagId,opts){opts=opts||{};// verify the required parameter 'tagId' is set
|
|
26485
|
-
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']);}/**
|
|
26486
26576
|
* Delete wrap-up code
|
|
26487
26577
|
*
|
|
26488
26578
|
* @param {String} codeId Wrapup Code ID
|
|
@@ -26641,6 +26731,20 @@ if(domainId===undefined||domainId===null||domainId===''){throw'Missing the requi
|
|
|
26641
26731
|
* @param {Object} opts.expand Expand options. Valid values: settings
|
|
26642
26732
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
26643
26733
|
*/},{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']);}/**
|
|
26734
|
+
* Get a paged list of email routing settings.
|
|
26735
|
+
*
|
|
26736
|
+
* @param {Object} opts Optional parameters
|
|
26737
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
26738
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
26739
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
26740
|
+
*/},{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']);}/**
|
|
26741
|
+
* Get email setting. Returns the specified email setting that defines settings for email
|
|
26742
|
+
*
|
|
26743
|
+
* @param {String} emailSettingId Email Setting ID
|
|
26744
|
+
* @param {Object} opts Optional parameters
|
|
26745
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
26746
|
+
*/},{key:"getRoutingEmailSettingEmailSettingId",value:function getRoutingEmailSettingEmailSettingId(emailSettingId,opts){opts=opts||{};// verify the required parameter 'emailSettingId' is set
|
|
26747
|
+
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']);}/**
|
|
26644
26748
|
* Get email setup
|
|
26645
26749
|
*
|
|
26646
26750
|
* @param {Object} opts Optional parameters
|
|
@@ -26867,7 +26971,7 @@ if(queueId===undefined||queueId===null||queueId===''){throw'Missing the required
|
|
|
26867
26971
|
* @param {Object} opts.sortOrder Sort order (default to asc)
|
|
26868
26972
|
* @param {String} opts.name Name
|
|
26869
26973
|
* @param {Array.<String>} opts.id Queue ID(s)
|
|
26870
|
-
* @param {Array.<String>} opts.divisionId Division ID(s)
|
|
26974
|
+
* @param {Array.<String>} opts.divisionId Division ID(s). Including '*' will query for all divisions
|
|
26871
26975
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
26872
26976
|
*/},{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']);}/**
|
|
26873
26977
|
* Get a paged listing of simplified queue objects, sorted by name. Can be used to get a digest of all queues in an organization.
|
|
@@ -26909,6 +27013,32 @@ if(queueId===undefined||queueId===null||queueId===''){throw'Missing the required
|
|
|
26909
27013
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
26910
27014
|
*/},{key:"getRoutingSkill",value:function getRoutingSkill(skillId,opts){opts=opts||{};// verify the required parameter 'skillId' is set
|
|
26911
27015
|
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']);}/**
|
|
27016
|
+
* Get a skill expression by ID
|
|
27017
|
+
*
|
|
27018
|
+
* @param {String} expressionId Expression ID
|
|
27019
|
+
* @param {Object} opts Optional parameters
|
|
27020
|
+
* @param {Boolean} opts.includeArchived Include archived (default to false)
|
|
27021
|
+
* @param {Object} opts.format Response format: raw expression or normalized (default to Raw)
|
|
27022
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
27023
|
+
*/},{key:"getRoutingSkillexpression",value:function getRoutingSkillexpression(expressionId,opts){opts=opts||{};// verify the required parameter 'expressionId' is set
|
|
27024
|
+
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']);}/**
|
|
27025
|
+
* Get skill expressions
|
|
27026
|
+
*
|
|
27027
|
+
* @param {Object} opts Optional parameters
|
|
27028
|
+
* @param {Object} opts.format Response format: raw expression or normalized (default to Raw)
|
|
27029
|
+
* @param {Boolean} opts.includeArchived Include archived (default to false)
|
|
27030
|
+
* @param {Array.<String>} opts.id Expression ID(s) to filter. Repeat for multiple or use comma-separated list.
|
|
27031
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
27032
|
+
*/},{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']);}/**
|
|
27033
|
+
* Get skill expressions associated with a queue
|
|
27034
|
+
*
|
|
27035
|
+
* @param {String} queueId Queue ID
|
|
27036
|
+
* @param {Object} opts Optional parameters
|
|
27037
|
+
* @param {Object} opts.format Response format: raw expression or normalized (default to Raw)
|
|
27038
|
+
* @param {Boolean} opts.includeArchived Include archived (default to false)
|
|
27039
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
27040
|
+
*/},{key:"getRoutingSkillexpressionsQueueQueueId",value:function getRoutingSkillexpressionsQueueQueueId(queueId,opts){opts=opts||{};// verify the required parameter 'queueId' is set
|
|
27041
|
+
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']);}/**
|
|
26912
27042
|
* Get skill group
|
|
26913
27043
|
*
|
|
26914
27044
|
* @param {String} skillGroupId Skill Group ID
|
|
@@ -26944,7 +27074,7 @@ if(skillGroupId===undefined||skillGroupId===null||skillGroupId===''){throw'Missi
|
|
|
26944
27074
|
* @param {String} opts.before The cursor that points to the previous item
|
|
26945
27075
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
26946
27076
|
*/},{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']);}/**
|
|
26947
|
-
* Get the list of routing skills.
|
|
27077
|
+
* Get the list of routing skills. View permission enforcement only applies to skills assigned to a division.
|
|
26948
27078
|
*
|
|
26949
27079
|
* @param {Object} opts Optional parameters
|
|
26950
27080
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
@@ -27055,32 +27185,6 @@ if(labelId===undefined||labelId===null||labelId===''){throw'Missing the required
|
|
|
27055
27185
|
* @param {String} opts.name Utilization label's name (Wildcard is supported, e.g., 'label1*', '*label*'
|
|
27056
27186
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
27057
27187
|
*/},{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']);}/**
|
|
27058
|
-
* Get details about this utilization tag
|
|
27059
|
-
*
|
|
27060
|
-
* @param {String} tagId Utilization Tag ID
|
|
27061
|
-
* @param {Object} opts Optional parameters
|
|
27062
|
-
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
27063
|
-
* getRoutingUtilizationTag is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
27064
|
-
*/},{key:"getRoutingUtilizationTag",value:function getRoutingUtilizationTag(tagId,opts){opts=opts||{};// verify the required parameter 'tagId' is set
|
|
27065
|
-
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']);}/**
|
|
27066
|
-
* Get list of agent ids associated with a utilization tag
|
|
27067
|
-
*
|
|
27068
|
-
* @param {String} tagId Utilization Tag ID
|
|
27069
|
-
* @param {Object} opts Optional parameters
|
|
27070
|
-
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
27071
|
-
* getRoutingUtilizationTagAgents is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
27072
|
-
*/},{key:"getRoutingUtilizationTagAgents",value:function getRoutingUtilizationTagAgents(tagId,opts){opts=opts||{};// verify the required parameter 'tagId' is set
|
|
27073
|
-
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']);}/**
|
|
27074
|
-
* Get list of utilization tags
|
|
27075
|
-
*
|
|
27076
|
-
* @param {Object} opts Optional parameters
|
|
27077
|
-
* @param {Number} opts.pageSize Page size (default to 25)
|
|
27078
|
-
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
27079
|
-
* @param {Object} opts.sortOrder Sort order by name (default to ascending)
|
|
27080
|
-
* @param {String} opts.name Utilization tag's name (Wildcard is supported, e.g., 'tag1*')
|
|
27081
|
-
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
27082
|
-
* getRoutingUtilizationTags is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
27083
|
-
*/},{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']);}/**
|
|
27084
27188
|
* Get details about this wrap-up code.
|
|
27085
27189
|
*
|
|
27086
27190
|
* @param {String} codeId Wrapup Code ID
|
|
@@ -27195,6 +27299,15 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
27195
27299
|
*/},{key:"patchRoutingEmailOutboundDomain",value:function patchRoutingEmailOutboundDomain(domainId,body,opts){opts=opts||{};// verify the required parameter 'domainId' is set
|
|
27196
27300
|
if(domainId===undefined||domainId===null||domainId===''){throw'Missing the required parameter "domainId" when calling patchRoutingEmailOutboundDomain';}// verify the required parameter 'body' is set
|
|
27197
27301
|
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']);}/**
|
|
27302
|
+
* Update an email setting. Modifies the settings for email setting
|
|
27303
|
+
*
|
|
27304
|
+
* @param {String} emailSettingId Email Setting ID
|
|
27305
|
+
* @param {Object} body EmailSetting
|
|
27306
|
+
* @param {Object} opts Optional parameters
|
|
27307
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
27308
|
+
*/},{key:"patchRoutingEmailSettingEmailSettingId",value:function patchRoutingEmailSettingEmailSettingId(emailSettingId,body,opts){opts=opts||{};// verify the required parameter 'emailSettingId' is set
|
|
27309
|
+
if(emailSettingId===undefined||emailSettingId===null||emailSettingId===''){throw'Missing the required parameter "emailSettingId" when calling patchRoutingEmailSettingEmailSettingId';}// verify the required parameter 'body' is set
|
|
27310
|
+
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']);}/**
|
|
27198
27311
|
* Update single predictor.
|
|
27199
27312
|
*
|
|
27200
27313
|
* @param {String} predictorId Predictor ID
|
|
@@ -27442,6 +27555,13 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
27442
27555
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
27443
27556
|
*/},{key:"postRoutingEmailOutboundDomainsSimulated",value:function postRoutingEmailOutboundDomainsSimulated(body,opts){opts=opts||{};// verify the required parameter 'body' is set
|
|
27444
27557
|
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']);}/**
|
|
27558
|
+
* Create a new email setting. Used to define various settings, that can then be associated with email domains
|
|
27559
|
+
*
|
|
27560
|
+
* @param {Object} body EmailSetting
|
|
27561
|
+
* @param {Object} opts Optional parameters
|
|
27562
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
27563
|
+
*/},{key:"postRoutingEmailSetting",value:function postRoutingEmailSetting(body,opts){opts=opts||{};// verify the required parameter 'body' is set
|
|
27564
|
+
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']);}/**
|
|
27445
27565
|
* Create Language
|
|
27446
27566
|
*
|
|
27447
27567
|
* @param {Object} body Language
|
|
@@ -27500,6 +27620,13 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
27500
27620
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
27501
27621
|
*/},{key:"postRoutingQueues",value:function postRoutingQueues(body,opts){opts=opts||{};// verify the required parameter 'body' is set
|
|
27502
27622
|
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']);}/**
|
|
27623
|
+
* Validate and normalize a skill expression
|
|
27624
|
+
*
|
|
27625
|
+
* @param {Object} body Skill expression data to validate
|
|
27626
|
+
* @param {Object} opts Optional parameters
|
|
27627
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
27628
|
+
*/},{key:"postRoutingSkillexpressionsValidate",value:function postRoutingSkillexpressionsValidate(body,opts){opts=opts||{};// verify the required parameter 'body' is set
|
|
27629
|
+
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']);}/**
|
|
27503
27630
|
* Add or remove member divisions for this skill group.
|
|
27504
27631
|
*
|
|
27505
27632
|
* @param {String} skillGroupId Skill Group ID
|
|
@@ -27558,14 +27685,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
27558
27685
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
27559
27686
|
*/},{key:"postRoutingUtilizationLabels",value:function postRoutingUtilizationLabels(body,opts){opts=opts||{};// verify the required parameter 'body' is set
|
|
27560
27687
|
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']);}/**
|
|
27561
|
-
* Create an utilization tag
|
|
27562
|
-
*
|
|
27563
|
-
* @param {Object} body UtilizationTag
|
|
27564
|
-
* @param {Object} opts Optional parameters
|
|
27565
|
-
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
27566
|
-
* postRoutingUtilizationTags is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
27567
|
-
*/},{key:"postRoutingUtilizationTags",value:function postRoutingUtilizationTags(body,opts){opts=opts||{};// verify the required parameter 'body' is set
|
|
27568
|
-
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']);}/**
|
|
27569
27688
|
* Create a wrap-up code
|
|
27570
27689
|
*
|
|
27571
27690
|
* @param {Object} body WrapupCode
|
|
@@ -27742,7 +27861,7 @@ if(userId===undefined||userId===null||userId===''){throw'Missing the required pa
|
|
|
27742
27861
|
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(){/**
|
|
27743
27862
|
* SCIM service.
|
|
27744
27863
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
27745
|
-
* @version
|
|
27864
|
+
* @version 254.0.0
|
|
27746
27865
|
*//**
|
|
27747
27866
|
* Constructs a new SCIMApi.
|
|
27748
27867
|
* @alias module:purecloud-platform-client-v2/api/SCIMApi
|
|
@@ -28005,7 +28124,7 @@ if(userId===undefined||userId===null||userId===''){throw'Missing the required pa
|
|
|
28005
28124
|
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(){/**
|
|
28006
28125
|
* Scripts service.
|
|
28007
28126
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
28008
|
-
* @version
|
|
28127
|
+
* @version 254.0.0
|
|
28009
28128
|
*//**
|
|
28010
28129
|
* Constructs a new ScriptsApi.
|
|
28011
28130
|
* @alias module:purecloud-platform-client-v2/api/ScriptsApi
|
|
@@ -28167,7 +28286,7 @@ if(scriptId===undefined||scriptId===null||scriptId===''){throw'Missing the requi
|
|
|
28167
28286
|
*/},{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(){/**
|
|
28168
28287
|
* Search service.
|
|
28169
28288
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
28170
|
-
* @version
|
|
28289
|
+
* @version 254.0.0
|
|
28171
28290
|
*//**
|
|
28172
28291
|
* Constructs a new SearchApi.
|
|
28173
28292
|
* @alias module:purecloud-platform-client-v2/api/SearchApi
|
|
@@ -28374,7 +28493,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
28374
28493
|
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(){/**
|
|
28375
28494
|
* Settings service.
|
|
28376
28495
|
* @module purecloud-platform-client-v2/api/SettingsApi
|
|
28377
|
-
* @version
|
|
28496
|
+
* @version 254.0.0
|
|
28378
28497
|
*//**
|
|
28379
28498
|
* Constructs a new SettingsApi.
|
|
28380
28499
|
* @alias module:purecloud-platform-client-v2/api/SettingsApi
|
|
@@ -28471,7 +28590,7 @@ if(agentId===undefined||agentId===null||agentId===''){throw'Missing the required
|
|
|
28471
28590
|
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(){/**
|
|
28472
28591
|
* SocialMedia service.
|
|
28473
28592
|
* @module purecloud-platform-client-v2/api/SocialMediaApi
|
|
28474
|
-
* @version
|
|
28593
|
+
* @version 254.0.0
|
|
28475
28594
|
*//**
|
|
28476
28595
|
* Constructs a new SocialMediaApi.
|
|
28477
28596
|
* @alias module:purecloud-platform-client-v2/api/SocialMediaApi
|
|
@@ -29026,7 +29145,7 @@ if(topicId===undefined||topicId===null||topicId===''){throw'Missing the required
|
|
|
29026
29145
|
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(){/**
|
|
29027
29146
|
* SpeechTextAnalytics service.
|
|
29028
29147
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
29029
|
-
* @version
|
|
29148
|
+
* @version 254.0.0
|
|
29030
29149
|
*//**
|
|
29031
29150
|
* Constructs a new SpeechTextAnalyticsApi.
|
|
29032
29151
|
* @alias module:purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
@@ -29519,7 +29638,7 @@ if(topicId===undefined||topicId===null||topicId===''){throw'Missing the required
|
|
|
29519
29638
|
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(){/**
|
|
29520
29639
|
* Stations service.
|
|
29521
29640
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
29522
|
-
* @version
|
|
29641
|
+
* @version 254.0.0
|
|
29523
29642
|
*//**
|
|
29524
29643
|
* Constructs a new StationsApi.
|
|
29525
29644
|
* @alias module:purecloud-platform-client-v2/api/StationsApi
|
|
@@ -29556,7 +29675,7 @@ if(stationId===undefined||stationId===null||stationId===''){throw'Missing the re
|
|
|
29556
29675
|
*/},{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(){/**
|
|
29557
29676
|
* Suggest service.
|
|
29558
29677
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
29559
|
-
* @version
|
|
29678
|
+
* @version 254.0.0
|
|
29560
29679
|
*//**
|
|
29561
29680
|
* Constructs a new SuggestApi.
|
|
29562
29681
|
* @alias module:purecloud-platform-client-v2/api/SuggestApi
|
|
@@ -29600,7 +29719,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
29600
29719
|
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(){/**
|
|
29601
29720
|
* TaskManagement service.
|
|
29602
29721
|
* @module purecloud-platform-client-v2/api/TaskManagementApi
|
|
29603
|
-
* @version
|
|
29722
|
+
* @version 254.0.0
|
|
29604
29723
|
*//**
|
|
29605
29724
|
* Constructs a new TaskManagementApi.
|
|
29606
29725
|
* @alias module:purecloud-platform-client-v2/api/TaskManagementApi
|
|
@@ -30244,7 +30363,7 @@ if(schemaId===undefined||schemaId===null||schemaId===''){throw'Missing the requi
|
|
|
30244
30363
|
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(){/**
|
|
30245
30364
|
* Teams service.
|
|
30246
30365
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
30247
|
-
* @version
|
|
30366
|
+
* @version 254.0.0
|
|
30248
30367
|
*//**
|
|
30249
30368
|
* Constructs a new TeamsApi.
|
|
30250
30369
|
* @alias module:purecloud-platform-client-v2/api/TeamsApi
|
|
@@ -30340,7 +30459,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
30340
30459
|
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(){/**
|
|
30341
30460
|
* Telephony service.
|
|
30342
30461
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
30343
|
-
* @version
|
|
30462
|
+
* @version 254.0.0
|
|
30344
30463
|
*//**
|
|
30345
30464
|
* Constructs a new TelephonyApi.
|
|
30346
30465
|
* @alias module:purecloud-platform-client-v2/api/TelephonyApi
|
|
@@ -30348,12 +30467,19 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
30348
30467
|
* @param {module:purecloud-platform-client-v2/ApiClient} apiClient Optional API client implementation to use,
|
|
30349
30468
|
* default to {@link module:purecloud-platform-client-v2/ApiClient#instance} if unspecified.
|
|
30350
30469
|
*/function TelephonyApi(apiClient){_classCallCheck(this,TelephonyApi);this.apiClient=apiClient||ApiClient.instance;}/**
|
|
30470
|
+
* Delete a link
|
|
30471
|
+
*
|
|
30472
|
+
* @param {String} targetOrganizationId targetOrganizationId
|
|
30473
|
+
* @param {Object} opts Optional parameters
|
|
30474
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
30475
|
+
*/return _createClass(TelephonyApi,[{key:"deleteTelephonyOrganizationLinkTargetOrganizationId",value:function deleteTelephonyOrganizationLinkTargetOrganizationId(targetOrganizationId,opts){opts=opts||{};// verify the required parameter 'targetOrganizationId' is set
|
|
30476
|
+
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']);}/**
|
|
30351
30477
|
* Get an agent's greetings.
|
|
30352
30478
|
*
|
|
30353
30479
|
* @param {String} agentId User ID
|
|
30354
30480
|
* @param {Object} opts Optional parameters
|
|
30355
30481
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
30356
|
-
*/
|
|
30482
|
+
*/},{key:"getTelephonyAgentGreetings",value:function getTelephonyAgentGreetings(agentId,opts){opts=opts||{};// verify the required parameter 'agentId' is set
|
|
30357
30483
|
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']);}/**
|
|
30358
30484
|
* Get the agent's own greetings.
|
|
30359
30485
|
*
|
|
@@ -30371,6 +30497,28 @@ if(agentId===undefined||agentId===null||agentId===''){throw'Missing the required
|
|
|
30371
30497
|
* @param {Object} opts Optional parameters
|
|
30372
30498
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
30373
30499
|
*/},{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']);}/**
|
|
30500
|
+
* Get Number Routings by organizationId
|
|
30501
|
+
*
|
|
30502
|
+
* @param {Object} opts Optional parameters
|
|
30503
|
+
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
30504
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
30505
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
30506
|
+
* @param {String} opts.numberId numberId
|
|
30507
|
+
* @param {String} opts.activeRoutingOrganizationId activeRoutingOrganizationId
|
|
30508
|
+
* @param {String} opts.ownerOrganizationId ownerOrganizationId
|
|
30509
|
+
* @param {Object} opts.status status
|
|
30510
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
30511
|
+
*/},{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']);}/**
|
|
30512
|
+
* Get organization links
|
|
30513
|
+
*
|
|
30514
|
+
* @param {Object} opts Optional parameters
|
|
30515
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
30516
|
+
*/},{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']);}/**
|
|
30517
|
+
* Get all the replica regions by primary region
|
|
30518
|
+
*
|
|
30519
|
+
* @param {Object} opts Optional parameters
|
|
30520
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
30521
|
+
*/},{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']);}/**
|
|
30374
30522
|
* Get the global telephony configuration.
|
|
30375
30523
|
*
|
|
30376
30524
|
* @param {Object} opts Optional parameters
|
|
@@ -30411,6 +30559,43 @@ if(dateEnd===undefined||dateEnd===null){throw'Missing the required parameter "da
|
|
|
30411
30559
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
30412
30560
|
*/},{key:"getTelephonySiptracesDownloadDownloadId",value:function getTelephonySiptracesDownloadDownloadId(downloadId,opts){opts=opts||{};// verify the required parameter 'downloadId' is set
|
|
30413
30561
|
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']);}/**
|
|
30562
|
+
* Approving a requested link
|
|
30563
|
+
*
|
|
30564
|
+
* @param {String} requestingOrganizationId requestingOrganizationId
|
|
30565
|
+
* @param {Object} body Approval request body
|
|
30566
|
+
* @param {Object} opts Optional parameters
|
|
30567
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
30568
|
+
*/},{key:"patchTelephonyOrganizationLinkApproveRequestingOrganizationId",value:function patchTelephonyOrganizationLinkApproveRequestingOrganizationId(requestingOrganizationId,body,opts){opts=opts||{};// verify the required parameter 'requestingOrganizationId' is set
|
|
30569
|
+
if(requestingOrganizationId===undefined||requestingOrganizationId===null||requestingOrganizationId===''){throw'Missing the required parameter "requestingOrganizationId" when calling patchTelephonyOrganizationLinkApproveRequestingOrganizationId';}// verify the required parameter 'body' is set
|
|
30570
|
+
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']);}/**
|
|
30571
|
+
* Update the routing of numbers for one or multiple organizations
|
|
30572
|
+
*
|
|
30573
|
+
* @param {Array.<Object>} body drRoutingList
|
|
30574
|
+
* @param {Object} opts Optional parameters
|
|
30575
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
30576
|
+
*/},{key:"postTelephonyNumbersRouting",value:function postTelephonyNumbersRouting(body,opts){opts=opts||{};// verify the required parameter 'body' is set
|
|
30577
|
+
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']);}/**
|
|
30578
|
+
* Re-route all numbers on an organization
|
|
30579
|
+
*
|
|
30580
|
+
* @param {Object} body Value for all routing request body
|
|
30581
|
+
* @param {Object} opts Optional parameters
|
|
30582
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
30583
|
+
*/},{key:"postTelephonyNumbersRoutingAll",value:function postTelephonyNumbersRoutingAll(body,opts){opts=opts||{};// verify the required parameter 'body' is set
|
|
30584
|
+
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']);}/**
|
|
30585
|
+
* Reset routing for organization
|
|
30586
|
+
*
|
|
30587
|
+
* @param {Object} body Value for bulk routing request body
|
|
30588
|
+
* @param {Object} opts Optional parameters
|
|
30589
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
30590
|
+
*/},{key:"postTelephonyNumbersRoutingReset",value:function postTelephonyNumbersRoutingReset(body,opts){opts=opts||{};// verify the required parameter 'body' is set
|
|
30591
|
+
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']);}/**
|
|
30592
|
+
* Create a link with an organization
|
|
30593
|
+
*
|
|
30594
|
+
* @param {Object} body CreateLinkOrg body
|
|
30595
|
+
* @param {Object} opts Optional parameters
|
|
30596
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
30597
|
+
*/},{key:"postTelephonyOrganizationLink",value:function postTelephonyOrganizationLink(body,opts){opts=opts||{};// verify the required parameter 'body' is set
|
|
30598
|
+
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']);}/**
|
|
30414
30599
|
* Request a download of a pcap file to S3
|
|
30415
30600
|
*
|
|
30416
30601
|
* @param {Object} sIPSearchPublicRequest
|
|
@@ -30443,7 +30628,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
30443
30628
|
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(){/**
|
|
30444
30629
|
* TelephonyProvidersEdge service.
|
|
30445
30630
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
30446
|
-
* @version
|
|
30631
|
+
* @version 254.0.0
|
|
30447
30632
|
*//**
|
|
30448
30633
|
* Constructs a new TelephonyProvidersEdgeApi.
|
|
30449
30634
|
* @alias module:purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
@@ -31297,20 +31482,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
31297
31482
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
31298
31483
|
*/},{key:"postTelephonyProvidersEdgesExtensionpools",value:function postTelephonyProvidersEdgesExtensionpools(body,opts){opts=opts||{};// verify the required parameter 'body' is set
|
|
31299
31484
|
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']);}/**
|
|
31300
|
-
* Post media endpoint statistics event.
|
|
31301
|
-
*
|
|
31302
|
-
* @param {String} conversationId Identifier of the conversation
|
|
31303
|
-
* @param {String} communicationId Identifier of the media session
|
|
31304
|
-
* @param {String} mediaResourceId Identifier of the media resource of the endpoint
|
|
31305
|
-
* @param {Object} body MediaStatisticsPostRequest
|
|
31306
|
-
* @param {Object} opts Optional parameters
|
|
31307
|
-
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
31308
|
-
* postTelephonyProvidersEdgesMediastatisticsConversationCommunicationMediaresource is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
31309
|
-
*/},{key:"postTelephonyProvidersEdgesMediastatisticsConversationCommunicationMediaresource",value:function postTelephonyProvidersEdgesMediastatisticsConversationCommunicationMediaresource(conversationId,communicationId,mediaResourceId,body,opts){opts=opts||{};// verify the required parameter 'conversationId' is set
|
|
31310
|
-
if(conversationId===undefined||conversationId===null||conversationId===''){throw'Missing the required parameter "conversationId" when calling postTelephonyProvidersEdgesMediastatisticsConversationCommunicationMediaresource';}// verify the required parameter 'communicationId' is set
|
|
31311
|
-
if(communicationId===undefined||communicationId===null||communicationId===''){throw'Missing the required parameter "communicationId" when calling postTelephonyProvidersEdgesMediastatisticsConversationCommunicationMediaresource';}// verify the required parameter 'mediaResourceId' is set
|
|
31312
|
-
if(mediaResourceId===undefined||mediaResourceId===null||mediaResourceId===''){throw'Missing the required parameter "mediaResourceId" when calling postTelephonyProvidersEdgesMediastatisticsConversationCommunicationMediaresource';}// verify the required parameter 'body' is set
|
|
31313
|
-
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']);}/**
|
|
31314
31485
|
* Reboot a Phone
|
|
31315
31486
|
*
|
|
31316
31487
|
* @param {String} phoneId Phone Id
|
|
@@ -31510,7 +31681,7 @@ if(trunkBaseSettingsId===undefined||trunkBaseSettingsId===null||trunkBaseSetting
|
|
|
31510
31681
|
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(){/**
|
|
31511
31682
|
* Textbots service.
|
|
31512
31683
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
31513
|
-
* @version
|
|
31684
|
+
* @version 254.0.0
|
|
31514
31685
|
*//**
|
|
31515
31686
|
* Constructs a new TextbotsApi.
|
|
31516
31687
|
* @alias module:purecloud-platform-client-v2/api/TextbotsApi
|
|
@@ -31553,7 +31724,7 @@ if(launchRequest===undefined||launchRequest===null){throw'Missing the required p
|
|
|
31553
31724
|
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(){/**
|
|
31554
31725
|
* Tokens service.
|
|
31555
31726
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
31556
|
-
* @version
|
|
31727
|
+
* @version 254.0.0
|
|
31557
31728
|
*//**
|
|
31558
31729
|
* Constructs a new TokensApi.
|
|
31559
31730
|
* @alias module:purecloud-platform-client-v2/api/TokensApi
|
|
@@ -31597,7 +31768,7 @@ if(userId===undefined||userId===null||userId===''){throw'Missing the required pa
|
|
|
31597
31768
|
*/},{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(){/**
|
|
31598
31769
|
* Uploads service.
|
|
31599
31770
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
31600
|
-
* @version
|
|
31771
|
+
* @version 254.0.0
|
|
31601
31772
|
*//**
|
|
31602
31773
|
* Constructs a new UploadsApi.
|
|
31603
31774
|
* @alias module:purecloud-platform-client-v2/api/UploadsApi
|
|
@@ -31692,7 +31863,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
31692
31863
|
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(){/**
|
|
31693
31864
|
* Usage service.
|
|
31694
31865
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
31695
|
-
* @version
|
|
31866
|
+
* @version 254.0.0
|
|
31696
31867
|
*//**
|
|
31697
31868
|
* Constructs a new UsageApi.
|
|
31698
31869
|
* @alias module:purecloud-platform-client-v2/api/UsageApi
|
|
@@ -31794,7 +31965,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
31794
31965
|
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(){/**
|
|
31795
31966
|
* UserRecordings service.
|
|
31796
31967
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
31797
|
-
* @version
|
|
31968
|
+
* @version 254.0.0
|
|
31798
31969
|
*//**
|
|
31799
31970
|
* Constructs a new UserRecordingsApi.
|
|
31800
31971
|
* @alias module:purecloud-platform-client-v2/api/UserRecordingsApi
|
|
@@ -31850,7 +32021,7 @@ if(recordingId===undefined||recordingId===null||recordingId===''){throw'Missing
|
|
|
31850
32021
|
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(){/**
|
|
31851
32022
|
* Users service.
|
|
31852
32023
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
31853
|
-
* @version
|
|
32024
|
+
* @version 254.0.0
|
|
31854
32025
|
*//**
|
|
31855
32026
|
* Constructs a new UsersApi.
|
|
31856
32027
|
* @alias module:purecloud-platform-client-v2/api/UsersApi
|
|
@@ -31863,7 +32034,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
31863
32034
|
* @param {String} jobId jobId
|
|
31864
32035
|
* @param {Object} opts Optional parameters
|
|
31865
32036
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
31866
|
-
* deleteAnalyticsUsersAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
31867
32037
|
*/return _createClass(UsersApi,[{key:"deleteAnalyticsUsersAggregatesJob",value:function deleteAnalyticsUsersAggregatesJob(jobId,opts){opts=opts||{};// verify the required parameter 'jobId' is set
|
|
31868
32038
|
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']);}/**
|
|
31869
32039
|
* Delete/cancel an async request
|
|
@@ -31988,7 +32158,6 @@ if(schemaId===undefined||schemaId===null||schemaId===''){throw'Missing the requi
|
|
|
31988
32158
|
* @param {String} jobId jobId
|
|
31989
32159
|
* @param {Object} opts Optional parameters
|
|
31990
32160
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
31991
|
-
* getAnalyticsUsersAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
31992
32161
|
*/},{key:"getAnalyticsUsersAggregatesJob",value:function getAnalyticsUsersAggregatesJob(jobId,opts){opts=opts||{};// verify the required parameter 'jobId' is set
|
|
31993
32162
|
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']);}/**
|
|
31994
32163
|
* Fetch a page of results for an async aggregates query
|
|
@@ -31997,7 +32166,6 @@ if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required param
|
|
|
31997
32166
|
* @param {Object} opts Optional parameters
|
|
31998
32167
|
* @param {String} opts.cursor Cursor token to retrieve next page
|
|
31999
32168
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
32000
|
-
* getAnalyticsUsersAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
32001
32169
|
*/},{key:"getAnalyticsUsersAggregatesJobResults",value:function getAnalyticsUsersAggregatesJobResults(jobId,opts){opts=opts||{};// verify the required parameter 'jobId' is set
|
|
32002
32170
|
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']);}/**
|
|
32003
32171
|
* Get status for async query for user details
|
|
@@ -32583,7 +32751,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
32583
32751
|
* @param {Object} body query
|
|
32584
32752
|
* @param {Object} opts Optional parameters
|
|
32585
32753
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
32586
|
-
* postAnalyticsUsersAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
32587
32754
|
*/},{key:"postAnalyticsUsersAggregatesJobs",value:function postAnalyticsUsersAggregatesJobs(body,opts){opts=opts||{};// verify the required parameter 'body' is set
|
|
32588
32755
|
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']);}/**
|
|
32589
32756
|
* Query for user aggregates
|
|
@@ -32912,7 +33079,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
32912
33079
|
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(){/**
|
|
32913
33080
|
* UsersRules service.
|
|
32914
33081
|
* @module purecloud-platform-client-v2/api/UsersRulesApi
|
|
32915
|
-
* @version
|
|
33082
|
+
* @version 254.0.0
|
|
32916
33083
|
*//**
|
|
32917
33084
|
* Constructs a new UsersRulesApi.
|
|
32918
33085
|
* @alias module:purecloud-platform-client-v2/api/UsersRulesApi
|
|
@@ -33002,7 +33169,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
33002
33169
|
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(){/**
|
|
33003
33170
|
* Utilities service.
|
|
33004
33171
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
33005
|
-
* @version
|
|
33172
|
+
* @version 254.0.0
|
|
33006
33173
|
*//**
|
|
33007
33174
|
* Constructs a new UtilitiesApi.
|
|
33008
33175
|
* @alias module:purecloud-platform-client-v2/api/UtilitiesApi
|
|
@@ -33036,7 +33203,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
33036
33203
|
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(){/**
|
|
33037
33204
|
* Voicemail service.
|
|
33038
33205
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
33039
|
-
* @version
|
|
33206
|
+
* @version 254.0.0
|
|
33040
33207
|
*//**
|
|
33041
33208
|
* Constructs a new VoicemailApi.
|
|
33042
33209
|
* @alias module:purecloud-platform-client-v2/api/VoicemailApi
|
|
@@ -33243,7 +33410,7 @@ if(userId===undefined||userId===null||userId===''){throw'Missing the required pa
|
|
|
33243
33410
|
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(){/**
|
|
33244
33411
|
* WebChat service.
|
|
33245
33412
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
33246
|
-
* @version
|
|
33413
|
+
* @version 254.0.0
|
|
33247
33414
|
*//**
|
|
33248
33415
|
* Constructs a new WebChatApi.
|
|
33249
33416
|
* @alias module:purecloud-platform-client-v2/api/WebChatApi
|
|
@@ -33426,7 +33593,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
33426
33593
|
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(){/**
|
|
33427
33594
|
* WebDeployments service.
|
|
33428
33595
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
33429
|
-
* @version
|
|
33596
|
+
* @version 254.0.0
|
|
33430
33597
|
*//**
|
|
33431
33598
|
* Constructs a new WebDeploymentsApi.
|
|
33432
33599
|
* @alias module:purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
@@ -33604,7 +33771,7 @@ if(deploymentId===undefined||deploymentId===null||deploymentId===''){throw'Missi
|
|
|
33604
33771
|
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(){/**
|
|
33605
33772
|
* WebMessaging service.
|
|
33606
33773
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
33607
|
-
* @version
|
|
33774
|
+
* @version 254.0.0
|
|
33608
33775
|
*//**
|
|
33609
33776
|
* Constructs a new WebMessagingApi.
|
|
33610
33777
|
* @alias module:purecloud-platform-client-v2/api/WebMessagingApi
|
|
@@ -33652,7 +33819,7 @@ if(tokenId===undefined||tokenId===null||tokenId===''){throw'Missing the required
|
|
|
33652
33819
|
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(){/**
|
|
33653
33820
|
* Widgets service.
|
|
33654
33821
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
33655
|
-
* @version
|
|
33822
|
+
* @version 254.0.0
|
|
33656
33823
|
*//**
|
|
33657
33824
|
* Constructs a new WidgetsApi.
|
|
33658
33825
|
* @alias module:purecloud-platform-client-v2/api/WidgetsApi
|
|
@@ -33702,7 +33869,7 @@ if(deploymentId===undefined||deploymentId===null||deploymentId===''){throw'Missi
|
|
|
33702
33869
|
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(){/**
|
|
33703
33870
|
* WorkforceManagement service.
|
|
33704
33871
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
33705
|
-
* @version
|
|
33872
|
+
* @version 254.0.0
|
|
33706
33873
|
*//**
|
|
33707
33874
|
* Constructs a new WorkforceManagementApi.
|
|
33708
33875
|
* @alias module:purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
@@ -34177,6 +34344,16 @@ if(businessUnitId===undefined||businessUnitId===null||businessUnitId===''){throw
|
|
|
34177
34344
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
34178
34345
|
*/},{key:"getWorkforcemanagementBusinessunitMinimumstaffingSettings",value:function getWorkforcemanagementBusinessunitMinimumstaffingSettings(businessUnitId,opts){opts=opts||{};// verify the required parameter 'businessUnitId' is set
|
|
34179
34346
|
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']);}/**
|
|
34347
|
+
* Get opportunity details
|
|
34348
|
+
*
|
|
34349
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
34350
|
+
* @param {String} opportunityId The ID of the opportunity
|
|
34351
|
+
* @param {Object} opts Optional parameters
|
|
34352
|
+
* @param {Object} opts.expand List of resources to expand
|
|
34353
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
34354
|
+
*/},{key:"getWorkforcemanagementBusinessunitOpportunity",value:function getWorkforcemanagementBusinessunitOpportunity(businessUnitId,opportunityId,opts){opts=opts||{};// verify the required parameter 'businessUnitId' is set
|
|
34355
|
+
if(businessUnitId===undefined||businessUnitId===null||businessUnitId===''){throw'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitOpportunity';}// verify the required parameter 'opportunityId' is set
|
|
34356
|
+
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']);}/**
|
|
34180
34357
|
* Get a planning group
|
|
34181
34358
|
*
|
|
34182
34359
|
* @param {String} businessUnitId The ID of the business unit.
|
|
@@ -34342,9 +34519,10 @@ if(timeOffPlanId===undefined||timeOffPlanId===null||timeOffPlanId===''){throw'Mi
|
|
|
34342
34519
|
* @param {Object} opts Optional parameters
|
|
34343
34520
|
* @param {String} opts.managementUnitId The ID of the management unit to get management unit specific staffing groups
|
|
34344
34521
|
* @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
|
|
34522
|
+
* @param {Array.<String>} opts.expand Include to access additional data for the time-off plans
|
|
34345
34523
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
34346
34524
|
*/},{key:"getWorkforcemanagementBusinessunitTimeoffplans",value:function getWorkforcemanagementBusinessunitTimeoffplans(businessUnitId,opts){opts=opts||{};// verify the required parameter 'businessUnitId' is set
|
|
34347
|
-
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']);}/**
|
|
34525
|
+
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']);}/**
|
|
34348
34526
|
* Get users in the business unit
|
|
34349
34527
|
*
|
|
34350
34528
|
* @param {String} businessUnitId The ID of the business unit
|
|
@@ -34430,12 +34608,14 @@ if(recalculationId===undefined||recalculationId===null||recalculationId===''){th
|
|
|
34430
34608
|
* @param {String} businessUnitId The ID of the business unit
|
|
34431
34609
|
* @param {String} weekId First day of schedule week in yyyy-MM-dd format, or 'recent' (without quotes) to get recent schedules
|
|
34432
34610
|
* @param {Object} opts Optional parameters
|
|
34611
|
+
* @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
|
|
34612
|
+
* @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
|
|
34433
34613
|
* @param {Boolean} opts.includeOnlyPublished includeOnlyPublished
|
|
34434
34614
|
* @param {Object} opts.expand expand
|
|
34435
34615
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
34436
34616
|
*/},{key:"getWorkforcemanagementBusinessunitWeekSchedules",value:function getWorkforcemanagementBusinessunitWeekSchedules(businessUnitId,weekId,opts){opts=opts||{};// verify the required parameter 'businessUnitId' is set
|
|
34437
34617
|
if(businessUnitId===undefined||businessUnitId===null||businessUnitId===''){throw'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitWeekSchedules';}// verify the required parameter 'weekId' is set
|
|
34438
|
-
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']);}/**
|
|
34618
|
+
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']);}/**
|
|
34439
34619
|
* Get a short term forecast
|
|
34440
34620
|
*
|
|
34441
34621
|
* @param {String} businessUnitId The ID of the business unit to which the forecast belongs
|
|
@@ -34661,19 +34841,21 @@ if(managementUnitId===undefined||managementUnitId===null||managementUnitId==='')
|
|
|
34661
34841
|
if(managementUnitId===undefined||managementUnitId===null||managementUnitId===''){throw'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitAgent';}// verify the required parameter 'agentId' is set
|
|
34662
34842
|
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']);}/**
|
|
34663
34843
|
* Gets all the shift trades for a given agent
|
|
34664
|
-
*
|
|
34844
|
+
* Deprecated. Use new route instead (/businessunits/{businessUnitId}/shifttrading/trades/query/jobs)
|
|
34665
34845
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
34666
34846
|
* @param {String} agentId The agent id
|
|
34667
34847
|
* @param {Object} opts Optional parameters
|
|
34668
34848
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
34849
|
+
* @deprecated
|
|
34669
34850
|
*/},{key:"getWorkforcemanagementManagementunitAgentShifttrades",value:function getWorkforcemanagementManagementunitAgentShifttrades(managementUnitId,agentId,opts){opts=opts||{};// verify the required parameter 'managementUnitId' is set
|
|
34670
34851
|
if(managementUnitId===undefined||managementUnitId===null||managementUnitId===''){throw'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitAgentShifttrades';}// verify the required parameter 'agentId' is set
|
|
34671
34852
|
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']);}/**
|
|
34672
34853
|
* Gets a summary of all shift trades in the matched state
|
|
34673
|
-
*
|
|
34854
|
+
* Deprecated. Use new route instead (/businessunits/{businessUnitId}/shifttrading/weeks/summary/jobs)
|
|
34674
34855
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
34675
34856
|
* @param {Object} opts Optional parameters
|
|
34676
34857
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
34858
|
+
* @deprecated
|
|
34677
34859
|
*/},{key:"getWorkforcemanagementManagementunitShifttradesMatched",value:function getWorkforcemanagementManagementunitShifttradesMatched(managementUnitId,opts){opts=opts||{};// verify the required parameter 'managementUnitId' is set
|
|
34678
34860
|
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']);}/**
|
|
34679
34861
|
* Gets list of users available for whom you can send direct shift trade requests
|
|
@@ -34781,7 +34963,7 @@ if(scheduleId===undefined||scheduleId===null||scheduleId===''){throw'Missing the
|
|
|
34781
34963
|
if(managementUnitId===undefined||managementUnitId===null||managementUnitId===''){throw'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitWeekSchedules';}// verify the required parameter 'weekId' is set
|
|
34782
34964
|
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']);}/**
|
|
34783
34965
|
* Gets all the shift trades for a given week
|
|
34784
|
-
*
|
|
34966
|
+
* Deprecated. Use new route instead (/businessunits/{businessUnitId}/shifttrading/trades/evaluate/jobs)
|
|
34785
34967
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
34786
34968
|
* @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
|
|
34787
34969
|
* @param {Object} opts Optional parameters
|
|
@@ -34789,6 +34971,7 @@ if(weekId===undefined||weekId===null||weekId===''){throw'Missing the required pa
|
|
|
34789
34971
|
* @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)
|
|
34790
34972
|
* @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
|
|
34791
34973
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
34974
|
+
* @deprecated
|
|
34792
34975
|
*/},{key:"getWorkforcemanagementManagementunitWeekShifttrades",value:function getWorkforcemanagementManagementunitWeekShifttrades(managementUnitId,weekDateId,opts){opts=opts||{};// verify the required parameter 'managementUnitId' is set
|
|
34793
34976
|
if(managementUnitId===undefined||managementUnitId===null||managementUnitId===''){throw'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitWeekShifttrades';}// verify the required parameter 'weekDateId' is set
|
|
34794
34977
|
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']);}/**
|
|
@@ -34857,9 +35040,10 @@ if(managementUnitId===undefined||managementUnitId===null||managementUnitId==='')
|
|
|
34857
35040
|
*/},{key:"getWorkforcemanagementSchedulingjob",value:function getWorkforcemanagementSchedulingjob(jobId,opts){opts=opts||{};// verify the required parameter 'jobId' is set
|
|
34858
35041
|
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']);}/**
|
|
34859
35042
|
* Gets all of my shift trades
|
|
34860
|
-
*
|
|
35043
|
+
* Deprecated. Use new route instead (/shifttrading/trades/mine/query/jobs)
|
|
34861
35044
|
* @param {Object} opts Optional parameters
|
|
34862
35045
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
35046
|
+
* @deprecated
|
|
34863
35047
|
*/},{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']);}/**
|
|
34864
35048
|
* View result of update trade operation. Only the user who started the operation can query the status
|
|
34865
35049
|
* Job details are only retained if the initial request returned a 202 ACCEPTED response
|
|
@@ -35068,8 +35252,19 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
35068
35252
|
*/},{key:"patchWorkforcemanagementBusinessunitMinimumstaffingSettings",value:function patchWorkforcemanagementBusinessunitMinimumstaffingSettings(businessUnitId,body,opts){opts=opts||{};// verify the required parameter 'businessUnitId' is set
|
|
35069
35253
|
if(businessUnitId===undefined||businessUnitId===null||businessUnitId===''){throw'Missing the required parameter "businessUnitId" when calling patchWorkforcemanagementBusinessunitMinimumstaffingSettings';}// verify the required parameter 'body' is set
|
|
35070
35254
|
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']);}/**
|
|
35255
|
+
* Update the opportunity
|
|
35256
|
+
* Only opportunities with Draft status can be updated.
|
|
35257
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
35258
|
+
* @param {String} opportunityId The ID of the opportunity
|
|
35259
|
+
* @param {Object} body body
|
|
35260
|
+
* @param {Object} opts Optional parameters
|
|
35261
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
35262
|
+
*/},{key:"patchWorkforcemanagementBusinessunitOpportunity",value:function patchWorkforcemanagementBusinessunitOpportunity(businessUnitId,opportunityId,body,opts){opts=opts||{};// verify the required parameter 'businessUnitId' is set
|
|
35263
|
+
if(businessUnitId===undefined||businessUnitId===null||businessUnitId===''){throw'Missing the required parameter "businessUnitId" when calling patchWorkforcemanagementBusinessunitOpportunity';}// verify the required parameter 'opportunityId' is set
|
|
35264
|
+
if(opportunityId===undefined||opportunityId===null||opportunityId===''){throw'Missing the required parameter "opportunityId" when calling patchWorkforcemanagementBusinessunitOpportunity';}// verify the required parameter 'body' is set
|
|
35265
|
+
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']);}/**
|
|
35071
35266
|
* Updates the planning group
|
|
35072
|
-
*
|
|
35267
|
+
* If the request body contains queue references in route paths, routing:queue:view is required in each referenced queues division.
|
|
35073
35268
|
* @param {String} businessUnitId The ID of the business unit.
|
|
35074
35269
|
* @param {String} planningGroupId The ID of a planning group to update
|
|
35075
35270
|
* @param {Object} body body
|
|
@@ -35254,13 +35449,14 @@ if(userId===undefined||userId===null||userId===''){throw'Missing the required pa
|
|
|
35254
35449
|
if(timeOffRequestId===undefined||timeOffRequestId===null||timeOffRequestId===''){throw'Missing the required parameter "timeOffRequestId" when calling patchWorkforcemanagementManagementunitUserTimeoffrequest';}// verify the required parameter 'body' is set
|
|
35255
35450
|
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']);}/**
|
|
35256
35451
|
* Updates a shift trade. This route can only be called by the initiating agent
|
|
35257
|
-
*
|
|
35452
|
+
* Deprecated. Use new route instead (/shifttrading/trades/{tradeId}/jobs)
|
|
35258
35453
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
35259
35454
|
* @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
|
|
35260
35455
|
* @param {String} tradeId The ID of the shift trade to update
|
|
35261
35456
|
* @param {Object} body body
|
|
35262
35457
|
* @param {Object} opts Optional parameters
|
|
35263
35458
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
35459
|
+
* @deprecated
|
|
35264
35460
|
*/},{key:"patchWorkforcemanagementManagementunitWeekShifttrade",value:function patchWorkforcemanagementManagementunitWeekShifttrade(managementUnitId,weekDateId,tradeId,body,opts){opts=opts||{};// verify the required parameter 'managementUnitId' is set
|
|
35265
35461
|
if(managementUnitId===undefined||managementUnitId===null||managementUnitId===''){throw'Missing the required parameter "managementUnitId" when calling patchWorkforcemanagementManagementunitWeekShifttrade';}// verify the required parameter 'weekDateId' is set
|
|
35266
35462
|
if(weekDateId===undefined||weekDateId===null){throw'Missing the required parameter "weekDateId" when calling patchWorkforcemanagementManagementunitWeekShifttrade';}// verify the required parameter 'tradeId' is set
|
|
@@ -35346,13 +35542,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
35346
35542
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
35347
35543
|
*/},{key:"postWorkforcemanagementAdherenceExplanationsQuery",value:function postWorkforcemanagementAdherenceExplanationsQuery(body,opts){opts=opts||{};// verify the required parameter 'body' is set
|
|
35348
35544
|
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']);}/**
|
|
35349
|
-
* Deprecated. Use bulk routes instead (/adherence/historical/bulk)
|
|
35350
|
-
*
|
|
35351
|
-
* @param {Object} opts Optional parameters
|
|
35352
|
-
* @param {Object} opts.body body
|
|
35353
|
-
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
35354
|
-
* @deprecated
|
|
35355
|
-
*/},{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']);}/**
|
|
35356
35545
|
* Request a historical adherence report in bulk
|
|
35357
35546
|
*
|
|
35358
35547
|
* @param {Object} body body
|
|
@@ -35417,6 +35606,29 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
35417
35606
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
35418
35607
|
*/},{key:"postWorkforcemanagementAgentsMePossibleworkshifts",value:function postWorkforcemanagementAgentsMePossibleworkshifts(body,opts){opts=opts||{};// verify the required parameter 'body' is set
|
|
35419
35608
|
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']);}/**
|
|
35609
|
+
* Bulk add enrollments to opportunities for the authenticated agent
|
|
35610
|
+
* Allows an agent to enroll in opportunities. This endpoint can return partial success.
|
|
35611
|
+
* @param {Object} body body
|
|
35612
|
+
* @param {Object} opts Optional parameters
|
|
35613
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
35614
|
+
*/},{key:"postWorkforcemanagementAgentsOpportunitiesEnrollmentsBulkAdd",value:function postWorkforcemanagementAgentsOpportunitiesEnrollmentsBulkAdd(body,opts){opts=opts||{};// verify the required parameter 'body' is set
|
|
35615
|
+
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']);}/**
|
|
35616
|
+
* Bulk update enrollment status for the authenticated agent
|
|
35617
|
+
* Allows an agent to update the status of their enrollments (e.g. withdraw). Returns partial success if some enrollments cannot be updated.
|
|
35618
|
+
* @param {Object} body body
|
|
35619
|
+
* @param {Object} opts Optional parameters
|
|
35620
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
35621
|
+
*/},{key:"postWorkforcemanagementAgentsOpportunitiesEnrollmentsBulkStatusesUpdate",value:function postWorkforcemanagementAgentsOpportunitiesEnrollmentsBulkStatusesUpdate(body,opts){opts=opts||{};// verify the required parameter 'body' is set
|
|
35622
|
+
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']);}/**
|
|
35623
|
+
* Query opportunities for the authenticated agent
|
|
35624
|
+
* Queries within the specified date range. Each opportunity includes the agents enrollment details if they have enrolled.
|
|
35625
|
+
* @param {Object} body body
|
|
35626
|
+
* @param {Object} opts Optional parameters
|
|
35627
|
+
* @param {Object} opts.expand List of resources to expand
|
|
35628
|
+
* @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
|
|
35629
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
35630
|
+
*/},{key:"postWorkforcemanagementAgentsOpportunitiesQuery",value:function postWorkforcemanagementAgentsOpportunitiesQuery(body,opts){opts=opts||{};// verify the required parameter 'body' is set
|
|
35631
|
+
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']);}/**
|
|
35420
35632
|
* Fetch agent schedules for the logged in user's management unit
|
|
35421
35633
|
*
|
|
35422
35634
|
* @param {Object} body body
|
|
@@ -35594,8 +35806,83 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
35594
35806
|
*/},{key:"postWorkforcemanagementBusinessunitIntraday",value:function postWorkforcemanagementBusinessunitIntraday(businessUnitId,body,opts){opts=opts||{};// verify the required parameter 'businessUnitId' is set
|
|
35595
35807
|
if(businessUnitId===undefined||businessUnitId===null||businessUnitId===''){throw'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitIntraday';}// verify the required parameter 'body' is set
|
|
35596
35808
|
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']);}/**
|
|
35597
|
-
*
|
|
35809
|
+
* Bulk add opportunities
|
|
35810
|
+
*
|
|
35811
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
35812
|
+
* @param {Object} body body
|
|
35813
|
+
* @param {Object} opts Optional parameters
|
|
35814
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
35815
|
+
*/},{key:"postWorkforcemanagementBusinessunitOpportunitiesBulkAdd",value:function postWorkforcemanagementBusinessunitOpportunitiesBulkAdd(businessUnitId,body,opts){opts=opts||{};// verify the required parameter 'businessUnitId' is set
|
|
35816
|
+
if(businessUnitId===undefined||businessUnitId===null||businessUnitId===''){throw'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitOpportunitiesBulkAdd';}// verify the required parameter 'body' is set
|
|
35817
|
+
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']);}/**
|
|
35818
|
+
* Bulk publish opportunities
|
|
35819
|
+
* Published opportunities become available for agent enrollment when they open. Returns partial success if some opportunities cannot be published.
|
|
35820
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
35821
|
+
* @param {Object} body body
|
|
35822
|
+
* @param {Object} opts Optional parameters
|
|
35823
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
35824
|
+
*/},{key:"postWorkforcemanagementBusinessunitOpportunitiesBulkPublish",value:function postWorkforcemanagementBusinessunitOpportunitiesBulkPublish(businessUnitId,body,opts){opts=opts||{};// verify the required parameter 'businessUnitId' is set
|
|
35825
|
+
if(businessUnitId===undefined||businessUnitId===null||businessUnitId===''){throw'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitOpportunitiesBulkPublish';}// verify the required parameter 'body' is set
|
|
35826
|
+
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']);}/**
|
|
35827
|
+
* Bulk remove opportunities
|
|
35828
|
+
* This operation is permanent and cannot be undone. Returns partial success if some opportunities cannot be removed.
|
|
35829
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
35830
|
+
* @param {Object} body body
|
|
35831
|
+
* @param {Object} opts Optional parameters
|
|
35832
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
35833
|
+
*/},{key:"postWorkforcemanagementBusinessunitOpportunitiesBulkRemove",value:function postWorkforcemanagementBusinessunitOpportunitiesBulkRemove(businessUnitId,body,opts){opts=opts||{};// verify the required parameter 'businessUnitId' is set
|
|
35834
|
+
if(businessUnitId===undefined||businessUnitId===null||businessUnitId===''){throw'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitOpportunitiesBulkRemove';}// verify the required parameter 'body' is set
|
|
35835
|
+
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']);}/**
|
|
35836
|
+
* Bulk update opportunities status
|
|
35837
|
+
* If status is Closed, pending enrollments are automatically denied; approved enrollments remain in schedules. Returns partial success if some opportunities cannot be updated.
|
|
35838
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
35839
|
+
* @param {Object} body body
|
|
35840
|
+
* @param {Object} opts Optional parameters
|
|
35841
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
35842
|
+
*/},{key:"postWorkforcemanagementBusinessunitOpportunitiesBulkStatusesUpdate",value:function postWorkforcemanagementBusinessunitOpportunitiesBulkStatusesUpdate(businessUnitId,body,opts){opts=opts||{};// verify the required parameter 'businessUnitId' is set
|
|
35843
|
+
if(businessUnitId===undefined||businessUnitId===null||businessUnitId===''){throw'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitOpportunitiesBulkStatusesUpdate';}// verify the required parameter 'body' is set
|
|
35844
|
+
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']);}/**
|
|
35845
|
+
* Bulk update enrollment status
|
|
35846
|
+
* Updates the status of enrollments (approve/deny). Returns partial success if some enrollments cannot be updated.
|
|
35847
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
35848
|
+
* @param {Object} body body
|
|
35849
|
+
* @param {Object} opts Optional parameters
|
|
35850
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
35851
|
+
*/},{key:"postWorkforcemanagementBusinessunitOpportunitiesEnrollmentsBulkStatusesUpdate",value:function postWorkforcemanagementBusinessunitOpportunitiesEnrollmentsBulkStatusesUpdate(businessUnitId,body,opts){opts=opts||{};// verify the required parameter 'businessUnitId' is set
|
|
35852
|
+
if(businessUnitId===undefined||businessUnitId===null||businessUnitId===''){throw'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitOpportunitiesEnrollmentsBulkStatusesUpdate';}// verify the required parameter 'body' is set
|
|
35853
|
+
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']);}/**
|
|
35854
|
+
* Query enrollments
|
|
35855
|
+
* For more information about opportunities, use the expand parameter.
|
|
35856
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
35857
|
+
* @param {Object} body body
|
|
35858
|
+
* @param {Object} opts Optional parameters
|
|
35859
|
+
* @param {Object} opts.expand List of resources to expand
|
|
35860
|
+
* @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
|
|
35861
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
35862
|
+
*/},{key:"postWorkforcemanagementBusinessunitOpportunitiesEnrollmentsQuery",value:function postWorkforcemanagementBusinessunitOpportunitiesEnrollmentsQuery(businessUnitId,body,opts){opts=opts||{};// verify the required parameter 'businessUnitId' is set
|
|
35863
|
+
if(businessUnitId===undefined||businessUnitId===null||businessUnitId===''){throw'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitOpportunitiesEnrollmentsQuery';}// verify the required parameter 'body' is set
|
|
35864
|
+
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']);}/**
|
|
35865
|
+
* Query opportunities by external activity IDs
|
|
35598
35866
|
*
|
|
35867
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
35868
|
+
* @param {Object} body body
|
|
35869
|
+
* @param {Object} opts Optional parameters
|
|
35870
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
35871
|
+
*/},{key:"postWorkforcemanagementBusinessunitOpportunitiesExternalactivitiesQuery",value:function postWorkforcemanagementBusinessunitOpportunitiesExternalactivitiesQuery(businessUnitId,body,opts){opts=opts||{};// verify the required parameter 'businessUnitId' is set
|
|
35872
|
+
if(businessUnitId===undefined||businessUnitId===null||businessUnitId===''){throw'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitOpportunitiesExternalactivitiesQuery';}// verify the required parameter 'body' is set
|
|
35873
|
+
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']);}/**
|
|
35874
|
+
* Query opportunities within the specified date range
|
|
35875
|
+
*
|
|
35876
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
35877
|
+
* @param {Object} body body
|
|
35878
|
+
* @param {Object} opts Optional parameters
|
|
35879
|
+
* @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
|
|
35880
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
35881
|
+
*/},{key:"postWorkforcemanagementBusinessunitOpportunitiesQuery",value:function postWorkforcemanagementBusinessunitOpportunitiesQuery(businessUnitId,body,opts){opts=opts||{};// verify the required parameter 'businessUnitId' is set
|
|
35882
|
+
if(businessUnitId===undefined||businessUnitId===null||businessUnitId===''){throw'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitOpportunitiesQuery';}// verify the required parameter 'body' is set
|
|
35883
|
+
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']);}/**
|
|
35884
|
+
* Adds a new planning group
|
|
35885
|
+
* If the request body contains queue references in route paths, routing:queue:view is required in each referenced queues division.
|
|
35599
35886
|
* @param {String} businessUnitId The ID of the business unit.
|
|
35600
35887
|
* @param {Object} body body
|
|
35601
35888
|
* @param {Object} opts Optional parameters
|
|
@@ -36140,55 +36427,60 @@ if(timeOffRequestId===undefined||timeOffRequestId===null||timeOffRequestId==='')
|
|
|
36140
36427
|
* @param {String} userId The id of the user for whom the time off request estimate is requested
|
|
36141
36428
|
* @param {Object} body body
|
|
36142
36429
|
* @param {Object} opts Optional parameters
|
|
36430
|
+
* @param {Object} opts.includeOnly Limit response to the specified field
|
|
36143
36431
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
36144
36432
|
*/},{key:"postWorkforcemanagementManagementunitUserTimeoffrequestsEstimate",value:function postWorkforcemanagementManagementunitUserTimeoffrequestsEstimate(managementUnitId,userId,body,opts){opts=opts||{};// verify the required parameter 'managementUnitId' is set
|
|
36145
36433
|
if(managementUnitId===undefined||managementUnitId===null||managementUnitId===''){throw'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitUserTimeoffrequestsEstimate';}// verify the required parameter 'userId' is set
|
|
36146
36434
|
if(userId===undefined||userId===null||userId===''){throw'Missing the required parameter "userId" when calling postWorkforcemanagementManagementunitUserTimeoffrequestsEstimate';}// verify the required parameter 'body' is set
|
|
36147
|
-
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']);}/**
|
|
36435
|
+
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']);}/**
|
|
36148
36436
|
* Matches a shift trade. This route can only be called by the receiving agent
|
|
36149
|
-
*
|
|
36437
|
+
* Deprecated. Use new route instead (/shifttrading/trades/{tradeId}/match/jobs)
|
|
36150
36438
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
36151
36439
|
* @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
|
|
36152
36440
|
* @param {String} tradeId The ID of the shift trade to update
|
|
36153
36441
|
* @param {Object} body body
|
|
36154
36442
|
* @param {Object} opts Optional parameters
|
|
36155
36443
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
36444
|
+
* @deprecated
|
|
36156
36445
|
*/},{key:"postWorkforcemanagementManagementunitWeekShifttradeMatch",value:function postWorkforcemanagementManagementunitWeekShifttradeMatch(managementUnitId,weekDateId,tradeId,body,opts){opts=opts||{};// verify the required parameter 'managementUnitId' is set
|
|
36157
36446
|
if(managementUnitId===undefined||managementUnitId===null||managementUnitId===''){throw'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitWeekShifttradeMatch';}// verify the required parameter 'weekDateId' is set
|
|
36158
36447
|
if(weekDateId===undefined||weekDateId===null){throw'Missing the required parameter "weekDateId" when calling postWorkforcemanagementManagementunitWeekShifttradeMatch';}// verify the required parameter 'tradeId' is set
|
|
36159
36448
|
if(tradeId===undefined||tradeId===null||tradeId===''){throw'Missing the required parameter "tradeId" when calling postWorkforcemanagementManagementunitWeekShifttradeMatch';}// verify the required parameter 'body' is set
|
|
36160
36449
|
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']);}/**
|
|
36161
36450
|
* Adds a shift trade
|
|
36162
|
-
*
|
|
36451
|
+
* Deprecated. Use new route instead (/shifttrading/trades/jobs)
|
|
36163
36452
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
36164
36453
|
* @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
|
|
36165
36454
|
* @param {Object} body body
|
|
36166
36455
|
* @param {Object} opts Optional parameters
|
|
36167
36456
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
36457
|
+
* @deprecated
|
|
36168
36458
|
*/},{key:"postWorkforcemanagementManagementunitWeekShifttrades",value:function postWorkforcemanagementManagementunitWeekShifttrades(managementUnitId,weekDateId,body,opts){opts=opts||{};// verify the required parameter 'managementUnitId' is set
|
|
36169
36459
|
if(managementUnitId===undefined||managementUnitId===null||managementUnitId===''){throw'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitWeekShifttrades';}// verify the required parameter 'weekDateId' is set
|
|
36170
36460
|
if(weekDateId===undefined||weekDateId===null){throw'Missing the required parameter "weekDateId" when calling postWorkforcemanagementManagementunitWeekShifttrades';}// verify the required parameter 'body' is set
|
|
36171
36461
|
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']);}/**
|
|
36172
36462
|
* Searches for potential shift trade matches for the current agent
|
|
36173
|
-
*
|
|
36463
|
+
* Deprecated. Use new route instead (/businessunits/{businessUnitId}/shifttrading/unmatched/search/jobs)
|
|
36174
36464
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
36175
36465
|
* @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
|
|
36176
36466
|
* @param {Object} body body
|
|
36177
36467
|
* @param {Object} opts Optional parameters
|
|
36178
36468
|
* @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
|
|
36179
36469
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
36470
|
+
* @deprecated
|
|
36180
36471
|
*/},{key:"postWorkforcemanagementManagementunitWeekShifttradesSearch",value:function postWorkforcemanagementManagementunitWeekShifttradesSearch(managementUnitId,weekDateId,body,opts){opts=opts||{};// verify the required parameter 'managementUnitId' is set
|
|
36181
36472
|
if(managementUnitId===undefined||managementUnitId===null||managementUnitId===''){throw'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitWeekShifttradesSearch';}// verify the required parameter 'weekDateId' is set
|
|
36182
36473
|
if(weekDateId===undefined||weekDateId===null){throw'Missing the required parameter "weekDateId" when calling postWorkforcemanagementManagementunitWeekShifttradesSearch';}// verify the required parameter 'body' is set
|
|
36183
36474
|
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']);}/**
|
|
36184
36475
|
* Updates the state of a batch of shift trades
|
|
36185
|
-
* Admin functionality is not supported with "mine".
|
|
36476
|
+
* Admin functionality is not supported with "mine". Deprecated. Use new route instead (/businessunits/{buId}/shifttrading/trades/state/bulk/jobs)
|
|
36186
36477
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
36187
36478
|
* @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
|
|
36188
36479
|
* @param {Object} body body
|
|
36189
36480
|
* @param {Object} opts Optional parameters
|
|
36190
36481
|
* @param {Boolean} opts.forceAsync Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes
|
|
36191
36482
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
36483
|
+
* @deprecated
|
|
36192
36484
|
*/},{key:"postWorkforcemanagementManagementunitWeekShifttradesStateBulk",value:function postWorkforcemanagementManagementunitWeekShifttradesStateBulk(managementUnitId,weekDateId,body,opts){opts=opts||{};// verify the required parameter 'managementUnitId' is set
|
|
36193
36485
|
if(managementUnitId===undefined||managementUnitId===null||managementUnitId===''){throw'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitWeekShifttradesStateBulk';}// verify the required parameter 'weekDateId' is set
|
|
36194
36486
|
if(weekDateId===undefined||weekDateId===null){throw'Missing the required parameter "weekDateId" when calling postWorkforcemanagementManagementunitWeekShifttradesStateBulk';}// verify the required parameter 'body' is set
|
|
@@ -36357,9 +36649,10 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
36357
36649
|
*
|
|
36358
36650
|
* @param {Object} body body
|
|
36359
36651
|
* @param {Object} opts Optional parameters
|
|
36652
|
+
* @param {Object} opts.includeOnly Limit response to the specified field
|
|
36360
36653
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
36361
36654
|
*/},{key:"postWorkforcemanagementTimeoffrequestsEstimate",value:function postWorkforcemanagementTimeoffrequestsEstimate(body,opts){opts=opts||{};// verify the required parameter 'body' is set
|
|
36362
|
-
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']);}/**
|
|
36655
|
+
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']);}/**
|
|
36363
36656
|
* Retrieves integration statuses for a list of current user time off requests
|
|
36364
36657
|
*
|
|
36365
36658
|
* @param {Object} body body
|
|
@@ -36440,7 +36733,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
36440
36733
|
* </pre>
|
|
36441
36734
|
* </p>
|
|
36442
36735
|
* @module purecloud-platform-client-v2/index
|
|
36443
|
-
* @version
|
|
36736
|
+
* @version 254.0.0
|
|
36444
36737
|
*/var platformClient=/*#__PURE__*/_createClass(function platformClient(){_classCallCheck(this,platformClient);/**
|
|
36445
36738
|
* The ApiClient constructor.
|
|
36446
36739
|
* @property {module:purecloud-platform-client-v2/ApiClient}
|