purecloud-platform-client-v2 252.1.0 → 253.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 +908 -340
- package/dist/web-amd/purecloud-platform-client-v2.js +908 -340
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +336 -177
- package/dist/web-cjs/purecloud-platform-client-v2.js +336 -177
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +632 -102
- 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 -1
- 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 +1 -1
- package/src/purecloud-platform-client-v2/api/CarrierServicesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/CaseManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ChatApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/CoachingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ContentManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ConversationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/DataPrivacyApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/DownloadsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EmailsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EmployeeEngagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EventsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/FaxApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/FlowsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GamificationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GeolocationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GreetingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GroupsApi.js +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 -7
- 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 -1
- package/src/purecloud-platform-client-v2/api/RecordingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RoutingApi.js +179 -156
- 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 +1 -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 -1
- 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 +472 -39
- 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 253.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 253.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 253.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 253.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 253.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 253.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 253.0.0
|
|
7742
7743
|
*//**
|
|
7743
7744
|
* Constructs a new AnalyticsApi.
|
|
7744
7745
|
* @alias module:purecloud-platform-client-v2/api/AnalyticsApi
|
|
@@ -8860,7 +8861,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
8860
8861
|
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
8862
|
* Architect service.
|
|
8862
8863
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
8863
|
-
* @version
|
|
8864
|
+
* @version 253.0.0
|
|
8864
8865
|
*//**
|
|
8865
8866
|
* Constructs a new ArchitectApi.
|
|
8866
8867
|
* @alias module:purecloud-platform-client-v2/api/ArchitectApi
|
|
@@ -10074,8 +10075,9 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
10074
10075
|
* 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
10076
|
*
|
|
10076
10077
|
* @param {Object} opts Optional parameters
|
|
10078
|
+
* @param {Object} opts.body
|
|
10077
10079
|
* @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',{},{},{},{},
|
|
10080
|
+
*/},{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
10081
|
* Create a flow milestone
|
|
10080
10082
|
*
|
|
10081
10083
|
* @param {Object} opts Optional parameters
|
|
@@ -10229,7 +10231,7 @@ if(milestoneId===undefined||milestoneId===null||milestoneId===''){throw'Missing
|
|
|
10229
10231
|
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
10232
|
* AssistantCopilotVariations service.
|
|
10231
10233
|
* @module purecloud-platform-client-v2/api/AssistantCopilotVariationsApi
|
|
10232
|
-
* @version
|
|
10234
|
+
* @version 253.0.0
|
|
10233
10235
|
*//**
|
|
10234
10236
|
* Constructs a new AssistantCopilotVariationsApi.
|
|
10235
10237
|
* @alias module:purecloud-platform-client-v2/api/AssistantCopilotVariationsApi
|
|
@@ -10284,7 +10286,7 @@ if(variationId===undefined||variationId===null||variationId===''){throw'Missing
|
|
|
10284
10286
|
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
10287
|
* Audit service.
|
|
10286
10288
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
10287
|
-
* @version
|
|
10289
|
+
* @version 253.0.0
|
|
10288
10290
|
*//**
|
|
10289
10291
|
* Constructs a new AuditApi.
|
|
10290
10292
|
* @alias module:purecloud-platform-client-v2/api/AuditApi
|
|
@@ -10345,7 +10347,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
10345
10347
|
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
10348
|
* Authorization service.
|
|
10347
10349
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
10348
|
-
* @version
|
|
10350
|
+
* @version 253.0.0
|
|
10349
10351
|
*//**
|
|
10350
10352
|
* Constructs a new AuthorizationApi.
|
|
10351
10353
|
* @alias module:purecloud-platform-client-v2/api/AuthorizationApi
|
|
@@ -10863,7 +10865,7 @@ if(subjectId===undefined||subjectId===null||subjectId===''){throw'Missing the re
|
|
|
10863
10865
|
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
10866
|
* BackgroundAssistant service.
|
|
10865
10867
|
* @module purecloud-platform-client-v2/api/BackgroundAssistantApi
|
|
10866
|
-
* @version
|
|
10868
|
+
* @version 253.0.0
|
|
10867
10869
|
*//**
|
|
10868
10870
|
* Constructs a new BackgroundAssistantApi.
|
|
10869
10871
|
* @alias module:purecloud-platform-client-v2/api/BackgroundAssistantApi
|
|
@@ -10886,7 +10888,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
10886
10888
|
*/},{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
10889
|
* Billing service.
|
|
10888
10890
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
10889
|
-
* @version
|
|
10891
|
+
* @version 253.0.0
|
|
10890
10892
|
*//**
|
|
10891
10893
|
* Constructs a new BillingApi.
|
|
10892
10894
|
* @alias module:purecloud-platform-client-v2/api/BillingApi
|
|
@@ -10975,7 +10977,7 @@ if(endDate===undefined||endDate===null){throw'Missing the required parameter "en
|
|
|
10975
10977
|
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
10978
|
* BusinessRules service.
|
|
10977
10979
|
* @module purecloud-platform-client-v2/api/BusinessRulesApi
|
|
10978
|
-
* @version
|
|
10980
|
+
* @version 253.0.0
|
|
10979
10981
|
*//**
|
|
10980
10982
|
* Constructs a new BusinessRulesApi.
|
|
10981
10983
|
* @alias module:purecloud-platform-client-v2/api/BusinessRulesApi
|
|
@@ -11248,7 +11250,7 @@ if(schemaId===undefined||schemaId===null||schemaId===''){throw'Missing the requi
|
|
|
11248
11250
|
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
11251
|
* CarrierServices service.
|
|
11250
11252
|
* @module purecloud-platform-client-v2/api/CarrierServicesApi
|
|
11251
|
-
* @version
|
|
11253
|
+
* @version 253.0.0
|
|
11252
11254
|
*//**
|
|
11253
11255
|
* Constructs a new CarrierServicesApi.
|
|
11254
11256
|
* @alias module:purecloud-platform-client-v2/api/CarrierServicesApi
|
|
@@ -11271,7 +11273,7 @@ if(phoneNumber===undefined||phoneNumber===null){throw'Missing the required param
|
|
|
11271
11273
|
*/},{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
11274
|
* CaseManagement service.
|
|
11273
11275
|
* @module purecloud-platform-client-v2/api/CaseManagementApi
|
|
11274
|
-
* @version
|
|
11276
|
+
* @version 253.0.0
|
|
11275
11277
|
*//**
|
|
11276
11278
|
* Constructs a new CaseManagementApi.
|
|
11277
11279
|
* @alias module:purecloud-platform-client-v2/api/CaseManagementApi
|
|
@@ -11650,7 +11652,7 @@ if(caseplanId===undefined||caseplanId===null||caseplanId===''){throw'Missing the
|
|
|
11650
11652
|
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
11653
|
* Chat service.
|
|
11652
11654
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
11653
|
-
* @version
|
|
11655
|
+
* @version 253.0.0
|
|
11654
11656
|
*//**
|
|
11655
11657
|
* Constructs a new ChatApi.
|
|
11656
11658
|
* @alias module:purecloud-platform-client-v2/api/ChatApi
|
|
@@ -11945,7 +11947,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
11945
11947
|
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
11948
|
* Coaching service.
|
|
11947
11949
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
11948
|
-
* @version
|
|
11950
|
+
* @version 253.0.0
|
|
11949
11951
|
*//**
|
|
11950
11952
|
* Constructs a new CoachingApi.
|
|
11951
11953
|
* @alias module:purecloud-platform-client-v2/api/CoachingApi
|
|
@@ -12144,7 +12146,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
12144
12146
|
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
12147
|
* ContentManagement service.
|
|
12146
12148
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
12147
|
-
* @version
|
|
12149
|
+
* @version 253.0.0
|
|
12148
12150
|
*//**
|
|
12149
12151
|
* Constructs a new ContentManagementApi.
|
|
12150
12152
|
* @alias module:purecloud-platform-client-v2/api/ContentManagementApi
|
|
@@ -12476,7 +12478,7 @@ if(tagId===undefined||tagId===null||tagId===''){throw'Missing the required param
|
|
|
12476
12478
|
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
12479
|
* Conversations service.
|
|
12478
12480
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
12479
|
-
* @version
|
|
12481
|
+
* @version 253.0.0
|
|
12480
12482
|
*//**
|
|
12481
12483
|
* Constructs a new ConversationsApi.
|
|
12482
12484
|
* @alias module:purecloud-platform-client-v2/api/ConversationsApi
|
|
@@ -15408,7 +15410,7 @@ if(conversationId===undefined||conversationId===null||conversationId===''){throw
|
|
|
15408
15410
|
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
15411
|
* DataExtensions service.
|
|
15410
15412
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
15411
|
-
* @version
|
|
15413
|
+
* @version 253.0.0
|
|
15412
15414
|
*//**
|
|
15413
15415
|
* Constructs a new DataExtensionsApi.
|
|
15414
15416
|
* @alias module:purecloud-platform-client-v2/api/DataExtensionsApi
|
|
@@ -15435,7 +15437,7 @@ if(coretypeName===undefined||coretypeName===null||coretypeName===''){throw'Missi
|
|
|
15435
15437
|
*/},{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
15438
|
* DataPrivacy service.
|
|
15437
15439
|
* @module purecloud-platform-client-v2/api/DataPrivacyApi
|
|
15438
|
-
* @version
|
|
15440
|
+
* @version 253.0.0
|
|
15439
15441
|
*//**
|
|
15440
15442
|
* Constructs a new DataPrivacyApi.
|
|
15441
15443
|
* @alias module:purecloud-platform-client-v2/api/DataPrivacyApi
|
|
@@ -15486,7 +15488,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
15486
15488
|
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
15489
|
* Downloads service.
|
|
15488
15490
|
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
15489
|
-
* @version
|
|
15491
|
+
* @version 253.0.0
|
|
15490
15492
|
*//**
|
|
15491
15493
|
* Constructs a new DownloadsApi.
|
|
15492
15494
|
* @alias module:purecloud-platform-client-v2/api/DownloadsApi
|
|
@@ -15506,7 +15508,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
15506
15508
|
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
15509
|
* Emails service.
|
|
15508
15510
|
* @module purecloud-platform-client-v2/api/EmailsApi
|
|
15509
|
-
* @version
|
|
15511
|
+
* @version 253.0.0
|
|
15510
15512
|
*//**
|
|
15511
15513
|
* Constructs a new EmailsApi.
|
|
15512
15514
|
* @alias module:purecloud-platform-client-v2/api/EmailsApi
|
|
@@ -15543,7 +15545,7 @@ if(downloadId===undefined||downloadId===null||downloadId===''){throw'Missing the
|
|
|
15543
15545
|
*/},{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
15546
|
* EmployeeEngagement service.
|
|
15545
15547
|
* @module purecloud-platform-client-v2/api/EmployeeEngagementApi
|
|
15546
|
-
* @version
|
|
15548
|
+
* @version 253.0.0
|
|
15547
15549
|
*//**
|
|
15548
15550
|
* Constructs a new EmployeeEngagementApi.
|
|
15549
15551
|
* @alias module:purecloud-platform-client-v2/api/EmployeeEngagementApi
|
|
@@ -15601,7 +15603,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
15601
15603
|
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
15604
|
* Events service.
|
|
15603
15605
|
* @module purecloud-platform-client-v2/api/EventsApi
|
|
15604
|
-
* @version
|
|
15606
|
+
* @version 253.0.0
|
|
15605
15607
|
*//**
|
|
15606
15608
|
* Constructs a new EventsApi.
|
|
15607
15609
|
* @alias module:purecloud-platform-client-v2/api/EventsApi
|
|
@@ -15640,7 +15642,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
15640
15642
|
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
15643
|
* ExternalContacts service.
|
|
15642
15644
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
15643
|
-
* @version
|
|
15645
|
+
* @version 253.0.0
|
|
15644
15646
|
*//**
|
|
15645
15647
|
* Constructs a new ExternalContactsApi.
|
|
15646
15648
|
* @alias module:purecloud-platform-client-v2/api/ExternalContactsApi
|
|
@@ -16602,7 +16604,7 @@ if(relationshipId===undefined||relationshipId===null||relationshipId===''){throw
|
|
|
16602
16604
|
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
16605
|
* Fax service.
|
|
16604
16606
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
16605
|
-
* @version
|
|
16607
|
+
* @version 253.0.0
|
|
16606
16608
|
*//**
|
|
16607
16609
|
* Constructs a new FaxApi.
|
|
16608
16610
|
* @alias module:purecloud-platform-client-v2/api/FaxApi
|
|
@@ -16665,7 +16667,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
16665
16667
|
*/},{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
16668
|
* Flows service.
|
|
16667
16669
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
16668
|
-
* @version
|
|
16670
|
+
* @version 253.0.0
|
|
16669
16671
|
*//**
|
|
16670
16672
|
* Constructs a new FlowsApi.
|
|
16671
16673
|
* @alias module:purecloud-platform-client-v2/api/FlowsApi
|
|
@@ -16731,7 +16733,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
16731
16733
|
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
16734
|
* Gamification service.
|
|
16733
16735
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
16734
|
-
* @version
|
|
16736
|
+
* @version 253.0.0
|
|
16735
16737
|
*//**
|
|
16736
16738
|
* Constructs a new GamificationApi.
|
|
16737
16739
|
* @alias module:purecloud-platform-client-v2/api/GamificationApi
|
|
@@ -17526,7 +17528,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
17526
17528
|
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
17529
|
* GeneralDataProtectionRegulation service.
|
|
17528
17530
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
17529
|
-
* @version
|
|
17531
|
+
* @version 253.0.0
|
|
17530
17532
|
*//**
|
|
17531
17533
|
* Constructs a new GeneralDataProtectionRegulationApi.
|
|
17532
17534
|
* @alias module:purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
@@ -17567,7 +17569,7 @@ if(searchValue===undefined||searchValue===null){throw'Missing the required param
|
|
|
17567
17569
|
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
17570
|
* Geolocation service.
|
|
17569
17571
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
17570
|
-
* @version
|
|
17572
|
+
* @version 253.0.0
|
|
17571
17573
|
*//**
|
|
17572
17574
|
* Constructs a new GeolocationApi.
|
|
17573
17575
|
* @alias module:purecloud-platform-client-v2/api/GeolocationApi
|
|
@@ -17609,7 +17611,7 @@ if(clientId===undefined||clientId===null||clientId===''){throw'Missing the requi
|
|
|
17609
17611
|
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
17612
|
* Greetings service.
|
|
17611
17613
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
17612
|
-
* @version
|
|
17614
|
+
* @version 253.0.0
|
|
17613
17615
|
*//**
|
|
17614
17616
|
* Constructs a new GreetingsApi.
|
|
17615
17617
|
* @alias module:purecloud-platform-client-v2/api/GreetingsApi
|
|
@@ -17768,7 +17770,7 @@ if(userId===undefined||userId===null||userId===''){throw'Missing the required pa
|
|
|
17768
17770
|
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
17771
|
* Groups service.
|
|
17770
17772
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
17771
|
-
* @version
|
|
17773
|
+
* @version 253.0.0
|
|
17772
17774
|
*//**
|
|
17773
17775
|
* Constructs a new GroupsApi.
|
|
17774
17776
|
* @alias module:purecloud-platform-client-v2/api/GroupsApi
|
|
@@ -17931,7 +17933,7 @@ if(groupId===undefined||groupId===null||groupId===''){throw'Missing the required
|
|
|
17931
17933
|
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
17934
|
* IdentityProvider service.
|
|
17933
17935
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
17934
|
-
* @version
|
|
17936
|
+
* @version 253.0.0
|
|
17935
17937
|
*//**
|
|
17936
17938
|
* Constructs a new IdentityProviderApi.
|
|
17937
17939
|
* @alias module:purecloud-platform-client-v2/api/IdentityProviderApi
|
|
@@ -18163,7 +18165,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
18163
18165
|
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
18166
|
* InfrastructureAsCode service.
|
|
18165
18167
|
* @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
18166
|
-
* @version
|
|
18168
|
+
* @version 253.0.0
|
|
18167
18169
|
*//**
|
|
18168
18170
|
* Constructs a new InfrastructureAsCodeApi.
|
|
18169
18171
|
* @alias module:purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
@@ -18223,7 +18225,7 @@ if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required param
|
|
|
18223
18225
|
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
18226
|
* Integrations service.
|
|
18225
18227
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
18226
|
-
* @version
|
|
18228
|
+
* @version 253.0.0
|
|
18227
18229
|
*//**
|
|
18228
18230
|
* Constructs a new IntegrationsApi.
|
|
18229
18231
|
* @alias module:purecloud-platform-client-v2/api/IntegrationsApi
|
|
@@ -19053,7 +19055,7 @@ if(ucIntegrationId===undefined||ucIntegrationId===null||ucIntegrationId===''){th
|
|
|
19053
19055
|
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
19056
|
* Intents service.
|
|
19055
19057
|
* @module purecloud-platform-client-v2/api/IntentsApi
|
|
19056
|
-
* @version
|
|
19058
|
+
* @version 253.0.0
|
|
19057
19059
|
*//**
|
|
19058
19060
|
* Constructs a new IntentsApi.
|
|
19059
19061
|
* @alias module:purecloud-platform-client-v2/api/IntentsApi
|
|
@@ -19197,7 +19199,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
19197
19199
|
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
19200
|
* Journey service.
|
|
19199
19201
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
19200
|
-
* @version
|
|
19202
|
+
* @version 253.0.0
|
|
19201
19203
|
*//**
|
|
19202
19204
|
* Constructs a new JourneyApi.
|
|
19203
19205
|
* @alias module:purecloud-platform-client-v2/api/JourneyApi
|
|
@@ -19351,19 +19353,21 @@ if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required param
|
|
|
19351
19353
|
* @deprecated
|
|
19352
19354
|
*/},{key:"getJourneyActionmapsEstimatesJobResults",value:function getJourneyActionmapsEstimatesJobResults(jobId,opts){opts=opts||{};// verify the required parameter 'jobId' is set
|
|
19353
19355
|
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
|
-
*
|
|
19356
|
+
* Deprecated. Retrieve a single action target.
|
|
19357
|
+
* 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
19358
|
* @param {String} actionTargetId ID of the action target.
|
|
19357
19359
|
* @param {Object} opts Optional parameters
|
|
19358
19360
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
19361
|
+
* @deprecated
|
|
19359
19362
|
*/},{key:"getJourneyActiontarget",value:function getJourneyActiontarget(actionTargetId,opts){opts=opts||{};// verify the required parameter 'actionTargetId' is set
|
|
19360
19363
|
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
|
-
*
|
|
19364
|
+
* Deprecated. Retrieve all action targets.
|
|
19365
|
+
* 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
19366
|
* @param {Object} opts Optional parameters
|
|
19364
19367
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
19365
19368
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
19366
19369
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
19370
|
+
* @deprecated
|
|
19367
19371
|
*/},{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
19372
|
* Retrieve a single action template.
|
|
19369
19373
|
*
|
|
@@ -19671,6 +19675,16 @@ if(eventDefinitionId===undefined||eventDefinitionId===null||eventDefinitionId===
|
|
|
19671
19675
|
* @param {Object} opts Optional parameters
|
|
19672
19676
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
19673
19677
|
*/},{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']);}/**
|
|
19678
|
+
* Get external events for journey views
|
|
19679
|
+
*
|
|
19680
|
+
* @param {Object} opts Optional parameters
|
|
19681
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
19682
|
+
*/},{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']);}/**
|
|
19683
|
+
* Get changes in external event definitions
|
|
19684
|
+
*
|
|
19685
|
+
* @param {Object} opts Optional parameters
|
|
19686
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
19687
|
+
*/},{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
19688
|
* Get the jobs for an organization.
|
|
19675
19689
|
*
|
|
19676
19690
|
* @param {Object} opts Optional parameters
|
|
@@ -19704,12 +19718,13 @@ if(eventDefinitionId===undefined||eventDefinitionId===null||eventDefinitionId===
|
|
|
19704
19718
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
19705
19719
|
*/},{key:"patchJourneyActionmap",value:function patchJourneyActionmap(actionMapId,opts){opts=opts||{};// verify the required parameter 'actionMapId' is set
|
|
19706
19720
|
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
|
-
*
|
|
19721
|
+
* Deprecated. Update a single action target.
|
|
19722
|
+
* 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
19723
|
* @param {String} actionTargetId ID of the action target.
|
|
19710
19724
|
* @param {Object} opts Optional parameters
|
|
19711
19725
|
* @param {Object} opts.body
|
|
19712
19726
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
19727
|
+
* @deprecated
|
|
19713
19728
|
*/},{key:"patchJourneyActiontarget",value:function patchJourneyActiontarget(actionTargetId,opts){opts=opts||{};// verify the required parameter 'actionTargetId' is set
|
|
19714
19729
|
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
19730
|
* Update a single action template.
|
|
@@ -19949,10 +19964,26 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
19949
19964
|
*/},{key:"putJourneyViewVersion",value:function putJourneyViewVersion(viewId,versionId,body,opts){opts=opts||{};// verify the required parameter 'viewId' is set
|
|
19950
19965
|
if(viewId===undefined||viewId===null||viewId===''){throw'Missing the required parameter "viewId" when calling putJourneyViewVersion';}// verify the required parameter 'versionId' is set
|
|
19951
19966
|
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']);}
|
|
19967
|
+
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']);}/**
|
|
19968
|
+
* Update external event for journey views
|
|
19969
|
+
*
|
|
19970
|
+
* @param {String} eventDefinitionId Event Definition ID
|
|
19971
|
+
* @param {Object} opts Optional parameters
|
|
19972
|
+
* @param {Object} opts.body
|
|
19973
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
19974
|
+
*/},{key:"putJourneyViewsEventdefinition",value:function putJourneyViewsEventdefinition(eventDefinitionId,opts){opts=opts||{};// verify the required parameter 'eventDefinitionId' is set
|
|
19975
|
+
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']);}/**
|
|
19976
|
+
* Activate external event for journey views
|
|
19977
|
+
*
|
|
19978
|
+
* @param {String} eventDefinitionId Event Definition ID
|
|
19979
|
+
* @param {Object} opts Optional parameters
|
|
19980
|
+
* @param {Object} opts.body
|
|
19981
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
19982
|
+
*/},{key:"putJourneyViewsEventdefinitionActivate",value:function putJourneyViewsEventdefinitionActivate(eventDefinitionId,opts){opts=opts||{};// verify the required parameter 'eventDefinitionId' is set
|
|
19983
|
+
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
19984
|
* Knowledge service.
|
|
19954
19985
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
19955
|
-
* @version
|
|
19986
|
+
* @version 253.0.0
|
|
19956
19987
|
*//**
|
|
19957
19988
|
* Constructs a new KnowledgeApi.
|
|
19958
19989
|
* @alias module:purecloud-platform-client-v2/api/KnowledgeApi
|
|
@@ -20307,6 +20338,24 @@ if(documentId===undefined||documentId===null||documentId===''){throw'Missing the
|
|
|
20307
20338
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
20308
20339
|
*/},{key:"getKnowledgeKnowledgebaseDocuments",value:function getKnowledgeKnowledgebaseDocuments(knowledgeBaseId,opts){opts=opts||{};// verify the required parameter 'knowledgeBaseId' is set
|
|
20309
20340
|
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']);}/**
|
|
20341
|
+
* Get a list of feedback records given on documents in a knowledge base
|
|
20342
|
+
*
|
|
20343
|
+
* @param {String} knowledgeBaseId Knowledge base ID.
|
|
20344
|
+
* @param {Object} opts Optional parameters
|
|
20345
|
+
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
20346
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
20347
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
20348
|
+
* @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.
|
|
20349
|
+
* @param {String} opts.documentVersionId Document version ID to filter by. Supported only if onlyCommented=true is set.
|
|
20350
|
+
* @param {String} opts.documentVariationId Document variation ID to filter by. Supported only if onlyCommented=true is set.
|
|
20351
|
+
* @param {Object} opts.appType Application type to filter by. Supported only if onlyCommented=true is set.
|
|
20352
|
+
* @param {Object} opts.queryType Query type to filter by. Supported only if onlyCommented=true is set.
|
|
20353
|
+
* @param {String} opts.userId The ID of the user, who created the feedback, to filter by. Supported only if onlyCommented=true is set.
|
|
20354
|
+
* @param {String} opts.queueId Queue ID to filter by. Supported only if onlyCommented=true is set.
|
|
20355
|
+
* @param {Object} opts.state State to filter by. Supported only if onlyCommented=true is set. Default: Final
|
|
20356
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
20357
|
+
*/},{key:"getKnowledgeKnowledgebaseDocumentsFeedback",value:function getKnowledgeKnowledgebaseDocumentsFeedback(knowledgeBaseId,opts){opts=opts||{};// verify the required parameter 'knowledgeBaseId' is set
|
|
20358
|
+
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
20359
|
* Get export job report
|
|
20311
20360
|
*
|
|
20312
20361
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
@@ -21129,7 +21178,7 @@ if(sourceId===undefined||sourceId===null||sourceId===''){throw'Missing the requi
|
|
|
21129
21178
|
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
21179
|
* LanguageUnderstanding service.
|
|
21131
21180
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
21132
|
-
* @version
|
|
21181
|
+
* @version 253.0.0
|
|
21133
21182
|
*//**
|
|
21134
21183
|
* Constructs a new LanguageUnderstandingApi.
|
|
21135
21184
|
* @alias module:purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
@@ -21503,7 +21552,7 @@ if(domainVersionId===undefined||domainVersionId===null||domainVersionId===''){th
|
|
|
21503
21552
|
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
21553
|
* Languages service.
|
|
21505
21554
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
21506
|
-
* @version
|
|
21555
|
+
* @version 253.0.0
|
|
21507
21556
|
*//**
|
|
21508
21557
|
* Constructs a new LanguagesApi.
|
|
21509
21558
|
* @alias module:purecloud-platform-client-v2/api/LanguagesApi
|
|
@@ -21573,7 +21622,7 @@ if(userId===undefined||userId===null||userId===''){throw'Missing the required pa
|
|
|
21573
21622
|
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
21623
|
* Learning service.
|
|
21575
21624
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
21576
|
-
* @version
|
|
21625
|
+
* @version 253.0.0
|
|
21577
21626
|
*//**
|
|
21578
21627
|
* Constructs a new LearningApi.
|
|
21579
21628
|
* @alias module:purecloud-platform-client-v2/api/LearningApi
|
|
@@ -21921,7 +21970,7 @@ if(moduleId===undefined||moduleId===null||moduleId===''){throw'Missing the requi
|
|
|
21921
21970
|
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
21971
|
* License service.
|
|
21923
21972
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
21924
|
-
* @version
|
|
21973
|
+
* @version 253.0.0
|
|
21925
21974
|
*//**
|
|
21926
21975
|
* Constructs a new LicenseApi.
|
|
21927
21976
|
* @alias module:purecloud-platform-client-v2/api/LicenseApi
|
|
@@ -21996,7 +22045,7 @@ if(featureName===undefined||featureName===null||featureName===''){throw'Missing
|
|
|
21996
22045
|
*/},{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
22046
|
* Locations service.
|
|
21998
22047
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
21999
|
-
* @version
|
|
22048
|
+
* @version 253.0.0
|
|
22000
22049
|
*//**
|
|
22001
22050
|
* Constructs a new LocationsApi.
|
|
22002
22051
|
* @alias module:purecloud-platform-client-v2/api/LocationsApi
|
|
@@ -22068,7 +22117,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
22068
22117
|
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
22118
|
* LogCapture service.
|
|
22070
22119
|
* @module purecloud-platform-client-v2/api/LogCaptureApi
|
|
22071
|
-
* @version
|
|
22120
|
+
* @version 253.0.0
|
|
22072
22121
|
*//**
|
|
22073
22122
|
* Constructs a new LogCaptureApi.
|
|
22074
22123
|
* @alias module:purecloud-platform-client-v2/api/LogCaptureApi
|
|
@@ -22127,7 +22176,7 @@ if(userId===undefined||userId===null||userId===''){throw'Missing the required pa
|
|
|
22127
22176
|
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
22177
|
* Messaging service.
|
|
22129
22178
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
22130
|
-
* @version
|
|
22179
|
+
* @version 253.0.0
|
|
22131
22180
|
*//**
|
|
22132
22181
|
* Constructs a new MessagingApi.
|
|
22133
22182
|
* @alias module:purecloud-platform-client-v2/api/MessagingApi
|
|
@@ -22241,7 +22290,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
22241
22290
|
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
22291
|
* MobileDevices service.
|
|
22243
22292
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
22244
|
-
* @version
|
|
22293
|
+
* @version 253.0.0
|
|
22245
22294
|
*//**
|
|
22246
22295
|
* Constructs a new MobileDevicesApi.
|
|
22247
22296
|
* @alias module:purecloud-platform-client-v2/api/MobileDevicesApi
|
|
@@ -22288,7 +22337,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
22288
22337
|
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
22338
|
* Notifications service.
|
|
22290
22339
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
22291
|
-
* @version
|
|
22340
|
+
* @version 253.0.0
|
|
22292
22341
|
*//**
|
|
22293
22342
|
* Constructs a new NotificationsApi.
|
|
22294
22343
|
* @alias module:purecloud-platform-client-v2/api/NotificationsApi
|
|
@@ -22357,7 +22406,7 @@ if(channelId===undefined||channelId===null||channelId===''){throw'Missing the re
|
|
|
22357
22406
|
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
22407
|
* OAuth service.
|
|
22359
22408
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
22360
|
-
* @version
|
|
22409
|
+
* @version 253.0.0
|
|
22361
22410
|
*//**
|
|
22362
22411
|
* Constructs a new OAuthApi.
|
|
22363
22412
|
* @alias module:purecloud-platform-client-v2/api/OAuthApi
|
|
@@ -22463,7 +22512,7 @@ if(clientId===undefined||clientId===null||clientId===''){throw'Missing the requi
|
|
|
22463
22512
|
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
22513
|
* Objects service.
|
|
22465
22514
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
22466
|
-
* @version
|
|
22515
|
+
* @version 253.0.0
|
|
22467
22516
|
*//**
|
|
22468
22517
|
* Constructs a new ObjectsApi.
|
|
22469
22518
|
* @alias module:purecloud-platform-client-v2/api/ObjectsApi
|
|
@@ -22566,7 +22615,7 @@ if(divisionId===undefined||divisionId===null||divisionId===''){throw'Missing the
|
|
|
22566
22615
|
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
22616
|
* OperationalEvents service.
|
|
22568
22617
|
* @module purecloud-platform-client-v2/api/OperationalEventsApi
|
|
22569
|
-
* @version
|
|
22618
|
+
* @version 253.0.0
|
|
22570
22619
|
*//**
|
|
22571
22620
|
* Constructs a new OperationalEventsApi.
|
|
22572
22621
|
* @alias module:purecloud-platform-client-v2/api/OperationalEventsApi
|
|
@@ -22603,7 +22652,7 @@ if(eventDefinitionId===undefined||eventDefinitionId===null||eventDefinitionId===
|
|
|
22603
22652
|
*/},{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
22653
|
* Organization service.
|
|
22605
22654
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
22606
|
-
* @version
|
|
22655
|
+
* @version 253.0.0
|
|
22607
22656
|
*//**
|
|
22608
22657
|
* Constructs a new OrganizationApi.
|
|
22609
22658
|
* @alias module:purecloud-platform-client-v2/api/OrganizationApi
|
|
@@ -22743,7 +22792,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
22743
22792
|
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
22793
|
* OrganizationAuthorization service.
|
|
22745
22794
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
22746
|
-
* @version
|
|
22795
|
+
* @version 253.0.0
|
|
22747
22796
|
*//**
|
|
22748
22797
|
* Constructs a new OrganizationAuthorizationApi.
|
|
22749
22798
|
* @alias module:purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
@@ -23163,7 +23212,7 @@ if(trustorOrgId===undefined||trustorOrgId===null||trustorOrgId===''){throw'Missi
|
|
|
23163
23212
|
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
23213
|
* Outbound service.
|
|
23165
23214
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
23166
|
-
* @version
|
|
23215
|
+
* @version 253.0.0
|
|
23167
23216
|
*//**
|
|
23168
23217
|
* Constructs a new OutboundApi.
|
|
23169
23218
|
* @alias module:purecloud-platform-client-v2/api/OutboundApi
|
|
@@ -24649,7 +24698,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
24649
24698
|
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
24699
|
* Presence service.
|
|
24651
24700
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
24652
|
-
* @version
|
|
24701
|
+
* @version 253.0.0
|
|
24653
24702
|
*//**
|
|
24654
24703
|
* Constructs a new PresenceApi.
|
|
24655
24704
|
* @alias module:purecloud-platform-client-v2/api/PresenceApi
|
|
@@ -24869,7 +24918,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
24869
24918
|
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
24919
|
* ProcessAutomation service.
|
|
24871
24920
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
24872
|
-
* @version
|
|
24921
|
+
* @version 253.0.0
|
|
24873
24922
|
*//**
|
|
24874
24923
|
* Constructs a new ProcessAutomationApi.
|
|
24875
24924
|
* @alias module:purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
@@ -24983,7 +25032,7 @@ if(triggerId===undefined||triggerId===null||triggerId===''){throw'Missing the re
|
|
|
24983
25032
|
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
25033
|
* Quality service.
|
|
24985
25034
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
24986
|
-
* @version
|
|
25035
|
+
* @version 253.0.0
|
|
24987
25036
|
*//**
|
|
24988
25037
|
* Constructs a new QualityApi.
|
|
24989
25038
|
* @alias module:purecloud-platform-client-v2/api/QualityApi
|
|
@@ -25647,7 +25696,7 @@ if(customerSurveyUrl===undefined||customerSurveyUrl===null){throw'Missing the re
|
|
|
25647
25696
|
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
25697
|
* Recording service.
|
|
25649
25698
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
25650
|
-
* @version
|
|
25699
|
+
* @version 253.0.0
|
|
25651
25700
|
*//**
|
|
25652
25701
|
* Constructs a new RecordingApi.
|
|
25653
25702
|
* @alias module:purecloud-platform-client-v2/api/RecordingApi
|
|
@@ -26146,7 +26195,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
26146
26195
|
*/},{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
26196
|
* ResponseManagement service.
|
|
26148
26197
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
26149
|
-
* @version
|
|
26198
|
+
* @version 253.0.0
|
|
26150
26199
|
*//**
|
|
26151
26200
|
* Constructs a new ResponseManagementApi.
|
|
26152
26201
|
* @alias module:purecloud-platform-client-v2/api/ResponseManagementApi
|
|
@@ -26313,7 +26362,7 @@ if(responseAssetId===undefined||responseAssetId===null||responseAssetId===''){th
|
|
|
26313
26362
|
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
26363
|
* Routing service.
|
|
26315
26364
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
26316
|
-
* @version
|
|
26365
|
+
* @version 253.0.0
|
|
26317
26366
|
*//**
|
|
26318
26367
|
* Constructs a new RoutingApi.
|
|
26319
26368
|
* @alias module:purecloud-platform-client-v2/api/RoutingApi
|
|
@@ -26426,6 +26475,19 @@ if(codeId===undefined||codeId===null||codeId===''){throw'Missing the required pa
|
|
|
26426
26475
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
26427
26476
|
*/},{key:"deleteRoutingSkill",value:function deleteRoutingSkill(skillId,opts){opts=opts||{};// verify the required parameter 'skillId' is set
|
|
26428
26477
|
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']);}/**
|
|
26478
|
+
* Archive a skill expression to remove it from the set of active expressions
|
|
26479
|
+
*
|
|
26480
|
+
* @param {String} expressionId Expression ID
|
|
26481
|
+
* @param {Object} opts Optional parameters
|
|
26482
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
26483
|
+
*/},{key:"deleteRoutingSkillexpression",value:function deleteRoutingSkillexpression(expressionId,opts){opts=opts||{};// verify the required parameter 'expressionId' is set
|
|
26484
|
+
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']);}/**
|
|
26485
|
+
* Archive a set of skill expressions to remove them from the set of active expressions
|
|
26486
|
+
*
|
|
26487
|
+
* @param {Object} opts Optional parameters
|
|
26488
|
+
* @param {Array.<String>} opts.id Expression ID(s) to filter. Repeat for multiple or use comma-separated list.
|
|
26489
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
26490
|
+
*/},{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
26491
|
* Remove skill group definition
|
|
26430
26492
|
*
|
|
26431
26493
|
* @param {String} skillGroupId Skill Group ID
|
|
@@ -26474,15 +26536,6 @@ if(userId===undefined||userId===null||userId===''){throw'Missing the required pa
|
|
|
26474
26536
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
26475
26537
|
*/},{key:"deleteRoutingUtilizationLabel",value:function deleteRoutingUtilizationLabel(labelId,opts){opts=opts||{};// verify the required parameter 'labelId' is set
|
|
26476
26538
|
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
26539
|
* Delete wrap-up code
|
|
26487
26540
|
*
|
|
26488
26541
|
* @param {String} codeId Wrapup Code ID
|
|
@@ -26909,6 +26962,32 @@ if(queueId===undefined||queueId===null||queueId===''){throw'Missing the required
|
|
|
26909
26962
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
26910
26963
|
*/},{key:"getRoutingSkill",value:function getRoutingSkill(skillId,opts){opts=opts||{};// verify the required parameter 'skillId' is set
|
|
26911
26964
|
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']);}/**
|
|
26965
|
+
* Get a skill expression by ID
|
|
26966
|
+
*
|
|
26967
|
+
* @param {String} expressionId Expression ID
|
|
26968
|
+
* @param {Object} opts Optional parameters
|
|
26969
|
+
* @param {Boolean} opts.includeArchived Include archived (default to false)
|
|
26970
|
+
* @param {Object} opts.format Response format: raw expression or normalized (default to Raw)
|
|
26971
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
26972
|
+
*/},{key:"getRoutingSkillexpression",value:function getRoutingSkillexpression(expressionId,opts){opts=opts||{};// verify the required parameter 'expressionId' is set
|
|
26973
|
+
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']);}/**
|
|
26974
|
+
* Get skill expressions
|
|
26975
|
+
*
|
|
26976
|
+
* @param {Object} opts Optional parameters
|
|
26977
|
+
* @param {Object} opts.format Response format: raw expression or normalized (default to Raw)
|
|
26978
|
+
* @param {Boolean} opts.includeArchived Include archived (default to false)
|
|
26979
|
+
* @param {Array.<String>} opts.id Expression ID(s) to filter. Repeat for multiple or use comma-separated list.
|
|
26980
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
26981
|
+
*/},{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']);}/**
|
|
26982
|
+
* Get skill expressions associated with a queue
|
|
26983
|
+
*
|
|
26984
|
+
* @param {String} queueId Queue ID
|
|
26985
|
+
* @param {Object} opts Optional parameters
|
|
26986
|
+
* @param {Object} opts.format Response format: raw expression or normalized (default to Raw)
|
|
26987
|
+
* @param {Boolean} opts.includeArchived Include archived (default to false)
|
|
26988
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
26989
|
+
*/},{key:"getRoutingSkillexpressionsQueueQueueId",value:function getRoutingSkillexpressionsQueueQueueId(queueId,opts){opts=opts||{};// verify the required parameter 'queueId' is set
|
|
26990
|
+
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
26991
|
* Get skill group
|
|
26913
26992
|
*
|
|
26914
26993
|
* @param {String} skillGroupId Skill Group ID
|
|
@@ -27055,32 +27134,6 @@ if(labelId===undefined||labelId===null||labelId===''){throw'Missing the required
|
|
|
27055
27134
|
* @param {String} opts.name Utilization label's name (Wildcard is supported, e.g., 'label1*', '*label*'
|
|
27056
27135
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
27057
27136
|
*/},{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
27137
|
* Get details about this wrap-up code.
|
|
27085
27138
|
*
|
|
27086
27139
|
* @param {String} codeId Wrapup Code ID
|
|
@@ -27500,6 +27553,13 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
27500
27553
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
27501
27554
|
*/},{key:"postRoutingQueues",value:function postRoutingQueues(body,opts){opts=opts||{};// verify the required parameter 'body' is set
|
|
27502
27555
|
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']);}/**
|
|
27556
|
+
* Validate and normalize a skill expression
|
|
27557
|
+
*
|
|
27558
|
+
* @param {Object} body Skill expression data to validate
|
|
27559
|
+
* @param {Object} opts Optional parameters
|
|
27560
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
27561
|
+
*/},{key:"postRoutingSkillexpressionsValidate",value:function postRoutingSkillexpressionsValidate(body,opts){opts=opts||{};// verify the required parameter 'body' is set
|
|
27562
|
+
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
27563
|
* Add or remove member divisions for this skill group.
|
|
27504
27564
|
*
|
|
27505
27565
|
* @param {String} skillGroupId Skill Group ID
|
|
@@ -27558,14 +27618,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
27558
27618
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
27559
27619
|
*/},{key:"postRoutingUtilizationLabels",value:function postRoutingUtilizationLabels(body,opts){opts=opts||{};// verify the required parameter 'body' is set
|
|
27560
27620
|
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
27621
|
* Create a wrap-up code
|
|
27570
27622
|
*
|
|
27571
27623
|
* @param {Object} body WrapupCode
|
|
@@ -27742,7 +27794,7 @@ if(userId===undefined||userId===null||userId===''){throw'Missing the required pa
|
|
|
27742
27794
|
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
27795
|
* SCIM service.
|
|
27744
27796
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
27745
|
-
* @version
|
|
27797
|
+
* @version 253.0.0
|
|
27746
27798
|
*//**
|
|
27747
27799
|
* Constructs a new SCIMApi.
|
|
27748
27800
|
* @alias module:purecloud-platform-client-v2/api/SCIMApi
|
|
@@ -28005,7 +28057,7 @@ if(userId===undefined||userId===null||userId===''){throw'Missing the required pa
|
|
|
28005
28057
|
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
28058
|
* Scripts service.
|
|
28007
28059
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
28008
|
-
* @version
|
|
28060
|
+
* @version 253.0.0
|
|
28009
28061
|
*//**
|
|
28010
28062
|
* Constructs a new ScriptsApi.
|
|
28011
28063
|
* @alias module:purecloud-platform-client-v2/api/ScriptsApi
|
|
@@ -28167,7 +28219,7 @@ if(scriptId===undefined||scriptId===null||scriptId===''){throw'Missing the requi
|
|
|
28167
28219
|
*/},{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
28220
|
* Search service.
|
|
28169
28221
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
28170
|
-
* @version
|
|
28222
|
+
* @version 253.0.0
|
|
28171
28223
|
*//**
|
|
28172
28224
|
* Constructs a new SearchApi.
|
|
28173
28225
|
* @alias module:purecloud-platform-client-v2/api/SearchApi
|
|
@@ -28374,7 +28426,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
28374
28426
|
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
28427
|
* Settings service.
|
|
28376
28428
|
* @module purecloud-platform-client-v2/api/SettingsApi
|
|
28377
|
-
* @version
|
|
28429
|
+
* @version 253.0.0
|
|
28378
28430
|
*//**
|
|
28379
28431
|
* Constructs a new SettingsApi.
|
|
28380
28432
|
* @alias module:purecloud-platform-client-v2/api/SettingsApi
|
|
@@ -28471,7 +28523,7 @@ if(agentId===undefined||agentId===null||agentId===''){throw'Missing the required
|
|
|
28471
28523
|
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
28524
|
* SocialMedia service.
|
|
28473
28525
|
* @module purecloud-platform-client-v2/api/SocialMediaApi
|
|
28474
|
-
* @version
|
|
28526
|
+
* @version 253.0.0
|
|
28475
28527
|
*//**
|
|
28476
28528
|
* Constructs a new SocialMediaApi.
|
|
28477
28529
|
* @alias module:purecloud-platform-client-v2/api/SocialMediaApi
|
|
@@ -29026,7 +29078,7 @@ if(topicId===undefined||topicId===null||topicId===''){throw'Missing the required
|
|
|
29026
29078
|
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
29079
|
* SpeechTextAnalytics service.
|
|
29028
29080
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
29029
|
-
* @version
|
|
29081
|
+
* @version 253.0.0
|
|
29030
29082
|
*//**
|
|
29031
29083
|
* Constructs a new SpeechTextAnalyticsApi.
|
|
29032
29084
|
* @alias module:purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
@@ -29519,7 +29571,7 @@ if(topicId===undefined||topicId===null||topicId===''){throw'Missing the required
|
|
|
29519
29571
|
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
29572
|
* Stations service.
|
|
29521
29573
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
29522
|
-
* @version
|
|
29574
|
+
* @version 253.0.0
|
|
29523
29575
|
*//**
|
|
29524
29576
|
* Constructs a new StationsApi.
|
|
29525
29577
|
* @alias module:purecloud-platform-client-v2/api/StationsApi
|
|
@@ -29556,7 +29608,7 @@ if(stationId===undefined||stationId===null||stationId===''){throw'Missing the re
|
|
|
29556
29608
|
*/},{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
29609
|
* Suggest service.
|
|
29558
29610
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
29559
|
-
* @version
|
|
29611
|
+
* @version 253.0.0
|
|
29560
29612
|
*//**
|
|
29561
29613
|
* Constructs a new SuggestApi.
|
|
29562
29614
|
* @alias module:purecloud-platform-client-v2/api/SuggestApi
|
|
@@ -29600,7 +29652,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
29600
29652
|
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
29653
|
* TaskManagement service.
|
|
29602
29654
|
* @module purecloud-platform-client-v2/api/TaskManagementApi
|
|
29603
|
-
* @version
|
|
29655
|
+
* @version 253.0.0
|
|
29604
29656
|
*//**
|
|
29605
29657
|
* Constructs a new TaskManagementApi.
|
|
29606
29658
|
* @alias module:purecloud-platform-client-v2/api/TaskManagementApi
|
|
@@ -30244,7 +30296,7 @@ if(schemaId===undefined||schemaId===null||schemaId===''){throw'Missing the requi
|
|
|
30244
30296
|
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
30297
|
* Teams service.
|
|
30246
30298
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
30247
|
-
* @version
|
|
30299
|
+
* @version 253.0.0
|
|
30248
30300
|
*//**
|
|
30249
30301
|
* Constructs a new TeamsApi.
|
|
30250
30302
|
* @alias module:purecloud-platform-client-v2/api/TeamsApi
|
|
@@ -30340,7 +30392,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
30340
30392
|
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
30393
|
* Telephony service.
|
|
30342
30394
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
30343
|
-
* @version
|
|
30395
|
+
* @version 253.0.0
|
|
30344
30396
|
*//**
|
|
30345
30397
|
* Constructs a new TelephonyApi.
|
|
30346
30398
|
* @alias module:purecloud-platform-client-v2/api/TelephonyApi
|
|
@@ -30443,7 +30495,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
30443
30495
|
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
30496
|
* TelephonyProvidersEdge service.
|
|
30445
30497
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
30446
|
-
* @version
|
|
30498
|
+
* @version 253.0.0
|
|
30447
30499
|
*//**
|
|
30448
30500
|
* Constructs a new TelephonyProvidersEdgeApi.
|
|
30449
30501
|
* @alias module:purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
@@ -31297,20 +31349,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
31297
31349
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
31298
31350
|
*/},{key:"postTelephonyProvidersEdgesExtensionpools",value:function postTelephonyProvidersEdgesExtensionpools(body,opts){opts=opts||{};// verify the required parameter 'body' is set
|
|
31299
31351
|
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
31352
|
* Reboot a Phone
|
|
31315
31353
|
*
|
|
31316
31354
|
* @param {String} phoneId Phone Id
|
|
@@ -31510,7 +31548,7 @@ if(trunkBaseSettingsId===undefined||trunkBaseSettingsId===null||trunkBaseSetting
|
|
|
31510
31548
|
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
31549
|
* Textbots service.
|
|
31512
31550
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
31513
|
-
* @version
|
|
31551
|
+
* @version 253.0.0
|
|
31514
31552
|
*//**
|
|
31515
31553
|
* Constructs a new TextbotsApi.
|
|
31516
31554
|
* @alias module:purecloud-platform-client-v2/api/TextbotsApi
|
|
@@ -31553,7 +31591,7 @@ if(launchRequest===undefined||launchRequest===null){throw'Missing the required p
|
|
|
31553
31591
|
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
31592
|
* Tokens service.
|
|
31555
31593
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
31556
|
-
* @version
|
|
31594
|
+
* @version 253.0.0
|
|
31557
31595
|
*//**
|
|
31558
31596
|
* Constructs a new TokensApi.
|
|
31559
31597
|
* @alias module:purecloud-platform-client-v2/api/TokensApi
|
|
@@ -31597,7 +31635,7 @@ if(userId===undefined||userId===null||userId===''){throw'Missing the required pa
|
|
|
31597
31635
|
*/},{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
31636
|
* Uploads service.
|
|
31599
31637
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
31600
|
-
* @version
|
|
31638
|
+
* @version 253.0.0
|
|
31601
31639
|
*//**
|
|
31602
31640
|
* Constructs a new UploadsApi.
|
|
31603
31641
|
* @alias module:purecloud-platform-client-v2/api/UploadsApi
|
|
@@ -31692,7 +31730,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
31692
31730
|
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
31731
|
* Usage service.
|
|
31694
31732
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
31695
|
-
* @version
|
|
31733
|
+
* @version 253.0.0
|
|
31696
31734
|
*//**
|
|
31697
31735
|
* Constructs a new UsageApi.
|
|
31698
31736
|
* @alias module:purecloud-platform-client-v2/api/UsageApi
|
|
@@ -31794,7 +31832,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
31794
31832
|
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
31833
|
* UserRecordings service.
|
|
31796
31834
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
31797
|
-
* @version
|
|
31835
|
+
* @version 253.0.0
|
|
31798
31836
|
*//**
|
|
31799
31837
|
* Constructs a new UserRecordingsApi.
|
|
31800
31838
|
* @alias module:purecloud-platform-client-v2/api/UserRecordingsApi
|
|
@@ -31850,7 +31888,7 @@ if(recordingId===undefined||recordingId===null||recordingId===''){throw'Missing
|
|
|
31850
31888
|
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
31889
|
* Users service.
|
|
31852
31890
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
31853
|
-
* @version
|
|
31891
|
+
* @version 253.0.0
|
|
31854
31892
|
*//**
|
|
31855
31893
|
* Constructs a new UsersApi.
|
|
31856
31894
|
* @alias module:purecloud-platform-client-v2/api/UsersApi
|
|
@@ -32912,7 +32950,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
32912
32950
|
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
32951
|
* UsersRules service.
|
|
32914
32952
|
* @module purecloud-platform-client-v2/api/UsersRulesApi
|
|
32915
|
-
* @version
|
|
32953
|
+
* @version 253.0.0
|
|
32916
32954
|
*//**
|
|
32917
32955
|
* Constructs a new UsersRulesApi.
|
|
32918
32956
|
* @alias module:purecloud-platform-client-v2/api/UsersRulesApi
|
|
@@ -33002,7 +33040,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
33002
33040
|
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
33041
|
* Utilities service.
|
|
33004
33042
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
33005
|
-
* @version
|
|
33043
|
+
* @version 253.0.0
|
|
33006
33044
|
*//**
|
|
33007
33045
|
* Constructs a new UtilitiesApi.
|
|
33008
33046
|
* @alias module:purecloud-platform-client-v2/api/UtilitiesApi
|
|
@@ -33036,7 +33074,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
33036
33074
|
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
33075
|
* Voicemail service.
|
|
33038
33076
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
33039
|
-
* @version
|
|
33077
|
+
* @version 253.0.0
|
|
33040
33078
|
*//**
|
|
33041
33079
|
* Constructs a new VoicemailApi.
|
|
33042
33080
|
* @alias module:purecloud-platform-client-v2/api/VoicemailApi
|
|
@@ -33243,7 +33281,7 @@ if(userId===undefined||userId===null||userId===''){throw'Missing the required pa
|
|
|
33243
33281
|
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
33282
|
* WebChat service.
|
|
33245
33283
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
33246
|
-
* @version
|
|
33284
|
+
* @version 253.0.0
|
|
33247
33285
|
*//**
|
|
33248
33286
|
* Constructs a new WebChatApi.
|
|
33249
33287
|
* @alias module:purecloud-platform-client-v2/api/WebChatApi
|
|
@@ -33426,7 +33464,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
33426
33464
|
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
33465
|
* WebDeployments service.
|
|
33428
33466
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
33429
|
-
* @version
|
|
33467
|
+
* @version 253.0.0
|
|
33430
33468
|
*//**
|
|
33431
33469
|
* Constructs a new WebDeploymentsApi.
|
|
33432
33470
|
* @alias module:purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
@@ -33604,7 +33642,7 @@ if(deploymentId===undefined||deploymentId===null||deploymentId===''){throw'Missi
|
|
|
33604
33642
|
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
33643
|
* WebMessaging service.
|
|
33606
33644
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
33607
|
-
* @version
|
|
33645
|
+
* @version 253.0.0
|
|
33608
33646
|
*//**
|
|
33609
33647
|
* Constructs a new WebMessagingApi.
|
|
33610
33648
|
* @alias module:purecloud-platform-client-v2/api/WebMessagingApi
|
|
@@ -33652,7 +33690,7 @@ if(tokenId===undefined||tokenId===null||tokenId===''){throw'Missing the required
|
|
|
33652
33690
|
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
33691
|
* Widgets service.
|
|
33654
33692
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
33655
|
-
* @version
|
|
33693
|
+
* @version 253.0.0
|
|
33656
33694
|
*//**
|
|
33657
33695
|
* Constructs a new WidgetsApi.
|
|
33658
33696
|
* @alias module:purecloud-platform-client-v2/api/WidgetsApi
|
|
@@ -33702,7 +33740,7 @@ if(deploymentId===undefined||deploymentId===null||deploymentId===''){throw'Missi
|
|
|
33702
33740
|
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
33741
|
* WorkforceManagement service.
|
|
33704
33742
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
33705
|
-
* @version
|
|
33743
|
+
* @version 253.0.0
|
|
33706
33744
|
*//**
|
|
33707
33745
|
* Constructs a new WorkforceManagementApi.
|
|
33708
33746
|
* @alias module:purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
@@ -34177,6 +34215,16 @@ if(businessUnitId===undefined||businessUnitId===null||businessUnitId===''){throw
|
|
|
34177
34215
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
34178
34216
|
*/},{key:"getWorkforcemanagementBusinessunitMinimumstaffingSettings",value:function getWorkforcemanagementBusinessunitMinimumstaffingSettings(businessUnitId,opts){opts=opts||{};// verify the required parameter 'businessUnitId' is set
|
|
34179
34217
|
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']);}/**
|
|
34218
|
+
* Get opportunity details
|
|
34219
|
+
*
|
|
34220
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
34221
|
+
* @param {String} opportunityId The ID of the opportunity
|
|
34222
|
+
* @param {Object} opts Optional parameters
|
|
34223
|
+
* @param {Object} opts.expand List of resources to expand
|
|
34224
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
34225
|
+
*/},{key:"getWorkforcemanagementBusinessunitOpportunity",value:function getWorkforcemanagementBusinessunitOpportunity(businessUnitId,opportunityId,opts){opts=opts||{};// verify the required parameter 'businessUnitId' is set
|
|
34226
|
+
if(businessUnitId===undefined||businessUnitId===null||businessUnitId===''){throw'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitOpportunity';}// verify the required parameter 'opportunityId' is set
|
|
34227
|
+
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
34228
|
* Get a planning group
|
|
34181
34229
|
*
|
|
34182
34230
|
* @param {String} businessUnitId The ID of the business unit.
|
|
@@ -34661,19 +34709,21 @@ if(managementUnitId===undefined||managementUnitId===null||managementUnitId==='')
|
|
|
34661
34709
|
if(managementUnitId===undefined||managementUnitId===null||managementUnitId===''){throw'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitAgent';}// verify the required parameter 'agentId' is set
|
|
34662
34710
|
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
34711
|
* Gets all the shift trades for a given agent
|
|
34664
|
-
*
|
|
34712
|
+
* Deprecated. Use new route instead (/businessunits/{businessUnitId}/shifttrading/trades/query/jobs)
|
|
34665
34713
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
34666
34714
|
* @param {String} agentId The agent id
|
|
34667
34715
|
* @param {Object} opts Optional parameters
|
|
34668
34716
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
34717
|
+
* @deprecated
|
|
34669
34718
|
*/},{key:"getWorkforcemanagementManagementunitAgentShifttrades",value:function getWorkforcemanagementManagementunitAgentShifttrades(managementUnitId,agentId,opts){opts=opts||{};// verify the required parameter 'managementUnitId' is set
|
|
34670
34719
|
if(managementUnitId===undefined||managementUnitId===null||managementUnitId===''){throw'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitAgentShifttrades';}// verify the required parameter 'agentId' is set
|
|
34671
34720
|
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
34721
|
* Gets a summary of all shift trades in the matched state
|
|
34673
|
-
*
|
|
34722
|
+
* Deprecated. Use new route instead (/businessunits/{businessUnitId}/shifttrading/weeks/summary/jobs)
|
|
34674
34723
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
34675
34724
|
* @param {Object} opts Optional parameters
|
|
34676
34725
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
34726
|
+
* @deprecated
|
|
34677
34727
|
*/},{key:"getWorkforcemanagementManagementunitShifttradesMatched",value:function getWorkforcemanagementManagementunitShifttradesMatched(managementUnitId,opts){opts=opts||{};// verify the required parameter 'managementUnitId' is set
|
|
34678
34728
|
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
34729
|
* Gets list of users available for whom you can send direct shift trade requests
|
|
@@ -34781,7 +34831,7 @@ if(scheduleId===undefined||scheduleId===null||scheduleId===''){throw'Missing the
|
|
|
34781
34831
|
if(managementUnitId===undefined||managementUnitId===null||managementUnitId===''){throw'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitWeekSchedules';}// verify the required parameter 'weekId' is set
|
|
34782
34832
|
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
34833
|
* Gets all the shift trades for a given week
|
|
34784
|
-
*
|
|
34834
|
+
* Deprecated. Use new route instead (/businessunits/{businessUnitId}/shifttrading/trades/evaluate/jobs)
|
|
34785
34835
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
34786
34836
|
* @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
34837
|
* @param {Object} opts Optional parameters
|
|
@@ -34789,6 +34839,7 @@ if(weekId===undefined||weekId===null||weekId===''){throw'Missing the required pa
|
|
|
34789
34839
|
* @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
34840
|
* @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
|
|
34791
34841
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
34842
|
+
* @deprecated
|
|
34792
34843
|
*/},{key:"getWorkforcemanagementManagementunitWeekShifttrades",value:function getWorkforcemanagementManagementunitWeekShifttrades(managementUnitId,weekDateId,opts){opts=opts||{};// verify the required parameter 'managementUnitId' is set
|
|
34793
34844
|
if(managementUnitId===undefined||managementUnitId===null||managementUnitId===''){throw'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitWeekShifttrades';}// verify the required parameter 'weekDateId' is set
|
|
34794
34845
|
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 +34908,10 @@ if(managementUnitId===undefined||managementUnitId===null||managementUnitId==='')
|
|
|
34857
34908
|
*/},{key:"getWorkforcemanagementSchedulingjob",value:function getWorkforcemanagementSchedulingjob(jobId,opts){opts=opts||{};// verify the required parameter 'jobId' is set
|
|
34858
34909
|
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
34910
|
* Gets all of my shift trades
|
|
34860
|
-
*
|
|
34911
|
+
* Deprecated. Use new route instead (/shifttrading/trades/mine/query/jobs)
|
|
34861
34912
|
* @param {Object} opts Optional parameters
|
|
34862
34913
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
34914
|
+
* @deprecated
|
|
34863
34915
|
*/},{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
34916
|
* View result of update trade operation. Only the user who started the operation can query the status
|
|
34865
34917
|
* Job details are only retained if the initial request returned a 202 ACCEPTED response
|
|
@@ -35068,8 +35120,19 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
35068
35120
|
*/},{key:"patchWorkforcemanagementBusinessunitMinimumstaffingSettings",value:function patchWorkforcemanagementBusinessunitMinimumstaffingSettings(businessUnitId,body,opts){opts=opts||{};// verify the required parameter 'businessUnitId' is set
|
|
35069
35121
|
if(businessUnitId===undefined||businessUnitId===null||businessUnitId===''){throw'Missing the required parameter "businessUnitId" when calling patchWorkforcemanagementBusinessunitMinimumstaffingSettings';}// verify the required parameter 'body' is set
|
|
35070
35122
|
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']);}/**
|
|
35123
|
+
* Update the opportunity
|
|
35124
|
+
* Only opportunities with Draft status can be updated.
|
|
35125
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
35126
|
+
* @param {String} opportunityId The ID of the opportunity
|
|
35127
|
+
* @param {Object} body body
|
|
35128
|
+
* @param {Object} opts Optional parameters
|
|
35129
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
35130
|
+
*/},{key:"patchWorkforcemanagementBusinessunitOpportunity",value:function patchWorkforcemanagementBusinessunitOpportunity(businessUnitId,opportunityId,body,opts){opts=opts||{};// verify the required parameter 'businessUnitId' is set
|
|
35131
|
+
if(businessUnitId===undefined||businessUnitId===null||businessUnitId===''){throw'Missing the required parameter "businessUnitId" when calling patchWorkforcemanagementBusinessunitOpportunity';}// verify the required parameter 'opportunityId' is set
|
|
35132
|
+
if(opportunityId===undefined||opportunityId===null||opportunityId===''){throw'Missing the required parameter "opportunityId" when calling patchWorkforcemanagementBusinessunitOpportunity';}// verify the required parameter 'body' is set
|
|
35133
|
+
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
35134
|
* Updates the planning group
|
|
35072
|
-
*
|
|
35135
|
+
* If the request body contains queue references in route paths, routing:queue:view is required in each referenced queues division.
|
|
35073
35136
|
* @param {String} businessUnitId The ID of the business unit.
|
|
35074
35137
|
* @param {String} planningGroupId The ID of a planning group to update
|
|
35075
35138
|
* @param {Object} body body
|
|
@@ -35254,13 +35317,14 @@ if(userId===undefined||userId===null||userId===''){throw'Missing the required pa
|
|
|
35254
35317
|
if(timeOffRequestId===undefined||timeOffRequestId===null||timeOffRequestId===''){throw'Missing the required parameter "timeOffRequestId" when calling patchWorkforcemanagementManagementunitUserTimeoffrequest';}// verify the required parameter 'body' is set
|
|
35255
35318
|
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
35319
|
* Updates a shift trade. This route can only be called by the initiating agent
|
|
35257
|
-
*
|
|
35320
|
+
* Deprecated. Use new route instead (/shifttrading/trades/{tradeId}/jobs)
|
|
35258
35321
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
35259
35322
|
* @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
35323
|
* @param {String} tradeId The ID of the shift trade to update
|
|
35261
35324
|
* @param {Object} body body
|
|
35262
35325
|
* @param {Object} opts Optional parameters
|
|
35263
35326
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
35327
|
+
* @deprecated
|
|
35264
35328
|
*/},{key:"patchWorkforcemanagementManagementunitWeekShifttrade",value:function patchWorkforcemanagementManagementunitWeekShifttrade(managementUnitId,weekDateId,tradeId,body,opts){opts=opts||{};// verify the required parameter 'managementUnitId' is set
|
|
35265
35329
|
if(managementUnitId===undefined||managementUnitId===null||managementUnitId===''){throw'Missing the required parameter "managementUnitId" when calling patchWorkforcemanagementManagementunitWeekShifttrade';}// verify the required parameter 'weekDateId' is set
|
|
35266
35330
|
if(weekDateId===undefined||weekDateId===null){throw'Missing the required parameter "weekDateId" when calling patchWorkforcemanagementManagementunitWeekShifttrade';}// verify the required parameter 'tradeId' is set
|
|
@@ -35346,13 +35410,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
35346
35410
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
35347
35411
|
*/},{key:"postWorkforcemanagementAdherenceExplanationsQuery",value:function postWorkforcemanagementAdherenceExplanationsQuery(body,opts){opts=opts||{};// verify the required parameter 'body' is set
|
|
35348
35412
|
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
35413
|
* Request a historical adherence report in bulk
|
|
35357
35414
|
*
|
|
35358
35415
|
* @param {Object} body body
|
|
@@ -35417,6 +35474,29 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
35417
35474
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
35418
35475
|
*/},{key:"postWorkforcemanagementAgentsMePossibleworkshifts",value:function postWorkforcemanagementAgentsMePossibleworkshifts(body,opts){opts=opts||{};// verify the required parameter 'body' is set
|
|
35419
35476
|
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']);}/**
|
|
35477
|
+
* Bulk add enrollments to opportunities for the authenticated agent
|
|
35478
|
+
* Allows an agent to enroll in opportunities. This endpoint can return partial success.
|
|
35479
|
+
* @param {Object} body body
|
|
35480
|
+
* @param {Object} opts Optional parameters
|
|
35481
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
35482
|
+
*/},{key:"postWorkforcemanagementAgentsOpportunitiesEnrollmentsBulkAdd",value:function postWorkforcemanagementAgentsOpportunitiesEnrollmentsBulkAdd(body,opts){opts=opts||{};// verify the required parameter 'body' is set
|
|
35483
|
+
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']);}/**
|
|
35484
|
+
* Bulk update enrollment status for the authenticated agent
|
|
35485
|
+
* Allows an agent to update the status of their enrollments (e.g. withdraw). Returns partial success if some enrollments cannot be updated.
|
|
35486
|
+
* @param {Object} body body
|
|
35487
|
+
* @param {Object} opts Optional parameters
|
|
35488
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
35489
|
+
*/},{key:"postWorkforcemanagementAgentsOpportunitiesEnrollmentsBulkStatusesUpdate",value:function postWorkforcemanagementAgentsOpportunitiesEnrollmentsBulkStatusesUpdate(body,opts){opts=opts||{};// verify the required parameter 'body' is set
|
|
35490
|
+
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']);}/**
|
|
35491
|
+
* Query opportunities for the authenticated agent
|
|
35492
|
+
* Queries within the specified date range. Each opportunity includes the agents enrollment details if they have enrolled.
|
|
35493
|
+
* @param {Object} body body
|
|
35494
|
+
* @param {Object} opts Optional parameters
|
|
35495
|
+
* @param {Object} opts.expand List of resources to expand
|
|
35496
|
+
* @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
|
|
35497
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
35498
|
+
*/},{key:"postWorkforcemanagementAgentsOpportunitiesQuery",value:function postWorkforcemanagementAgentsOpportunitiesQuery(body,opts){opts=opts||{};// verify the required parameter 'body' is set
|
|
35499
|
+
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
35500
|
* Fetch agent schedules for the logged in user's management unit
|
|
35421
35501
|
*
|
|
35422
35502
|
* @param {Object} body body
|
|
@@ -35594,8 +35674,83 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
35594
35674
|
*/},{key:"postWorkforcemanagementBusinessunitIntraday",value:function postWorkforcemanagementBusinessunitIntraday(businessUnitId,body,opts){opts=opts||{};// verify the required parameter 'businessUnitId' is set
|
|
35595
35675
|
if(businessUnitId===undefined||businessUnitId===null||businessUnitId===''){throw'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitIntraday';}// verify the required parameter 'body' is set
|
|
35596
35676
|
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
|
-
*
|
|
35677
|
+
* Bulk add opportunities
|
|
35598
35678
|
*
|
|
35679
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
35680
|
+
* @param {Object} body body
|
|
35681
|
+
* @param {Object} opts Optional parameters
|
|
35682
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
35683
|
+
*/},{key:"postWorkforcemanagementBusinessunitOpportunitiesBulkAdd",value:function postWorkforcemanagementBusinessunitOpportunitiesBulkAdd(businessUnitId,body,opts){opts=opts||{};// verify the required parameter 'businessUnitId' is set
|
|
35684
|
+
if(businessUnitId===undefined||businessUnitId===null||businessUnitId===''){throw'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitOpportunitiesBulkAdd';}// verify the required parameter 'body' is set
|
|
35685
|
+
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']);}/**
|
|
35686
|
+
* Bulk publish opportunities
|
|
35687
|
+
* Published opportunities become available for agent enrollment when they open. Returns partial success if some opportunities cannot be published.
|
|
35688
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
35689
|
+
* @param {Object} body body
|
|
35690
|
+
* @param {Object} opts Optional parameters
|
|
35691
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
35692
|
+
*/},{key:"postWorkforcemanagementBusinessunitOpportunitiesBulkPublish",value:function postWorkforcemanagementBusinessunitOpportunitiesBulkPublish(businessUnitId,body,opts){opts=opts||{};// verify the required parameter 'businessUnitId' is set
|
|
35693
|
+
if(businessUnitId===undefined||businessUnitId===null||businessUnitId===''){throw'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitOpportunitiesBulkPublish';}// verify the required parameter 'body' is set
|
|
35694
|
+
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']);}/**
|
|
35695
|
+
* Bulk remove opportunities
|
|
35696
|
+
* This operation is permanent and cannot be undone. Returns partial success if some opportunities cannot be removed.
|
|
35697
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
35698
|
+
* @param {Object} body body
|
|
35699
|
+
* @param {Object} opts Optional parameters
|
|
35700
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
35701
|
+
*/},{key:"postWorkforcemanagementBusinessunitOpportunitiesBulkRemove",value:function postWorkforcemanagementBusinessunitOpportunitiesBulkRemove(businessUnitId,body,opts){opts=opts||{};// verify the required parameter 'businessUnitId' is set
|
|
35702
|
+
if(businessUnitId===undefined||businessUnitId===null||businessUnitId===''){throw'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitOpportunitiesBulkRemove';}// verify the required parameter 'body' is set
|
|
35703
|
+
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']);}/**
|
|
35704
|
+
* Bulk update opportunities status
|
|
35705
|
+
* If status is Closed, pending enrollments are automatically denied; approved enrollments remain in schedules. Returns partial success if some opportunities cannot be updated.
|
|
35706
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
35707
|
+
* @param {Object} body body
|
|
35708
|
+
* @param {Object} opts Optional parameters
|
|
35709
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
35710
|
+
*/},{key:"postWorkforcemanagementBusinessunitOpportunitiesBulkStatusesUpdate",value:function postWorkforcemanagementBusinessunitOpportunitiesBulkStatusesUpdate(businessUnitId,body,opts){opts=opts||{};// verify the required parameter 'businessUnitId' is set
|
|
35711
|
+
if(businessUnitId===undefined||businessUnitId===null||businessUnitId===''){throw'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitOpportunitiesBulkStatusesUpdate';}// verify the required parameter 'body' is set
|
|
35712
|
+
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']);}/**
|
|
35713
|
+
* Bulk update enrollment status
|
|
35714
|
+
* Updates the status of enrollments (approve/deny). Returns partial success if some enrollments cannot be updated.
|
|
35715
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
35716
|
+
* @param {Object} body body
|
|
35717
|
+
* @param {Object} opts Optional parameters
|
|
35718
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
35719
|
+
*/},{key:"postWorkforcemanagementBusinessunitOpportunitiesEnrollmentsBulkStatusesUpdate",value:function postWorkforcemanagementBusinessunitOpportunitiesEnrollmentsBulkStatusesUpdate(businessUnitId,body,opts){opts=opts||{};// verify the required parameter 'businessUnitId' is set
|
|
35720
|
+
if(businessUnitId===undefined||businessUnitId===null||businessUnitId===''){throw'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitOpportunitiesEnrollmentsBulkStatusesUpdate';}// verify the required parameter 'body' is set
|
|
35721
|
+
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']);}/**
|
|
35722
|
+
* Query enrollments
|
|
35723
|
+
* For more information about opportunities, use the expand parameter.
|
|
35724
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
35725
|
+
* @param {Object} body body
|
|
35726
|
+
* @param {Object} opts Optional parameters
|
|
35727
|
+
* @param {Object} opts.expand List of resources to expand
|
|
35728
|
+
* @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
|
|
35729
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
35730
|
+
*/},{key:"postWorkforcemanagementBusinessunitOpportunitiesEnrollmentsQuery",value:function postWorkforcemanagementBusinessunitOpportunitiesEnrollmentsQuery(businessUnitId,body,opts){opts=opts||{};// verify the required parameter 'businessUnitId' is set
|
|
35731
|
+
if(businessUnitId===undefined||businessUnitId===null||businessUnitId===''){throw'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitOpportunitiesEnrollmentsQuery';}// verify the required parameter 'body' is set
|
|
35732
|
+
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']);}/**
|
|
35733
|
+
* Query opportunities by external activity IDs
|
|
35734
|
+
*
|
|
35735
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
35736
|
+
* @param {Object} body body
|
|
35737
|
+
* @param {Object} opts Optional parameters
|
|
35738
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
35739
|
+
*/},{key:"postWorkforcemanagementBusinessunitOpportunitiesExternalactivitiesQuery",value:function postWorkforcemanagementBusinessunitOpportunitiesExternalactivitiesQuery(businessUnitId,body,opts){opts=opts||{};// verify the required parameter 'businessUnitId' is set
|
|
35740
|
+
if(businessUnitId===undefined||businessUnitId===null||businessUnitId===''){throw'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitOpportunitiesExternalactivitiesQuery';}// verify the required parameter 'body' is set
|
|
35741
|
+
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']);}/**
|
|
35742
|
+
* Query opportunities within the specified date range
|
|
35743
|
+
*
|
|
35744
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
35745
|
+
* @param {Object} body body
|
|
35746
|
+
* @param {Object} opts Optional parameters
|
|
35747
|
+
* @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
|
|
35748
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
35749
|
+
*/},{key:"postWorkforcemanagementBusinessunitOpportunitiesQuery",value:function postWorkforcemanagementBusinessunitOpportunitiesQuery(businessUnitId,body,opts){opts=opts||{};// verify the required parameter 'businessUnitId' is set
|
|
35750
|
+
if(businessUnitId===undefined||businessUnitId===null||businessUnitId===''){throw'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitOpportunitiesQuery';}// verify the required parameter 'body' is set
|
|
35751
|
+
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']);}/**
|
|
35752
|
+
* Adds a new planning group
|
|
35753
|
+
* If the request body contains queue references in route paths, routing:queue:view is required in each referenced queues division.
|
|
35599
35754
|
* @param {String} businessUnitId The ID of the business unit.
|
|
35600
35755
|
* @param {Object} body body
|
|
35601
35756
|
* @param {Object} opts Optional parameters
|
|
@@ -36146,49 +36301,53 @@ if(managementUnitId===undefined||managementUnitId===null||managementUnitId==='')
|
|
|
36146
36301
|
if(userId===undefined||userId===null||userId===''){throw'Missing the required parameter "userId" when calling postWorkforcemanagementManagementunitUserTimeoffrequestsEstimate';}// verify the required parameter 'body' is set
|
|
36147
36302
|
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']);}/**
|
|
36148
36303
|
* Matches a shift trade. This route can only be called by the receiving agent
|
|
36149
|
-
*
|
|
36304
|
+
* Deprecated. Use new route instead (/shifttrading/trades/{tradeId}/match/jobs)
|
|
36150
36305
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
36151
36306
|
* @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
36307
|
* @param {String} tradeId The ID of the shift trade to update
|
|
36153
36308
|
* @param {Object} body body
|
|
36154
36309
|
* @param {Object} opts Optional parameters
|
|
36155
36310
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
36311
|
+
* @deprecated
|
|
36156
36312
|
*/},{key:"postWorkforcemanagementManagementunitWeekShifttradeMatch",value:function postWorkforcemanagementManagementunitWeekShifttradeMatch(managementUnitId,weekDateId,tradeId,body,opts){opts=opts||{};// verify the required parameter 'managementUnitId' is set
|
|
36157
36313
|
if(managementUnitId===undefined||managementUnitId===null||managementUnitId===''){throw'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitWeekShifttradeMatch';}// verify the required parameter 'weekDateId' is set
|
|
36158
36314
|
if(weekDateId===undefined||weekDateId===null){throw'Missing the required parameter "weekDateId" when calling postWorkforcemanagementManagementunitWeekShifttradeMatch';}// verify the required parameter 'tradeId' is set
|
|
36159
36315
|
if(tradeId===undefined||tradeId===null||tradeId===''){throw'Missing the required parameter "tradeId" when calling postWorkforcemanagementManagementunitWeekShifttradeMatch';}// verify the required parameter 'body' is set
|
|
36160
36316
|
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
36317
|
* Adds a shift trade
|
|
36162
|
-
*
|
|
36318
|
+
* Deprecated. Use new route instead (/shifttrading/trades/jobs)
|
|
36163
36319
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
36164
36320
|
* @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
36321
|
* @param {Object} body body
|
|
36166
36322
|
* @param {Object} opts Optional parameters
|
|
36167
36323
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
36324
|
+
* @deprecated
|
|
36168
36325
|
*/},{key:"postWorkforcemanagementManagementunitWeekShifttrades",value:function postWorkforcemanagementManagementunitWeekShifttrades(managementUnitId,weekDateId,body,opts){opts=opts||{};// verify the required parameter 'managementUnitId' is set
|
|
36169
36326
|
if(managementUnitId===undefined||managementUnitId===null||managementUnitId===''){throw'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitWeekShifttrades';}// verify the required parameter 'weekDateId' is set
|
|
36170
36327
|
if(weekDateId===undefined||weekDateId===null){throw'Missing the required parameter "weekDateId" when calling postWorkforcemanagementManagementunitWeekShifttrades';}// verify the required parameter 'body' is set
|
|
36171
36328
|
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
36329
|
* Searches for potential shift trade matches for the current agent
|
|
36173
|
-
*
|
|
36330
|
+
* Deprecated. Use new route instead (/businessunits/{businessUnitId}/shifttrading/unmatched/search/jobs)
|
|
36174
36331
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
36175
36332
|
* @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
36333
|
* @param {Object} body body
|
|
36177
36334
|
* @param {Object} opts Optional parameters
|
|
36178
36335
|
* @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
|
|
36179
36336
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
36337
|
+
* @deprecated
|
|
36180
36338
|
*/},{key:"postWorkforcemanagementManagementunitWeekShifttradesSearch",value:function postWorkforcemanagementManagementunitWeekShifttradesSearch(managementUnitId,weekDateId,body,opts){opts=opts||{};// verify the required parameter 'managementUnitId' is set
|
|
36181
36339
|
if(managementUnitId===undefined||managementUnitId===null||managementUnitId===''){throw'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitWeekShifttradesSearch';}// verify the required parameter 'weekDateId' is set
|
|
36182
36340
|
if(weekDateId===undefined||weekDateId===null){throw'Missing the required parameter "weekDateId" when calling postWorkforcemanagementManagementunitWeekShifttradesSearch';}// verify the required parameter 'body' is set
|
|
36183
36341
|
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
36342
|
* Updates the state of a batch of shift trades
|
|
36185
|
-
* Admin functionality is not supported with "mine".
|
|
36343
|
+
* Admin functionality is not supported with "mine". Deprecated. Use new route instead (/businessunits/{buId}/shifttrading/trades/state/bulk/jobs)
|
|
36186
36344
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
36187
36345
|
* @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
36346
|
* @param {Object} body body
|
|
36189
36347
|
* @param {Object} opts Optional parameters
|
|
36190
36348
|
* @param {Boolean} opts.forceAsync Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes
|
|
36191
36349
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
36350
|
+
* @deprecated
|
|
36192
36351
|
*/},{key:"postWorkforcemanagementManagementunitWeekShifttradesStateBulk",value:function postWorkforcemanagementManagementunitWeekShifttradesStateBulk(managementUnitId,weekDateId,body,opts){opts=opts||{};// verify the required parameter 'managementUnitId' is set
|
|
36193
36352
|
if(managementUnitId===undefined||managementUnitId===null||managementUnitId===''){throw'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitWeekShifttradesStateBulk';}// verify the required parameter 'weekDateId' is set
|
|
36194
36353
|
if(weekDateId===undefined||weekDateId===null){throw'Missing the required parameter "weekDateId" when calling postWorkforcemanagementManagementunitWeekShifttradesStateBulk';}// verify the required parameter 'body' is set
|
|
@@ -36440,7 +36599,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
36440
36599
|
* </pre>
|
|
36441
36600
|
* </p>
|
|
36442
36601
|
* @module purecloud-platform-client-v2/index
|
|
36443
|
-
* @version
|
|
36602
|
+
* @version 253.0.0
|
|
36444
36603
|
*/var platformClient=/*#__PURE__*/_createClass(function platformClient(){_classCallCheck(this,platformClient);/**
|
|
36445
36604
|
* The ApiClient constructor.
|
|
36446
36605
|
* @property {module:purecloud-platform-client-v2/ApiClient}
|