purecloud-platform-client-v2 235.0.0 → 237.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 +492 -88
- package/dist/web-amd/purecloud-platform-client-v2.js +492 -88
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +201 -89
- package/dist/web-cjs/purecloud-platform-client-v2.js +201 -89
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +889 -596
- package/package.json +1 -1
- package/src/purecloud-platform-client-v2/ApiClient.js +1 -1
- package/src/purecloud-platform-client-v2/api/AIStudioApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AgentAssistantsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AgentCopilotApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AgentUIApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AlertingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ArchitectApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AuditApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +2 -2
- 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/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 +37 -3
- 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/JourneyApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LanguagesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LearningApi.js +27 -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 +2 -2
- 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 +1 -1
- package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ScreenRecordingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ScriptsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SearchApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SettingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SocialMediaApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/StationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SuggestApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TaskManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TeamsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TelephonyApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TextbotsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TokensApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UploadsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsageApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsersApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsersRulesApi.js +294 -0
- 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 +51 -1
- package/src/purecloud-platform-client-v2/index.js +7 -1
package/dist/web-cjs/bundle.js
CHANGED
|
@@ -953,7 +953,7 @@ if(env)this.environment=env;else this.environment=this.host?this.host:'mypureclo
|
|
|
953
953
|
this.environment=this.environment.replace(/\/+$/,'');// Strip protocol and subdomain
|
|
954
954
|
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];}}}]);}();/**
|
|
955
955
|
* @module purecloud-platform-client-v2/ApiClient
|
|
956
|
-
* @version
|
|
956
|
+
* @version 237.0.0
|
|
957
957
|
*/var ApiClient=/*#__PURE__*/function(){/**
|
|
958
958
|
* Manages low level client-server communications, parameter marshalling, etc. There should not be any need for an
|
|
959
959
|
* application to use this class directly - the *Api and model classes provide the public API for the service. The
|
|
@@ -1309,7 +1309,7 @@ resolve(data);})["catch"](function(error){var data=error;if(error.response&&erro
|
|
|
1309
1309
|
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(){/**
|
|
1310
1310
|
* AIStudio service.
|
|
1311
1311
|
* @module purecloud-platform-client-v2/api/AIStudioApi
|
|
1312
|
-
* @version
|
|
1312
|
+
* @version 237.0.0
|
|
1313
1313
|
*//**
|
|
1314
1314
|
* Constructs a new AIStudioApi.
|
|
1315
1315
|
* @alias module:purecloud-platform-client-v2/api/AIStudioApi
|
|
@@ -1460,7 +1460,7 @@ if(summarySettingId===undefined||summarySettingId===null||summarySettingId==='')
|
|
|
1460
1460
|
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']);}}]);}();var AgentAssistantsApi=/*#__PURE__*/function(){/**
|
|
1461
1461
|
* AgentAssistants service.
|
|
1462
1462
|
* @module purecloud-platform-client-v2/api/AgentAssistantsApi
|
|
1463
|
-
* @version
|
|
1463
|
+
* @version 237.0.0
|
|
1464
1464
|
*//**
|
|
1465
1465
|
* Constructs a new AgentAssistantsApi.
|
|
1466
1466
|
* @alias module:purecloud-platform-client-v2/api/AgentAssistantsApi
|
|
@@ -1591,7 +1591,7 @@ if(queueId===undefined||queueId===null||queueId===''){throw'Missing the required
|
|
|
1591
1591
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putAssistantQueue';}return this.apiClient.callApi('/api/v2/assistants/{assistantId}/queues/{queueId}','PUT',{'assistantId':assistantId,'queueId':queueId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var AgentCopilotApi=/*#__PURE__*/function(){/**
|
|
1592
1592
|
* AgentCopilot service.
|
|
1593
1593
|
* @module purecloud-platform-client-v2/api/AgentCopilotApi
|
|
1594
|
-
* @version
|
|
1594
|
+
* @version 237.0.0
|
|
1595
1595
|
*//**
|
|
1596
1596
|
* Constructs a new AgentCopilotApi.
|
|
1597
1597
|
* @alias module:purecloud-platform-client-v2/api/AgentCopilotApi
|
|
@@ -1618,7 +1618,7 @@ if(assistantId===undefined||assistantId===null||assistantId===''){throw'Missing
|
|
|
1618
1618
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putAssistantCopilot';}return this.apiClient.callApi('/api/v2/assistants/{assistantId}/copilot','PUT',{'assistantId':assistantId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var AgentUIApi=/*#__PURE__*/function(){/**
|
|
1619
1619
|
* AgentUI service.
|
|
1620
1620
|
* @module purecloud-platform-client-v2/api/AgentUIApi
|
|
1621
|
-
* @version
|
|
1621
|
+
* @version 237.0.0
|
|
1622
1622
|
*//**
|
|
1623
1623
|
* Constructs a new AgentUIApi.
|
|
1624
1624
|
* @alias module:purecloud-platform-client-v2/api/AgentUIApi
|
|
@@ -1652,7 +1652,7 @@ if(agentId===undefined||agentId===null||agentId===''){throw'Missing the required
|
|
|
1652
1652
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putUsersAgentuiAgentsAutoanswerAgentIdSettings';}return this.apiClient.callApi('/api/v2/users/agentui/agents/autoanswer/{agentId}/settings','PUT',{'agentId':agentId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var AlertingApi=/*#__PURE__*/function(){/**
|
|
1653
1653
|
* Alerting service.
|
|
1654
1654
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
1655
|
-
* @version
|
|
1655
|
+
* @version 237.0.0
|
|
1656
1656
|
*//**
|
|
1657
1657
|
* Constructs a new AlertingApi.
|
|
1658
1658
|
* @alias module:purecloud-platform-client-v2/api/AlertingApi
|
|
@@ -1741,7 +1741,7 @@ if(ruleId===undefined||ruleId===null||ruleId===''){throw'Missing the required pa
|
|
|
1741
1741
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putAlertingRule';}return this.apiClient.callApi('/api/v2/alerting/rules/{ruleId}','PUT',{'ruleId':ruleId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var AnalyticsApi=/*#__PURE__*/function(){/**
|
|
1742
1742
|
* Analytics service.
|
|
1743
1743
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
1744
|
-
* @version
|
|
1744
|
+
* @version 237.0.0
|
|
1745
1745
|
*//**
|
|
1746
1746
|
* Constructs a new AnalyticsApi.
|
|
1747
1747
|
* @alias module:purecloud-platform-client-v2/api/AnalyticsApi
|
|
@@ -2517,7 +2517,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
2517
2517
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putAnalyticsDataretentionSettings';}return this.apiClient.callApi('/api/v2/analytics/dataretention/settings','PUT',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var ArchitectApi=/*#__PURE__*/function(){/**
|
|
2518
2518
|
* Architect service.
|
|
2519
2519
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
2520
|
-
* @version
|
|
2520
|
+
* @version 237.0.0
|
|
2521
2521
|
*//**
|
|
2522
2522
|
* Constructs a new ArchitectApi.
|
|
2523
2523
|
* @alias module:purecloud-platform-client-v2/api/ArchitectApi
|
|
@@ -3651,7 +3651,7 @@ if(milestoneId===undefined||milestoneId===null||milestoneId===''){throw'Missing
|
|
|
3651
3651
|
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']);}}]);}();var AuditApi=/*#__PURE__*/function(){/**
|
|
3652
3652
|
* Audit service.
|
|
3653
3653
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
3654
|
-
* @version
|
|
3654
|
+
* @version 237.0.0
|
|
3655
3655
|
*//**
|
|
3656
3656
|
* Constructs a new AuditApi.
|
|
3657
3657
|
* @alias module:purecloud-platform-client-v2/api/AuditApi
|
|
@@ -3701,7 +3701,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
3701
3701
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postAuditsQueryRealtimeRelated';}return this.apiClient.callApi('/api/v2/audits/query/realtime/related','POST',{},{'expand':this.apiClient.buildCollectionParam(opts['expand'],'multi')},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var AuthorizationApi=/*#__PURE__*/function(){/**
|
|
3702
3702
|
* Authorization service.
|
|
3703
3703
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
3704
|
-
* @version
|
|
3704
|
+
* @version 237.0.0
|
|
3705
3705
|
*//**
|
|
3706
3706
|
* Constructs a new AuthorizationApi.
|
|
3707
3707
|
* @alias module:purecloud-platform-client-v2/api/AuthorizationApi
|
|
@@ -3783,7 +3783,7 @@ if(divisionId===undefined||divisionId===null||divisionId===''){throw'Missing the
|
|
|
3783
3783
|
* @param {Object} opts Optional parameters
|
|
3784
3784
|
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
3785
3785
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
3786
|
-
* @param {String} opts.pageSize
|
|
3786
|
+
* @param {String} opts.pageSize Page size (max 200, default 25) (default to 25)
|
|
3787
3787
|
* @param {Array.<String>} opts.id Optionally request specific divisions by their IDs
|
|
3788
3788
|
* @param {String} opts.name Optionally request specific divisions by division name
|
|
3789
3789
|
*/},{key:"getAuthorizationDivisionsQuery",value:function getAuthorizationDivisionsQuery(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/authorization/divisions/query','GET',{},{'before':opts['before'],'after':opts['after'],'pageSize':opts['pageSize'],'id':this.apiClient.buildCollectionParam(opts['id'],'multi'),'name':opts['name']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
@@ -4136,7 +4136,7 @@ if(subjectId===undefined||subjectId===null||subjectId===''){throw'Missing the re
|
|
|
4136
4136
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putUserRoles';}return this.apiClient.callApi('/api/v2/users/{subjectId}/roles','PUT',{'subjectId':subjectId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var BillingApi=/*#__PURE__*/function(){/**
|
|
4137
4137
|
* Billing service.
|
|
4138
4138
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
4139
|
-
* @version
|
|
4139
|
+
* @version 237.0.0
|
|
4140
4140
|
*//**
|
|
4141
4141
|
* Constructs a new BillingApi.
|
|
4142
4142
|
* @alias module:purecloud-platform-client-v2/api/BillingApi
|
|
@@ -4213,7 +4213,7 @@ if(endDate===undefined||endDate===null){throw'Missing the required parameter "en
|
|
|
4213
4213
|
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']);}}]);}();var BusinessRulesApi=/*#__PURE__*/function(){/**
|
|
4214
4214
|
* BusinessRules service.
|
|
4215
4215
|
* @module purecloud-platform-client-v2/api/BusinessRulesApi
|
|
4216
|
-
* @version
|
|
4216
|
+
* @version 237.0.0
|
|
4217
4217
|
*//**
|
|
4218
4218
|
* Constructs a new BusinessRulesApi.
|
|
4219
4219
|
* @alias module:purecloud-platform-client-v2/api/BusinessRulesApi
|
|
@@ -4434,7 +4434,7 @@ if(schemaId===undefined||schemaId===null||schemaId===''){throw'Missing the requi
|
|
|
4434
4434
|
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']);}}]);}();var CarrierServicesApi=/*#__PURE__*/function(){/**
|
|
4435
4435
|
* CarrierServices service.
|
|
4436
4436
|
* @module purecloud-platform-client-v2/api/CarrierServicesApi
|
|
4437
|
-
* @version
|
|
4437
|
+
* @version 237.0.0
|
|
4438
4438
|
*//**
|
|
4439
4439
|
* Constructs a new CarrierServicesApi.
|
|
4440
4440
|
* @alias module:purecloud-platform-client-v2/api/CarrierServicesApi
|
|
@@ -4454,7 +4454,7 @@ if(phoneNumber===undefined||phoneNumber===null){throw'Missing the required param
|
|
|
4454
4454
|
*/},{key:"postCarrierservicesIntegrationsEmergencylocationsMe",value:function postCarrierservicesIntegrationsEmergencylocationsMe(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/carrierservices/integrations/emergencylocations/me','POST',{},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var ChatApi=/*#__PURE__*/function(){/**
|
|
4455
4455
|
* Chat service.
|
|
4456
4456
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
4457
|
-
* @version
|
|
4457
|
+
* @version 237.0.0
|
|
4458
4458
|
*//**
|
|
4459
4459
|
* Constructs a new ChatApi.
|
|
4460
4460
|
* @alias module:purecloud-platform-client-v2/api/ChatApi
|
|
@@ -4685,7 +4685,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
4685
4685
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putChatsSettings';}return this.apiClient.callApi('/api/v2/chats/settings','PUT',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var CoachingApi=/*#__PURE__*/function(){/**
|
|
4686
4686
|
* Coaching service.
|
|
4687
4687
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
4688
|
-
* @version
|
|
4688
|
+
* @version 237.0.0
|
|
4689
4689
|
*//**
|
|
4690
4690
|
* Constructs a new CoachingApi.
|
|
4691
4691
|
* @alias module:purecloud-platform-client-v2/api/CoachingApi
|
|
@@ -4848,7 +4848,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
4848
4848
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postCoachingScheduleslotsQuery';}return this.apiClient.callApi('/api/v2/coaching/scheduleslots/query','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var ContentManagementApi=/*#__PURE__*/function(){/**
|
|
4849
4849
|
* ContentManagement service.
|
|
4850
4850
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
4851
|
-
* @version
|
|
4851
|
+
* @version 237.0.0
|
|
4852
4852
|
*//**
|
|
4853
4853
|
* Constructs a new ContentManagementApi.
|
|
4854
4854
|
* @alias module:purecloud-platform-client-v2/api/ContentManagementApi
|
|
@@ -5130,7 +5130,7 @@ if(tagId===undefined||tagId===null||tagId===''){throw'Missing the required param
|
|
|
5130
5130
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putContentmanagementWorkspaceTagvalue';}return this.apiClient.callApi('/api/v2/contentmanagement/workspaces/{workspaceId}/tagvalues/{tagId}','PUT',{'workspaceId':workspaceId,'tagId':tagId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var ConversationsApi=/*#__PURE__*/function(){/**
|
|
5131
5131
|
* Conversations service.
|
|
5132
5132
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
5133
|
-
* @version
|
|
5133
|
+
* @version 237.0.0
|
|
5134
5134
|
*//**
|
|
5135
5135
|
* Constructs a new ConversationsApi.
|
|
5136
5136
|
* @alias module:purecloud-platform-client-v2/api/ConversationsApi
|
|
@@ -5617,6 +5617,17 @@ if(keyconfigurationsId===undefined||keyconfigurationsId===null||keyconfiguration
|
|
|
5617
5617
|
* @param {String} conversationId conversationId
|
|
5618
5618
|
*/},{key:"getConversationsMessage",value:function getConversationsMessage(conversationId){// verify the required parameter 'conversationId' is set
|
|
5619
5619
|
if(conversationId===undefined||conversationId===null||conversationId===''){throw'Missing the required parameter "conversationId" when calling getConversationsMessage';}return this.apiClient.callApi('/api/v2/conversations/messages/{conversationId}','GET',{'conversationId':conversationId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
5620
|
+
* Get message media list by status
|
|
5621
|
+
*
|
|
5622
|
+
* @param {String} conversationId conversationId
|
|
5623
|
+
* @param {String} communicationId communicationId
|
|
5624
|
+
* @param {Object} opts Optional parameters
|
|
5625
|
+
* @param {Object} opts.status The status on which to filter the response.
|
|
5626
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
5627
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
5628
|
+
*/},{key:"getConversationsMessageCommunicationMessagesMedia",value:function getConversationsMessageCommunicationMessagesMedia(conversationId,communicationId,opts){opts=opts||{};// verify the required parameter 'conversationId' is set
|
|
5629
|
+
if(conversationId===undefined||conversationId===null||conversationId===''){throw'Missing the required parameter "conversationId" when calling getConversationsMessageCommunicationMessagesMedia';}// verify the required parameter 'communicationId' is set
|
|
5630
|
+
if(communicationId===undefined||communicationId===null||communicationId===''){throw'Missing the required parameter "communicationId" when calling getConversationsMessageCommunicationMessagesMedia';}return this.apiClient.callApi('/api/v2/conversations/messages/{conversationId}/communications/{communicationId}/messages/media','GET',{'conversationId':conversationId,'communicationId':communicationId},{'status':opts['status'],'pageNumber':opts['pageNumber'],'pageSize':opts['pageSize']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
5620
5631
|
* Get media
|
|
5621
5632
|
* See https://developer.genesys.cloud/api/rest/v2/conversations/messaging-media-upload for example usage.
|
|
5622
5633
|
* @param {String} conversationId conversationId
|
|
@@ -5919,7 +5930,6 @@ if(communicationId===undefined||communicationId===null||communicationId===''){th
|
|
|
5919
5930
|
* Gets a record for a given meetingId
|
|
5920
5931
|
*
|
|
5921
5932
|
* @param {String} meetingId meetingId
|
|
5922
|
-
* getConversationsVideosMeeting is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
5923
5933
|
*/},{key:"getConversationsVideosMeeting",value:function getConversationsVideosMeeting(meetingId){// verify the required parameter 'meetingId' is set
|
|
5924
5934
|
if(meetingId===undefined||meetingId===null||meetingId===''){throw'Missing the required parameter "meetingId" when calling getConversationsVideosMeeting';}return this.apiClient.callApi('/api/v2/conversations/videos/meetings/{meetingId}','GET',{'meetingId':meetingId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
5925
5935
|
* Update a participant.
|
|
@@ -7048,7 +7058,6 @@ if(communicationId===undefined||communicationId===null||communicationId===''){th
|
|
|
7048
7058
|
* Generate a meetingId for a given conferenceId
|
|
7049
7059
|
*
|
|
7050
7060
|
* @param {Object} body MeetingIdRequest
|
|
7051
|
-
* postConversationsVideosMeetings is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
7052
7061
|
*/},{key:"postConversationsVideosMeetings",value:function postConversationsVideosMeetings(body){// verify the required parameter 'body' is set
|
|
7053
7062
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postConversationsVideosMeetings';}return this.apiClient.callApi('/api/v2/conversations/videos/meetings','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
7054
7063
|
* Set flagged reason on conversation participant to indicate bad conversation quality.
|
|
@@ -7222,7 +7231,7 @@ if(conversationId===undefined||conversationId===null||conversationId===''){throw
|
|
|
7222
7231
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putConversationsVideoRecordingstate';}return this.apiClient.callApi('/api/v2/conversations/videos/{conversationId}/recordingstate','PUT',{'conversationId':conversationId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var DataExtensionsApi=/*#__PURE__*/function(){/**
|
|
7223
7232
|
* DataExtensions service.
|
|
7224
7233
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
7225
|
-
* @version
|
|
7234
|
+
* @version 237.0.0
|
|
7226
7235
|
*//**
|
|
7227
7236
|
* Constructs a new DataExtensionsApi.
|
|
7228
7237
|
* @alias module:purecloud-platform-client-v2/api/DataExtensionsApi
|
|
@@ -7243,7 +7252,7 @@ if(coretypeName===undefined||coretypeName===null||coretypeName===''){throw'Missi
|
|
|
7243
7252
|
*/},{key:"getDataextensionsLimits",value:function getDataextensionsLimits(){return this.apiClient.callApi('/api/v2/dataextensions/limits','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var DataPrivacyApi=/*#__PURE__*/function(){/**
|
|
7244
7253
|
* DataPrivacy service.
|
|
7245
7254
|
* @module purecloud-platform-client-v2/api/DataPrivacyApi
|
|
7246
|
-
* @version
|
|
7255
|
+
* @version 237.0.0
|
|
7247
7256
|
*//**
|
|
7248
7257
|
* Constructs a new DataPrivacyApi.
|
|
7249
7258
|
* @alias module:purecloud-platform-client-v2/api/DataPrivacyApi
|
|
@@ -7283,7 +7292,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
7283
7292
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postDataprivacyMaskingrulesValidate';}return this.apiClient.callApi('/api/v2/dataprivacy/maskingrules/validate','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var DownloadsApi=/*#__PURE__*/function(){/**
|
|
7284
7293
|
* Downloads service.
|
|
7285
7294
|
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
7286
|
-
* @version
|
|
7295
|
+
* @version 237.0.0
|
|
7287
7296
|
*//**
|
|
7288
7297
|
* Constructs a new DownloadsApi.
|
|
7289
7298
|
* @alias module:purecloud-platform-client-v2/api/DownloadsApi
|
|
@@ -7302,7 +7311,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
7302
7311
|
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']);}}]);}();var EmailsApi=/*#__PURE__*/function(){/**
|
|
7303
7312
|
* Emails service.
|
|
7304
7313
|
* @module purecloud-platform-client-v2/api/EmailsApi
|
|
7305
|
-
* @version
|
|
7314
|
+
* @version 237.0.0
|
|
7306
7315
|
*//**
|
|
7307
7316
|
* Constructs a new EmailsApi.
|
|
7308
7317
|
* @alias module:purecloud-platform-client-v2/api/EmailsApi
|
|
@@ -7331,7 +7340,7 @@ if(downloadId===undefined||downloadId===null||downloadId===''){throw'Missing the
|
|
|
7331
7340
|
*/},{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']);}}]);}();var EmployeeEngagementApi=/*#__PURE__*/function(){/**
|
|
7332
7341
|
* EmployeeEngagement service.
|
|
7333
7342
|
* @module purecloud-platform-client-v2/api/EmployeeEngagementApi
|
|
7334
|
-
* @version
|
|
7343
|
+
* @version 237.0.0
|
|
7335
7344
|
*//**
|
|
7336
7345
|
* Constructs a new EmployeeEngagementApi.
|
|
7337
7346
|
* @alias module:purecloud-platform-client-v2/api/EmployeeEngagementApi
|
|
@@ -7369,7 +7378,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
7369
7378
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postEmployeeengagementRecognitions';}return this.apiClient.callApi('/api/v2/employeeengagement/recognitions','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var EventsApi=/*#__PURE__*/function(){/**
|
|
7370
7379
|
* Events service.
|
|
7371
7380
|
* @module purecloud-platform-client-v2/api/EventsApi
|
|
7372
|
-
* @version
|
|
7381
|
+
* @version 237.0.0
|
|
7373
7382
|
*//**
|
|
7374
7383
|
* Constructs a new EventsApi.
|
|
7375
7384
|
* @alias module:purecloud-platform-client-v2/api/EventsApi
|
|
@@ -7394,7 +7403,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
7394
7403
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postEventsUsersRoutingstatus';}return this.apiClient.callApi('/api/v2/events/users/routingstatus','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var ExternalContactsApi=/*#__PURE__*/function(){/**
|
|
7395
7404
|
* ExternalContacts service.
|
|
7396
7405
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
7397
|
-
* @version
|
|
7406
|
+
* @version 237.0.0
|
|
7398
7407
|
*//**
|
|
7399
7408
|
* Constructs a new ExternalContactsApi.
|
|
7400
7409
|
* @alias module:purecloud-platform-client-v2/api/ExternalContactsApi
|
|
@@ -8144,7 +8153,7 @@ if(relationshipId===undefined||relationshipId===null||relationshipId===''){throw
|
|
|
8144
8153
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putExternalcontactsRelationship';}return this.apiClient.callApi('/api/v2/externalcontacts/relationships/{relationshipId}','PUT',{'relationshipId':relationshipId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var FaxApi=/*#__PURE__*/function(){/**
|
|
8145
8154
|
* Fax service.
|
|
8146
8155
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
8147
|
-
* @version
|
|
8156
|
+
* @version 237.0.0
|
|
8148
8157
|
*//**
|
|
8149
8158
|
* Constructs a new FaxApi.
|
|
8150
8159
|
* @alias module:purecloud-platform-client-v2/api/FaxApi
|
|
@@ -8193,7 +8202,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
8193
8202
|
*/},{key:"putFaxSettings",value:function putFaxSettings(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/fax/settings','PUT',{},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var FlowsApi=/*#__PURE__*/function(){/**
|
|
8194
8203
|
* Flows service.
|
|
8195
8204
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
8196
|
-
* @version
|
|
8205
|
+
* @version 237.0.0
|
|
8197
8206
|
*//**
|
|
8198
8207
|
* Constructs a new FlowsApi.
|
|
8199
8208
|
* @alias module:purecloud-platform-client-v2/api/FlowsApi
|
|
@@ -8247,7 +8256,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
8247
8256
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postAnalyticsFlowsObservationsQuery';}return this.apiClient.callApi('/api/v2/analytics/flows/observations/query','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var GamificationApi=/*#__PURE__*/function(){/**
|
|
8248
8257
|
* Gamification service.
|
|
8249
8258
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
8250
|
-
* @version
|
|
8259
|
+
* @version 237.0.0
|
|
8251
8260
|
*//**
|
|
8252
8261
|
* Constructs a new GamificationApi.
|
|
8253
8262
|
* @alias module:purecloud-platform-client-v2/api/GamificationApi
|
|
@@ -8918,7 +8927,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
8918
8927
|
if(status===undefined||status===null){throw'Missing the required parameter "status" when calling putGamificationStatus';}return this.apiClient.callApi('/api/v2/gamification/status','PUT',{},{},{},{},status,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var GeneralDataProtectionRegulationApi=/*#__PURE__*/function(){/**
|
|
8919
8928
|
* GeneralDataProtectionRegulation service.
|
|
8920
8929
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
8921
|
-
* @version
|
|
8930
|
+
* @version 237.0.0
|
|
8922
8931
|
*//**
|
|
8923
8932
|
* Constructs a new GeneralDataProtectionRegulationApi.
|
|
8924
8933
|
* @alias module:purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
@@ -8953,7 +8962,7 @@ if(searchValue===undefined||searchValue===null){throw'Missing the required param
|
|
|
8953
8962
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postGdprRequests';}return this.apiClient.callApi('/api/v2/gdpr/requests','POST',{},{'deleteConfirmed':opts['deleteConfirmed']},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var GeolocationApi=/*#__PURE__*/function(){/**
|
|
8954
8963
|
* Geolocation service.
|
|
8955
8964
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
8956
|
-
* @version
|
|
8965
|
+
* @version 237.0.0
|
|
8957
8966
|
*//**
|
|
8958
8967
|
* Constructs a new GeolocationApi.
|
|
8959
8968
|
* @alias module:purecloud-platform-client-v2/api/GeolocationApi
|
|
@@ -8987,7 +8996,7 @@ if(clientId===undefined||clientId===null||clientId===''){throw'Missing the requi
|
|
|
8987
8996
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling patchUserGeolocation';}return this.apiClient.callApi('/api/v2/users/{userId}/geolocations/{clientId}','PATCH',{'userId':userId,'clientId':clientId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var GreetingsApi=/*#__PURE__*/function(){/**
|
|
8988
8997
|
* Greetings service.
|
|
8989
8998
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
8990
|
-
* @version
|
|
8999
|
+
* @version 237.0.0
|
|
8991
9000
|
*//**
|
|
8992
9001
|
* Constructs a new GreetingsApi.
|
|
8993
9002
|
* @alias module:purecloud-platform-client-v2/api/GreetingsApi
|
|
@@ -9115,7 +9124,7 @@ if(userId===undefined||userId===null||userId===''){throw'Missing the required pa
|
|
|
9115
9124
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putUserGreetingsDefaults';}return this.apiClient.callApi('/api/v2/users/{userId}/greetings/defaults','PUT',{'userId':userId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var GroupsApi=/*#__PURE__*/function(){/**
|
|
9116
9125
|
* Groups service.
|
|
9117
9126
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
9118
|
-
* @version
|
|
9127
|
+
* @version 237.0.0
|
|
9119
9128
|
*//**
|
|
9120
9129
|
* Constructs a new GroupsApi.
|
|
9121
9130
|
* @alias module:purecloud-platform-client-v2/api/GroupsApi
|
|
@@ -9248,7 +9257,7 @@ if(groupId===undefined||groupId===null||groupId===''){throw'Missing the required
|
|
|
9248
9257
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putGroupDynamicsettings';}return this.apiClient.callApi('/api/v2/groups/{groupId}/dynamicsettings','PUT',{'groupId':groupId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var IdentityProviderApi=/*#__PURE__*/function(){/**
|
|
9249
9258
|
* IdentityProvider service.
|
|
9250
9259
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
9251
|
-
* @version
|
|
9260
|
+
* @version 237.0.0
|
|
9252
9261
|
*//**
|
|
9253
9262
|
* Constructs a new IdentityProviderApi.
|
|
9254
9263
|
* @alias module:purecloud-platform-client-v2/api/IdentityProviderApi
|
|
@@ -9404,7 +9413,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
9404
9413
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putIdentityprovidersSalesforce';}return this.apiClient.callApi('/api/v2/identityproviders/salesforce','PUT',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var InfrastructureAsCodeApi=/*#__PURE__*/function(){/**
|
|
9405
9414
|
* InfrastructureAsCode service.
|
|
9406
9415
|
* @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
9407
|
-
* @version
|
|
9416
|
+
* @version 237.0.0
|
|
9408
9417
|
*//**
|
|
9409
9418
|
* Constructs a new InfrastructureAsCodeApi.
|
|
9410
9419
|
* @alias module:purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
@@ -9458,7 +9467,7 @@ if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required param
|
|
|
9458
9467
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postInfrastructureascodeJobs';}return this.apiClient.callApi('/api/v2/infrastructureascode/jobs','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var IntegrationsApi=/*#__PURE__*/function(){/**
|
|
9459
9468
|
* Integrations service.
|
|
9460
9469
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
9461
|
-
* @version
|
|
9470
|
+
* @version 237.0.0
|
|
9462
9471
|
*//**
|
|
9463
9472
|
* Constructs a new IntegrationsApi.
|
|
9464
9473
|
* @alias module:purecloud-platform-client-v2/api/IntegrationsApi
|
|
@@ -10148,7 +10157,7 @@ if(ucIntegrationId===undefined||ucIntegrationId===null||ucIntegrationId===''){th
|
|
|
10148
10157
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putIntegrationsUnifiedcommunicationThirdpartypresences';}return this.apiClient.callApi('/api/v2/integrations/unifiedcommunications/{ucIntegrationId}/thirdpartypresences','PUT',{'ucIntegrationId':ucIntegrationId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var JourneyApi=/*#__PURE__*/function(){/**
|
|
10149
10158
|
* Journey service.
|
|
10150
10159
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
10151
|
-
* @version
|
|
10160
|
+
* @version 237.0.0
|
|
10152
10161
|
*//**
|
|
10153
10162
|
* Constructs a new JourneyApi.
|
|
10154
10163
|
* @alias module:purecloud-platform-client-v2/api/JourneyApi
|
|
@@ -10657,7 +10666,7 @@ if(versionId===undefined||versionId===null||versionId===''){throw'Missing the re
|
|
|
10657
10666
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putJourneyViewVersion';}return this.apiClient.callApi('/api/v2/journey/views/{viewId}/versions/{versionId}','PUT',{'viewId':viewId,'versionId':versionId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var KnowledgeApi=/*#__PURE__*/function(){/**
|
|
10658
10667
|
* Knowledge service.
|
|
10659
10668
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
10660
|
-
* @version
|
|
10669
|
+
* @version 237.0.0
|
|
10661
10670
|
*//**
|
|
10662
10671
|
* Constructs a new KnowledgeApi.
|
|
10663
10672
|
* @alias module:purecloud-platform-client-v2/api/KnowledgeApi
|
|
@@ -11485,7 +11494,7 @@ if(sourceId===undefined||sourceId===null||sourceId===''){throw'Missing the requi
|
|
|
11485
11494
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putKnowledgeKnowledgebaseSourcesServicenowSourceId';}return this.apiClient.callApi('/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/sources/servicenow/{sourceId}','PUT',{'knowledgeBaseId':knowledgeBaseId,'sourceId':sourceId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var LanguageUnderstandingApi=/*#__PURE__*/function(){/**
|
|
11486
11495
|
* LanguageUnderstanding service.
|
|
11487
11496
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
11488
|
-
* @version
|
|
11497
|
+
* @version 237.0.0
|
|
11489
11498
|
*//**
|
|
11490
11499
|
* Constructs a new LanguageUnderstandingApi.
|
|
11491
11500
|
* @alias module:purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
@@ -11794,7 +11803,7 @@ if(domainVersionId===undefined||domainVersionId===null||domainVersionId===''){th
|
|
|
11794
11803
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putLanguageunderstandingDomainVersion';}return this.apiClient.callApi('/api/v2/languageunderstanding/domains/{domainId}/versions/{domainVersionId}','PUT',{'domainId':domainId,'domainVersionId':domainVersionId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var LanguagesApi=/*#__PURE__*/function(){/**
|
|
11795
11804
|
* Languages service.
|
|
11796
11805
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
11797
|
-
* @version
|
|
11806
|
+
* @version 237.0.0
|
|
11798
11807
|
*//**
|
|
11799
11808
|
* Constructs a new LanguagesApi.
|
|
11800
11809
|
* @alias module:purecloud-platform-client-v2/api/LanguagesApi
|
|
@@ -11849,7 +11858,7 @@ if(userId===undefined||userId===null||userId===''){throw'Missing the required pa
|
|
|
11849
11858
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postLanguages';}return this.apiClient.callApi('/api/v2/languages','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var LearningApi=/*#__PURE__*/function(){/**
|
|
11850
11859
|
* Learning service.
|
|
11851
11860
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
11852
|
-
* @version
|
|
11861
|
+
* @version 237.0.0
|
|
11853
11862
|
*//**
|
|
11854
11863
|
* Constructs a new LearningApi.
|
|
11855
11864
|
* @alias module:purecloud-platform-client-v2/api/LearningApi
|
|
@@ -12078,6 +12087,12 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
12078
12087
|
* @param {Object} opts.body The request body
|
|
12079
12088
|
*/},{key:"postLearningModulePublish",value:function postLearningModulePublish(moduleId,opts){opts=opts||{};// verify the required parameter 'moduleId' is set
|
|
12080
12089
|
if(moduleId===undefined||moduleId===null||moduleId===''){throw'Missing the required parameter "moduleId" when calling postLearningModulePublish';}return this.apiClient.callApi('/api/v2/learning/modules/{moduleId}/publish','POST',{'moduleId':moduleId},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
12090
|
+
* Migrate a legacy learning module rule to a users rule.
|
|
12091
|
+
*
|
|
12092
|
+
* @param {String} moduleId The ID of the learning module
|
|
12093
|
+
* postLearningModuleRuleMigrate is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
12094
|
+
*/},{key:"postLearningModuleRuleMigrate",value:function postLearningModuleRuleMigrate(moduleId){// verify the required parameter 'moduleId' is set
|
|
12095
|
+
if(moduleId===undefined||moduleId===null||moduleId===''){throw'Missing the required parameter "moduleId" when calling postLearningModuleRuleMigrate';}return this.apiClient.callApi('/api/v2/learning/modules/{moduleId}/rule/migrate','POST',{'moduleId':moduleId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
12081
12096
|
* Create a new learning module
|
|
12082
12097
|
* This will create a new unpublished learning module with the specified fields.
|
|
12083
12098
|
* @param {Object} body The learning module to be created
|
|
@@ -12132,7 +12147,7 @@ if(moduleId===undefined||moduleId===null||moduleId===''){throw'Missing the requi
|
|
|
12132
12147
|
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']);}}]);}();var LicenseApi=/*#__PURE__*/function(){/**
|
|
12133
12148
|
* License service.
|
|
12134
12149
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
12135
|
-
* @version
|
|
12150
|
+
* @version 237.0.0
|
|
12136
12151
|
*//**
|
|
12137
12152
|
* Constructs a new LicenseApi.
|
|
12138
12153
|
* @alias module:purecloud-platform-client-v2/api/LicenseApi
|
|
@@ -12186,7 +12201,7 @@ if(featureName===undefined||featureName===null||featureName===''){throw'Missing
|
|
|
12186
12201
|
*/},{key:"postLicenseUsers",value:function postLicenseUsers(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/license/users','POST',{},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var LocationsApi=/*#__PURE__*/function(){/**
|
|
12187
12202
|
* Locations service.
|
|
12188
12203
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
12189
|
-
* @version
|
|
12204
|
+
* @version 237.0.0
|
|
12190
12205
|
*//**
|
|
12191
12206
|
* Constructs a new LocationsApi.
|
|
12192
12207
|
* @alias module:purecloud-platform-client-v2/api/LocationsApi
|
|
@@ -12245,7 +12260,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
12245
12260
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postLocationsSearch';}return this.apiClient.callApi('/api/v2/locations/search','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var LogCaptureApi=/*#__PURE__*/function(){/**
|
|
12246
12261
|
* LogCapture service.
|
|
12247
12262
|
* @module purecloud-platform-client-v2/api/LogCaptureApi
|
|
12248
|
-
* @version
|
|
12263
|
+
* @version 237.0.0
|
|
12249
12264
|
*//**
|
|
12250
12265
|
* Constructs a new LogCaptureApi.
|
|
12251
12266
|
* @alias module:purecloud-platform-client-v2/api/LogCaptureApi
|
|
@@ -12294,7 +12309,7 @@ if(userId===undefined||userId===null||userId===''){throw'Missing the required pa
|
|
|
12294
12309
|
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']);}}]);}();var MessagingApi=/*#__PURE__*/function(){/**
|
|
12295
12310
|
* Messaging service.
|
|
12296
12311
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
12297
|
-
* @version
|
|
12312
|
+
* @version 237.0.0
|
|
12298
12313
|
*//**
|
|
12299
12314
|
* Constructs a new MessagingApi.
|
|
12300
12315
|
* @alias module:purecloud-platform-client-v2/api/MessagingApi
|
|
@@ -12384,7 +12399,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
12384
12399
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putMessagingSettingsDefault';}return this.apiClient.callApi('/api/v2/messaging/settings/default','PUT',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var MobileDevicesApi=/*#__PURE__*/function(){/**
|
|
12385
12400
|
* MobileDevices service.
|
|
12386
12401
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
12387
|
-
* @version
|
|
12402
|
+
* @version 237.0.0
|
|
12388
12403
|
*//**
|
|
12389
12404
|
* Constructs a new MobileDevicesApi.
|
|
12390
12405
|
* @alias module:purecloud-platform-client-v2/api/MobileDevicesApi
|
|
@@ -12423,7 +12438,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
12423
12438
|
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']);}}]);}();var NotificationsApi=/*#__PURE__*/function(){/**
|
|
12424
12439
|
* Notifications service.
|
|
12425
12440
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
12426
|
-
* @version
|
|
12441
|
+
* @version 237.0.0
|
|
12427
12442
|
*//**
|
|
12428
12443
|
* Constructs a new NotificationsApi.
|
|
12429
12444
|
* @alias module:purecloud-platform-client-v2/api/NotificationsApi
|
|
@@ -12480,7 +12495,7 @@ if(channelId===undefined||channelId===null||channelId===''){throw'Missing the re
|
|
|
12480
12495
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putNotificationsChannelSubscriptions';}return this.apiClient.callApi('/api/v2/notifications/channels/{channelId}/subscriptions','PUT',{'channelId':channelId},{'ignoreErrors':opts['ignoreErrors']},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var OAuthApi=/*#__PURE__*/function(){/**
|
|
12481
12496
|
* OAuth service.
|
|
12482
12497
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
12483
|
-
* @version
|
|
12498
|
+
* @version 237.0.0
|
|
12484
12499
|
*//**
|
|
12485
12500
|
* Constructs a new OAuthApi.
|
|
12486
12501
|
* @alias module:purecloud-platform-client-v2/api/OAuthApi
|
|
@@ -12565,7 +12580,7 @@ if(clientId===undefined||clientId===null||clientId===''){throw'Missing the requi
|
|
|
12565
12580
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putOauthClient';}return this.apiClient.callApi('/api/v2/oauth/clients/{clientId}','PUT',{'clientId':clientId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var ObjectsApi=/*#__PURE__*/function(){/**
|
|
12566
12581
|
* Objects service.
|
|
12567
12582
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
12568
|
-
* @version
|
|
12583
|
+
* @version 237.0.0
|
|
12569
12584
|
*//**
|
|
12570
12585
|
* Constructs a new ObjectsApi.
|
|
12571
12586
|
* @alias module:purecloud-platform-client-v2/api/ObjectsApi
|
|
@@ -12617,7 +12632,7 @@ if(divisionId===undefined||divisionId===null||divisionId===''){throw'Missing the
|
|
|
12617
12632
|
* @param {Object} opts Optional parameters
|
|
12618
12633
|
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
12619
12634
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
12620
|
-
* @param {String} opts.pageSize
|
|
12635
|
+
* @param {String} opts.pageSize Page size (max 200, default 25) (default to 25)
|
|
12621
12636
|
* @param {Array.<String>} opts.id Optionally request specific divisions by their IDs
|
|
12622
12637
|
* @param {String} opts.name Optionally request specific divisions by division name
|
|
12623
12638
|
*/},{key:"getAuthorizationDivisionsQuery",value:function getAuthorizationDivisionsQuery(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/authorization/divisions/query','GET',{},{'before':opts['before'],'after':opts['after'],'pageSize':opts['pageSize'],'id':this.apiClient.buildCollectionParam(opts['id'],'multi'),'name':opts['name']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
@@ -12651,7 +12666,7 @@ if(divisionId===undefined||divisionId===null||divisionId===''){throw'Missing the
|
|
|
12651
12666
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putAuthorizationDivision';}return this.apiClient.callApi('/api/v2/authorization/divisions/{divisionId}','PUT',{'divisionId':divisionId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var OperationalEventsApi=/*#__PURE__*/function(){/**
|
|
12652
12667
|
* OperationalEvents service.
|
|
12653
12668
|
* @module purecloud-platform-client-v2/api/OperationalEventsApi
|
|
12654
|
-
* @version
|
|
12669
|
+
* @version 237.0.0
|
|
12655
12670
|
*//**
|
|
12656
12671
|
* Constructs a new OperationalEventsApi.
|
|
12657
12672
|
* @alias module:purecloud-platform-client-v2/api/OperationalEventsApi
|
|
@@ -12682,7 +12697,7 @@ if(eventDefinitionId===undefined||eventDefinitionId===null||eventDefinitionId===
|
|
|
12682
12697
|
*/},{key:"postUsageEventsQuery",value:function postUsageEventsQuery(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/usage/events/query','POST',{},{'before':opts['before'],'after':opts['after'],'pageSize':opts['pageSize']},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var OrganizationApi=/*#__PURE__*/function(){/**
|
|
12683
12698
|
* Organization service.
|
|
12684
12699
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
12685
|
-
* @version
|
|
12700
|
+
* @version 237.0.0
|
|
12686
12701
|
*//**
|
|
12687
12702
|
* Constructs a new OrganizationApi.
|
|
12688
12703
|
* @alias module:purecloud-platform-client-v2/api/OrganizationApi
|
|
@@ -12787,7 +12802,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
12787
12802
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putOrganizationsWhitelist';}return this.apiClient.callApi('/api/v2/organizations/whitelist','PUT',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var OrganizationAuthorizationApi=/*#__PURE__*/function(){/**
|
|
12788
12803
|
* OrganizationAuthorization service.
|
|
12789
12804
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
12790
|
-
* @version
|
|
12805
|
+
* @version 237.0.0
|
|
12791
12806
|
*//**
|
|
12792
12807
|
* Constructs a new OrganizationAuthorizationApi.
|
|
12793
12808
|
* @alias module:purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
@@ -13121,7 +13136,7 @@ if(trustorOrgId===undefined||trustorOrgId===null||trustorOrgId===''){throw'Missi
|
|
|
13121
13136
|
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']);}}]);}();var OutboundApi=/*#__PURE__*/function(){/**
|
|
13122
13137
|
* Outbound service.
|
|
13123
13138
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
13124
|
-
* @version
|
|
13139
|
+
* @version 237.0.0
|
|
13125
13140
|
*//**
|
|
13126
13141
|
* Constructs a new OutboundApi.
|
|
13127
13142
|
* @alias module:purecloud-platform-client-v2/api/OutboundApi
|
|
@@ -14277,7 +14292,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
14277
14292
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putOutboundWrapupcodemappings';}return this.apiClient.callApi('/api/v2/outbound/wrapupcodemappings','PUT',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var PresenceApi=/*#__PURE__*/function(){/**
|
|
14278
14293
|
* Presence service.
|
|
14279
14294
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
14280
|
-
* @version
|
|
14295
|
+
* @version 237.0.0
|
|
14281
14296
|
*//**
|
|
14282
14297
|
* Constructs a new PresenceApi.
|
|
14283
14298
|
* @alias module:purecloud-platform-client-v2/api/PresenceApi
|
|
@@ -14450,7 +14465,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
14450
14465
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putUsersPresencesBulk';}return this.apiClient.callApi('/api/v2/users/presences/bulk','PUT',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var ProcessAutomationApi=/*#__PURE__*/function(){/**
|
|
14451
14466
|
* ProcessAutomation service.
|
|
14452
14467
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
14453
|
-
* @version
|
|
14468
|
+
* @version 237.0.0
|
|
14454
14469
|
*//**
|
|
14455
14470
|
* Constructs a new ProcessAutomationApi.
|
|
14456
14471
|
* @alias module:purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
@@ -14513,7 +14528,7 @@ if(triggerId===undefined||triggerId===null||triggerId===''){throw'Missing the re
|
|
|
14513
14528
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putProcessautomationTrigger';}return this.apiClient.callApi('/api/v2/processautomation/triggers/{triggerId}','PUT',{'triggerId':triggerId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var QualityApi=/*#__PURE__*/function(){/**
|
|
14514
14529
|
* Quality service.
|
|
14515
14530
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
14516
|
-
* @version
|
|
14531
|
+
* @version 237.0.0
|
|
14517
14532
|
*//**
|
|
14518
14533
|
* Constructs a new QualityApi.
|
|
14519
14534
|
* @alias module:purecloud-platform-client-v2/api/QualityApi
|
|
@@ -15003,7 +15018,7 @@ if(customerSurveyUrl===undefined||customerSurveyUrl===null){throw'Missing the re
|
|
|
15003
15018
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putQualitySurveysScorable';}return this.apiClient.callApi('/api/v2/quality/surveys/scorable','PUT',{},{'customerSurveyUrl':customerSurveyUrl},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var RecordingApi=/*#__PURE__*/function(){/**
|
|
15004
15019
|
* Recording service.
|
|
15005
15020
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
15006
|
-
* @version
|
|
15021
|
+
* @version 237.0.0
|
|
15007
15022
|
*//**
|
|
15008
15023
|
* Constructs a new RecordingApi.
|
|
15009
15024
|
* @alias module:purecloud-platform-client-v2/api/RecordingApi
|
|
@@ -15402,7 +15417,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
15402
15417
|
*/},{key:"putRecordingsDeletionprotection",value:function putRecordingsDeletionprotection(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/recordings/deletionprotection','PUT',{},{'protect':opts['protect']},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var ResponseManagementApi=/*#__PURE__*/function(){/**
|
|
15403
15418
|
* ResponseManagement service.
|
|
15404
15419
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
15405
|
-
* @version
|
|
15420
|
+
* @version 237.0.0
|
|
15406
15421
|
*//**
|
|
15407
15422
|
* Constructs a new ResponseManagementApi.
|
|
15408
15423
|
* @alias module:purecloud-platform-client-v2/api/ResponseManagementApi
|
|
@@ -15523,7 +15538,7 @@ if(responseAssetId===undefined||responseAssetId===null||responseAssetId===''){th
|
|
|
15523
15538
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putResponsemanagementResponseasset';}return this.apiClient.callApi('/api/v2/responsemanagement/responseassets/{responseAssetId}','PUT',{'responseAssetId':responseAssetId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var RoutingApi=/*#__PURE__*/function(){/**
|
|
15524
15539
|
* Routing service.
|
|
15525
15540
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
15526
|
-
* @version
|
|
15541
|
+
* @version 237.0.0
|
|
15527
15542
|
*//**
|
|
15528
15543
|
* Constructs a new RoutingApi.
|
|
15529
15544
|
* @alias module:purecloud-platform-client-v2/api/RoutingApi
|
|
@@ -16614,7 +16629,7 @@ if(userId===undefined||userId===null||userId===''){throw'Missing the required pa
|
|
|
16614
16629
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putUserRoutingskillsBulk';}return this.apiClient.callApi('/api/v2/users/{userId}/routingskills/bulk','PUT',{'userId':userId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var SCIMApi=/*#__PURE__*/function(){/**
|
|
16615
16630
|
* SCIM service.
|
|
16616
16631
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
16617
|
-
* @version
|
|
16632
|
+
* @version 237.0.0
|
|
16618
16633
|
*//**
|
|
16619
16634
|
* Constructs a new SCIMApi.
|
|
16620
16635
|
* @alias module:purecloud-platform-client-v2/api/SCIMApi
|
|
@@ -16839,7 +16854,7 @@ if(userId===undefined||userId===null||userId===''){throw'Missing the required pa
|
|
|
16839
16854
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putScimV2User';}return this.apiClient.callApi('/api/v2/scim/v2/users/{userId}','PUT',{'userId':userId},{},{'If-Match':opts['ifMatch']},{},body,['PureCloud OAuth'],['application/scim+json','application/json'],['application/scim+json','application/json']);}}]);}();var ScreenRecordingApi=/*#__PURE__*/function(){/**
|
|
16840
16855
|
* ScreenRecording service.
|
|
16841
16856
|
* @module purecloud-platform-client-v2/api/ScreenRecordingApi
|
|
16842
|
-
* @version
|
|
16857
|
+
* @version 237.0.0
|
|
16843
16858
|
*//**
|
|
16844
16859
|
* Constructs a new ScreenRecordingApi.
|
|
16845
16860
|
* @alias module:purecloud-platform-client-v2/api/ScreenRecordingApi
|
|
@@ -16854,7 +16869,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
16854
16869
|
*/return _createClass(ScreenRecordingApi,[{key:"postScreenrecordingToken",value:function postScreenrecordingToken(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/screenrecording/token','POST',{},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var ScriptsApi=/*#__PURE__*/function(){/**
|
|
16855
16870
|
* Scripts service.
|
|
16856
16871
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
16857
|
-
* @version
|
|
16872
|
+
* @version 237.0.0
|
|
16858
16873
|
*//**
|
|
16859
16874
|
* Constructs a new ScriptsApi.
|
|
16860
16875
|
* @alias module:purecloud-platform-client-v2/api/ScriptsApi
|
|
@@ -17000,7 +17015,7 @@ if(scriptId===undefined||scriptId===null||scriptId===''){throw'Missing the requi
|
|
|
17000
17015
|
*/},{key:"postScriptsPublished",value:function postScriptsPublished(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/scripts/published','POST',{},{'scriptDataVersion':opts['scriptDataVersion']},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var SearchApi=/*#__PURE__*/function(){/**
|
|
17001
17016
|
* Search service.
|
|
17002
17017
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
17003
|
-
* @version
|
|
17018
|
+
* @version 237.0.0
|
|
17004
17019
|
*//**
|
|
17005
17020
|
* Constructs a new SearchApi.
|
|
17006
17021
|
* @alias module:purecloud-platform-client-v2/api/SearchApi
|
|
@@ -17159,7 +17174,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
17159
17174
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postVoicemailSearch';}return this.apiClient.callApi('/api/v2/voicemail/search','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var SettingsApi=/*#__PURE__*/function(){/**
|
|
17160
17175
|
* Settings service.
|
|
17161
17176
|
* @module purecloud-platform-client-v2/api/SettingsApi
|
|
17162
|
-
* @version
|
|
17177
|
+
* @version 237.0.0
|
|
17163
17178
|
*//**
|
|
17164
17179
|
* Constructs a new SettingsApi.
|
|
17165
17180
|
* @alias module:purecloud-platform-client-v2/api/SettingsApi
|
|
@@ -17231,7 +17246,7 @@ if(agentId===undefined||agentId===null||agentId===''){throw'Missing the required
|
|
|
17231
17246
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putUsersAgentuiAgentsAutoanswerAgentIdSettings';}return this.apiClient.callApi('/api/v2/users/agentui/agents/autoanswer/{agentId}/settings','PUT',{'agentId':agentId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var SocialMediaApi=/*#__PURE__*/function(){/**
|
|
17232
17247
|
* SocialMedia service.
|
|
17233
17248
|
* @module purecloud-platform-client-v2/api/SocialMediaApi
|
|
17234
|
-
* @version
|
|
17249
|
+
* @version 237.0.0
|
|
17235
17250
|
*//**
|
|
17236
17251
|
* Constructs a new SocialMediaApi.
|
|
17237
17252
|
* @alias module:purecloud-platform-client-v2/api/SocialMediaApi
|
|
@@ -17646,7 +17661,7 @@ if(topicId===undefined||topicId===null||topicId===''){throw'Missing the required
|
|
|
17646
17661
|
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']);}}]);}();var SpeechTextAnalyticsApi=/*#__PURE__*/function(){/**
|
|
17647
17662
|
* SpeechTextAnalytics service.
|
|
17648
17663
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
17649
|
-
* @version
|
|
17664
|
+
* @version 237.0.0
|
|
17650
17665
|
*//**
|
|
17651
17666
|
* Constructs a new SpeechTextAnalyticsApi.
|
|
17652
17667
|
* @alias module:purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
@@ -18016,7 +18031,7 @@ if(topicId===undefined||topicId===null||topicId===''){throw'Missing the required
|
|
|
18016
18031
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putSpeechandtextanalyticsTopic';}return this.apiClient.callApi('/api/v2/speechandtextanalytics/topics/{topicId}','PUT',{'topicId':topicId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var StationsApi=/*#__PURE__*/function(){/**
|
|
18017
18032
|
* Stations service.
|
|
18018
18033
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
18019
|
-
* @version
|
|
18034
|
+
* @version 237.0.0
|
|
18020
18035
|
*//**
|
|
18021
18036
|
* Constructs a new StationsApi.
|
|
18022
18037
|
* @alias module:purecloud-platform-client-v2/api/StationsApi
|
|
@@ -18048,7 +18063,7 @@ if(stationId===undefined||stationId===null||stationId===''){throw'Missing the re
|
|
|
18048
18063
|
*/},{key:"getStations",value:function getStations(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/stations','GET',{},{'pageSize':opts['pageSize'],'pageNumber':opts['pageNumber'],'sortBy':opts['sortBy'],'name':opts['name'],'userSelectable':opts['userSelectable'],'webRtcUserId':opts['webRtcUserId'],'id':opts['id'],'lineAppearanceId':opts['lineAppearanceId']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var SuggestApi=/*#__PURE__*/function(){/**
|
|
18049
18064
|
* Suggest service.
|
|
18050
18065
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
18051
|
-
* @version
|
|
18066
|
+
* @version 237.0.0
|
|
18052
18067
|
*//**
|
|
18053
18068
|
* Constructs a new SuggestApi.
|
|
18054
18069
|
* @alias module:purecloud-platform-client-v2/api/SuggestApi
|
|
@@ -18088,7 +18103,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
18088
18103
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postSearchSuggest';}return this.apiClient.callApi('/api/v2/search/suggest','POST',{},{'profile':opts['profile']},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var TaskManagementApi=/*#__PURE__*/function(){/**
|
|
18089
18104
|
* TaskManagement service.
|
|
18090
18105
|
* @module purecloud-platform-client-v2/api/TaskManagementApi
|
|
18091
|
-
* @version
|
|
18106
|
+
* @version 237.0.0
|
|
18092
18107
|
*//**
|
|
18093
18108
|
* Constructs a new TaskManagementApi.
|
|
18094
18109
|
* @alias module:purecloud-platform-client-v2/api/TaskManagementApi
|
|
@@ -18596,7 +18611,7 @@ if(schemaId===undefined||schemaId===null||schemaId===''){throw'Missing the requi
|
|
|
18596
18611
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putTaskmanagementWorkitemsSchema';}return this.apiClient.callApi('/api/v2/taskmanagement/workitems/schemas/{schemaId}','PUT',{'schemaId':schemaId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var TeamsApi=/*#__PURE__*/function(){/**
|
|
18597
18612
|
* Teams service.
|
|
18598
18613
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
18599
|
-
* @version
|
|
18614
|
+
* @version 237.0.0
|
|
18600
18615
|
*//**
|
|
18601
18616
|
* Constructs a new TeamsApi.
|
|
18602
18617
|
* @alias module:purecloud-platform-client-v2/api/TeamsApi
|
|
@@ -18676,7 +18691,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
18676
18691
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postTeamsSearch';}return this.apiClient.callApi('/api/v2/teams/search','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var TelephonyApi=/*#__PURE__*/function(){/**
|
|
18677
18692
|
* Telephony service.
|
|
18678
18693
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
18679
|
-
* @version
|
|
18694
|
+
* @version 237.0.0
|
|
18680
18695
|
*//**
|
|
18681
18696
|
* Constructs a new TelephonyApi.
|
|
18682
18697
|
* @alias module:purecloud-platform-client-v2/api/TelephonyApi
|
|
@@ -18747,7 +18762,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
18747
18762
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putTelephonyAgentsGreetingsMe';}return this.apiClient.callApi('/api/v2/telephony/agents/greetings/me','PUT',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var TelephonyProvidersEdgeApi=/*#__PURE__*/function(){/**
|
|
18748
18763
|
* TelephonyProvidersEdge service.
|
|
18749
18764
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
18750
|
-
* @version
|
|
18765
|
+
* @version 237.0.0
|
|
18751
18766
|
*//**
|
|
18752
18767
|
* Constructs a new TelephonyProvidersEdgeApi.
|
|
18753
18768
|
* @alias module:purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
@@ -19595,7 +19610,7 @@ if(trunkBaseSettingsId===undefined||trunkBaseSettingsId===null||trunkBaseSetting
|
|
|
19595
19610
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putTelephonyProvidersEdgesTrunkbasesetting';}return this.apiClient.callApi('/api/v2/telephony/providers/edges/trunkbasesettings/{trunkBaseSettingsId}','PUT',{'trunkBaseSettingsId':trunkBaseSettingsId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var TextbotsApi=/*#__PURE__*/function(){/**
|
|
19596
19611
|
* Textbots service.
|
|
19597
19612
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
19598
|
-
* @version
|
|
19613
|
+
* @version 237.0.0
|
|
19599
19614
|
*//**
|
|
19600
19615
|
* Constructs a new TextbotsApi.
|
|
19601
19616
|
* @alias module:purecloud-platform-client-v2/api/TextbotsApi
|
|
@@ -19631,7 +19646,7 @@ if(launchRequest===undefined||launchRequest===null){throw'Missing the required p
|
|
|
19631
19646
|
if(postTextRequest===undefined||postTextRequest===null){throw'Missing the required parameter "postTextRequest" when calling postTextbotsBotsExecute';}return this.apiClient.callApi('/api/v2/textbots/bots/execute','POST',{},{},{},{},postTextRequest,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var TokensApi=/*#__PURE__*/function(){/**
|
|
19632
19647
|
* Tokens service.
|
|
19633
19648
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
19634
|
-
* @version
|
|
19649
|
+
* @version 237.0.0
|
|
19635
19650
|
*//**
|
|
19636
19651
|
* Constructs a new TokensApi.
|
|
19637
19652
|
* @alias module:purecloud-platform-client-v2/api/TokensApi
|
|
@@ -19665,7 +19680,7 @@ if(userId===undefined||userId===null||userId===''){throw'Missing the required pa
|
|
|
19665
19680
|
*/},{key:"putTokensTimeout",value:function putTokensTimeout(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/tokens/timeout','PUT',{},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var UploadsApi=/*#__PURE__*/function(){/**
|
|
19666
19681
|
* Uploads service.
|
|
19667
19682
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
19668
|
-
* @version
|
|
19683
|
+
* @version 237.0.0
|
|
19669
19684
|
*//**
|
|
19670
19685
|
* Constructs a new UploadsApi.
|
|
19671
19686
|
* @alias module:purecloud-platform-client-v2/api/UploadsApi
|
|
@@ -19733,7 +19748,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
19733
19748
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postUploadsWorkforcemanagementHistoricaldataCsv';}return this.apiClient.callApi('/api/v2/uploads/workforcemanagement/historicaldata/csv','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var UsageApi=/*#__PURE__*/function(){/**
|
|
19734
19749
|
* Usage service.
|
|
19735
19750
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
19736
|
-
* @version
|
|
19751
|
+
* @version 237.0.0
|
|
19737
19752
|
*//**
|
|
19738
19753
|
* Constructs a new UsageApi.
|
|
19739
19754
|
* @alias module:purecloud-platform-client-v2/api/UsageApi
|
|
@@ -19817,7 +19832,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
19817
19832
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postUsageSimplesearch';}return this.apiClient.callApi('/api/v2/usage/simplesearch','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var UserRecordingsApi=/*#__PURE__*/function(){/**
|
|
19818
19833
|
* UserRecordings service.
|
|
19819
19834
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
19820
|
-
* @version
|
|
19835
|
+
* @version 237.0.0
|
|
19821
19836
|
*//**
|
|
19822
19837
|
* Constructs a new UserRecordingsApi.
|
|
19823
19838
|
* @alias module:purecloud-platform-client-v2/api/UserRecordingsApi
|
|
@@ -19865,7 +19880,7 @@ if(recordingId===undefined||recordingId===null||recordingId===''){throw'Missing
|
|
|
19865
19880
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putUserrecording';}return this.apiClient.callApi('/api/v2/userrecordings/{recordingId}','PUT',{'recordingId':recordingId},{'expand':this.apiClient.buildCollectionParam(opts['expand'],'multi')},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var UsersApi=/*#__PURE__*/function(){/**
|
|
19866
19881
|
* Users service.
|
|
19867
19882
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
19868
|
-
* @version
|
|
19883
|
+
* @version 237.0.0
|
|
19869
19884
|
*//**
|
|
19870
19885
|
* Constructs a new UsersApi.
|
|
19871
19886
|
* @alias module:purecloud-platform-client-v2/api/UsersApi
|
|
@@ -20606,10 +20621,93 @@ if(stationId===undefined||stationId===null||stationId===''){throw'Missing the re
|
|
|
20606
20621
|
*/},{key:"putUserVerifier",value:function putUserVerifier(userId,verifierId,body){// verify the required parameter 'userId' is set
|
|
20607
20622
|
if(userId===undefined||userId===null||userId===''){throw'Missing the required parameter "userId" when calling putUserVerifier';}// verify the required parameter 'verifierId' is set
|
|
20608
20623
|
if(verifierId===undefined||verifierId===null||verifierId===''){throw'Missing the required parameter "verifierId" when calling putUserVerifier';}// verify the required parameter 'body' is set
|
|
20609
|
-
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putUserVerifier';}return this.apiClient.callApi('/api/v2/users/{userId}/verifiers/{verifierId}','PUT',{'userId':userId,'verifierId':verifierId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var
|
|
20624
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putUserVerifier';}return this.apiClient.callApi('/api/v2/users/{userId}/verifiers/{verifierId}','PUT',{'userId':userId,'verifierId':verifierId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var UsersRulesApi=/*#__PURE__*/function(){/**
|
|
20625
|
+
* UsersRules service.
|
|
20626
|
+
* @module purecloud-platform-client-v2/api/UsersRulesApi
|
|
20627
|
+
* @version 237.0.0
|
|
20628
|
+
*//**
|
|
20629
|
+
* Constructs a new UsersRulesApi.
|
|
20630
|
+
* @alias module:purecloud-platform-client-v2/api/UsersRulesApi
|
|
20631
|
+
* @class
|
|
20632
|
+
* @param {module:purecloud-platform-client-v2/ApiClient} apiClient Optional API client implementation to use,
|
|
20633
|
+
* default to {@link module:purecloud-platform-client-v2/ApiClient#instance} if unspecified.
|
|
20634
|
+
*/function UsersRulesApi(apiClient){_classCallCheck(this,UsersRulesApi);this.apiClient=apiClient||ApiClient.instance;}/**
|
|
20635
|
+
* Delete an existing users rule
|
|
20636
|
+
*
|
|
20637
|
+
* @param {String} ruleId The id of the rule
|
|
20638
|
+
* deleteUsersRule is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
20639
|
+
*/return _createClass(UsersRulesApi,[{key:"deleteUsersRule",value:function deleteUsersRule(ruleId){// verify the required parameter 'ruleId' is set
|
|
20640
|
+
if(ruleId===undefined||ruleId===null||ruleId===''){throw'Missing the required parameter "ruleId" when calling deleteUsersRule';}return this.apiClient.callApi('/api/v2/users/rules/{ruleId}','DELETE',{'ruleId':ruleId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
20641
|
+
* Get a users rule
|
|
20642
|
+
*
|
|
20643
|
+
* @param {String} ruleId The ID of the rule to retrieve
|
|
20644
|
+
* getUsersRule is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
20645
|
+
*/},{key:"getUsersRule",value:function getUsersRule(ruleId){// verify the required parameter 'ruleId' is set
|
|
20646
|
+
if(ruleId===undefined||ruleId===null||ruleId===''){throw'Missing the required parameter "ruleId" when calling getUsersRule';}return this.apiClient.callApi('/api/v2/users/rules/{ruleId}','GET',{'ruleId':ruleId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
20647
|
+
* Get dependent of a users rule
|
|
20648
|
+
*
|
|
20649
|
+
* @param {String} ruleId The ID of the rule for which to retrieve dependents
|
|
20650
|
+
* @param {Object} ruleType The type of the dependent
|
|
20651
|
+
* @param {String} typeId The type ID of the dependent
|
|
20652
|
+
* getUsersRuleDependentTypeId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
20653
|
+
*/},{key:"getUsersRuleDependentTypeId",value:function getUsersRuleDependentTypeId(ruleId,ruleType,typeId){// verify the required parameter 'ruleId' is set
|
|
20654
|
+
if(ruleId===undefined||ruleId===null||ruleId===''){throw'Missing the required parameter "ruleId" when calling getUsersRuleDependentTypeId';}// verify the required parameter 'ruleType' is set
|
|
20655
|
+
if(ruleType===undefined||ruleType===null||ruleType===''){throw'Missing the required parameter "ruleType" when calling getUsersRuleDependentTypeId';}// verify the required parameter 'typeId' is set
|
|
20656
|
+
if(typeId===undefined||typeId===null||typeId===''){throw'Missing the required parameter "typeId" when calling getUsersRuleDependentTypeId';}return this.apiClient.callApi('/api/v2/users/rules/{ruleId}/dependents/{ruleType}/{typeId}','GET',{'ruleId':ruleId,'ruleType':ruleType,'typeId':typeId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
20657
|
+
* Get dependents for a users rule
|
|
20658
|
+
*
|
|
20659
|
+
* @param {String} ruleId The ID of the rule for which to retrieve dependents
|
|
20660
|
+
* @param {Object} opts Optional parameters
|
|
20661
|
+
* @param {Number} opts.pageSize Number of results per page (default to 25)
|
|
20662
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
20663
|
+
* @param {Object} opts.sortOrder Sort order for dependents (by last run date, then created date) (default to descending)
|
|
20664
|
+
* getUsersRuleDependents is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
20665
|
+
*/},{key:"getUsersRuleDependents",value:function getUsersRuleDependents(ruleId,opts){opts=opts||{};// verify the required parameter 'ruleId' is set
|
|
20666
|
+
if(ruleId===undefined||ruleId===null||ruleId===''){throw'Missing the required parameter "ruleId" when calling getUsersRuleDependents';}return this.apiClient.callApi('/api/v2/users/rules/{ruleId}/dependents','GET',{'ruleId':ruleId},{'pageSize':opts['pageSize'],'pageNumber':opts['pageNumber'],'sortOrder':opts['sortOrder']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
20667
|
+
* Get the list of users rules
|
|
20668
|
+
*
|
|
20669
|
+
* @param {Array.<String>} types The types of the rule
|
|
20670
|
+
* @param {Object} opts Optional parameters
|
|
20671
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
20672
|
+
* @param {Number} opts.pageSize Number of results per page (default to 25)
|
|
20673
|
+
* @param {Array.<String>} opts.expand Fields to expand in response
|
|
20674
|
+
* @param {String} opts.searchTerm a search term for finding a rule by name
|
|
20675
|
+
* @param {Object} opts.sortOrder sort rules by name, ascending, descending (default to ascending)
|
|
20676
|
+
* getUsersRules is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
20677
|
+
*/},{key:"getUsersRules",value:function getUsersRules(types,opts){opts=opts||{};// verify the required parameter 'types' is set
|
|
20678
|
+
if(types===undefined||types===null){throw'Missing the required parameter "types" when calling getUsersRules';}return this.apiClient.callApi('/api/v2/users/rules','GET',{},{'pageNumber':opts['pageNumber'],'pageSize':opts['pageSize'],'types':this.apiClient.buildCollectionParam(types,'multi'),'expand':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'searchTerm':opts['searchTerm'],'sortOrder':opts['sortOrder']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
20679
|
+
* Get the settings for a specific users rule type
|
|
20680
|
+
*
|
|
20681
|
+
* @param {Object} ruleType The type of the rule
|
|
20682
|
+
* getUsersRulesSetting is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
20683
|
+
*/},{key:"getUsersRulesSetting",value:function getUsersRulesSetting(ruleType){// verify the required parameter 'ruleType' is set
|
|
20684
|
+
if(ruleType===undefined||ruleType===null||ruleType===''){throw'Missing the required parameter "ruleType" when calling getUsersRulesSetting';}return this.apiClient.callApi('/api/v2/users/rules/settings/{ruleType}','GET',{'ruleType':ruleType},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
20685
|
+
* Update an existing users rule
|
|
20686
|
+
* This will update an existing users rule with the specified fields.
|
|
20687
|
+
* @param {String} ruleId The ID of the rule to update
|
|
20688
|
+
* @param {Object} body updateRuleRequest
|
|
20689
|
+
* patchUsersRule is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
20690
|
+
*/},{key:"patchUsersRule",value:function patchUsersRule(ruleId,body){// verify the required parameter 'ruleId' is set
|
|
20691
|
+
if(ruleId===undefined||ruleId===null||ruleId===''){throw'Missing the required parameter "ruleId" when calling patchUsersRule';}// verify the required parameter 'body' is set
|
|
20692
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling patchUsersRule';}return this.apiClient.callApi('/api/v2/users/rules/{ruleId}','PATCH',{'ruleId':ruleId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
20693
|
+
* Create a new rule
|
|
20694
|
+
* This will create a new rule with the specified fields.
|
|
20695
|
+
* @param {Object} body usersRulesCreateRuleRequest
|
|
20696
|
+
* postUsersRules is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
20697
|
+
*/},{key:"postUsersRules",value:function postUsersRules(body){// verify the required parameter 'body' is set
|
|
20698
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postUsersRules';}return this.apiClient.callApi('/api/v2/users/rules','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
20699
|
+
* Query the result of a users rule
|
|
20700
|
+
* This will query the result of a rule.
|
|
20701
|
+
* @param {Object} body usersRulesQueryRuleRequest
|
|
20702
|
+
* @param {Object} opts Optional parameters
|
|
20703
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
20704
|
+
* @param {Number} opts.pageSize Number of results per page (default to 25)
|
|
20705
|
+
* postUsersRulesQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
20706
|
+
*/},{key:"postUsersRulesQuery",value:function postUsersRulesQuery(body,opts){opts=opts||{};// verify the required parameter 'body' is set
|
|
20707
|
+
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']);}}]);}();var UtilitiesApi=/*#__PURE__*/function(){/**
|
|
20610
20708
|
* Utilities service.
|
|
20611
20709
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
20612
|
-
* @version
|
|
20710
|
+
* @version 237.0.0
|
|
20613
20711
|
*//**
|
|
20614
20712
|
* Constructs a new UtilitiesApi.
|
|
20615
20713
|
* @alias module:purecloud-platform-client-v2/api/UtilitiesApi
|
|
@@ -20636,7 +20734,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
20636
20734
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postCertificateDetails';}return this.apiClient.callApi('/api/v2/certificate/details','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var VoicemailApi=/*#__PURE__*/function(){/**
|
|
20637
20735
|
* Voicemail service.
|
|
20638
20736
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
20639
|
-
* @version
|
|
20737
|
+
* @version 237.0.0
|
|
20640
20738
|
*//**
|
|
20641
20739
|
* Constructs a new VoicemailApi.
|
|
20642
20740
|
* @alias module:purecloud-platform-client-v2/api/VoicemailApi
|
|
@@ -20798,7 +20896,7 @@ if(userId===undefined||userId===null||userId===''){throw'Missing the required pa
|
|
|
20798
20896
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putVoicemailUserpolicy';}return this.apiClient.callApi('/api/v2/voicemail/userpolicies/{userId}','PUT',{'userId':userId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var WebChatApi=/*#__PURE__*/function(){/**
|
|
20799
20897
|
* WebChat service.
|
|
20800
20898
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
20801
|
-
* @version
|
|
20899
|
+
* @version 237.0.0
|
|
20802
20900
|
*//**
|
|
20803
20901
|
* Constructs a new WebChatApi.
|
|
20804
20902
|
* @alias module:purecloud-platform-client-v2/api/WebChatApi
|
|
@@ -20945,7 +21043,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
20945
21043
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putWebchatSettings';}return this.apiClient.callApi('/api/v2/webchat/settings','PUT',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var WebDeploymentsApi=/*#__PURE__*/function(){/**
|
|
20946
21044
|
* WebDeployments service.
|
|
20947
21045
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
20948
|
-
* @version
|
|
21046
|
+
* @version 237.0.0
|
|
20949
21047
|
*//**
|
|
20950
21048
|
* Constructs a new WebDeploymentsApi.
|
|
20951
21049
|
* @alias module:purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
@@ -21078,7 +21176,7 @@ if(deploymentId===undefined||deploymentId===null||deploymentId===''){throw'Missi
|
|
|
21078
21176
|
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']);}}]);}();var WebMessagingApi=/*#__PURE__*/function(){/**
|
|
21079
21177
|
* WebMessaging service.
|
|
21080
21178
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
21081
|
-
* @version
|
|
21179
|
+
* @version 237.0.0
|
|
21082
21180
|
*//**
|
|
21083
21181
|
* Constructs a new WebMessagingApi.
|
|
21084
21182
|
* @alias module:purecloud-platform-client-v2/api/WebMessagingApi
|
|
@@ -21119,7 +21217,7 @@ if(tokenId===undefined||tokenId===null||tokenId===''){throw'Missing the required
|
|
|
21119
21217
|
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']);}}]);}();var WidgetsApi=/*#__PURE__*/function(){/**
|
|
21120
21218
|
* Widgets service.
|
|
21121
21219
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
21122
|
-
* @version
|
|
21220
|
+
* @version 237.0.0
|
|
21123
21221
|
*//**
|
|
21124
21222
|
* Constructs a new WidgetsApi.
|
|
21125
21223
|
* @alias module:purecloud-platform-client-v2/api/WidgetsApi
|
|
@@ -21159,7 +21257,7 @@ if(deploymentId===undefined||deploymentId===null||deploymentId===''){throw'Missi
|
|
|
21159
21257
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putWidgetsDeployment';}return this.apiClient.callApi('/api/v2/widgets/deployments/{deploymentId}','PUT',{'deploymentId':deploymentId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var WorkforceManagementApi=/*#__PURE__*/function(){/**
|
|
21160
21258
|
* WorkforceManagement service.
|
|
21161
21259
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
21162
|
-
* @version
|
|
21260
|
+
* @version 237.0.0
|
|
21163
21261
|
*//**
|
|
21164
21262
|
* Constructs a new WorkforceManagementApi.
|
|
21165
21263
|
* @alias module:purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
@@ -21337,6 +21435,11 @@ if(explanationId===undefined||explanationId===null||explanationId===''){throw'Mi
|
|
|
21337
21435
|
* @param {String} agentId The ID of the agent to look up
|
|
21338
21436
|
*/},{key:"getWorkforcemanagementAgentManagementunit",value:function getWorkforcemanagementAgentManagementunit(agentId){// verify the required parameter 'agentId' is set
|
|
21339
21437
|
if(agentId===undefined||agentId===null||agentId===''){throw'Missing the required parameter "agentId" when calling getWorkforcemanagementAgentManagementunit';}return this.apiClient.callApi('/api/v2/workforcemanagement/agents/{agentId}/managementunit','GET',{'agentId':agentId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
21438
|
+
* Request to fetch the status of the agent adherence job. Only the user who started the operation can query the status
|
|
21439
|
+
* Job details are only retained if the initial request returned a 202 ACCEPTED response
|
|
21440
|
+
* @param {String} jobId ID of the job to get
|
|
21441
|
+
*/},{key:"getWorkforcemanagementAgentsMeAdherenceHistoricalJob",value:function getWorkforcemanagementAgentsMeAdherenceHistoricalJob(jobId){// verify the required parameter 'jobId' is set
|
|
21442
|
+
if(jobId===undefined||jobId===null||jobId===''){throw'Missing the required parameter "jobId" when calling getWorkforcemanagementAgentsMeAdherenceHistoricalJob';}return this.apiClient.callApi('/api/v2/workforcemanagement/agents/me/adherence/historical/jobs/{jobId}','GET',{'jobId':jobId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
21340
21443
|
* Get the management unit to which the currently logged in agent belongs
|
|
21341
21444
|
*
|
|
21342
21445
|
*/},{key:"getWorkforcemanagementAgentsMeManagementunit",value:function getWorkforcemanagementAgentsMeManagementunit(){return this.apiClient.callApi('/api/v2/workforcemanagement/agents/me/managementunit','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
@@ -22382,6 +22485,12 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
22382
22485
|
* @param {Object} body body
|
|
22383
22486
|
*/},{key:"postWorkforcemanagementAgentsIntegrationsHrisQuery",value:function postWorkforcemanagementAgentsIntegrationsHrisQuery(body){// verify the required parameter 'body' is set
|
|
22384
22487
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postWorkforcemanagementAgentsIntegrationsHrisQuery';}return this.apiClient.callApi('/api/v2/workforcemanagement/agents/integrations/hris/query','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
22488
|
+
* Request an agent historical adherence report
|
|
22489
|
+
* The maximum supported range for historical adherence queries is 31 days, or 7 days when the expand query parameter includes any of the following: exceptionInfo, actuals, scheduledActivities
|
|
22490
|
+
* @param {Object} opts Optional parameters
|
|
22491
|
+
* @param {Array.<String>} opts.expand Which fields, if any, to expand with. wfm:AgentHistoricalAdherenceConformance:view permission is required for conformance, and wfm:agentSchedule:view permission is required for scheduledActivities.
|
|
22492
|
+
* @param {Object} opts.body body
|
|
22493
|
+
*/},{key:"postWorkforcemanagementAgentsMeAdherenceHistoricalJobs",value:function postWorkforcemanagementAgentsMeAdherenceHistoricalJobs(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/workforcemanagement/agents/me/adherence/historical/jobs','POST',{},{'expand':this.apiClient.buildCollectionParam(opts['expand'],'multi')},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
22385
22494
|
* Get agent possible work shifts for requested time frame
|
|
22386
22495
|
*
|
|
22387
22496
|
* @param {Object} body body
|
|
@@ -23120,7 +23229,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
23120
23229
|
* </pre>
|
|
23121
23230
|
* </p>
|
|
23122
23231
|
* @module purecloud-platform-client-v2/index
|
|
23123
|
-
* @version
|
|
23232
|
+
* @version 237.0.0
|
|
23124
23233
|
*/var platformClient=/*#__PURE__*/_createClass(function platformClient(){_classCallCheck(this,platformClient);/**
|
|
23125
23234
|
* The ApiClient constructor.
|
|
23126
23235
|
* @property {module:purecloud-platform-client-v2/ApiClient}
|
|
@@ -23353,6 +23462,9 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
23353
23462
|
* The UsersApi service constructor.
|
|
23354
23463
|
* @property {module:purecloud-platform-client-v2/api/UsersApi}
|
|
23355
23464
|
*/this.UsersApi=UsersApi;/**
|
|
23465
|
+
* The UsersRulesApi service constructor.
|
|
23466
|
+
* @property {module:purecloud-platform-client-v2/api/UsersRulesApi}
|
|
23467
|
+
*/this.UsersRulesApi=UsersRulesApi;/**
|
|
23356
23468
|
* The UtilitiesApi service constructor.
|
|
23357
23469
|
* @property {module:purecloud-platform-client-v2/api/UtilitiesApi}
|
|
23358
23470
|
*/this.UtilitiesApi=UtilitiesApi;/**
|