purecloud-platform-client-v2 204.1.0 → 206.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 +5 -3
- package/dist/node/purecloud-platform-client-v2.js +1344 -85
- package/dist/web-amd/purecloud-platform-client-v2.js +1344 -85
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +410 -87
- package/dist/web-cjs/purecloud-platform-client-v2.js +410 -87
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +986 -7
- package/package.json +1 -1
- package/src/purecloud-platform-client-v2/ApiClient.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 +1 -1
- package/src/purecloud-platform-client-v2/api/BillingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/CarrierServicesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ChatApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/CoachingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ContentManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ConversationsApi.js +33 -4
- package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/DownloadsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EmailsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/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 +191 -1
- package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +516 -1
- package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LanguagesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LearningApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LicenseApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LocationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LogCaptureApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/MessagingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/MobileDevicesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/NotificationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OAuthApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ObjectsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OperationalEventsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OrganizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OutboundApi.js +31 -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/SpeechTextAnalyticsApi.js +58 -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 +311 -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 +70 -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/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 +3 -3
- 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 +60 -1
- package/src/purecloud-platform-client-v2/index.js +1 -1
package/dist/web-cjs/bundle.js
CHANGED
|
@@ -879,7 +879,7 @@ if(env)this.environment=env;else this.environment=this.host?this.host:'mypureclo
|
|
|
879
879
|
this.environment=this.environment.replace(/\/+$/,'');// Strip protocol and subdomain
|
|
880
880
|
if(this.environment.startsWith('https://'))this.environment=this.environment.substring(8);if(this.environment.startsWith('http://'))this.environment=this.environment.substring(7);if(this.environment.startsWith('api.'))this.environment=this.environment.substring(4);this.basePath="https://api.".concat(this.environment);this.authUrl="https://login.".concat(this.environment);}},{key:"getConfigString",value:function getConfigString(section,key){if(this.config._sections[section])return this.config._sections[section][key];}},{key:"getConfigBoolean",value:function getConfigBoolean(section,key){if(this.config._sections[section]&&this.config._sections[section][key]!==undefined){if(typeof this.config._sections[section][key]==='string'){return this.config._sections[section][key]==='true';}else return this.config._sections[section][key];}}},{key:"getConfigInt",value:function getConfigInt(section,key){if(this.config._sections[section]&&this.config._sections[section][key]){if(typeof this.config._sections[section][key]==='string'){return parseInt(this.config._sections[section][key]);}else return this.config._sections[section][key];}}}]);}();/**
|
|
881
881
|
* @module purecloud-platform-client-v2/ApiClient
|
|
882
|
-
* @version
|
|
882
|
+
* @version 206.0.0
|
|
883
883
|
*/var ApiClient=/*#__PURE__*/function(){/**
|
|
884
884
|
* Manages low level client-server communications, parameter marshalling, etc. There should not be any need for an
|
|
885
885
|
* application to use this class directly - the *Api and model classes provide the public API for the service. The
|
|
@@ -1191,7 +1191,7 @@ resolve(data);})["catch"](function(error){var data=error;if(error.response&&erro
|
|
|
1191
1191
|
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 AgentAssistantsApi=/*#__PURE__*/function(){/**
|
|
1192
1192
|
* AgentAssistants service.
|
|
1193
1193
|
* @module purecloud-platform-client-v2/api/AgentAssistantsApi
|
|
1194
|
-
* @version
|
|
1194
|
+
* @version 206.0.0
|
|
1195
1195
|
*//**
|
|
1196
1196
|
* Constructs a new AgentAssistantsApi.
|
|
1197
1197
|
* @alias module:purecloud-platform-client-v2/api/AgentAssistantsApi
|
|
@@ -1292,7 +1292,7 @@ if(queueId===undefined||queueId===null){throw'Missing the required parameter "qu
|
|
|
1292
1292
|
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(){/**
|
|
1293
1293
|
* AgentCopilot service.
|
|
1294
1294
|
* @module purecloud-platform-client-v2/api/AgentCopilotApi
|
|
1295
|
-
* @version
|
|
1295
|
+
* @version 206.0.0
|
|
1296
1296
|
*//**
|
|
1297
1297
|
* Constructs a new AgentCopilotApi.
|
|
1298
1298
|
* @alias module:purecloud-platform-client-v2/api/AgentCopilotApi
|
|
@@ -1314,7 +1314,7 @@ if(assistantId===undefined||assistantId===null){throw'Missing the required param
|
|
|
1314
1314
|
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(){/**
|
|
1315
1315
|
* AgentUI service.
|
|
1316
1316
|
* @module purecloud-platform-client-v2/api/AgentUIApi
|
|
1317
|
-
* @version
|
|
1317
|
+
* @version 206.0.0
|
|
1318
1318
|
*//**
|
|
1319
1319
|
* Constructs a new AgentUIApi.
|
|
1320
1320
|
* @alias module:purecloud-platform-client-v2/api/AgentUIApi
|
|
@@ -1348,7 +1348,7 @@ if(agentId===undefined||agentId===null){throw'Missing the required parameter "ag
|
|
|
1348
1348
|
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(){/**
|
|
1349
1349
|
* Alerting service.
|
|
1350
1350
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
1351
|
-
* @version
|
|
1351
|
+
* @version 206.0.0
|
|
1352
1352
|
*//**
|
|
1353
1353
|
* Constructs a new AlertingApi.
|
|
1354
1354
|
* @alias module:purecloud-platform-client-v2/api/AlertingApi
|
|
@@ -1505,7 +1505,7 @@ if(ruleId===undefined||ruleId===null){throw'Missing the required parameter "rule
|
|
|
1505
1505
|
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(){/**
|
|
1506
1506
|
* Analytics service.
|
|
1507
1507
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
1508
|
-
* @version
|
|
1508
|
+
* @version 206.0.0
|
|
1509
1509
|
*//**
|
|
1510
1510
|
* Constructs a new AnalyticsApi.
|
|
1511
1511
|
* @alias module:purecloud-platform-client-v2/api/AnalyticsApi
|
|
@@ -2126,7 +2126,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
2126
2126
|
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(){/**
|
|
2127
2127
|
* Architect service.
|
|
2128
2128
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
2129
|
-
* @version
|
|
2129
|
+
* @version 206.0.0
|
|
2130
2130
|
*//**
|
|
2131
2131
|
* Constructs a new ArchitectApi.
|
|
2132
2132
|
* @alias module:purecloud-platform-client-v2/api/ArchitectApi
|
|
@@ -3218,7 +3218,7 @@ if(milestoneId===undefined||milestoneId===null){throw'Missing the required param
|
|
|
3218
3218
|
if(flowOutcomeId===undefined||flowOutcomeId===null){throw'Missing the required parameter "flowOutcomeId" when calling putFlowsOutcome';}return this.apiClient.callApi('/api/v2/flows/outcomes/{flowOutcomeId}','PUT',{'flowOutcomeId':flowOutcomeId},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var AuditApi=/*#__PURE__*/function(){/**
|
|
3219
3219
|
* Audit service.
|
|
3220
3220
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
3221
|
-
* @version
|
|
3221
|
+
* @version 206.0.0
|
|
3222
3222
|
*//**
|
|
3223
3223
|
* Constructs a new AuditApi.
|
|
3224
3224
|
* @alias module:purecloud-platform-client-v2/api/AuditApi
|
|
@@ -3268,7 +3268,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
3268
3268
|
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(){/**
|
|
3269
3269
|
* Authorization service.
|
|
3270
3270
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
3271
|
-
* @version
|
|
3271
|
+
* @version 206.0.0
|
|
3272
3272
|
*//**
|
|
3273
3273
|
* Constructs a new AuthorizationApi.
|
|
3274
3274
|
* @alias module:purecloud-platform-client-v2/api/AuthorizationApi
|
|
@@ -3591,7 +3591,7 @@ if(subjectId===undefined||subjectId===null){throw'Missing the required parameter
|
|
|
3591
3591
|
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(){/**
|
|
3592
3592
|
* Billing service.
|
|
3593
3593
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
3594
|
-
* @version
|
|
3594
|
+
* @version 206.0.0
|
|
3595
3595
|
*//**
|
|
3596
3596
|
* Constructs a new BillingApi.
|
|
3597
3597
|
* @alias module:purecloud-platform-client-v2/api/BillingApi
|
|
@@ -3615,7 +3615,7 @@ if(endDate===undefined||endDate===null){throw'Missing the required parameter "en
|
|
|
3615
3615
|
if(trustorOrgId===undefined||trustorOrgId===null){throw'Missing the required parameter "trustorOrgId" when calling getBillingTrusteebillingoverviewTrustorOrgId';}return this.apiClient.callApi('/api/v2/billing/trusteebillingoverview/{trustorOrgId}','GET',{'trustorOrgId':trustorOrgId},{'billingPeriodIndex':opts['billingPeriodIndex']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var CarrierServicesApi=/*#__PURE__*/function(){/**
|
|
3616
3616
|
* CarrierServices service.
|
|
3617
3617
|
* @module purecloud-platform-client-v2/api/CarrierServicesApi
|
|
3618
|
-
* @version
|
|
3618
|
+
* @version 206.0.0
|
|
3619
3619
|
*//**
|
|
3620
3620
|
* Constructs a new CarrierServicesApi.
|
|
3621
3621
|
* @alias module:purecloud-platform-client-v2/api/CarrierServicesApi
|
|
@@ -3635,7 +3635,7 @@ if(phoneNumber===undefined||phoneNumber===null){throw'Missing the required param
|
|
|
3635
3635
|
*/},{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(){/**
|
|
3636
3636
|
* Chat service.
|
|
3637
3637
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
3638
|
-
* @version
|
|
3638
|
+
* @version 206.0.0
|
|
3639
3639
|
*//**
|
|
3640
3640
|
* Constructs a new ChatApi.
|
|
3641
3641
|
* @alias module:purecloud-platform-client-v2/api/ChatApi
|
|
@@ -3860,7 +3860,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
3860
3860
|
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(){/**
|
|
3861
3861
|
* Coaching service.
|
|
3862
3862
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
3863
|
-
* @version
|
|
3863
|
+
* @version 206.0.0
|
|
3864
3864
|
*//**
|
|
3865
3865
|
* Constructs a new CoachingApi.
|
|
3866
3866
|
* @alias module:purecloud-platform-client-v2/api/CoachingApi
|
|
@@ -4013,7 +4013,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
4013
4013
|
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(){/**
|
|
4014
4014
|
* ContentManagement service.
|
|
4015
4015
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
4016
|
-
* @version
|
|
4016
|
+
* @version 206.0.0
|
|
4017
4017
|
*//**
|
|
4018
4018
|
* Constructs a new ContentManagementApi.
|
|
4019
4019
|
* @alias module:purecloud-platform-client-v2/api/ContentManagementApi
|
|
@@ -4296,7 +4296,7 @@ if(tagId===undefined||tagId===null){throw'Missing the required parameter "tagId"
|
|
|
4296
4296
|
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(){/**
|
|
4297
4297
|
* Conversations service.
|
|
4298
4298
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
4299
|
-
* @version
|
|
4299
|
+
* @version 206.0.0
|
|
4300
4300
|
*//**
|
|
4301
4301
|
* Constructs a new ConversationsApi.
|
|
4302
4302
|
* @alias module:purecloud-platform-client-v2/api/ConversationsApi
|
|
@@ -4477,6 +4477,12 @@ if(suggestionId===undefined||suggestionId===null){throw'Missing the required par
|
|
|
4477
4477
|
* @param {Object} opts.state Suggestion state to filter Copilot suggestions.
|
|
4478
4478
|
*/},{key:"getConversationSuggestions",value:function getConversationSuggestions(conversationId,opts){opts=opts||{};// verify the required parameter 'conversationId' is set
|
|
4479
4479
|
if(conversationId===undefined||conversationId===null){throw'Missing the required parameter "conversationId" when calling getConversationSuggestions';}return this.apiClient.callApi('/api/v2/conversations/{conversationId}/suggestions','GET',{'conversationId':conversationId},{'before':opts['before'],'after':opts['after'],'pageSize':opts['pageSize'],'type':opts['type'],'state':opts['state']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
4480
|
+
* Get the summaries of the conversation.
|
|
4481
|
+
*
|
|
4482
|
+
* @param {String} conversationId Conversation ID
|
|
4483
|
+
* getConversationSummaries is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
4484
|
+
*/},{key:"getConversationSummaries",value:function getConversationSummaries(conversationId){// verify the required parameter 'conversationId' is set
|
|
4485
|
+
if(conversationId===undefined||conversationId===null){throw'Missing the required parameter "conversationId" when calling getConversationSummaries';}return this.apiClient.callApi('/api/v2/conversations/{conversationId}/summaries','GET',{'conversationId':conversationId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
4480
4486
|
* Get active conversations for the logged in user
|
|
4481
4487
|
*
|
|
4482
4488
|
* @param {Object} opts Optional parameters
|
|
@@ -5204,7 +5210,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
5204
5210
|
* @param {String} conversationId conversationId
|
|
5205
5211
|
* @param {String} participantId participantId
|
|
5206
5212
|
* @param {Object} body Parking update request
|
|
5207
|
-
* patchConversationsEmailParticipantParkingstate is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
5208
5213
|
*/},{key:"patchConversationsEmailParticipantParkingstate",value:function patchConversationsEmailParticipantParkingstate(conversationId,participantId,body){// verify the required parameter 'conversationId' is set
|
|
5209
5214
|
if(conversationId===undefined||conversationId===null){throw'Missing the required parameter "conversationId" when calling patchConversationsEmailParticipantParkingstate';}// verify the required parameter 'participantId' is set
|
|
5210
5215
|
if(participantId===undefined||participantId===null){throw'Missing the required parameter "participantId" when calling patchConversationsEmailParticipantParkingstate';}// verify the required parameter 'body' is set
|
|
@@ -5748,9 +5753,11 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
5748
5753
|
* Send an inbound message to an Open Messaging integration. In order to call this endpoint you will need OAuth token generated using OAuth client credentials authorized with at least messaging scope. This will either generate a new Conversation, or be a part of an existing conversation. See https://developer.genesys.cloud/api/digital/openmessaging/ for example usage.
|
|
5749
5754
|
* @param {String} integrationId integrationId
|
|
5750
5755
|
* @param {Object} body NormalizedMessage
|
|
5751
|
-
|
|
5756
|
+
* @param {Object} opts Optional parameters
|
|
5757
|
+
* @param {Boolean} opts.prefetchConversationId Indicates whether or not to prefetch conversationId (default to false)
|
|
5758
|
+
*/},{key:"postConversationsMessageInboundOpenMessage",value:function postConversationsMessageInboundOpenMessage(integrationId,body,opts){opts=opts||{};// verify the required parameter 'integrationId' is set
|
|
5752
5759
|
if(integrationId===undefined||integrationId===null){throw'Missing the required parameter "integrationId" when calling postConversationsMessageInboundOpenMessage';}// verify the required parameter 'body' is set
|
|
5753
|
-
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postConversationsMessageInboundOpenMessage';}return this.apiClient.callApi('/api/v2/conversations/messages/{integrationId}/inbound/open/message','POST',{'integrationId':integrationId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
5760
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postConversationsMessageInboundOpenMessage';}return this.apiClient.callApi('/api/v2/conversations/messages/{integrationId}/inbound/open/message','POST',{'integrationId':integrationId},{'prefetchConversationId':opts['prefetchConversationId']},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
5754
5761
|
* Send an inbound Open Receipt Message
|
|
5755
5762
|
* Send an inbound open Receipt to an Open Messaging integration. In order to call this endpoint you will need OAuth token generated using OAuth client credentials authorized with at least messaging scope. This will either generate a new Conversation, or be a part of an existing conversation. See https://developer.genesys.cloud/api/digital/openmessaging/ for example usage.
|
|
5756
5763
|
* @param {String} integrationId integrationId
|
|
@@ -6017,7 +6024,7 @@ if(conversationId===undefined||conversationId===null){throw'Missing the required
|
|
|
6017
6024
|
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(){/**
|
|
6018
6025
|
* DataExtensions service.
|
|
6019
6026
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
6020
|
-
* @version
|
|
6027
|
+
* @version 206.0.0
|
|
6021
6028
|
*//**
|
|
6022
6029
|
* Constructs a new DataExtensionsApi.
|
|
6023
6030
|
* @alias module:purecloud-platform-client-v2/api/DataExtensionsApi
|
|
@@ -6038,7 +6045,7 @@ if(coretypeName===undefined||coretypeName===null){throw'Missing the required par
|
|
|
6038
6045
|
*/},{key:"getDataextensionsLimits",value:function getDataextensionsLimits(){return this.apiClient.callApi('/api/v2/dataextensions/limits','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var DownloadsApi=/*#__PURE__*/function(){/**
|
|
6039
6046
|
* Downloads service.
|
|
6040
6047
|
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
6041
|
-
* @version
|
|
6048
|
+
* @version 206.0.0
|
|
6042
6049
|
*//**
|
|
6043
6050
|
* Constructs a new DownloadsApi.
|
|
6044
6051
|
* @alias module:purecloud-platform-client-v2/api/DownloadsApi
|
|
@@ -6057,7 +6064,7 @@ if(coretypeName===undefined||coretypeName===null){throw'Missing the required par
|
|
|
6057
6064
|
if(downloadId===undefined||downloadId===null){throw'Missing the required parameter "downloadId" when calling getDownload';}return this.apiClient.callApi('/api/v2/downloads/{downloadId}','GET',{'downloadId':downloadId},{'contentDisposition':opts['contentDisposition'],'issueRedirect':opts['issueRedirect'],'redirectToAuth':opts['redirectToAuth']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var EmailsApi=/*#__PURE__*/function(){/**
|
|
6058
6065
|
* Emails service.
|
|
6059
6066
|
* @module purecloud-platform-client-v2/api/EmailsApi
|
|
6060
|
-
* @version
|
|
6067
|
+
* @version 206.0.0
|
|
6061
6068
|
*//**
|
|
6062
6069
|
* Constructs a new EmailsApi.
|
|
6063
6070
|
* @alias module:purecloud-platform-client-v2/api/EmailsApi
|
|
@@ -6075,7 +6082,7 @@ if(downloadId===undefined||downloadId===null){throw'Missing the required paramet
|
|
|
6075
6082
|
*/},{key:"patchEmailsSettings",value:function patchEmailsSettings(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/emails/settings','PATCH',{},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var EmployeeEngagementApi=/*#__PURE__*/function(){/**
|
|
6076
6083
|
* EmployeeEngagement service.
|
|
6077
6084
|
* @module purecloud-platform-client-v2/api/EmployeeEngagementApi
|
|
6078
|
-
* @version
|
|
6085
|
+
* @version 206.0.0
|
|
6079
6086
|
*//**
|
|
6080
6087
|
* Constructs a new EmployeeEngagementApi.
|
|
6081
6088
|
* @alias module:purecloud-platform-client-v2/api/EmployeeEngagementApi
|
|
@@ -6113,7 +6120,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
6113
6120
|
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(){/**
|
|
6114
6121
|
* Events service.
|
|
6115
6122
|
* @module purecloud-platform-client-v2/api/EventsApi
|
|
6116
|
-
* @version
|
|
6123
|
+
* @version 206.0.0
|
|
6117
6124
|
*//**
|
|
6118
6125
|
* Constructs a new EventsApi.
|
|
6119
6126
|
* @alias module:purecloud-platform-client-v2/api/EventsApi
|
|
@@ -6138,7 +6145,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
6138
6145
|
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(){/**
|
|
6139
6146
|
* ExternalContacts service.
|
|
6140
6147
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
6141
|
-
* @version
|
|
6148
|
+
* @version 206.0.0
|
|
6142
6149
|
*//**
|
|
6143
6150
|
* Constructs a new ExternalContactsApi.
|
|
6144
6151
|
* @alias module:purecloud-platform-client-v2/api/ExternalContactsApi
|
|
@@ -6630,7 +6637,7 @@ if(relationshipId===undefined||relationshipId===null){throw'Missing the required
|
|
|
6630
6637
|
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(){/**
|
|
6631
6638
|
* Fax service.
|
|
6632
6639
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
6633
|
-
* @version
|
|
6640
|
+
* @version 206.0.0
|
|
6634
6641
|
*//**
|
|
6635
6642
|
* Constructs a new FaxApi.
|
|
6636
6643
|
* @alias module:purecloud-platform-client-v2/api/FaxApi
|
|
@@ -6679,7 +6686,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
6679
6686
|
*/},{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(){/**
|
|
6680
6687
|
* Flows service.
|
|
6681
6688
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
6682
|
-
* @version
|
|
6689
|
+
* @version 206.0.0
|
|
6683
6690
|
*//**
|
|
6684
6691
|
* Constructs a new FlowsApi.
|
|
6685
6692
|
* @alias module:purecloud-platform-client-v2/api/FlowsApi
|
|
@@ -6727,7 +6734,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
6727
6734
|
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(){/**
|
|
6728
6735
|
* Gamification service.
|
|
6729
6736
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
6730
|
-
* @version
|
|
6737
|
+
* @version 206.0.0
|
|
6731
6738
|
*//**
|
|
6732
6739
|
* Constructs a new GamificationApi.
|
|
6733
6740
|
* @alias module:purecloud-platform-client-v2/api/GamificationApi
|
|
@@ -7267,7 +7274,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
7267
7274
|
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(){/**
|
|
7268
7275
|
* GeneralDataProtectionRegulation service.
|
|
7269
7276
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
7270
|
-
* @version
|
|
7277
|
+
* @version 206.0.0
|
|
7271
7278
|
*//**
|
|
7272
7279
|
* Constructs a new GeneralDataProtectionRegulationApi.
|
|
7273
7280
|
* @alias module:purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
@@ -7302,7 +7309,7 @@ if(searchValue===undefined||searchValue===null){throw'Missing the required param
|
|
|
7302
7309
|
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(){/**
|
|
7303
7310
|
* Geolocation service.
|
|
7304
7311
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
7305
|
-
* @version
|
|
7312
|
+
* @version 206.0.0
|
|
7306
7313
|
*//**
|
|
7307
7314
|
* Constructs a new GeolocationApi.
|
|
7308
7315
|
* @alias module:purecloud-platform-client-v2/api/GeolocationApi
|
|
@@ -7336,7 +7343,7 @@ if(clientId===undefined||clientId===null){throw'Missing the required parameter "
|
|
|
7336
7343
|
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(){/**
|
|
7337
7344
|
* Greetings service.
|
|
7338
7345
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
7339
|
-
* @version
|
|
7346
|
+
* @version 206.0.0
|
|
7340
7347
|
*//**
|
|
7341
7348
|
* Constructs a new GreetingsApi.
|
|
7342
7349
|
* @alias module:purecloud-platform-client-v2/api/GreetingsApi
|
|
@@ -7443,7 +7450,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
7443
7450
|
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(){/**
|
|
7444
7451
|
* Groups service.
|
|
7445
7452
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
7446
|
-
* @version
|
|
7453
|
+
* @version 206.0.0
|
|
7447
7454
|
*//**
|
|
7448
7455
|
* Constructs a new GroupsApi.
|
|
7449
7456
|
* @alias module:purecloud-platform-client-v2/api/GroupsApi
|
|
@@ -7576,7 +7583,7 @@ if(groupId===undefined||groupId===null){throw'Missing the required parameter "gr
|
|
|
7576
7583
|
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(){/**
|
|
7577
7584
|
* IdentityProvider service.
|
|
7578
7585
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
7579
|
-
* @version
|
|
7586
|
+
* @version 206.0.0
|
|
7580
7587
|
*//**
|
|
7581
7588
|
* Constructs a new IdentityProviderApi.
|
|
7582
7589
|
* @alias module:purecloud-platform-client-v2/api/IdentityProviderApi
|
|
@@ -7732,7 +7739,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
7732
7739
|
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(){/**
|
|
7733
7740
|
* InfrastructureAsCode service.
|
|
7734
7741
|
* @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
7735
|
-
* @version
|
|
7742
|
+
* @version 206.0.0
|
|
7736
7743
|
*//**
|
|
7737
7744
|
* Constructs a new InfrastructureAsCodeApi.
|
|
7738
7745
|
* @alias module:purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
@@ -7786,7 +7793,7 @@ if(jobId===undefined||jobId===null){throw'Missing the required parameter "jobId"
|
|
|
7786
7793
|
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(){/**
|
|
7787
7794
|
* Integrations service.
|
|
7788
7795
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
7789
|
-
* @version
|
|
7796
|
+
* @version 206.0.0
|
|
7790
7797
|
*//**
|
|
7791
7798
|
* Constructs a new IntegrationsApi.
|
|
7792
7799
|
* @alias module:purecloud-platform-client-v2/api/IntegrationsApi
|
|
@@ -8411,7 +8418,7 @@ if(ucIntegrationId===undefined||ucIntegrationId===null){throw'Missing the requir
|
|
|
8411
8418
|
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(){/**
|
|
8412
8419
|
* Journey service.
|
|
8413
8420
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
8414
|
-
* @version
|
|
8421
|
+
* @version 206.0.0
|
|
8415
8422
|
*//**
|
|
8416
8423
|
* Constructs a new JourneyApi.
|
|
8417
8424
|
* @alias module:purecloud-platform-client-v2/api/JourneyApi
|
|
@@ -8623,6 +8630,26 @@ if(viewId===undefined||viewId===null){throw'Missing the required parameter "view
|
|
|
8623
8630
|
*/},{key:"getJourneyViewVersion",value:function getJourneyViewVersion(viewId,versionId){// verify the required parameter 'viewId' is set
|
|
8624
8631
|
if(viewId===undefined||viewId===null){throw'Missing the required parameter "viewId" when calling getJourneyViewVersion';}// verify the required parameter 'versionId' is set
|
|
8625
8632
|
if(versionId===undefined||versionId===null){throw'Missing the required parameter "versionId" when calling getJourneyViewVersion';}return this.apiClient.callApi('/api/v2/journey/views/{viewId}/versions/{versionId}','GET',{'viewId':viewId,'versionId':versionId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
8633
|
+
* Get a Chart by ID
|
|
8634
|
+
* returns the latest version
|
|
8635
|
+
* @param {String} viewId viewId
|
|
8636
|
+
* @param {String} journeyViewVersion Journey View Version
|
|
8637
|
+
* @param {String} chartId chartId
|
|
8638
|
+
*/},{key:"getJourneyViewVersionChart",value:function getJourneyViewVersionChart(viewId,journeyViewVersion,chartId){// verify the required parameter 'viewId' is set
|
|
8639
|
+
if(viewId===undefined||viewId===null){throw'Missing the required parameter "viewId" when calling getJourneyViewVersionChart';}// verify the required parameter 'journeyViewVersion' is set
|
|
8640
|
+
if(journeyViewVersion===undefined||journeyViewVersion===null){throw'Missing the required parameter "journeyViewVersion" when calling getJourneyViewVersionChart';}// verify the required parameter 'chartId' is set
|
|
8641
|
+
if(chartId===undefined||chartId===null){throw'Missing the required parameter "chartId" when calling getJourneyViewVersionChart';}return this.apiClient.callApi('/api/v2/journey/views/{viewId}/versions/{journeyViewVersion}/charts/{chartId}','GET',{'viewId':viewId,'journeyViewVersion':journeyViewVersion,'chartId':chartId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
8642
|
+
* Get a Chart by ID and version
|
|
8643
|
+
*
|
|
8644
|
+
* @param {String} viewId viewId
|
|
8645
|
+
* @param {String} journeyViewVersion Journey View Version
|
|
8646
|
+
* @param {String} chartId chartId
|
|
8647
|
+
* @param {String} chartVersion chartVersion
|
|
8648
|
+
*/},{key:"getJourneyViewVersionChartVersion",value:function getJourneyViewVersionChartVersion(viewId,journeyViewVersion,chartId,chartVersion){// verify the required parameter 'viewId' is set
|
|
8649
|
+
if(viewId===undefined||viewId===null){throw'Missing the required parameter "viewId" when calling getJourneyViewVersionChartVersion';}// verify the required parameter 'journeyViewVersion' is set
|
|
8650
|
+
if(journeyViewVersion===undefined||journeyViewVersion===null){throw'Missing the required parameter "journeyViewVersion" when calling getJourneyViewVersionChartVersion';}// verify the required parameter 'chartId' is set
|
|
8651
|
+
if(chartId===undefined||chartId===null){throw'Missing the required parameter "chartId" when calling getJourneyViewVersionChartVersion';}// verify the required parameter 'chartVersion' is set
|
|
8652
|
+
if(chartVersion===undefined||chartVersion===null){throw'Missing the required parameter "chartVersion" when calling getJourneyViewVersionChartVersion';}return this.apiClient.callApi('/api/v2/journey/views/{viewId}/versions/{journeyViewVersion}/charts/{chartId}/versions/{chartVersion}','GET',{'viewId':viewId,'journeyViewVersion':journeyViewVersion,'chartId':chartId,'chartVersion':chartVersion},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
8626
8653
|
* Get the job for a journey view version.
|
|
8627
8654
|
* used for long descriptions
|
|
8628
8655
|
* @param {String} viewId Journey View Id
|
|
@@ -8641,6 +8668,17 @@ if(jobId===undefined||jobId===null){throw'Missing the required parameter "jobId"
|
|
|
8641
8668
|
if(viewId===undefined||viewId===null){throw'Missing the required parameter "viewId" when calling getJourneyViewVersionJobResults';}// verify the required parameter 'journeyViewVersion' is set
|
|
8642
8669
|
if(journeyViewVersion===undefined||journeyViewVersion===null){throw'Missing the required parameter "journeyViewVersion" when calling getJourneyViewVersionJobResults';}// verify the required parameter 'jobId' is set
|
|
8643
8670
|
if(jobId===undefined||jobId===null){throw'Missing the required parameter "jobId" when calling getJourneyViewVersionJobResults';}return this.apiClient.callApi('/api/v2/journey/views/{viewId}/versions/{journeyViewVersion}/jobs/{jobId}/results','GET',{'viewId':viewId,'journeyViewVersion':journeyViewVersion,'jobId':jobId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
8671
|
+
* Get the chart result associated with a journey view job.
|
|
8672
|
+
*
|
|
8673
|
+
* @param {String} viewId Journey View Id
|
|
8674
|
+
* @param {String} journeyVersionId Journey View Version
|
|
8675
|
+
* @param {String} jobId JobId
|
|
8676
|
+
* @param {String} chartId ChartId
|
|
8677
|
+
*/},{key:"getJourneyViewVersionJobResultsChart",value:function getJourneyViewVersionJobResultsChart(viewId,journeyVersionId,jobId,chartId){// verify the required parameter 'viewId' is set
|
|
8678
|
+
if(viewId===undefined||viewId===null){throw'Missing the required parameter "viewId" when calling getJourneyViewVersionJobResultsChart';}// verify the required parameter 'journeyVersionId' is set
|
|
8679
|
+
if(journeyVersionId===undefined||journeyVersionId===null){throw'Missing the required parameter "journeyVersionId" when calling getJourneyViewVersionJobResultsChart';}// verify the required parameter 'jobId' is set
|
|
8680
|
+
if(jobId===undefined||jobId===null){throw'Missing the required parameter "jobId" when calling getJourneyViewVersionJobResultsChart';}// verify the required parameter 'chartId' is set
|
|
8681
|
+
if(chartId===undefined||chartId===null){throw'Missing the required parameter "chartId" when calling getJourneyViewVersionJobResultsChart';}return this.apiClient.callApi('/api/v2/journey/views/{viewId}/versions/{journeyVersionId}/jobs/{jobId}/results/charts/{chartId}','GET',{'viewId':viewId,'journeyVersionId':journeyVersionId,'jobId':jobId,'chartId':chartId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
8644
8682
|
* Get the latest job of a journey view version.
|
|
8645
8683
|
* used for long descriptions
|
|
8646
8684
|
* @param {String} viewId Journey View Id
|
|
@@ -8710,6 +8748,17 @@ if(outcomeId===undefined||outcomeId===null){throw'Missing the required parameter
|
|
|
8710
8748
|
* @param {Object} opts.body
|
|
8711
8749
|
*/},{key:"patchJourneySegment",value:function patchJourneySegment(segmentId,opts){opts=opts||{};// verify the required parameter 'segmentId' is set
|
|
8712
8750
|
if(segmentId===undefined||segmentId===null){throw'Missing the required parameter "segmentId" when calling patchJourneySegment';}return this.apiClient.callApi('/api/v2/journey/segments/{segmentId}','PATCH',{'segmentId':segmentId},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
8751
|
+
* Update the job for a journey view version. Only the status can be changed and only to Cancelled
|
|
8752
|
+
* used for long descriptions
|
|
8753
|
+
* @param {String} viewId Journey View Id
|
|
8754
|
+
* @param {String} journeyVersionId Journey View Version
|
|
8755
|
+
* @param {String} jobId JobId
|
|
8756
|
+
* @param {Object} body journeyViewJob
|
|
8757
|
+
*/},{key:"patchJourneyViewVersionJob",value:function patchJourneyViewVersionJob(viewId,journeyVersionId,jobId,body){// verify the required parameter 'viewId' is set
|
|
8758
|
+
if(viewId===undefined||viewId===null){throw'Missing the required parameter "viewId" when calling patchJourneyViewVersionJob';}// verify the required parameter 'journeyVersionId' is set
|
|
8759
|
+
if(journeyVersionId===undefined||journeyVersionId===null){throw'Missing the required parameter "journeyVersionId" when calling patchJourneyViewVersionJob';}// verify the required parameter 'jobId' is set
|
|
8760
|
+
if(jobId===undefined||jobId===null){throw'Missing the required parameter "jobId" when calling patchJourneyViewVersionJob';}// verify the required parameter 'body' is set
|
|
8761
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling patchJourneyViewVersionJob';}return this.apiClient.callApi('/api/v2/journey/views/{viewId}/versions/{journeyVersionId}/jobs/{jobId}','PATCH',{'viewId':viewId,'journeyVersionId':journeyVersionId,'jobId':jobId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
8713
8762
|
* Query for journey aggregates asynchronously
|
|
8714
8763
|
*
|
|
8715
8764
|
* @param {Object} body query
|
|
@@ -8807,10 +8856,19 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
8807
8856
|
* @param {Object} opts Optional parameters
|
|
8808
8857
|
* @param {Array.<Object>} opts.body
|
|
8809
8858
|
* postJourneyViewsEncodingsValidate is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
8810
|
-
*/},{key:"postJourneyViewsEncodingsValidate",value:function postJourneyViewsEncodingsValidate(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/journey/views/encodings/validate','POST',{},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}
|
|
8859
|
+
*/},{key:"postJourneyViewsEncodingsValidate",value:function postJourneyViewsEncodingsValidate(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/journey/views/encodings/validate','POST',{},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
8860
|
+
* Update a Journey View by ID and version
|
|
8861
|
+
* does not create a new version
|
|
8862
|
+
* @param {String} viewId viewId
|
|
8863
|
+
* @param {String} versionId versionId
|
|
8864
|
+
* @param {Object} body JourneyView
|
|
8865
|
+
*/},{key:"putJourneyViewVersion",value:function putJourneyViewVersion(viewId,versionId,body){// verify the required parameter 'viewId' is set
|
|
8866
|
+
if(viewId===undefined||viewId===null){throw'Missing the required parameter "viewId" when calling putJourneyViewVersion';}// verify the required parameter 'versionId' is set
|
|
8867
|
+
if(versionId===undefined||versionId===null){throw'Missing the required parameter "versionId" when calling putJourneyViewVersion';}// verify the required parameter 'body' is set
|
|
8868
|
+
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(){/**
|
|
8811
8869
|
* Knowledge service.
|
|
8812
8870
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
8813
|
-
* @version
|
|
8871
|
+
* @version 206.0.0
|
|
8814
8872
|
*//**
|
|
8815
8873
|
* Constructs a new KnowledgeApi.
|
|
8816
8874
|
* @alias module:purecloud-platform-client-v2/api/KnowledgeApi
|
|
@@ -8897,6 +8955,30 @@ if(languageCode===undefined||languageCode===null){throw'Missing the required par
|
|
|
8897
8955
|
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling deleteKnowledgeKnowledgebaseLanguageDocumentsImport';}// verify the required parameter 'languageCode' is set
|
|
8898
8956
|
if(languageCode===undefined||languageCode===null){throw'Missing the required parameter "languageCode" when calling deleteKnowledgeKnowledgebaseLanguageDocumentsImport';}// verify the required parameter 'importId' is set
|
|
8899
8957
|
if(importId===undefined||importId===null){throw'Missing the required parameter "importId" when calling deleteKnowledgeKnowledgebaseLanguageDocumentsImport';}return this.apiClient.callApi('/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/documents/imports/{importId}','DELETE',{'knowledgeBaseId':knowledgeBaseId,'languageCode':languageCode,'importId':importId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
8958
|
+
* Delete Salesforce Knowledge integration source
|
|
8959
|
+
*
|
|
8960
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
8961
|
+
* @param {String} sourceId Source ID
|
|
8962
|
+
* deleteKnowledgeKnowledgebaseSourcesSalesforceSourceId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
8963
|
+
*/},{key:"deleteKnowledgeKnowledgebaseSourcesSalesforceSourceId",value:function deleteKnowledgeKnowledgebaseSourcesSalesforceSourceId(knowledgeBaseId,sourceId){// verify the required parameter 'knowledgeBaseId' is set
|
|
8964
|
+
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling deleteKnowledgeKnowledgebaseSourcesSalesforceSourceId';}// verify the required parameter 'sourceId' is set
|
|
8965
|
+
if(sourceId===undefined||sourceId===null){throw'Missing the required parameter "sourceId" when calling deleteKnowledgeKnowledgebaseSourcesSalesforceSourceId';}return this.apiClient.callApi('/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/sources/salesforce/{sourceId}','DELETE',{'knowledgeBaseId':knowledgeBaseId,'sourceId':sourceId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
8966
|
+
* Delete ServiceNow Knowledge integration source
|
|
8967
|
+
*
|
|
8968
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
8969
|
+
* @param {String} sourceId Source ID
|
|
8970
|
+
* deleteKnowledgeKnowledgebaseSourcesServicenowSourceId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
8971
|
+
*/},{key:"deleteKnowledgeKnowledgebaseSourcesServicenowSourceId",value:function deleteKnowledgeKnowledgebaseSourcesServicenowSourceId(knowledgeBaseId,sourceId){// verify the required parameter 'knowledgeBaseId' is set
|
|
8972
|
+
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling deleteKnowledgeKnowledgebaseSourcesServicenowSourceId';}// verify the required parameter 'sourceId' is set
|
|
8973
|
+
if(sourceId===undefined||sourceId===null){throw'Missing the required parameter "sourceId" when calling deleteKnowledgeKnowledgebaseSourcesServicenowSourceId';}return this.apiClient.callApi('/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/sources/servicenow/{sourceId}','DELETE',{'knowledgeBaseId':knowledgeBaseId,'sourceId':sourceId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
8974
|
+
* Delete synchronization job
|
|
8975
|
+
*
|
|
8976
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
8977
|
+
* @param {String} syncJobId Synchronization job ID
|
|
8978
|
+
* deleteKnowledgeKnowledgebaseSynchronizeJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
8979
|
+
*/},{key:"deleteKnowledgeKnowledgebaseSynchronizeJob",value:function deleteKnowledgeKnowledgebaseSynchronizeJob(knowledgeBaseId,syncJobId){// verify the required parameter 'knowledgeBaseId' is set
|
|
8980
|
+
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling deleteKnowledgeKnowledgebaseSynchronizeJob';}// verify the required parameter 'syncJobId' is set
|
|
8981
|
+
if(syncJobId===undefined||syncJobId===null){throw'Missing the required parameter "syncJobId" when calling deleteKnowledgeKnowledgebaseSynchronizeJob';}return this.apiClient.callApi('/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/synchronize/jobs/{syncJobId}','DELETE',{'knowledgeBaseId':knowledgeBaseId,'syncJobId':syncJobId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
8900
8982
|
* Get categories
|
|
8901
8983
|
*
|
|
8902
8984
|
* @param {String} sessionId Knowledge guest session ID.
|
|
@@ -8927,6 +9009,12 @@ if(documentId===undefined||documentId===null){throw'Missing the required paramet
|
|
|
8927
9009
|
* @param {Number} opts.pageSize Number of entities to return. Maximum of 200.
|
|
8928
9010
|
*/},{key:"getKnowledgeGuestSessionDocuments",value:function getKnowledgeGuestSessionDocuments(sessionId,opts){opts=opts||{};// verify the required parameter 'sessionId' is set
|
|
8929
9011
|
if(sessionId===undefined||sessionId===null){throw'Missing the required parameter "sessionId" when calling getKnowledgeGuestSessionDocuments';}return this.apiClient.callApi('/api/v2/knowledge/guest/sessions/{sessionId}/documents','GET',{'sessionId':sessionId},{'categoryId':this.apiClient.buildCollectionParam(opts['categoryId'],'multi'),'pageSize':opts['pageSize']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
9012
|
+
* Get sync options available for a knowledge-connect integration
|
|
9013
|
+
*
|
|
9014
|
+
* @param {String} integrationId Integration ID
|
|
9015
|
+
* getKnowledgeIntegrationOptions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
9016
|
+
*/},{key:"getKnowledgeIntegrationOptions",value:function getKnowledgeIntegrationOptions(integrationId){// verify the required parameter 'integrationId' is set
|
|
9017
|
+
if(integrationId===undefined||integrationId===null){throw'Missing the required parameter "integrationId" when calling getKnowledgeIntegrationOptions';}return this.apiClient.callApi('/api/v2/knowledge/integrations/{integrationId}/options','GET',{'integrationId':integrationId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
8930
9018
|
* Get knowledge base
|
|
8931
9019
|
*
|
|
8932
9020
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
@@ -9243,6 +9331,44 @@ if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the requir
|
|
|
9243
9331
|
*/},{key:"getKnowledgeKnowledgebaseParseJob",value:function getKnowledgeKnowledgebaseParseJob(knowledgeBaseId,parseJobId,opts){opts=opts||{};// verify the required parameter 'knowledgeBaseId' is set
|
|
9244
9332
|
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseParseJob';}// verify the required parameter 'parseJobId' is set
|
|
9245
9333
|
if(parseJobId===undefined||parseJobId===null){throw'Missing the required parameter "parseJobId" when calling getKnowledgeKnowledgebaseParseJob';}return this.apiClient.callApi('/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/parse/jobs/{parseJobId}','GET',{'knowledgeBaseId':knowledgeBaseId,'parseJobId':parseJobId},{'expand':this.apiClient.buildCollectionParam(opts['expand'],'multi')},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
9334
|
+
* Get Knowledge integration sources
|
|
9335
|
+
*
|
|
9336
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
9337
|
+
* @param {Object} opts Optional parameters
|
|
9338
|
+
* @param {Object} opts.type If specified, retrieves integration sources with specified integration type.
|
|
9339
|
+
* @param {Array.<String>} opts.expand The specified entity attributes will be filled. Comma separated values expected.
|
|
9340
|
+
* @param {Array.<String>} opts.ids If specified, retrieves integration sources with specified IDs.
|
|
9341
|
+
* getKnowledgeKnowledgebaseSources is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
9342
|
+
*/},{key:"getKnowledgeKnowledgebaseSources",value:function getKnowledgeKnowledgebaseSources(knowledgeBaseId,opts){opts=opts||{};// verify the required parameter 'knowledgeBaseId' is set
|
|
9343
|
+
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseSources';}return this.apiClient.callApi('/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/sources','GET',{'knowledgeBaseId':knowledgeBaseId},{'type':opts['type'],'expand':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'ids':this.apiClient.buildCollectionParam(opts['ids'],'multi')},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
9344
|
+
* Get Salesforce Knowledge integration source
|
|
9345
|
+
*
|
|
9346
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
9347
|
+
* @param {String} sourceId Source ID
|
|
9348
|
+
* @param {Object} opts Optional parameters
|
|
9349
|
+
* @param {Array.<String>} opts.expand The specified entity attributes will be filled. Comma separated values expected.
|
|
9350
|
+
* getKnowledgeKnowledgebaseSourcesSalesforceSourceId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
9351
|
+
*/},{key:"getKnowledgeKnowledgebaseSourcesSalesforceSourceId",value:function getKnowledgeKnowledgebaseSourcesSalesforceSourceId(knowledgeBaseId,sourceId,opts){opts=opts||{};// verify the required parameter 'knowledgeBaseId' is set
|
|
9352
|
+
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseSourcesSalesforceSourceId';}// verify the required parameter 'sourceId' is set
|
|
9353
|
+
if(sourceId===undefined||sourceId===null){throw'Missing the required parameter "sourceId" when calling getKnowledgeKnowledgebaseSourcesSalesforceSourceId';}return this.apiClient.callApi('/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/sources/salesforce/{sourceId}','GET',{'knowledgeBaseId':knowledgeBaseId,'sourceId':sourceId},{'expand':this.apiClient.buildCollectionParam(opts['expand'],'multi')},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
9354
|
+
* Get ServiceNow Knowledge integration source
|
|
9355
|
+
*
|
|
9356
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
9357
|
+
* @param {String} sourceId Source ID
|
|
9358
|
+
* @param {Object} opts Optional parameters
|
|
9359
|
+
* @param {Array.<String>} opts.expand The specified entity attributes will be filled. Comma separated values expected.
|
|
9360
|
+
* getKnowledgeKnowledgebaseSourcesServicenowSourceId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
9361
|
+
*/},{key:"getKnowledgeKnowledgebaseSourcesServicenowSourceId",value:function getKnowledgeKnowledgebaseSourcesServicenowSourceId(knowledgeBaseId,sourceId,opts){opts=opts||{};// verify the required parameter 'knowledgeBaseId' is set
|
|
9362
|
+
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseSourcesServicenowSourceId';}// verify the required parameter 'sourceId' is set
|
|
9363
|
+
if(sourceId===undefined||sourceId===null){throw'Missing the required parameter "sourceId" when calling getKnowledgeKnowledgebaseSourcesServicenowSourceId';}return this.apiClient.callApi('/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/sources/servicenow/{sourceId}','GET',{'knowledgeBaseId':knowledgeBaseId,'sourceId':sourceId},{'expand':this.apiClient.buildCollectionParam(opts['expand'],'multi')},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
9364
|
+
* Get synchronization job report
|
|
9365
|
+
*
|
|
9366
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
9367
|
+
* @param {String} syncJobId Synchronization job ID
|
|
9368
|
+
* getKnowledgeKnowledgebaseSynchronizeJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
9369
|
+
*/},{key:"getKnowledgeKnowledgebaseSynchronizeJob",value:function getKnowledgeKnowledgebaseSynchronizeJob(knowledgeBaseId,syncJobId){// verify the required parameter 'knowledgeBaseId' is set
|
|
9370
|
+
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseSynchronizeJob';}// verify the required parameter 'syncJobId' is set
|
|
9371
|
+
if(syncJobId===undefined||syncJobId===null){throw'Missing the required parameter "syncJobId" when calling getKnowledgeKnowledgebaseSynchronizeJob';}return this.apiClient.callApi('/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/synchronize/jobs/{syncJobId}','GET',{'knowledgeBaseId':knowledgeBaseId,'syncJobId':syncJobId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
9246
9372
|
* Get knowledge base unanswered group for a particular groupId
|
|
9247
9373
|
*
|
|
9248
9374
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
@@ -9436,6 +9562,16 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
9436
9562
|
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling patchKnowledgeKnowledgebaseParseJob';}// verify the required parameter 'parseJobId' is set
|
|
9437
9563
|
if(parseJobId===undefined||parseJobId===null){throw'Missing the required parameter "parseJobId" when calling patchKnowledgeKnowledgebaseParseJob';}// verify the required parameter 'body' is set
|
|
9438
9564
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling patchKnowledgeKnowledgebaseParseJob';}return this.apiClient.callApi('/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/parse/jobs/{parseJobId}','PATCH',{'knowledgeBaseId':knowledgeBaseId,'parseJobId':parseJobId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
9565
|
+
* Update synchronization job
|
|
9566
|
+
*
|
|
9567
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
9568
|
+
* @param {String} syncJobId Synchronization job ID
|
|
9569
|
+
* @param {Object} body
|
|
9570
|
+
* patchKnowledgeKnowledgebaseSynchronizeJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
9571
|
+
*/},{key:"patchKnowledgeKnowledgebaseSynchronizeJob",value:function patchKnowledgeKnowledgebaseSynchronizeJob(knowledgeBaseId,syncJobId,body){// verify the required parameter 'knowledgeBaseId' is set
|
|
9572
|
+
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling patchKnowledgeKnowledgebaseSynchronizeJob';}// verify the required parameter 'syncJobId' is set
|
|
9573
|
+
if(syncJobId===undefined||syncJobId===null){throw'Missing the required parameter "syncJobId" when calling patchKnowledgeKnowledgebaseSynchronizeJob';}// verify the required parameter 'body' is set
|
|
9574
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling patchKnowledgeKnowledgebaseSynchronizeJob';}return this.apiClient.callApi('/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/synchronize/jobs/{syncJobId}','PATCH',{'knowledgeBaseId':knowledgeBaseId,'syncJobId':syncJobId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
9439
9575
|
* Update a Knowledge base unanswered phrase group
|
|
9440
9576
|
*
|
|
9441
9577
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
@@ -9741,6 +9877,46 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
9741
9877
|
* @deprecated
|
|
9742
9878
|
*/},{key:"postKnowledgeKnowledgebaseSearch",value:function postKnowledgeKnowledgebaseSearch(knowledgeBaseId,opts){opts=opts||{};// verify the required parameter 'knowledgeBaseId' is set
|
|
9743
9879
|
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseSearch';}return this.apiClient.callApi('/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/search','POST',{'knowledgeBaseId':knowledgeBaseId},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
9880
|
+
* Create Salesforce Knowledge integration source
|
|
9881
|
+
*
|
|
9882
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
9883
|
+
* @param {Object} body
|
|
9884
|
+
* postKnowledgeKnowledgebaseSourcesSalesforce is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
9885
|
+
*/},{key:"postKnowledgeKnowledgebaseSourcesSalesforce",value:function postKnowledgeKnowledgebaseSourcesSalesforce(knowledgeBaseId,body){// verify the required parameter 'knowledgeBaseId' is set
|
|
9886
|
+
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseSourcesSalesforce';}// verify the required parameter 'body' is set
|
|
9887
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postKnowledgeKnowledgebaseSourcesSalesforce';}return this.apiClient.callApi('/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/sources/salesforce','POST',{'knowledgeBaseId':knowledgeBaseId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
9888
|
+
* Start sync on Salesforce Knowledge integration source
|
|
9889
|
+
*
|
|
9890
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
9891
|
+
* @param {String} sourceId Source ID
|
|
9892
|
+
* postKnowledgeKnowledgebaseSourcesSalesforceSourceIdSync is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
9893
|
+
*/},{key:"postKnowledgeKnowledgebaseSourcesSalesforceSourceIdSync",value:function postKnowledgeKnowledgebaseSourcesSalesforceSourceIdSync(knowledgeBaseId,sourceId){// verify the required parameter 'knowledgeBaseId' is set
|
|
9894
|
+
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseSourcesSalesforceSourceIdSync';}// verify the required parameter 'sourceId' is set
|
|
9895
|
+
if(sourceId===undefined||sourceId===null){throw'Missing the required parameter "sourceId" when calling postKnowledgeKnowledgebaseSourcesSalesforceSourceIdSync';}return this.apiClient.callApi('/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/sources/salesforce/{sourceId}/sync','POST',{'knowledgeBaseId':knowledgeBaseId,'sourceId':sourceId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
9896
|
+
* Create ServiceNow Knowledge integration source
|
|
9897
|
+
*
|
|
9898
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
9899
|
+
* @param {Object} body
|
|
9900
|
+
* postKnowledgeKnowledgebaseSourcesServicenow is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
9901
|
+
*/},{key:"postKnowledgeKnowledgebaseSourcesServicenow",value:function postKnowledgeKnowledgebaseSourcesServicenow(knowledgeBaseId,body){// verify the required parameter 'knowledgeBaseId' is set
|
|
9902
|
+
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseSourcesServicenow';}// verify the required parameter 'body' is set
|
|
9903
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postKnowledgeKnowledgebaseSourcesServicenow';}return this.apiClient.callApi('/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/sources/servicenow','POST',{'knowledgeBaseId':knowledgeBaseId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
9904
|
+
* Start synchronization on ServiceNow Knowledge integration source
|
|
9905
|
+
*
|
|
9906
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
9907
|
+
* @param {String} sourceId Source ID
|
|
9908
|
+
* postKnowledgeKnowledgebaseSourcesServicenowSourceIdSync is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
9909
|
+
*/},{key:"postKnowledgeKnowledgebaseSourcesServicenowSourceIdSync",value:function postKnowledgeKnowledgebaseSourcesServicenowSourceIdSync(knowledgeBaseId,sourceId){// verify the required parameter 'knowledgeBaseId' is set
|
|
9910
|
+
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseSourcesServicenowSourceIdSync';}// verify the required parameter 'sourceId' is set
|
|
9911
|
+
if(sourceId===undefined||sourceId===null){throw'Missing the required parameter "sourceId" when calling postKnowledgeKnowledgebaseSourcesServicenowSourceIdSync';}return this.apiClient.callApi('/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/sources/servicenow/{sourceId}/sync','POST',{'knowledgeBaseId':knowledgeBaseId,'sourceId':sourceId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
9912
|
+
* Create synchronization job
|
|
9913
|
+
*
|
|
9914
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
9915
|
+
* @param {Object} body
|
|
9916
|
+
* postKnowledgeKnowledgebaseSynchronizeJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
9917
|
+
*/},{key:"postKnowledgeKnowledgebaseSynchronizeJobs",value:function postKnowledgeKnowledgebaseSynchronizeJobs(knowledgeBaseId,body){// verify the required parameter 'knowledgeBaseId' is set
|
|
9918
|
+
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseSynchronizeJobs';}// verify the required parameter 'body' is set
|
|
9919
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postKnowledgeKnowledgebaseSynchronizeJobs';}return this.apiClient.callApi('/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/synchronize/jobs','POST',{'knowledgeBaseId':knowledgeBaseId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
9744
9920
|
* Create content upload from URL job
|
|
9745
9921
|
*
|
|
9746
9922
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
@@ -9753,10 +9929,30 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
9753
9929
|
*
|
|
9754
9930
|
* @param {Object} body
|
|
9755
9931
|
*/},{key:"postKnowledgeKnowledgebases",value:function postKnowledgeKnowledgebases(body){// verify the required parameter 'body' is set
|
|
9756
|
-
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postKnowledgeKnowledgebases';}return this.apiClient.callApi('/api/v2/knowledge/knowledgebases','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}
|
|
9932
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postKnowledgeKnowledgebases';}return this.apiClient.callApi('/api/v2/knowledge/knowledgebases','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
9933
|
+
* Update Salesforce Knowledge integration source
|
|
9934
|
+
*
|
|
9935
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
9936
|
+
* @param {String} sourceId Source ID
|
|
9937
|
+
* @param {Object} body
|
|
9938
|
+
* putKnowledgeKnowledgebaseSourcesSalesforceSourceId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
9939
|
+
*/},{key:"putKnowledgeKnowledgebaseSourcesSalesforceSourceId",value:function putKnowledgeKnowledgebaseSourcesSalesforceSourceId(knowledgeBaseId,sourceId,body){// verify the required parameter 'knowledgeBaseId' is set
|
|
9940
|
+
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling putKnowledgeKnowledgebaseSourcesSalesforceSourceId';}// verify the required parameter 'sourceId' is set
|
|
9941
|
+
if(sourceId===undefined||sourceId===null){throw'Missing the required parameter "sourceId" when calling putKnowledgeKnowledgebaseSourcesSalesforceSourceId';}// verify the required parameter 'body' is set
|
|
9942
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putKnowledgeKnowledgebaseSourcesSalesforceSourceId';}return this.apiClient.callApi('/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/sources/salesforce/{sourceId}','PUT',{'knowledgeBaseId':knowledgeBaseId,'sourceId':sourceId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
9943
|
+
* Update ServiceNow Knowledge integration source
|
|
9944
|
+
*
|
|
9945
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
9946
|
+
* @param {String} sourceId Source ID
|
|
9947
|
+
* @param {Object} body
|
|
9948
|
+
* putKnowledgeKnowledgebaseSourcesServicenowSourceId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
9949
|
+
*/},{key:"putKnowledgeKnowledgebaseSourcesServicenowSourceId",value:function putKnowledgeKnowledgebaseSourcesServicenowSourceId(knowledgeBaseId,sourceId,body){// verify the required parameter 'knowledgeBaseId' is set
|
|
9950
|
+
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling putKnowledgeKnowledgebaseSourcesServicenowSourceId';}// verify the required parameter 'sourceId' is set
|
|
9951
|
+
if(sourceId===undefined||sourceId===null){throw'Missing the required parameter "sourceId" when calling putKnowledgeKnowledgebaseSourcesServicenowSourceId';}// verify the required parameter 'body' is set
|
|
9952
|
+
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(){/**
|
|
9757
9953
|
* LanguageUnderstanding service.
|
|
9758
9954
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
9759
|
-
* @version
|
|
9955
|
+
* @version 206.0.0
|
|
9760
9956
|
*//**
|
|
9761
9957
|
* Constructs a new LanguageUnderstandingApi.
|
|
9762
9958
|
* @alias module:purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
@@ -10016,7 +10212,7 @@ if(domainVersionId===undefined||domainVersionId===null){throw'Missing the requir
|
|
|
10016
10212
|
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(){/**
|
|
10017
10213
|
* Languages service.
|
|
10018
10214
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
10019
|
-
* @version
|
|
10215
|
+
* @version 206.0.0
|
|
10020
10216
|
*//**
|
|
10021
10217
|
* Constructs a new LanguagesApi.
|
|
10022
10218
|
* @alias module:purecloud-platform-client-v2/api/LanguagesApi
|
|
@@ -10071,7 +10267,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
10071
10267
|
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(){/**
|
|
10072
10268
|
* Learning service.
|
|
10073
10269
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
10074
|
-
* @version
|
|
10270
|
+
* @version 206.0.0
|
|
10075
10271
|
*//**
|
|
10076
10272
|
* Constructs a new LearningApi.
|
|
10077
10273
|
* @alias module:purecloud-platform-client-v2/api/LearningApi
|
|
@@ -10342,7 +10538,7 @@ if(moduleId===undefined||moduleId===null){throw'Missing the required parameter "
|
|
|
10342
10538
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putLearningModuleRule';}return this.apiClient.callApi('/api/v2/learning/modules/{moduleId}/rule','PUT',{'moduleId':moduleId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var LicenseApi=/*#__PURE__*/function(){/**
|
|
10343
10539
|
* License service.
|
|
10344
10540
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
10345
|
-
* @version
|
|
10541
|
+
* @version 206.0.0
|
|
10346
10542
|
*//**
|
|
10347
10543
|
* Constructs a new LicenseApi.
|
|
10348
10544
|
* @alias module:purecloud-platform-client-v2/api/LicenseApi
|
|
@@ -10396,7 +10592,7 @@ if(featureName===undefined||featureName===null){throw'Missing the required param
|
|
|
10396
10592
|
*/},{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(){/**
|
|
10397
10593
|
* Locations service.
|
|
10398
10594
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
10399
|
-
* @version
|
|
10595
|
+
* @version 206.0.0
|
|
10400
10596
|
*//**
|
|
10401
10597
|
* Constructs a new LocationsApi.
|
|
10402
10598
|
* @alias module:purecloud-platform-client-v2/api/LocationsApi
|
|
@@ -10455,7 +10651,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
10455
10651
|
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(){/**
|
|
10456
10652
|
* LogCapture service.
|
|
10457
10653
|
* @module purecloud-platform-client-v2/api/LogCaptureApi
|
|
10458
|
-
* @version
|
|
10654
|
+
* @version 206.0.0
|
|
10459
10655
|
*//**
|
|
10460
10656
|
* Constructs a new LogCaptureApi.
|
|
10461
10657
|
* @alias module:purecloud-platform-client-v2/api/LogCaptureApi
|
|
@@ -10505,7 +10701,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
10505
10701
|
if(userId===undefined||userId===null){throw'Missing the required parameter "userId" when calling postDiagnosticsLogcaptureBrowserUser';}return this.apiClient.callApi('/api/v2/diagnostics/logcapture/browser/users/{userId}','POST',{'userId':userId},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var MessagingApi=/*#__PURE__*/function(){/**
|
|
10506
10702
|
* Messaging service.
|
|
10507
10703
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
10508
|
-
* @version
|
|
10704
|
+
* @version 206.0.0
|
|
10509
10705
|
*//**
|
|
10510
10706
|
* Constructs a new MessagingApi.
|
|
10511
10707
|
* @alias module:purecloud-platform-client-v2/api/MessagingApi
|
|
@@ -10595,7 +10791,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
10595
10791
|
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(){/**
|
|
10596
10792
|
* MobileDevices service.
|
|
10597
10793
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
10598
|
-
* @version
|
|
10794
|
+
* @version 206.0.0
|
|
10599
10795
|
*//**
|
|
10600
10796
|
* Constructs a new MobileDevicesApi.
|
|
10601
10797
|
* @alias module:purecloud-platform-client-v2/api/MobileDevicesApi
|
|
@@ -10634,7 +10830,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
10634
10830
|
if(deviceId===undefined||deviceId===null){throw'Missing the required parameter "deviceId" when calling putMobiledevice';}return this.apiClient.callApi('/api/v2/mobiledevices/{deviceId}','PUT',{'deviceId':deviceId},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var NotificationsApi=/*#__PURE__*/function(){/**
|
|
10635
10831
|
* Notifications service.
|
|
10636
10832
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
10637
|
-
* @version
|
|
10833
|
+
* @version 206.0.0
|
|
10638
10834
|
*//**
|
|
10639
10835
|
* Constructs a new NotificationsApi.
|
|
10640
10836
|
* @alias module:purecloud-platform-client-v2/api/NotificationsApi
|
|
@@ -10691,7 +10887,7 @@ if(channelId===undefined||channelId===null){throw'Missing the required parameter
|
|
|
10691
10887
|
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(){/**
|
|
10692
10888
|
* OAuth service.
|
|
10693
10889
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
10694
|
-
* @version
|
|
10890
|
+
* @version 206.0.0
|
|
10695
10891
|
*//**
|
|
10696
10892
|
* Constructs a new OAuthApi.
|
|
10697
10893
|
* @alias module:purecloud-platform-client-v2/api/OAuthApi
|
|
@@ -10776,7 +10972,7 @@ if(clientId===undefined||clientId===null){throw'Missing the required parameter "
|
|
|
10776
10972
|
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(){/**
|
|
10777
10973
|
* Objects service.
|
|
10778
10974
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
10779
|
-
* @version
|
|
10975
|
+
* @version 206.0.0
|
|
10780
10976
|
*//**
|
|
10781
10977
|
* Constructs a new ObjectsApi.
|
|
10782
10978
|
* @alias module:purecloud-platform-client-v2/api/ObjectsApi
|
|
@@ -10847,7 +11043,7 @@ if(divisionId===undefined||divisionId===null){throw'Missing the required paramet
|
|
|
10847
11043
|
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(){/**
|
|
10848
11044
|
* OperationalEvents service.
|
|
10849
11045
|
* @module purecloud-platform-client-v2/api/OperationalEventsApi
|
|
10850
|
-
* @version
|
|
11046
|
+
* @version 206.0.0
|
|
10851
11047
|
*//**
|
|
10852
11048
|
* Constructs a new OperationalEventsApi.
|
|
10853
11049
|
* @alias module:purecloud-platform-client-v2/api/OperationalEventsApi
|
|
@@ -10865,7 +11061,7 @@ if(eventDefinitionId===undefined||eventDefinitionId===null){throw'Missing the re
|
|
|
10865
11061
|
*/},{key:"getUsageEventsDefinitions",value:function getUsageEventsDefinitions(){return this.apiClient.callApi('/api/v2/usage/events/definitions','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var OrganizationApi=/*#__PURE__*/function(){/**
|
|
10866
11062
|
* Organization service.
|
|
10867
11063
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
10868
|
-
* @version
|
|
11064
|
+
* @version 206.0.0
|
|
10869
11065
|
*//**
|
|
10870
11066
|
* Constructs a new OrganizationApi.
|
|
10871
11067
|
* @alias module:purecloud-platform-client-v2/api/OrganizationApi
|
|
@@ -10990,7 +11186,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
10990
11186
|
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(){/**
|
|
10991
11187
|
* OrganizationAuthorization service.
|
|
10992
11188
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
10993
|
-
* @version
|
|
11189
|
+
* @version 206.0.0
|
|
10994
11190
|
*//**
|
|
10995
11191
|
* Constructs a new OrganizationAuthorizationApi.
|
|
10996
11192
|
* @alias module:purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
@@ -11313,7 +11509,7 @@ if(trustorOrgId===undefined||trustorOrgId===null){throw'Missing the required par
|
|
|
11313
11509
|
if(trusteeUserId===undefined||trusteeUserId===null){throw'Missing the required parameter "trusteeUserId" when calling putOrgauthorizationTrustorUser';}return this.apiClient.callApi('/api/v2/orgauthorization/trustors/{trustorOrgId}/users/{trusteeUserId}','PUT',{'trustorOrgId':trustorOrgId,'trusteeUserId':trusteeUserId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var OutboundApi=/*#__PURE__*/function(){/**
|
|
11314
11510
|
* Outbound service.
|
|
11315
11511
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
11316
|
-
* @version
|
|
11512
|
+
* @version 206.0.0
|
|
11317
11513
|
*//**
|
|
11318
11514
|
* Constructs a new OutboundApi.
|
|
11319
11515
|
* @alias module:purecloud-platform-client-v2/api/OutboundApi
|
|
@@ -11566,6 +11762,14 @@ if(campaignId===undefined||campaignId===null){throw'Missing the required paramet
|
|
|
11566
11762
|
* @param {String} campaignId Campaign ID
|
|
11567
11763
|
*/},{key:"getOutboundCampaignProgress",value:function getOutboundCampaignProgress(campaignId){// verify the required parameter 'campaignId' is set
|
|
11568
11764
|
if(campaignId===undefined||campaignId===null){throw'Missing the required parameter "campaignId" when calling getOutboundCampaignProgress';}return this.apiClient.callApi('/api/v2/outbound/campaigns/{campaignId}/progress','GET',{'campaignId':campaignId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
11765
|
+
* Get the remaining and total contact count for each skill combination in a skills campaign
|
|
11766
|
+
*
|
|
11767
|
+
* @param {String} campaignId Campaign ID
|
|
11768
|
+
* @param {Object} opts Optional parameters
|
|
11769
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
11770
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
11771
|
+
*/},{key:"getOutboundCampaignSkillcombinations",value:function getOutboundCampaignSkillcombinations(campaignId,opts){opts=opts||{};// verify the required parameter 'campaignId' is set
|
|
11772
|
+
if(campaignId===undefined||campaignId===null){throw'Missing the required parameter "campaignId" when calling getOutboundCampaignSkillcombinations';}return this.apiClient.callApi('/api/v2/outbound/campaigns/{campaignId}/skillcombinations','GET',{'campaignId':campaignId},{'pageNumber':opts['pageNumber'],'pageSize':opts['pageSize']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
11569
11773
|
* Get statistics about a Dialer Campaign
|
|
11570
11774
|
*
|
|
11571
11775
|
* @param {String} campaignId Campaign ID
|
|
@@ -12392,7 +12596,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
12392
12596
|
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(){/**
|
|
12393
12597
|
* Presence service.
|
|
12394
12598
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
12395
|
-
* @version
|
|
12599
|
+
* @version 206.0.0
|
|
12396
12600
|
*//**
|
|
12397
12601
|
* Constructs a new PresenceApi.
|
|
12398
12602
|
* @alias module:purecloud-platform-client-v2/api/PresenceApi
|
|
@@ -12565,7 +12769,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
12565
12769
|
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(){/**
|
|
12566
12770
|
* ProcessAutomation service.
|
|
12567
12771
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
12568
|
-
* @version
|
|
12772
|
+
* @version 206.0.0
|
|
12569
12773
|
*//**
|
|
12570
12774
|
* Constructs a new ProcessAutomationApi.
|
|
12571
12775
|
* @alias module:purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
@@ -12628,7 +12832,7 @@ if(triggerId===undefined||triggerId===null){throw'Missing the required parameter
|
|
|
12628
12832
|
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(){/**
|
|
12629
12833
|
* Quality service.
|
|
12630
12834
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
12631
|
-
* @version
|
|
12835
|
+
* @version 206.0.0
|
|
12632
12836
|
*//**
|
|
12633
12837
|
* Constructs a new QualityApi.
|
|
12634
12838
|
* @alias module:purecloud-platform-client-v2/api/QualityApi
|
|
@@ -13105,7 +13309,7 @@ if(customerSurveyUrl===undefined||customerSurveyUrl===null){throw'Missing the re
|
|
|
13105
13309
|
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(){/**
|
|
13106
13310
|
* Recording service.
|
|
13107
13311
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
13108
|
-
* @version
|
|
13312
|
+
* @version 206.0.0
|
|
13109
13313
|
*//**
|
|
13110
13314
|
* Constructs a new RecordingApi.
|
|
13111
13315
|
* @alias module:purecloud-platform-client-v2/api/RecordingApi
|
|
@@ -13517,7 +13721,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
13517
13721
|
*/},{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(){/**
|
|
13518
13722
|
* ResponseManagement service.
|
|
13519
13723
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
13520
|
-
* @version
|
|
13724
|
+
* @version 206.0.0
|
|
13521
13725
|
*//**
|
|
13522
13726
|
* Constructs a new ResponseManagementApi.
|
|
13523
13727
|
* @alias module:purecloud-platform-client-v2/api/ResponseManagementApi
|
|
@@ -13638,7 +13842,7 @@ if(responseAssetId===undefined||responseAssetId===null){throw'Missing the requir
|
|
|
13638
13842
|
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(){/**
|
|
13639
13843
|
* Routing service.
|
|
13640
13844
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
13641
|
-
* @version
|
|
13845
|
+
* @version 206.0.0
|
|
13642
13846
|
*//**
|
|
13643
13847
|
* Constructs a new RoutingApi.
|
|
13644
13848
|
* @alias module:purecloud-platform-client-v2/api/RoutingApi
|
|
@@ -14642,7 +14846,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
14642
14846
|
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(){/**
|
|
14643
14847
|
* SCIM service.
|
|
14644
14848
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
14645
|
-
* @version
|
|
14849
|
+
* @version 206.0.0
|
|
14646
14850
|
*//**
|
|
14647
14851
|
* Constructs a new SCIMApi.
|
|
14648
14852
|
* @alias module:purecloud-platform-client-v2/api/SCIMApi
|
|
@@ -14867,7 +15071,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
14867
15071
|
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(){/**
|
|
14868
15072
|
* ScreenRecording service.
|
|
14869
15073
|
* @module purecloud-platform-client-v2/api/ScreenRecordingApi
|
|
14870
|
-
* @version
|
|
15074
|
+
* @version 206.0.0
|
|
14871
15075
|
*//**
|
|
14872
15076
|
* Constructs a new ScreenRecordingApi.
|
|
14873
15077
|
* @alias module:purecloud-platform-client-v2/api/ScreenRecordingApi
|
|
@@ -14882,7 +15086,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
14882
15086
|
*/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(){/**
|
|
14883
15087
|
* Scripts service.
|
|
14884
15088
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
14885
|
-
* @version
|
|
15089
|
+
* @version 206.0.0
|
|
14886
15090
|
*//**
|
|
14887
15091
|
* Constructs a new ScriptsApi.
|
|
14888
15092
|
* @alias module:purecloud-platform-client-v2/api/ScriptsApi
|
|
@@ -15018,7 +15222,7 @@ if(scriptId===undefined||scriptId===null){throw'Missing the required parameter "
|
|
|
15018
15222
|
*/},{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(){/**
|
|
15019
15223
|
* Search service.
|
|
15020
15224
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
15021
|
-
* @version
|
|
15225
|
+
* @version 206.0.0
|
|
15022
15226
|
*//**
|
|
15023
15227
|
* Constructs a new SearchApi.
|
|
15024
15228
|
* @alias module:purecloud-platform-client-v2/api/SearchApi
|
|
@@ -15178,7 +15382,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
15178
15382
|
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(){/**
|
|
15179
15383
|
* Settings service.
|
|
15180
15384
|
* @module purecloud-platform-client-v2/api/SettingsApi
|
|
15181
|
-
* @version
|
|
15385
|
+
* @version 206.0.0
|
|
15182
15386
|
*//**
|
|
15183
15387
|
* Constructs a new SettingsApi.
|
|
15184
15388
|
* @alias module:purecloud-platform-client-v2/api/SettingsApi
|
|
@@ -15228,7 +15432,7 @@ if(agentId===undefined||agentId===null){throw'Missing the required parameter "ag
|
|
|
15228
15432
|
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 SpeechTextAnalyticsApi=/*#__PURE__*/function(){/**
|
|
15229
15433
|
* SpeechTextAnalytics service.
|
|
15230
15434
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
15231
|
-
* @version
|
|
15435
|
+
* @version 206.0.0
|
|
15232
15436
|
*//**
|
|
15233
15437
|
* Constructs a new SpeechTextAnalyticsApi.
|
|
15234
15438
|
* @alias module:purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
@@ -15413,6 +15617,21 @@ if(topicId===undefined||topicId===null){throw'Missing the required parameter "to
|
|
|
15413
15617
|
* @param {String} jobId The id of the publish topics job
|
|
15414
15618
|
*/},{key:"getSpeechandtextanalyticsTopicsPublishjob",value:function getSpeechandtextanalyticsTopicsPublishjob(jobId){// verify the required parameter 'jobId' is set
|
|
15415
15619
|
if(jobId===undefined||jobId===null){throw'Missing the required parameter "jobId" when calling getSpeechandtextanalyticsTopicsPublishjob';}return this.apiClient.callApi('/api/v2/speechandtextanalytics/topics/publishjobs/{jobId}','GET',{'jobId':jobId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
15620
|
+
* Translate all communication(s) for an interaction.
|
|
15621
|
+
*
|
|
15622
|
+
* @param {String} languageId Target translation language
|
|
15623
|
+
* @param {String} conversationId Conversation id
|
|
15624
|
+
* @param {Object} opts Optional parameters
|
|
15625
|
+
* @param {String} opts.communicationId Communication id associated with the conversation
|
|
15626
|
+
* @param {String} opts.recordingId Recording id associated with the communication
|
|
15627
|
+
* getSpeechandtextanalyticsTranslationsLanguageConversation is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
15628
|
+
*/},{key:"getSpeechandtextanalyticsTranslationsLanguageConversation",value:function getSpeechandtextanalyticsTranslationsLanguageConversation(languageId,conversationId,opts){opts=opts||{};// verify the required parameter 'languageId' is set
|
|
15629
|
+
if(languageId===undefined||languageId===null){throw'Missing the required parameter "languageId" when calling getSpeechandtextanalyticsTranslationsLanguageConversation';}// verify the required parameter 'conversationId' is set
|
|
15630
|
+
if(conversationId===undefined||conversationId===null){throw'Missing the required parameter "conversationId" when calling getSpeechandtextanalyticsTranslationsLanguageConversation';}return this.apiClient.callApi('/api/v2/speechandtextanalytics/translations/languages/{languageId}/conversations/{conversationId}','GET',{'languageId':languageId,'conversationId':conversationId},{'communicationId':opts['communicationId'],'recordingId':opts['recordingId']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
15631
|
+
* Get supported translation languages
|
|
15632
|
+
*
|
|
15633
|
+
* getSpeechandtextanalyticsTranslationsLanguages is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
15634
|
+
*/},{key:"getSpeechandtextanalyticsTranslationsLanguages",value:function getSpeechandtextanalyticsTranslationsLanguages(){return this.apiClient.callApi('/api/v2/speechandtextanalytics/translations/languages','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
15416
15635
|
* Patch Speech And Text Analytics Settings
|
|
15417
15636
|
*
|
|
15418
15637
|
* @param {Object} body Speech And Text Analytics Settings
|
|
@@ -15512,7 +15731,7 @@ if(topicId===undefined||topicId===null){throw'Missing the required parameter "to
|
|
|
15512
15731
|
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(){/**
|
|
15513
15732
|
* Stations service.
|
|
15514
15733
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
15515
|
-
* @version
|
|
15734
|
+
* @version 206.0.0
|
|
15516
15735
|
*//**
|
|
15517
15736
|
* Constructs a new StationsApi.
|
|
15518
15737
|
* @alias module:purecloud-platform-client-v2/api/StationsApi
|
|
@@ -15544,7 +15763,7 @@ if(stationId===undefined||stationId===null){throw'Missing the required parameter
|
|
|
15544
15763
|
*/},{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(){/**
|
|
15545
15764
|
* Suggest service.
|
|
15546
15765
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
15547
|
-
* @version
|
|
15766
|
+
* @version 206.0.0
|
|
15548
15767
|
*//**
|
|
15549
15768
|
* Constructs a new SuggestApi.
|
|
15550
15769
|
* @alias module:purecloud-platform-client-v2/api/SuggestApi
|
|
@@ -15584,7 +15803,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
15584
15803
|
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(){/**
|
|
15585
15804
|
* TaskManagement service.
|
|
15586
15805
|
* @module purecloud-platform-client-v2/api/TaskManagementApi
|
|
15587
|
-
* @version
|
|
15806
|
+
* @version 206.0.0
|
|
15588
15807
|
*//**
|
|
15589
15808
|
* Constructs a new TaskManagementApi.
|
|
15590
15809
|
* @alias module:purecloud-platform-client-v2/api/TaskManagementApi
|
|
@@ -15612,6 +15831,20 @@ if(schemaId===undefined||schemaId===null){throw'Missing the required parameter "
|
|
|
15612
15831
|
* @param {String} worktypeId Worktype id
|
|
15613
15832
|
*/},{key:"deleteTaskmanagementWorktype",value:function deleteTaskmanagementWorktype(worktypeId){// verify the required parameter 'worktypeId' is set
|
|
15614
15833
|
if(worktypeId===undefined||worktypeId===null){throw'Missing the required parameter "worktypeId" when calling deleteTaskmanagementWorktype';}return this.apiClient.callApi('/api/v2/taskmanagement/worktypes/{worktypeId}','DELETE',{'worktypeId':worktypeId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
15834
|
+
* Delete a rule
|
|
15835
|
+
*
|
|
15836
|
+
* @param {String} worktypeId Worktype id
|
|
15837
|
+
* @param {String} ruleId ruleId
|
|
15838
|
+
*/},{key:"deleteTaskmanagementWorktypeFlowsOnattributechangeRule",value:function deleteTaskmanagementWorktypeFlowsOnattributechangeRule(worktypeId,ruleId){// verify the required parameter 'worktypeId' is set
|
|
15839
|
+
if(worktypeId===undefined||worktypeId===null){throw'Missing the required parameter "worktypeId" when calling deleteTaskmanagementWorktypeFlowsOnattributechangeRule';}// verify the required parameter 'ruleId' is set
|
|
15840
|
+
if(ruleId===undefined||ruleId===null){throw'Missing the required parameter "ruleId" when calling deleteTaskmanagementWorktypeFlowsOnattributechangeRule';}return this.apiClient.callApi('/api/v2/taskmanagement/worktypes/{worktypeId}/flows/onattributechange/rules/{ruleId}','DELETE',{'worktypeId':worktypeId,'ruleId':ruleId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
15841
|
+
* Delete a rule
|
|
15842
|
+
*
|
|
15843
|
+
* @param {String} worktypeId Worktype id
|
|
15844
|
+
* @param {String} ruleId ruleId
|
|
15845
|
+
*/},{key:"deleteTaskmanagementWorktypeFlowsOncreateRule",value:function deleteTaskmanagementWorktypeFlowsOncreateRule(worktypeId,ruleId){// verify the required parameter 'worktypeId' is set
|
|
15846
|
+
if(worktypeId===undefined||worktypeId===null){throw'Missing the required parameter "worktypeId" when calling deleteTaskmanagementWorktypeFlowsOncreateRule';}// verify the required parameter 'ruleId' is set
|
|
15847
|
+
if(ruleId===undefined||ruleId===null){throw'Missing the required parameter "ruleId" when calling deleteTaskmanagementWorktypeFlowsOncreateRule';}return this.apiClient.callApi('/api/v2/taskmanagement/worktypes/{worktypeId}/flows/oncreate/rules/{ruleId}','DELETE',{'worktypeId':worktypeId,'ruleId':ruleId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
15615
15848
|
* Delete a status
|
|
15616
15849
|
*
|
|
15617
15850
|
* @param {String} worktypeId Worktype id
|
|
@@ -15746,6 +15979,36 @@ if(schemaId===undefined||schemaId===null){throw'Missing the required parameter "
|
|
|
15746
15979
|
* @param {Array.<String>} opts.expands Which fields, if any, to expand.
|
|
15747
15980
|
*/},{key:"getTaskmanagementWorktype",value:function getTaskmanagementWorktype(worktypeId,opts){opts=opts||{};// verify the required parameter 'worktypeId' is set
|
|
15748
15981
|
if(worktypeId===undefined||worktypeId===null){throw'Missing the required parameter "worktypeId" when calling getTaskmanagementWorktype';}return this.apiClient.callApi('/api/v2/taskmanagement/worktypes/{worktypeId}','GET',{'worktypeId':worktypeId},{'expands':this.apiClient.buildCollectionParam(opts['expands'],'multi')},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
15982
|
+
* Get an attribute change rule
|
|
15983
|
+
*
|
|
15984
|
+
* @param {String} worktypeId Worktype id
|
|
15985
|
+
* @param {String} ruleId ruleId
|
|
15986
|
+
*/},{key:"getTaskmanagementWorktypeFlowsOnattributechangeRule",value:function getTaskmanagementWorktypeFlowsOnattributechangeRule(worktypeId,ruleId){// verify the required parameter 'worktypeId' is set
|
|
15987
|
+
if(worktypeId===undefined||worktypeId===null){throw'Missing the required parameter "worktypeId" when calling getTaskmanagementWorktypeFlowsOnattributechangeRule';}// verify the required parameter 'ruleId' is set
|
|
15988
|
+
if(ruleId===undefined||ruleId===null){throw'Missing the required parameter "ruleId" when calling getTaskmanagementWorktypeFlowsOnattributechangeRule';}return this.apiClient.callApi('/api/v2/taskmanagement/worktypes/{worktypeId}/flows/onattributechange/rules/{ruleId}','GET',{'worktypeId':worktypeId,'ruleId':ruleId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
15989
|
+
* Get all attribute-change rules for a worktype
|
|
15990
|
+
*
|
|
15991
|
+
* @param {String} worktypeId Worktype id
|
|
15992
|
+
* @param {Object} opts Optional parameters
|
|
15993
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
15994
|
+
* @param {Number} opts.pageSize Limit the number of entities to return. It is not guaranteed that the requested number of entities will be filled in a single request. If an `after` key is returned as part of the response it is possible that more entities that match the filter criteria exist. Maximum of 200. (default to 25)
|
|
15995
|
+
*/},{key:"getTaskmanagementWorktypeFlowsOnattributechangeRules",value:function getTaskmanagementWorktypeFlowsOnattributechangeRules(worktypeId,opts){opts=opts||{};// verify the required parameter 'worktypeId' is set
|
|
15996
|
+
if(worktypeId===undefined||worktypeId===null){throw'Missing the required parameter "worktypeId" when calling getTaskmanagementWorktypeFlowsOnattributechangeRules';}return this.apiClient.callApi('/api/v2/taskmanagement/worktypes/{worktypeId}/flows/onattributechange/rules','GET',{'worktypeId':worktypeId},{'after':opts['after'],'pageSize':opts['pageSize']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
15997
|
+
* Get an on-create rule
|
|
15998
|
+
*
|
|
15999
|
+
* @param {String} worktypeId Worktype id
|
|
16000
|
+
* @param {String} ruleId ruleId
|
|
16001
|
+
*/},{key:"getTaskmanagementWorktypeFlowsOncreateRule",value:function getTaskmanagementWorktypeFlowsOncreateRule(worktypeId,ruleId){// verify the required parameter 'worktypeId' is set
|
|
16002
|
+
if(worktypeId===undefined||worktypeId===null){throw'Missing the required parameter "worktypeId" when calling getTaskmanagementWorktypeFlowsOncreateRule';}// verify the required parameter 'ruleId' is set
|
|
16003
|
+
if(ruleId===undefined||ruleId===null){throw'Missing the required parameter "ruleId" when calling getTaskmanagementWorktypeFlowsOncreateRule';}return this.apiClient.callApi('/api/v2/taskmanagement/worktypes/{worktypeId}/flows/oncreate/rules/{ruleId}','GET',{'worktypeId':worktypeId,'ruleId':ruleId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
16004
|
+
* Get all on-create rules for a worktype
|
|
16005
|
+
*
|
|
16006
|
+
* @param {String} worktypeId Worktype id
|
|
16007
|
+
* @param {Object} opts Optional parameters
|
|
16008
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
16009
|
+
* @param {Number} opts.pageSize Limit the number of entities to return. It is not guaranteed that the requested number of entities will be filled in a single request. If an `after` key is returned as part of the response it is possible that more entities that match the filter criteria exist. Maximum of 200. (default to 25)
|
|
16010
|
+
*/},{key:"getTaskmanagementWorktypeFlowsOncreateRules",value:function getTaskmanagementWorktypeFlowsOncreateRules(worktypeId,opts){opts=opts||{};// verify the required parameter 'worktypeId' is set
|
|
16011
|
+
if(worktypeId===undefined||worktypeId===null){throw'Missing the required parameter "worktypeId" when calling getTaskmanagementWorktypeFlowsOncreateRules';}return this.apiClient.callApi('/api/v2/taskmanagement/worktypes/{worktypeId}/flows/oncreate/rules','GET',{'worktypeId':worktypeId},{'after':opts['after'],'pageSize':opts['pageSize']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
15749
16012
|
* Get a listing of a worktype's attribute change history
|
|
15750
16013
|
*
|
|
15751
16014
|
* @param {String} worktypeId Worktype id
|
|
@@ -15831,6 +16094,24 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
15831
16094
|
*/},{key:"patchTaskmanagementWorktype",value:function patchTaskmanagementWorktype(worktypeId,body){// verify the required parameter 'worktypeId' is set
|
|
15832
16095
|
if(worktypeId===undefined||worktypeId===null){throw'Missing the required parameter "worktypeId" when calling patchTaskmanagementWorktype';}// verify the required parameter 'body' is set
|
|
15833
16096
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling patchTaskmanagementWorktype';}return this.apiClient.callApi('/api/v2/taskmanagement/worktypes/{worktypeId}','PATCH',{'worktypeId':worktypeId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
16097
|
+
* Update the attributes of a rule
|
|
16098
|
+
*
|
|
16099
|
+
* @param {String} worktypeId Worktype id
|
|
16100
|
+
* @param {String} ruleId ruleId
|
|
16101
|
+
* @param {Object} body Rule
|
|
16102
|
+
*/},{key:"patchTaskmanagementWorktypeFlowsOnattributechangeRule",value:function patchTaskmanagementWorktypeFlowsOnattributechangeRule(worktypeId,ruleId,body){// verify the required parameter 'worktypeId' is set
|
|
16103
|
+
if(worktypeId===undefined||worktypeId===null){throw'Missing the required parameter "worktypeId" when calling patchTaskmanagementWorktypeFlowsOnattributechangeRule';}// verify the required parameter 'ruleId' is set
|
|
16104
|
+
if(ruleId===undefined||ruleId===null){throw'Missing the required parameter "ruleId" when calling patchTaskmanagementWorktypeFlowsOnattributechangeRule';}// verify the required parameter 'body' is set
|
|
16105
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling patchTaskmanagementWorktypeFlowsOnattributechangeRule';}return this.apiClient.callApi('/api/v2/taskmanagement/worktypes/{worktypeId}/flows/onattributechange/rules/{ruleId}','PATCH',{'worktypeId':worktypeId,'ruleId':ruleId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
16106
|
+
* Update the attributes of a rule
|
|
16107
|
+
*
|
|
16108
|
+
* @param {String} worktypeId Worktype id
|
|
16109
|
+
* @param {String} ruleId ruleId
|
|
16110
|
+
* @param {Object} body Rule
|
|
16111
|
+
*/},{key:"patchTaskmanagementWorktypeFlowsOncreateRule",value:function patchTaskmanagementWorktypeFlowsOncreateRule(worktypeId,ruleId,body){// verify the required parameter 'worktypeId' is set
|
|
16112
|
+
if(worktypeId===undefined||worktypeId===null){throw'Missing the required parameter "worktypeId" when calling patchTaskmanagementWorktypeFlowsOncreateRule';}// verify the required parameter 'ruleId' is set
|
|
16113
|
+
if(ruleId===undefined||ruleId===null){throw'Missing the required parameter "ruleId" when calling patchTaskmanagementWorktypeFlowsOncreateRule';}// verify the required parameter 'body' is set
|
|
16114
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling patchTaskmanagementWorktypeFlowsOncreateRule';}return this.apiClient.callApi('/api/v2/taskmanagement/worktypes/{worktypeId}/flows/oncreate/rules/{ruleId}','PATCH',{'worktypeId':worktypeId,'ruleId':ruleId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
15834
16115
|
* Update the attributes of a status
|
|
15835
16116
|
*
|
|
15836
16117
|
* @param {String} worktypeId Worktype id
|
|
@@ -15888,6 +16169,20 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
15888
16169
|
* @param {Object} body Schema
|
|
15889
16170
|
*/},{key:"postTaskmanagementWorkitemsSchemas",value:function postTaskmanagementWorkitemsSchemas(body){// verify the required parameter 'body' is set
|
|
15890
16171
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postTaskmanagementWorkitemsSchemas';}return this.apiClient.callApi('/api/v2/taskmanagement/workitems/schemas','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
16172
|
+
* Add an attribute-change rule to a worktype
|
|
16173
|
+
*
|
|
16174
|
+
* @param {String} worktypeId Worktype id
|
|
16175
|
+
* @param {Object} body Rule
|
|
16176
|
+
*/},{key:"postTaskmanagementWorktypeFlowsOnattributechangeRules",value:function postTaskmanagementWorktypeFlowsOnattributechangeRules(worktypeId,body){// verify the required parameter 'worktypeId' is set
|
|
16177
|
+
if(worktypeId===undefined||worktypeId===null){throw'Missing the required parameter "worktypeId" when calling postTaskmanagementWorktypeFlowsOnattributechangeRules';}// verify the required parameter 'body' is set
|
|
16178
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postTaskmanagementWorktypeFlowsOnattributechangeRules';}return this.apiClient.callApi('/api/v2/taskmanagement/worktypes/{worktypeId}/flows/onattributechange/rules','POST',{'worktypeId':worktypeId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
16179
|
+
* Add an on-create rule to a worktype
|
|
16180
|
+
*
|
|
16181
|
+
* @param {String} worktypeId Worktype id
|
|
16182
|
+
* @param {Object} body Rule
|
|
16183
|
+
*/},{key:"postTaskmanagementWorktypeFlowsOncreateRules",value:function postTaskmanagementWorktypeFlowsOncreateRules(worktypeId,body){// verify the required parameter 'worktypeId' is set
|
|
16184
|
+
if(worktypeId===undefined||worktypeId===null){throw'Missing the required parameter "worktypeId" when calling postTaskmanagementWorktypeFlowsOncreateRules';}// verify the required parameter 'body' is set
|
|
16185
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postTaskmanagementWorktypeFlowsOncreateRules';}return this.apiClient.callApi('/api/v2/taskmanagement/worktypes/{worktypeId}/flows/oncreate/rules','POST',{'worktypeId':worktypeId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
15891
16186
|
* Add a status to a worktype
|
|
15892
16187
|
*
|
|
15893
16188
|
* @param {String} worktypeId Worktype id
|
|
@@ -15914,7 +16209,7 @@ if(schemaId===undefined||schemaId===null){throw'Missing the required parameter "
|
|
|
15914
16209
|
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(){/**
|
|
15915
16210
|
* Teams service.
|
|
15916
16211
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
15917
|
-
* @version
|
|
16212
|
+
* @version 206.0.0
|
|
15918
16213
|
*//**
|
|
15919
16214
|
* Constructs a new TeamsApi.
|
|
15920
16215
|
* @alias module:purecloud-platform-client-v2/api/TeamsApi
|
|
@@ -15992,7 +16287,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
15992
16287
|
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(){/**
|
|
15993
16288
|
* Telephony service.
|
|
15994
16289
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
15995
|
-
* @version
|
|
16290
|
+
* @version 206.0.0
|
|
15996
16291
|
*//**
|
|
15997
16292
|
* Constructs a new TelephonyApi.
|
|
15998
16293
|
* @alias module:purecloud-platform-client-v2/api/TelephonyApi
|
|
@@ -16039,7 +16334,7 @@ if(downloadId===undefined||downloadId===null){throw'Missing the required paramet
|
|
|
16039
16334
|
if(sIPSearchPublicRequest===undefined||sIPSearchPublicRequest===null){throw'Missing the required parameter "sIPSearchPublicRequest" when calling postTelephonySiptracesDownload';}return this.apiClient.callApi('/api/v2/telephony/siptraces/download','POST',{},{},{},{},sIPSearchPublicRequest,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var TelephonyProvidersEdgeApi=/*#__PURE__*/function(){/**
|
|
16040
16335
|
* TelephonyProvidersEdge service.
|
|
16041
16336
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
16042
|
-
* @version
|
|
16337
|
+
* @version 206.0.0
|
|
16043
16338
|
*//**
|
|
16044
16339
|
* Constructs a new TelephonyProvidersEdgeApi.
|
|
16045
16340
|
* @alias module:purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
@@ -16064,6 +16359,9 @@ if(interfaceId===undefined||interfaceId===null){throw'Missing the required param
|
|
|
16064
16359
|
* @param {String} edgeId Edge ID
|
|
16065
16360
|
*/},{key:"deleteTelephonyProvidersEdgeSoftwareupdate",value:function deleteTelephonyProvidersEdgeSoftwareupdate(edgeId){// verify the required parameter 'edgeId' is set
|
|
16066
16361
|
if(edgeId===undefined||edgeId===null){throw'Missing the required parameter "edgeId" when calling deleteTelephonyProvidersEdgeSoftwareupdate';}return this.apiClient.callApi('/api/v2/telephony/providers/edges/{edgeId}/softwareupdate','DELETE',{'edgeId':edgeId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
16362
|
+
* Deletes alertable presences overrides.
|
|
16363
|
+
*
|
|
16364
|
+
*/},{key:"deleteTelephonyProvidersEdgesAlertablepresences",value:function deleteTelephonyProvidersEdgesAlertablepresences(){return this.apiClient.callApi('/api/v2/telephony/providers/edges/alertablepresences','DELETE',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
16067
16365
|
* Delete a certificate authority.
|
|
16068
16366
|
*
|
|
16069
16367
|
* @param {String} certificateId Certificate ID
|
|
@@ -16217,6 +16515,11 @@ if(edgeId===undefined||edgeId===null){throw'Missing the required parameter "edge
|
|
|
16217
16515
|
* @param {Boolean} opts.managed Filter by managed
|
|
16218
16516
|
* @param {Boolean} opts.showCloudMedia True to show the cloud media devices in the result. (default to true)
|
|
16219
16517
|
*/},{key:"getTelephonyProvidersEdges",value:function getTelephonyProvidersEdges(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/telephony/providers/edges','GET',{},{'pageSize':opts['pageSize'],'pageNumber':opts['pageNumber'],'name':opts['name'],'site.id':opts['siteId'],'edgeGroup.id':opts['edgeGroupId'],'sortBy':opts['sortBy'],'managed':opts['managed'],'showCloudMedia':opts['showCloudMedia']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
16518
|
+
* Get the list alertable presences. The 'type' query parameter can be used to If there are any overrides, this is the list of overrides; if there are no overrides, it is the default list.
|
|
16519
|
+
*
|
|
16520
|
+
* @param {Object} opts Optional parameters
|
|
16521
|
+
* @param {Object} opts.type
|
|
16522
|
+
*/},{key:"getTelephonyProvidersEdgesAlertablepresences",value:function getTelephonyProvidersEdgesAlertablepresences(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/telephony/providers/edges/alertablepresences','GET',{},{'type':opts['type']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
16220
16523
|
* Get the list of certificate authorities.
|
|
16221
16524
|
*
|
|
16222
16525
|
*/},{key:"getTelephonyProvidersEdgesCertificateauthorities",value:function getTelephonyProvidersEdgesCertificateauthorities(){return this.apiClient.callApi('/api/v2/telephony/providers/edges/certificateauthorities','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
@@ -16759,6 +17062,11 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
16759
17062
|
if(edgeId===undefined||edgeId===null){throw'Missing the required parameter "edgeId" when calling putTelephonyProvidersEdgeLogicalinterface';}// verify the required parameter 'interfaceId' is set
|
|
16760
17063
|
if(interfaceId===undefined||interfaceId===null){throw'Missing the required parameter "interfaceId" when calling putTelephonyProvidersEdgeLogicalinterface';}// verify the required parameter 'body' is set
|
|
16761
17064
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putTelephonyProvidersEdgeLogicalinterface';}return this.apiClient.callApi('/api/v2/telephony/providers/edges/{edgeId}/logicalinterfaces/{interfaceId}','PUT',{'edgeId':edgeId,'interfaceId':interfaceId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
17065
|
+
* Creates or updates alertable presences overrides.
|
|
17066
|
+
*
|
|
17067
|
+
* @param {Object} body Alertable Presences Overrides
|
|
17068
|
+
*/},{key:"putTelephonyProvidersEdgesAlertablepresences",value:function putTelephonyProvidersEdgesAlertablepresences(body){// verify the required parameter 'body' is set
|
|
17069
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putTelephonyProvidersEdgesAlertablepresences';}return this.apiClient.callApi('/api/v2/telephony/providers/edges/alertablepresences','PUT',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
16762
17070
|
* Update a certificate authority.
|
|
16763
17071
|
*
|
|
16764
17072
|
* @param {String} certificateId Certificate ID
|
|
@@ -16849,7 +17157,7 @@ if(trunkBaseSettingsId===undefined||trunkBaseSettingsId===null){throw'Missing th
|
|
|
16849
17157
|
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(){/**
|
|
16850
17158
|
* Textbots service.
|
|
16851
17159
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
16852
|
-
* @version
|
|
17160
|
+
* @version 206.0.0
|
|
16853
17161
|
*//**
|
|
16854
17162
|
* Constructs a new TextbotsApi.
|
|
16855
17163
|
* @alias module:purecloud-platform-client-v2/api/TextbotsApi
|
|
@@ -16884,7 +17192,7 @@ if(launchRequest===undefined||launchRequest===null){throw'Missing the required p
|
|
|
16884
17192
|
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(){/**
|
|
16885
17193
|
* Tokens service.
|
|
16886
17194
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
16887
|
-
* @version
|
|
17195
|
+
* @version 206.0.0
|
|
16888
17196
|
*//**
|
|
16889
17197
|
* Constructs a new TokensApi.
|
|
16890
17198
|
* @alias module:purecloud-platform-client-v2/api/TokensApi
|
|
@@ -16918,7 +17226,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
16918
17226
|
*/},{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(){/**
|
|
16919
17227
|
* Uploads service.
|
|
16920
17228
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
16921
|
-
* @version
|
|
17229
|
+
* @version 206.0.0
|
|
16922
17230
|
*//**
|
|
16923
17231
|
* Constructs a new UploadsApi.
|
|
16924
17232
|
* @alias module:purecloud-platform-client-v2/api/UploadsApi
|
|
@@ -16984,7 +17292,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
16984
17292
|
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(){/**
|
|
16985
17293
|
* Usage service.
|
|
16986
17294
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
16987
|
-
* @version
|
|
17295
|
+
* @version 206.0.0
|
|
16988
17296
|
*//**
|
|
16989
17297
|
* Constructs a new UsageApi.
|
|
16990
17298
|
* @alias module:purecloud-platform-client-v2/api/UsageApi
|
|
@@ -17038,7 +17346,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
17038
17346
|
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(){/**
|
|
17039
17347
|
* UserRecordings service.
|
|
17040
17348
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
17041
|
-
* @version
|
|
17349
|
+
* @version 206.0.0
|
|
17042
17350
|
*//**
|
|
17043
17351
|
* Constructs a new UserRecordingsApi.
|
|
17044
17352
|
* @alias module:purecloud-platform-client-v2/api/UserRecordingsApi
|
|
@@ -17095,7 +17403,7 @@ if(recordingId===undefined||recordingId===null){throw'Missing the required param
|
|
|
17095
17403
|
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(){/**
|
|
17096
17404
|
* Users service.
|
|
17097
17405
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
17098
|
-
* @version
|
|
17406
|
+
* @version 206.0.0
|
|
17099
17407
|
*//**
|
|
17100
17408
|
* Constructs a new UsersApi.
|
|
17101
17409
|
* @alias module:purecloud-platform-client-v2/api/UsersApi
|
|
@@ -17785,7 +18093,7 @@ if(verifierId===undefined||verifierId===null){throw'Missing the required paramet
|
|
|
17785
18093
|
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 UtilitiesApi=/*#__PURE__*/function(){/**
|
|
17786
18094
|
* Utilities service.
|
|
17787
18095
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
17788
|
-
* @version
|
|
18096
|
+
* @version 206.0.0
|
|
17789
18097
|
*//**
|
|
17790
18098
|
* Constructs a new UtilitiesApi.
|
|
17791
18099
|
* @alias module:purecloud-platform-client-v2/api/UtilitiesApi
|
|
@@ -17812,7 +18120,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
17812
18120
|
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(){/**
|
|
17813
18121
|
* Voicemail service.
|
|
17814
18122
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
17815
|
-
* @version
|
|
18123
|
+
* @version 206.0.0
|
|
17816
18124
|
*//**
|
|
17817
18125
|
* Constructs a new VoicemailApi.
|
|
17818
18126
|
* @alias module:purecloud-platform-client-v2/api/VoicemailApi
|
|
@@ -17961,7 +18269,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
17961
18269
|
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(){/**
|
|
17962
18270
|
* WebChat service.
|
|
17963
18271
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
17964
|
-
* @version
|
|
18272
|
+
* @version 206.0.0
|
|
17965
18273
|
*//**
|
|
17966
18274
|
* Constructs a new WebChatApi.
|
|
17967
18275
|
* @alias module:purecloud-platform-client-v2/api/WebChatApi
|
|
@@ -18096,7 +18404,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
18096
18404
|
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(){/**
|
|
18097
18405
|
* WebDeployments service.
|
|
18098
18406
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
18099
|
-
* @version
|
|
18407
|
+
* @version 206.0.0
|
|
18100
18408
|
*//**
|
|
18101
18409
|
* Constructs a new WebDeploymentsApi.
|
|
18102
18410
|
* @alias module:purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
@@ -18147,7 +18455,7 @@ if(configurationId===undefined||configurationId===null){throw'Missing the requir
|
|
|
18147
18455
|
* View configuration drafts
|
|
18148
18456
|
*
|
|
18149
18457
|
* @param {Object} opts Optional parameters
|
|
18150
|
-
* @param {Boolean} opts.showOnlyPublished
|
|
18458
|
+
* @param {Boolean} opts.showOnlyPublished Filter by published status.
|
|
18151
18459
|
*/},{key:"getWebdeploymentsConfigurations",value:function getWebdeploymentsConfigurations(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/webdeployments/configurations','GET',{},{'showOnlyPublished':opts['showOnlyPublished']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
18152
18460
|
* Get a deployment
|
|
18153
18461
|
*
|
|
@@ -18174,7 +18482,7 @@ if(deploymentId===undefined||deploymentId===null){throw'Missing the required par
|
|
|
18174
18482
|
* Get deployments
|
|
18175
18483
|
*
|
|
18176
18484
|
* @param {Object} opts Optional parameters
|
|
18177
|
-
* @param {Array.<String>} opts.expand The specified entity attributes will be filled. Comma separated values expected.
|
|
18485
|
+
* @param {Array.<String>} opts.expand The specified entity attributes will be filled. Comma separated values expected.
|
|
18178
18486
|
*/},{key:"getWebdeploymentsDeployments",value:function getWebdeploymentsDeployments(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/webdeployments/deployments','GET',{},{'expand':this.apiClient.buildCollectionParam(opts['expand'],'multi')},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
18179
18487
|
* Publish the configuration draft and create a new version
|
|
18180
18488
|
*
|
|
@@ -18217,7 +18525,7 @@ if(deploymentId===undefined||deploymentId===null){throw'Missing the required par
|
|
|
18217
18525
|
if(deployment===undefined||deployment===null){throw'Missing the required parameter "deployment" when calling putWebdeploymentsDeployment';}return this.apiClient.callApi('/api/v2/webdeployments/deployments/{deploymentId}','PUT',{'deploymentId':deploymentId},{},{},{},deployment,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var WebMessagingApi=/*#__PURE__*/function(){/**
|
|
18218
18526
|
* WebMessaging service.
|
|
18219
18527
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
18220
|
-
* @version
|
|
18528
|
+
* @version 206.0.0
|
|
18221
18529
|
*//**
|
|
18222
18530
|
* Constructs a new WebMessagingApi.
|
|
18223
18531
|
* @alias module:purecloud-platform-client-v2/api/WebMessagingApi
|
|
@@ -18233,7 +18541,7 @@ if(deployment===undefined||deployment===null){throw'Missing the required paramet
|
|
|
18233
18541
|
*/return _createClass(WebMessagingApi,[{key:"getWebmessagingMessages",value:function getWebmessagingMessages(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/webmessaging/messages','GET',{},{'pageSize':opts['pageSize'],'pageNumber':opts['pageNumber']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var WidgetsApi=/*#__PURE__*/function(){/**
|
|
18234
18542
|
* Widgets service.
|
|
18235
18543
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
18236
|
-
* @version
|
|
18544
|
+
* @version 206.0.0
|
|
18237
18545
|
*//**
|
|
18238
18546
|
* Constructs a new WidgetsApi.
|
|
18239
18547
|
* @alias module:purecloud-platform-client-v2/api/WidgetsApi
|
|
@@ -18268,7 +18576,7 @@ if(deploymentId===undefined||deploymentId===null){throw'Missing the required par
|
|
|
18268
18576
|
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(){/**
|
|
18269
18577
|
* WorkforceManagement service.
|
|
18270
18578
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
18271
|
-
* @version
|
|
18579
|
+
* @version 206.0.0
|
|
18272
18580
|
*//**
|
|
18273
18581
|
* Constructs a new WorkforceManagementApi.
|
|
18274
18582
|
* @alias module:purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
@@ -19242,6 +19550,13 @@ if(managementUnitId===undefined||managementUnitId===null){throw'Missing the requ
|
|
|
19242
19550
|
* @param {Object} opts.body body
|
|
19243
19551
|
*/},{key:"patchWorkforcemanagementManagementunitAgents",value:function patchWorkforcemanagementManagementunitAgents(managementUnitId,opts){opts=opts||{};// verify the required parameter 'managementUnitId' is set
|
|
19244
19552
|
if(managementUnitId===undefined||managementUnitId===null){throw'Missing the required parameter "managementUnitId" when calling patchWorkforcemanagementManagementunitAgents';}return this.apiClient.callApi('/api/v2/workforcemanagement/managementunits/{managementUnitId}/agents','PATCH',{'managementUnitId':managementUnitId},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
19553
|
+
* Updates agent work plan configuration
|
|
19554
|
+
*
|
|
19555
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
19556
|
+
* @param {Object} opts Optional parameters
|
|
19557
|
+
* @param {Object} opts.body body
|
|
19558
|
+
*/},{key:"patchWorkforcemanagementManagementunitAgentsWorkplansBulk",value:function patchWorkforcemanagementManagementunitAgentsWorkplansBulk(managementUnitId,opts){opts=opts||{};// verify the required parameter 'managementUnitId' is set
|
|
19559
|
+
if(managementUnitId===undefined||managementUnitId===null){throw'Missing the required parameter "managementUnitId" when calling patchWorkforcemanagementManagementunitAgentsWorkplansBulk';}return this.apiClient.callApi('/api/v2/workforcemanagement/managementunits/{managementUnitId}/agents/workplans/bulk','PATCH',{'managementUnitId':managementUnitId},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
19245
19560
|
* Updates a time off limit object.
|
|
19246
19561
|
* Updates time off limit object properties, but not daily values.
|
|
19247
19562
|
* @param {String} managementUnitId The ID of the management unit.
|
|
@@ -19726,6 +20041,14 @@ if(businessUnitId===undefined||businessUnitId===null){throw'Missing the required
|
|
|
19726
20041
|
* @param {String} hrisIntegrationId The ID of the HRIS integration for which time off types are queried.
|
|
19727
20042
|
*/},{key:"postWorkforcemanagementIntegrationsHriTimeofftypesJobs",value:function postWorkforcemanagementIntegrationsHriTimeofftypesJobs(hrisIntegrationId){// verify the required parameter 'hrisIntegrationId' is set
|
|
19728
20043
|
if(hrisIntegrationId===undefined||hrisIntegrationId===null){throw'Missing the required parameter "hrisIntegrationId" when calling postWorkforcemanagementIntegrationsHriTimeofftypesJobs';}return this.apiClient.callApi('/api/v2/workforcemanagement/integrations/hris/{hrisIntegrationId}/timeofftypes/jobs','POST',{'hrisIntegrationId':hrisIntegrationId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
20044
|
+
* Get agents work plans configuration
|
|
20045
|
+
*
|
|
20046
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
20047
|
+
* @param {Object} opts Optional parameters
|
|
20048
|
+
* @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
|
|
20049
|
+
* @param {Object} opts.body body
|
|
20050
|
+
*/},{key:"postWorkforcemanagementManagementunitAgentsWorkplansQuery",value:function postWorkforcemanagementManagementunitAgentsWorkplansQuery(managementUnitId,opts){opts=opts||{};// verify the required parameter 'managementUnitId' is set
|
|
20051
|
+
if(managementUnitId===undefined||managementUnitId===null){throw'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitAgentsWorkplansQuery';}return this.apiClient.callApi('/api/v2/workforcemanagement/managementunits/{managementUnitId}/agents/workplans/query','POST',{'managementUnitId':managementUnitId},{'forceDownloadService':opts['forceDownloadService']},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
19729
20052
|
* Query published schedules for given given time range for set of users
|
|
19730
20053
|
*
|
|
19731
20054
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
@@ -20034,7 +20357,7 @@ if(timeOffLimitId===undefined||timeOffLimitId===null){throw'Missing the required
|
|
|
20034
20357
|
* </pre>
|
|
20035
20358
|
* </p>
|
|
20036
20359
|
* @module purecloud-platform-client-v2/index
|
|
20037
|
-
* @version
|
|
20360
|
+
* @version 206.0.0
|
|
20038
20361
|
*/var platformClient=/*#__PURE__*/_createClass(function platformClient(){_classCallCheck(this,platformClient);/**
|
|
20039
20362
|
* The ApiClient constructor.
|
|
20040
20363
|
* @property {module:purecloud-platform-client-v2/ApiClient}
|