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
|
@@ -6168,7 +6168,7 @@ if(env)this.environment=env;else this.environment=this.host?this.host:'mypureclo
|
|
|
6168
6168
|
this.environment=this.environment.replace(/\/+$/,'');// Strip protocol and subdomain
|
|
6169
6169
|
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];}}}]);}();/**
|
|
6170
6170
|
* @module purecloud-platform-client-v2/ApiClient
|
|
6171
|
-
* @version
|
|
6171
|
+
* @version 206.0.0
|
|
6172
6172
|
*/var ApiClient=/*#__PURE__*/function(){/**
|
|
6173
6173
|
* Manages low level client-server communications, parameter marshalling, etc. There should not be any need for an
|
|
6174
6174
|
* application to use this class directly - the *Api and model classes provide the public API for the service. The
|
|
@@ -6480,7 +6480,7 @@ resolve(data);})["catch"](function(error){var data=error;if(error.response&&erro
|
|
|
6480
6480
|
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(){/**
|
|
6481
6481
|
* AgentAssistants service.
|
|
6482
6482
|
* @module purecloud-platform-client-v2/api/AgentAssistantsApi
|
|
6483
|
-
* @version
|
|
6483
|
+
* @version 206.0.0
|
|
6484
6484
|
*//**
|
|
6485
6485
|
* Constructs a new AgentAssistantsApi.
|
|
6486
6486
|
* @alias module:purecloud-platform-client-v2/api/AgentAssistantsApi
|
|
@@ -6581,7 +6581,7 @@ if(queueId===undefined||queueId===null){throw'Missing the required parameter "qu
|
|
|
6581
6581
|
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(){/**
|
|
6582
6582
|
* AgentCopilot service.
|
|
6583
6583
|
* @module purecloud-platform-client-v2/api/AgentCopilotApi
|
|
6584
|
-
* @version
|
|
6584
|
+
* @version 206.0.0
|
|
6585
6585
|
*//**
|
|
6586
6586
|
* Constructs a new AgentCopilotApi.
|
|
6587
6587
|
* @alias module:purecloud-platform-client-v2/api/AgentCopilotApi
|
|
@@ -6603,7 +6603,7 @@ if(assistantId===undefined||assistantId===null){throw'Missing the required param
|
|
|
6603
6603
|
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(){/**
|
|
6604
6604
|
* AgentUI service.
|
|
6605
6605
|
* @module purecloud-platform-client-v2/api/AgentUIApi
|
|
6606
|
-
* @version
|
|
6606
|
+
* @version 206.0.0
|
|
6607
6607
|
*//**
|
|
6608
6608
|
* Constructs a new AgentUIApi.
|
|
6609
6609
|
* @alias module:purecloud-platform-client-v2/api/AgentUIApi
|
|
@@ -6637,7 +6637,7 @@ if(agentId===undefined||agentId===null){throw'Missing the required parameter "ag
|
|
|
6637
6637
|
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(){/**
|
|
6638
6638
|
* Alerting service.
|
|
6639
6639
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
6640
|
-
* @version
|
|
6640
|
+
* @version 206.0.0
|
|
6641
6641
|
*//**
|
|
6642
6642
|
* Constructs a new AlertingApi.
|
|
6643
6643
|
* @alias module:purecloud-platform-client-v2/api/AlertingApi
|
|
@@ -6794,7 +6794,7 @@ if(ruleId===undefined||ruleId===null){throw'Missing the required parameter "rule
|
|
|
6794
6794
|
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(){/**
|
|
6795
6795
|
* Analytics service.
|
|
6796
6796
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
6797
|
-
* @version
|
|
6797
|
+
* @version 206.0.0
|
|
6798
6798
|
*//**
|
|
6799
6799
|
* Constructs a new AnalyticsApi.
|
|
6800
6800
|
* @alias module:purecloud-platform-client-v2/api/AnalyticsApi
|
|
@@ -7415,7 +7415,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
7415
7415
|
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(){/**
|
|
7416
7416
|
* Architect service.
|
|
7417
7417
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
7418
|
-
* @version
|
|
7418
|
+
* @version 206.0.0
|
|
7419
7419
|
*//**
|
|
7420
7420
|
* Constructs a new ArchitectApi.
|
|
7421
7421
|
* @alias module:purecloud-platform-client-v2/api/ArchitectApi
|
|
@@ -8507,7 +8507,7 @@ if(milestoneId===undefined||milestoneId===null){throw'Missing the required param
|
|
|
8507
8507
|
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(){/**
|
|
8508
8508
|
* Audit service.
|
|
8509
8509
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
8510
|
-
* @version
|
|
8510
|
+
* @version 206.0.0
|
|
8511
8511
|
*//**
|
|
8512
8512
|
* Constructs a new AuditApi.
|
|
8513
8513
|
* @alias module:purecloud-platform-client-v2/api/AuditApi
|
|
@@ -8557,7 +8557,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
8557
8557
|
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(){/**
|
|
8558
8558
|
* Authorization service.
|
|
8559
8559
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
8560
|
-
* @version
|
|
8560
|
+
* @version 206.0.0
|
|
8561
8561
|
*//**
|
|
8562
8562
|
* Constructs a new AuthorizationApi.
|
|
8563
8563
|
* @alias module:purecloud-platform-client-v2/api/AuthorizationApi
|
|
@@ -8880,7 +8880,7 @@ if(subjectId===undefined||subjectId===null){throw'Missing the required parameter
|
|
|
8880
8880
|
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(){/**
|
|
8881
8881
|
* Billing service.
|
|
8882
8882
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
8883
|
-
* @version
|
|
8883
|
+
* @version 206.0.0
|
|
8884
8884
|
*//**
|
|
8885
8885
|
* Constructs a new BillingApi.
|
|
8886
8886
|
* @alias module:purecloud-platform-client-v2/api/BillingApi
|
|
@@ -8904,7 +8904,7 @@ if(endDate===undefined||endDate===null){throw'Missing the required parameter "en
|
|
|
8904
8904
|
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(){/**
|
|
8905
8905
|
* CarrierServices service.
|
|
8906
8906
|
* @module purecloud-platform-client-v2/api/CarrierServicesApi
|
|
8907
|
-
* @version
|
|
8907
|
+
* @version 206.0.0
|
|
8908
8908
|
*//**
|
|
8909
8909
|
* Constructs a new CarrierServicesApi.
|
|
8910
8910
|
* @alias module:purecloud-platform-client-v2/api/CarrierServicesApi
|
|
@@ -8924,7 +8924,7 @@ if(phoneNumber===undefined||phoneNumber===null){throw'Missing the required param
|
|
|
8924
8924
|
*/},{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(){/**
|
|
8925
8925
|
* Chat service.
|
|
8926
8926
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
8927
|
-
* @version
|
|
8927
|
+
* @version 206.0.0
|
|
8928
8928
|
*//**
|
|
8929
8929
|
* Constructs a new ChatApi.
|
|
8930
8930
|
* @alias module:purecloud-platform-client-v2/api/ChatApi
|
|
@@ -9149,7 +9149,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
9149
9149
|
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(){/**
|
|
9150
9150
|
* Coaching service.
|
|
9151
9151
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
9152
|
-
* @version
|
|
9152
|
+
* @version 206.0.0
|
|
9153
9153
|
*//**
|
|
9154
9154
|
* Constructs a new CoachingApi.
|
|
9155
9155
|
* @alias module:purecloud-platform-client-v2/api/CoachingApi
|
|
@@ -9302,7 +9302,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
9302
9302
|
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(){/**
|
|
9303
9303
|
* ContentManagement service.
|
|
9304
9304
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
9305
|
-
* @version
|
|
9305
|
+
* @version 206.0.0
|
|
9306
9306
|
*//**
|
|
9307
9307
|
* Constructs a new ContentManagementApi.
|
|
9308
9308
|
* @alias module:purecloud-platform-client-v2/api/ContentManagementApi
|
|
@@ -9585,7 +9585,7 @@ if(tagId===undefined||tagId===null){throw'Missing the required parameter "tagId"
|
|
|
9585
9585
|
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(){/**
|
|
9586
9586
|
* Conversations service.
|
|
9587
9587
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
9588
|
-
* @version
|
|
9588
|
+
* @version 206.0.0
|
|
9589
9589
|
*//**
|
|
9590
9590
|
* Constructs a new ConversationsApi.
|
|
9591
9591
|
* @alias module:purecloud-platform-client-v2/api/ConversationsApi
|
|
@@ -9766,6 +9766,12 @@ if(suggestionId===undefined||suggestionId===null){throw'Missing the required par
|
|
|
9766
9766
|
* @param {Object} opts.state Suggestion state to filter Copilot suggestions.
|
|
9767
9767
|
*/},{key:"getConversationSuggestions",value:function getConversationSuggestions(conversationId,opts){opts=opts||{};// verify the required parameter 'conversationId' is set
|
|
9768
9768
|
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']);}/**
|
|
9769
|
+
* Get the summaries of the conversation.
|
|
9770
|
+
*
|
|
9771
|
+
* @param {String} conversationId Conversation ID
|
|
9772
|
+
* getConversationSummaries is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
9773
|
+
*/},{key:"getConversationSummaries",value:function getConversationSummaries(conversationId){// verify the required parameter 'conversationId' is set
|
|
9774
|
+
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']);}/**
|
|
9769
9775
|
* Get active conversations for the logged in user
|
|
9770
9776
|
*
|
|
9771
9777
|
* @param {Object} opts Optional parameters
|
|
@@ -10493,7 +10499,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
10493
10499
|
* @param {String} conversationId conversationId
|
|
10494
10500
|
* @param {String} participantId participantId
|
|
10495
10501
|
* @param {Object} body Parking update request
|
|
10496
|
-
* patchConversationsEmailParticipantParkingstate is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
10497
10502
|
*/},{key:"patchConversationsEmailParticipantParkingstate",value:function patchConversationsEmailParticipantParkingstate(conversationId,participantId,body){// verify the required parameter 'conversationId' is set
|
|
10498
10503
|
if(conversationId===undefined||conversationId===null){throw'Missing the required parameter "conversationId" when calling patchConversationsEmailParticipantParkingstate';}// verify the required parameter 'participantId' is set
|
|
10499
10504
|
if(participantId===undefined||participantId===null){throw'Missing the required parameter "participantId" when calling patchConversationsEmailParticipantParkingstate';}// verify the required parameter 'body' is set
|
|
@@ -11037,9 +11042,11 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
11037
11042
|
* 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.
|
|
11038
11043
|
* @param {String} integrationId integrationId
|
|
11039
11044
|
* @param {Object} body NormalizedMessage
|
|
11040
|
-
|
|
11045
|
+
* @param {Object} opts Optional parameters
|
|
11046
|
+
* @param {Boolean} opts.prefetchConversationId Indicates whether or not to prefetch conversationId (default to false)
|
|
11047
|
+
*/},{key:"postConversationsMessageInboundOpenMessage",value:function postConversationsMessageInboundOpenMessage(integrationId,body,opts){opts=opts||{};// verify the required parameter 'integrationId' is set
|
|
11041
11048
|
if(integrationId===undefined||integrationId===null){throw'Missing the required parameter "integrationId" when calling postConversationsMessageInboundOpenMessage';}// verify the required parameter 'body' is set
|
|
11042
|
-
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']);}/**
|
|
11049
|
+
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']);}/**
|
|
11043
11050
|
* Send an inbound Open Receipt Message
|
|
11044
11051
|
* 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.
|
|
11045
11052
|
* @param {String} integrationId integrationId
|
|
@@ -11306,7 +11313,7 @@ if(conversationId===undefined||conversationId===null){throw'Missing the required
|
|
|
11306
11313
|
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(){/**
|
|
11307
11314
|
* DataExtensions service.
|
|
11308
11315
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
11309
|
-
* @version
|
|
11316
|
+
* @version 206.0.0
|
|
11310
11317
|
*//**
|
|
11311
11318
|
* Constructs a new DataExtensionsApi.
|
|
11312
11319
|
* @alias module:purecloud-platform-client-v2/api/DataExtensionsApi
|
|
@@ -11327,7 +11334,7 @@ if(coretypeName===undefined||coretypeName===null){throw'Missing the required par
|
|
|
11327
11334
|
*/},{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(){/**
|
|
11328
11335
|
* Downloads service.
|
|
11329
11336
|
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
11330
|
-
* @version
|
|
11337
|
+
* @version 206.0.0
|
|
11331
11338
|
*//**
|
|
11332
11339
|
* Constructs a new DownloadsApi.
|
|
11333
11340
|
* @alias module:purecloud-platform-client-v2/api/DownloadsApi
|
|
@@ -11346,7 +11353,7 @@ if(coretypeName===undefined||coretypeName===null){throw'Missing the required par
|
|
|
11346
11353
|
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(){/**
|
|
11347
11354
|
* Emails service.
|
|
11348
11355
|
* @module purecloud-platform-client-v2/api/EmailsApi
|
|
11349
|
-
* @version
|
|
11356
|
+
* @version 206.0.0
|
|
11350
11357
|
*//**
|
|
11351
11358
|
* Constructs a new EmailsApi.
|
|
11352
11359
|
* @alias module:purecloud-platform-client-v2/api/EmailsApi
|
|
@@ -11364,7 +11371,7 @@ if(downloadId===undefined||downloadId===null){throw'Missing the required paramet
|
|
|
11364
11371
|
*/},{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(){/**
|
|
11365
11372
|
* EmployeeEngagement service.
|
|
11366
11373
|
* @module purecloud-platform-client-v2/api/EmployeeEngagementApi
|
|
11367
|
-
* @version
|
|
11374
|
+
* @version 206.0.0
|
|
11368
11375
|
*//**
|
|
11369
11376
|
* Constructs a new EmployeeEngagementApi.
|
|
11370
11377
|
* @alias module:purecloud-platform-client-v2/api/EmployeeEngagementApi
|
|
@@ -11402,7 +11409,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
11402
11409
|
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(){/**
|
|
11403
11410
|
* Events service.
|
|
11404
11411
|
* @module purecloud-platform-client-v2/api/EventsApi
|
|
11405
|
-
* @version
|
|
11412
|
+
* @version 206.0.0
|
|
11406
11413
|
*//**
|
|
11407
11414
|
* Constructs a new EventsApi.
|
|
11408
11415
|
* @alias module:purecloud-platform-client-v2/api/EventsApi
|
|
@@ -11427,7 +11434,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
11427
11434
|
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(){/**
|
|
11428
11435
|
* ExternalContacts service.
|
|
11429
11436
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
11430
|
-
* @version
|
|
11437
|
+
* @version 206.0.0
|
|
11431
11438
|
*//**
|
|
11432
11439
|
* Constructs a new ExternalContactsApi.
|
|
11433
11440
|
* @alias module:purecloud-platform-client-v2/api/ExternalContactsApi
|
|
@@ -11919,7 +11926,7 @@ if(relationshipId===undefined||relationshipId===null){throw'Missing the required
|
|
|
11919
11926
|
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(){/**
|
|
11920
11927
|
* Fax service.
|
|
11921
11928
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
11922
|
-
* @version
|
|
11929
|
+
* @version 206.0.0
|
|
11923
11930
|
*//**
|
|
11924
11931
|
* Constructs a new FaxApi.
|
|
11925
11932
|
* @alias module:purecloud-platform-client-v2/api/FaxApi
|
|
@@ -11968,7 +11975,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
11968
11975
|
*/},{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(){/**
|
|
11969
11976
|
* Flows service.
|
|
11970
11977
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
11971
|
-
* @version
|
|
11978
|
+
* @version 206.0.0
|
|
11972
11979
|
*//**
|
|
11973
11980
|
* Constructs a new FlowsApi.
|
|
11974
11981
|
* @alias module:purecloud-platform-client-v2/api/FlowsApi
|
|
@@ -12016,7 +12023,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
12016
12023
|
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(){/**
|
|
12017
12024
|
* Gamification service.
|
|
12018
12025
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
12019
|
-
* @version
|
|
12026
|
+
* @version 206.0.0
|
|
12020
12027
|
*//**
|
|
12021
12028
|
* Constructs a new GamificationApi.
|
|
12022
12029
|
* @alias module:purecloud-platform-client-v2/api/GamificationApi
|
|
@@ -12556,7 +12563,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
12556
12563
|
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(){/**
|
|
12557
12564
|
* GeneralDataProtectionRegulation service.
|
|
12558
12565
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
12559
|
-
* @version
|
|
12566
|
+
* @version 206.0.0
|
|
12560
12567
|
*//**
|
|
12561
12568
|
* Constructs a new GeneralDataProtectionRegulationApi.
|
|
12562
12569
|
* @alias module:purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
@@ -12591,7 +12598,7 @@ if(searchValue===undefined||searchValue===null){throw'Missing the required param
|
|
|
12591
12598
|
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(){/**
|
|
12592
12599
|
* Geolocation service.
|
|
12593
12600
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
12594
|
-
* @version
|
|
12601
|
+
* @version 206.0.0
|
|
12595
12602
|
*//**
|
|
12596
12603
|
* Constructs a new GeolocationApi.
|
|
12597
12604
|
* @alias module:purecloud-platform-client-v2/api/GeolocationApi
|
|
@@ -12625,7 +12632,7 @@ if(clientId===undefined||clientId===null){throw'Missing the required parameter "
|
|
|
12625
12632
|
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(){/**
|
|
12626
12633
|
* Greetings service.
|
|
12627
12634
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
12628
|
-
* @version
|
|
12635
|
+
* @version 206.0.0
|
|
12629
12636
|
*//**
|
|
12630
12637
|
* Constructs a new GreetingsApi.
|
|
12631
12638
|
* @alias module:purecloud-platform-client-v2/api/GreetingsApi
|
|
@@ -12732,7 +12739,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
12732
12739
|
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(){/**
|
|
12733
12740
|
* Groups service.
|
|
12734
12741
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
12735
|
-
* @version
|
|
12742
|
+
* @version 206.0.0
|
|
12736
12743
|
*//**
|
|
12737
12744
|
* Constructs a new GroupsApi.
|
|
12738
12745
|
* @alias module:purecloud-platform-client-v2/api/GroupsApi
|
|
@@ -12865,7 +12872,7 @@ if(groupId===undefined||groupId===null){throw'Missing the required parameter "gr
|
|
|
12865
12872
|
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(){/**
|
|
12866
12873
|
* IdentityProvider service.
|
|
12867
12874
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
12868
|
-
* @version
|
|
12875
|
+
* @version 206.0.0
|
|
12869
12876
|
*//**
|
|
12870
12877
|
* Constructs a new IdentityProviderApi.
|
|
12871
12878
|
* @alias module:purecloud-platform-client-v2/api/IdentityProviderApi
|
|
@@ -13021,7 +13028,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
13021
13028
|
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(){/**
|
|
13022
13029
|
* InfrastructureAsCode service.
|
|
13023
13030
|
* @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
13024
|
-
* @version
|
|
13031
|
+
* @version 206.0.0
|
|
13025
13032
|
*//**
|
|
13026
13033
|
* Constructs a new InfrastructureAsCodeApi.
|
|
13027
13034
|
* @alias module:purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
@@ -13075,7 +13082,7 @@ if(jobId===undefined||jobId===null){throw'Missing the required parameter "jobId"
|
|
|
13075
13082
|
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(){/**
|
|
13076
13083
|
* Integrations service.
|
|
13077
13084
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
13078
|
-
* @version
|
|
13085
|
+
* @version 206.0.0
|
|
13079
13086
|
*//**
|
|
13080
13087
|
* Constructs a new IntegrationsApi.
|
|
13081
13088
|
* @alias module:purecloud-platform-client-v2/api/IntegrationsApi
|
|
@@ -13700,7 +13707,7 @@ if(ucIntegrationId===undefined||ucIntegrationId===null){throw'Missing the requir
|
|
|
13700
13707
|
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(){/**
|
|
13701
13708
|
* Journey service.
|
|
13702
13709
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
13703
|
-
* @version
|
|
13710
|
+
* @version 206.0.0
|
|
13704
13711
|
*//**
|
|
13705
13712
|
* Constructs a new JourneyApi.
|
|
13706
13713
|
* @alias module:purecloud-platform-client-v2/api/JourneyApi
|
|
@@ -13912,6 +13919,26 @@ if(viewId===undefined||viewId===null){throw'Missing the required parameter "view
|
|
|
13912
13919
|
*/},{key:"getJourneyViewVersion",value:function getJourneyViewVersion(viewId,versionId){// verify the required parameter 'viewId' is set
|
|
13913
13920
|
if(viewId===undefined||viewId===null){throw'Missing the required parameter "viewId" when calling getJourneyViewVersion';}// verify the required parameter 'versionId' is set
|
|
13914
13921
|
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']);}/**
|
|
13922
|
+
* Get a Chart by ID
|
|
13923
|
+
* returns the latest version
|
|
13924
|
+
* @param {String} viewId viewId
|
|
13925
|
+
* @param {String} journeyViewVersion Journey View Version
|
|
13926
|
+
* @param {String} chartId chartId
|
|
13927
|
+
*/},{key:"getJourneyViewVersionChart",value:function getJourneyViewVersionChart(viewId,journeyViewVersion,chartId){// verify the required parameter 'viewId' is set
|
|
13928
|
+
if(viewId===undefined||viewId===null){throw'Missing the required parameter "viewId" when calling getJourneyViewVersionChart';}// verify the required parameter 'journeyViewVersion' is set
|
|
13929
|
+
if(journeyViewVersion===undefined||journeyViewVersion===null){throw'Missing the required parameter "journeyViewVersion" when calling getJourneyViewVersionChart';}// verify the required parameter 'chartId' is set
|
|
13930
|
+
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']);}/**
|
|
13931
|
+
* Get a Chart by ID and version
|
|
13932
|
+
*
|
|
13933
|
+
* @param {String} viewId viewId
|
|
13934
|
+
* @param {String} journeyViewVersion Journey View Version
|
|
13935
|
+
* @param {String} chartId chartId
|
|
13936
|
+
* @param {String} chartVersion chartVersion
|
|
13937
|
+
*/},{key:"getJourneyViewVersionChartVersion",value:function getJourneyViewVersionChartVersion(viewId,journeyViewVersion,chartId,chartVersion){// verify the required parameter 'viewId' is set
|
|
13938
|
+
if(viewId===undefined||viewId===null){throw'Missing the required parameter "viewId" when calling getJourneyViewVersionChartVersion';}// verify the required parameter 'journeyViewVersion' is set
|
|
13939
|
+
if(journeyViewVersion===undefined||journeyViewVersion===null){throw'Missing the required parameter "journeyViewVersion" when calling getJourneyViewVersionChartVersion';}// verify the required parameter 'chartId' is set
|
|
13940
|
+
if(chartId===undefined||chartId===null){throw'Missing the required parameter "chartId" when calling getJourneyViewVersionChartVersion';}// verify the required parameter 'chartVersion' is set
|
|
13941
|
+
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']);}/**
|
|
13915
13942
|
* Get the job for a journey view version.
|
|
13916
13943
|
* used for long descriptions
|
|
13917
13944
|
* @param {String} viewId Journey View Id
|
|
@@ -13930,6 +13957,17 @@ if(jobId===undefined||jobId===null){throw'Missing the required parameter "jobId"
|
|
|
13930
13957
|
if(viewId===undefined||viewId===null){throw'Missing the required parameter "viewId" when calling getJourneyViewVersionJobResults';}// verify the required parameter 'journeyViewVersion' is set
|
|
13931
13958
|
if(journeyViewVersion===undefined||journeyViewVersion===null){throw'Missing the required parameter "journeyViewVersion" when calling getJourneyViewVersionJobResults';}// verify the required parameter 'jobId' is set
|
|
13932
13959
|
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']);}/**
|
|
13960
|
+
* Get the chart result associated with a journey view job.
|
|
13961
|
+
*
|
|
13962
|
+
* @param {String} viewId Journey View Id
|
|
13963
|
+
* @param {String} journeyVersionId Journey View Version
|
|
13964
|
+
* @param {String} jobId JobId
|
|
13965
|
+
* @param {String} chartId ChartId
|
|
13966
|
+
*/},{key:"getJourneyViewVersionJobResultsChart",value:function getJourneyViewVersionJobResultsChart(viewId,journeyVersionId,jobId,chartId){// verify the required parameter 'viewId' is set
|
|
13967
|
+
if(viewId===undefined||viewId===null){throw'Missing the required parameter "viewId" when calling getJourneyViewVersionJobResultsChart';}// verify the required parameter 'journeyVersionId' is set
|
|
13968
|
+
if(journeyVersionId===undefined||journeyVersionId===null){throw'Missing the required parameter "journeyVersionId" when calling getJourneyViewVersionJobResultsChart';}// verify the required parameter 'jobId' is set
|
|
13969
|
+
if(jobId===undefined||jobId===null){throw'Missing the required parameter "jobId" when calling getJourneyViewVersionJobResultsChart';}// verify the required parameter 'chartId' is set
|
|
13970
|
+
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']);}/**
|
|
13933
13971
|
* Get the latest job of a journey view version.
|
|
13934
13972
|
* used for long descriptions
|
|
13935
13973
|
* @param {String} viewId Journey View Id
|
|
@@ -13999,6 +14037,17 @@ if(outcomeId===undefined||outcomeId===null){throw'Missing the required parameter
|
|
|
13999
14037
|
* @param {Object} opts.body
|
|
14000
14038
|
*/},{key:"patchJourneySegment",value:function patchJourneySegment(segmentId,opts){opts=opts||{};// verify the required parameter 'segmentId' is set
|
|
14001
14039
|
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']);}/**
|
|
14040
|
+
* Update the job for a journey view version. Only the status can be changed and only to Cancelled
|
|
14041
|
+
* used for long descriptions
|
|
14042
|
+
* @param {String} viewId Journey View Id
|
|
14043
|
+
* @param {String} journeyVersionId Journey View Version
|
|
14044
|
+
* @param {String} jobId JobId
|
|
14045
|
+
* @param {Object} body journeyViewJob
|
|
14046
|
+
*/},{key:"patchJourneyViewVersionJob",value:function patchJourneyViewVersionJob(viewId,journeyVersionId,jobId,body){// verify the required parameter 'viewId' is set
|
|
14047
|
+
if(viewId===undefined||viewId===null){throw'Missing the required parameter "viewId" when calling patchJourneyViewVersionJob';}// verify the required parameter 'journeyVersionId' is set
|
|
14048
|
+
if(journeyVersionId===undefined||journeyVersionId===null){throw'Missing the required parameter "journeyVersionId" when calling patchJourneyViewVersionJob';}// verify the required parameter 'jobId' is set
|
|
14049
|
+
if(jobId===undefined||jobId===null){throw'Missing the required parameter "jobId" when calling patchJourneyViewVersionJob';}// verify the required parameter 'body' is set
|
|
14050
|
+
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']);}/**
|
|
14002
14051
|
* Query for journey aggregates asynchronously
|
|
14003
14052
|
*
|
|
14004
14053
|
* @param {Object} body query
|
|
@@ -14096,10 +14145,19 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
14096
14145
|
* @param {Object} opts Optional parameters
|
|
14097
14146
|
* @param {Array.<Object>} opts.body
|
|
14098
14147
|
* postJourneyViewsEncodingsValidate is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
14099
|
-
*/},{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']);}
|
|
14148
|
+
*/},{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']);}/**
|
|
14149
|
+
* Update a Journey View by ID and version
|
|
14150
|
+
* does not create a new version
|
|
14151
|
+
* @param {String} viewId viewId
|
|
14152
|
+
* @param {String} versionId versionId
|
|
14153
|
+
* @param {Object} body JourneyView
|
|
14154
|
+
*/},{key:"putJourneyViewVersion",value:function putJourneyViewVersion(viewId,versionId,body){// verify the required parameter 'viewId' is set
|
|
14155
|
+
if(viewId===undefined||viewId===null){throw'Missing the required parameter "viewId" when calling putJourneyViewVersion';}// verify the required parameter 'versionId' is set
|
|
14156
|
+
if(versionId===undefined||versionId===null){throw'Missing the required parameter "versionId" when calling putJourneyViewVersion';}// verify the required parameter 'body' is set
|
|
14157
|
+
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(){/**
|
|
14100
14158
|
* Knowledge service.
|
|
14101
14159
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
14102
|
-
* @version
|
|
14160
|
+
* @version 206.0.0
|
|
14103
14161
|
*//**
|
|
14104
14162
|
* Constructs a new KnowledgeApi.
|
|
14105
14163
|
* @alias module:purecloud-platform-client-v2/api/KnowledgeApi
|
|
@@ -14186,6 +14244,30 @@ if(languageCode===undefined||languageCode===null){throw'Missing the required par
|
|
|
14186
14244
|
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling deleteKnowledgeKnowledgebaseLanguageDocumentsImport';}// verify the required parameter 'languageCode' is set
|
|
14187
14245
|
if(languageCode===undefined||languageCode===null){throw'Missing the required parameter "languageCode" when calling deleteKnowledgeKnowledgebaseLanguageDocumentsImport';}// verify the required parameter 'importId' is set
|
|
14188
14246
|
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']);}/**
|
|
14247
|
+
* Delete Salesforce Knowledge integration source
|
|
14248
|
+
*
|
|
14249
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
14250
|
+
* @param {String} sourceId Source ID
|
|
14251
|
+
* deleteKnowledgeKnowledgebaseSourcesSalesforceSourceId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
14252
|
+
*/},{key:"deleteKnowledgeKnowledgebaseSourcesSalesforceSourceId",value:function deleteKnowledgeKnowledgebaseSourcesSalesforceSourceId(knowledgeBaseId,sourceId){// verify the required parameter 'knowledgeBaseId' is set
|
|
14253
|
+
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling deleteKnowledgeKnowledgebaseSourcesSalesforceSourceId';}// verify the required parameter 'sourceId' is set
|
|
14254
|
+
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']);}/**
|
|
14255
|
+
* Delete ServiceNow Knowledge integration source
|
|
14256
|
+
*
|
|
14257
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
14258
|
+
* @param {String} sourceId Source ID
|
|
14259
|
+
* deleteKnowledgeKnowledgebaseSourcesServicenowSourceId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
14260
|
+
*/},{key:"deleteKnowledgeKnowledgebaseSourcesServicenowSourceId",value:function deleteKnowledgeKnowledgebaseSourcesServicenowSourceId(knowledgeBaseId,sourceId){// verify the required parameter 'knowledgeBaseId' is set
|
|
14261
|
+
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling deleteKnowledgeKnowledgebaseSourcesServicenowSourceId';}// verify the required parameter 'sourceId' is set
|
|
14262
|
+
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']);}/**
|
|
14263
|
+
* Delete synchronization job
|
|
14264
|
+
*
|
|
14265
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
14266
|
+
* @param {String} syncJobId Synchronization job ID
|
|
14267
|
+
* deleteKnowledgeKnowledgebaseSynchronizeJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
14268
|
+
*/},{key:"deleteKnowledgeKnowledgebaseSynchronizeJob",value:function deleteKnowledgeKnowledgebaseSynchronizeJob(knowledgeBaseId,syncJobId){// verify the required parameter 'knowledgeBaseId' is set
|
|
14269
|
+
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling deleteKnowledgeKnowledgebaseSynchronizeJob';}// verify the required parameter 'syncJobId' is set
|
|
14270
|
+
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']);}/**
|
|
14189
14271
|
* Get categories
|
|
14190
14272
|
*
|
|
14191
14273
|
* @param {String} sessionId Knowledge guest session ID.
|
|
@@ -14216,6 +14298,12 @@ if(documentId===undefined||documentId===null){throw'Missing the required paramet
|
|
|
14216
14298
|
* @param {Number} opts.pageSize Number of entities to return. Maximum of 200.
|
|
14217
14299
|
*/},{key:"getKnowledgeGuestSessionDocuments",value:function getKnowledgeGuestSessionDocuments(sessionId,opts){opts=opts||{};// verify the required parameter 'sessionId' is set
|
|
14218
14300
|
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']);}/**
|
|
14301
|
+
* Get sync options available for a knowledge-connect integration
|
|
14302
|
+
*
|
|
14303
|
+
* @param {String} integrationId Integration ID
|
|
14304
|
+
* getKnowledgeIntegrationOptions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
14305
|
+
*/},{key:"getKnowledgeIntegrationOptions",value:function getKnowledgeIntegrationOptions(integrationId){// verify the required parameter 'integrationId' is set
|
|
14306
|
+
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']);}/**
|
|
14219
14307
|
* Get knowledge base
|
|
14220
14308
|
*
|
|
14221
14309
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
@@ -14532,6 +14620,44 @@ if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the requir
|
|
|
14532
14620
|
*/},{key:"getKnowledgeKnowledgebaseParseJob",value:function getKnowledgeKnowledgebaseParseJob(knowledgeBaseId,parseJobId,opts){opts=opts||{};// verify the required parameter 'knowledgeBaseId' is set
|
|
14533
14621
|
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseParseJob';}// verify the required parameter 'parseJobId' is set
|
|
14534
14622
|
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']);}/**
|
|
14623
|
+
* Get Knowledge integration sources
|
|
14624
|
+
*
|
|
14625
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
14626
|
+
* @param {Object} opts Optional parameters
|
|
14627
|
+
* @param {Object} opts.type If specified, retrieves integration sources with specified integration type.
|
|
14628
|
+
* @param {Array.<String>} opts.expand The specified entity attributes will be filled. Comma separated values expected.
|
|
14629
|
+
* @param {Array.<String>} opts.ids If specified, retrieves integration sources with specified IDs.
|
|
14630
|
+
* getKnowledgeKnowledgebaseSources is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
14631
|
+
*/},{key:"getKnowledgeKnowledgebaseSources",value:function getKnowledgeKnowledgebaseSources(knowledgeBaseId,opts){opts=opts||{};// verify the required parameter 'knowledgeBaseId' is set
|
|
14632
|
+
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']);}/**
|
|
14633
|
+
* Get Salesforce Knowledge integration source
|
|
14634
|
+
*
|
|
14635
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
14636
|
+
* @param {String} sourceId Source ID
|
|
14637
|
+
* @param {Object} opts Optional parameters
|
|
14638
|
+
* @param {Array.<String>} opts.expand The specified entity attributes will be filled. Comma separated values expected.
|
|
14639
|
+
* getKnowledgeKnowledgebaseSourcesSalesforceSourceId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
14640
|
+
*/},{key:"getKnowledgeKnowledgebaseSourcesSalesforceSourceId",value:function getKnowledgeKnowledgebaseSourcesSalesforceSourceId(knowledgeBaseId,sourceId,opts){opts=opts||{};// verify the required parameter 'knowledgeBaseId' is set
|
|
14641
|
+
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseSourcesSalesforceSourceId';}// verify the required parameter 'sourceId' is set
|
|
14642
|
+
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']);}/**
|
|
14643
|
+
* Get ServiceNow Knowledge integration source
|
|
14644
|
+
*
|
|
14645
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
14646
|
+
* @param {String} sourceId Source ID
|
|
14647
|
+
* @param {Object} opts Optional parameters
|
|
14648
|
+
* @param {Array.<String>} opts.expand The specified entity attributes will be filled. Comma separated values expected.
|
|
14649
|
+
* getKnowledgeKnowledgebaseSourcesServicenowSourceId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
14650
|
+
*/},{key:"getKnowledgeKnowledgebaseSourcesServicenowSourceId",value:function getKnowledgeKnowledgebaseSourcesServicenowSourceId(knowledgeBaseId,sourceId,opts){opts=opts||{};// verify the required parameter 'knowledgeBaseId' is set
|
|
14651
|
+
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseSourcesServicenowSourceId';}// verify the required parameter 'sourceId' is set
|
|
14652
|
+
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']);}/**
|
|
14653
|
+
* Get synchronization job report
|
|
14654
|
+
*
|
|
14655
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
14656
|
+
* @param {String} syncJobId Synchronization job ID
|
|
14657
|
+
* getKnowledgeKnowledgebaseSynchronizeJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
14658
|
+
*/},{key:"getKnowledgeKnowledgebaseSynchronizeJob",value:function getKnowledgeKnowledgebaseSynchronizeJob(knowledgeBaseId,syncJobId){// verify the required parameter 'knowledgeBaseId' is set
|
|
14659
|
+
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseSynchronizeJob';}// verify the required parameter 'syncJobId' is set
|
|
14660
|
+
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']);}/**
|
|
14535
14661
|
* Get knowledge base unanswered group for a particular groupId
|
|
14536
14662
|
*
|
|
14537
14663
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
@@ -14725,6 +14851,16 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
14725
14851
|
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling patchKnowledgeKnowledgebaseParseJob';}// verify the required parameter 'parseJobId' is set
|
|
14726
14852
|
if(parseJobId===undefined||parseJobId===null){throw'Missing the required parameter "parseJobId" when calling patchKnowledgeKnowledgebaseParseJob';}// verify the required parameter 'body' is set
|
|
14727
14853
|
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']);}/**
|
|
14854
|
+
* Update synchronization job
|
|
14855
|
+
*
|
|
14856
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
14857
|
+
* @param {String} syncJobId Synchronization job ID
|
|
14858
|
+
* @param {Object} body
|
|
14859
|
+
* patchKnowledgeKnowledgebaseSynchronizeJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
14860
|
+
*/},{key:"patchKnowledgeKnowledgebaseSynchronizeJob",value:function patchKnowledgeKnowledgebaseSynchronizeJob(knowledgeBaseId,syncJobId,body){// verify the required parameter 'knowledgeBaseId' is set
|
|
14861
|
+
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling patchKnowledgeKnowledgebaseSynchronizeJob';}// verify the required parameter 'syncJobId' is set
|
|
14862
|
+
if(syncJobId===undefined||syncJobId===null){throw'Missing the required parameter "syncJobId" when calling patchKnowledgeKnowledgebaseSynchronizeJob';}// verify the required parameter 'body' is set
|
|
14863
|
+
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']);}/**
|
|
14728
14864
|
* Update a Knowledge base unanswered phrase group
|
|
14729
14865
|
*
|
|
14730
14866
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
@@ -15030,6 +15166,46 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
15030
15166
|
* @deprecated
|
|
15031
15167
|
*/},{key:"postKnowledgeKnowledgebaseSearch",value:function postKnowledgeKnowledgebaseSearch(knowledgeBaseId,opts){opts=opts||{};// verify the required parameter 'knowledgeBaseId' is set
|
|
15032
15168
|
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']);}/**
|
|
15169
|
+
* Create Salesforce Knowledge integration source
|
|
15170
|
+
*
|
|
15171
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
15172
|
+
* @param {Object} body
|
|
15173
|
+
* postKnowledgeKnowledgebaseSourcesSalesforce is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
15174
|
+
*/},{key:"postKnowledgeKnowledgebaseSourcesSalesforce",value:function postKnowledgeKnowledgebaseSourcesSalesforce(knowledgeBaseId,body){// verify the required parameter 'knowledgeBaseId' is set
|
|
15175
|
+
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseSourcesSalesforce';}// verify the required parameter 'body' is set
|
|
15176
|
+
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']);}/**
|
|
15177
|
+
* Start sync on Salesforce Knowledge integration source
|
|
15178
|
+
*
|
|
15179
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
15180
|
+
* @param {String} sourceId Source ID
|
|
15181
|
+
* postKnowledgeKnowledgebaseSourcesSalesforceSourceIdSync is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
15182
|
+
*/},{key:"postKnowledgeKnowledgebaseSourcesSalesforceSourceIdSync",value:function postKnowledgeKnowledgebaseSourcesSalesforceSourceIdSync(knowledgeBaseId,sourceId){// verify the required parameter 'knowledgeBaseId' is set
|
|
15183
|
+
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseSourcesSalesforceSourceIdSync';}// verify the required parameter 'sourceId' is set
|
|
15184
|
+
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']);}/**
|
|
15185
|
+
* Create ServiceNow Knowledge integration source
|
|
15186
|
+
*
|
|
15187
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
15188
|
+
* @param {Object} body
|
|
15189
|
+
* postKnowledgeKnowledgebaseSourcesServicenow is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
15190
|
+
*/},{key:"postKnowledgeKnowledgebaseSourcesServicenow",value:function postKnowledgeKnowledgebaseSourcesServicenow(knowledgeBaseId,body){// verify the required parameter 'knowledgeBaseId' is set
|
|
15191
|
+
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseSourcesServicenow';}// verify the required parameter 'body' is set
|
|
15192
|
+
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']);}/**
|
|
15193
|
+
* Start synchronization on ServiceNow Knowledge integration source
|
|
15194
|
+
*
|
|
15195
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
15196
|
+
* @param {String} sourceId Source ID
|
|
15197
|
+
* postKnowledgeKnowledgebaseSourcesServicenowSourceIdSync is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
15198
|
+
*/},{key:"postKnowledgeKnowledgebaseSourcesServicenowSourceIdSync",value:function postKnowledgeKnowledgebaseSourcesServicenowSourceIdSync(knowledgeBaseId,sourceId){// verify the required parameter 'knowledgeBaseId' is set
|
|
15199
|
+
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseSourcesServicenowSourceIdSync';}// verify the required parameter 'sourceId' is set
|
|
15200
|
+
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']);}/**
|
|
15201
|
+
* Create synchronization job
|
|
15202
|
+
*
|
|
15203
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
15204
|
+
* @param {Object} body
|
|
15205
|
+
* postKnowledgeKnowledgebaseSynchronizeJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
15206
|
+
*/},{key:"postKnowledgeKnowledgebaseSynchronizeJobs",value:function postKnowledgeKnowledgebaseSynchronizeJobs(knowledgeBaseId,body){// verify the required parameter 'knowledgeBaseId' is set
|
|
15207
|
+
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseSynchronizeJobs';}// verify the required parameter 'body' is set
|
|
15208
|
+
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']);}/**
|
|
15033
15209
|
* Create content upload from URL job
|
|
15034
15210
|
*
|
|
15035
15211
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
@@ -15042,10 +15218,30 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
15042
15218
|
*
|
|
15043
15219
|
* @param {Object} body
|
|
15044
15220
|
*/},{key:"postKnowledgeKnowledgebases",value:function postKnowledgeKnowledgebases(body){// verify the required parameter 'body' is set
|
|
15045
|
-
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']);}
|
|
15221
|
+
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']);}/**
|
|
15222
|
+
* Update Salesforce Knowledge integration source
|
|
15223
|
+
*
|
|
15224
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
15225
|
+
* @param {String} sourceId Source ID
|
|
15226
|
+
* @param {Object} body
|
|
15227
|
+
* putKnowledgeKnowledgebaseSourcesSalesforceSourceId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
15228
|
+
*/},{key:"putKnowledgeKnowledgebaseSourcesSalesforceSourceId",value:function putKnowledgeKnowledgebaseSourcesSalesforceSourceId(knowledgeBaseId,sourceId,body){// verify the required parameter 'knowledgeBaseId' is set
|
|
15229
|
+
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling putKnowledgeKnowledgebaseSourcesSalesforceSourceId';}// verify the required parameter 'sourceId' is set
|
|
15230
|
+
if(sourceId===undefined||sourceId===null){throw'Missing the required parameter "sourceId" when calling putKnowledgeKnowledgebaseSourcesSalesforceSourceId';}// verify the required parameter 'body' is set
|
|
15231
|
+
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']);}/**
|
|
15232
|
+
* Update ServiceNow Knowledge integration source
|
|
15233
|
+
*
|
|
15234
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
15235
|
+
* @param {String} sourceId Source ID
|
|
15236
|
+
* @param {Object} body
|
|
15237
|
+
* putKnowledgeKnowledgebaseSourcesServicenowSourceId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
15238
|
+
*/},{key:"putKnowledgeKnowledgebaseSourcesServicenowSourceId",value:function putKnowledgeKnowledgebaseSourcesServicenowSourceId(knowledgeBaseId,sourceId,body){// verify the required parameter 'knowledgeBaseId' is set
|
|
15239
|
+
if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the required parameter "knowledgeBaseId" when calling putKnowledgeKnowledgebaseSourcesServicenowSourceId';}// verify the required parameter 'sourceId' is set
|
|
15240
|
+
if(sourceId===undefined||sourceId===null){throw'Missing the required parameter "sourceId" when calling putKnowledgeKnowledgebaseSourcesServicenowSourceId';}// verify the required parameter 'body' is set
|
|
15241
|
+
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(){/**
|
|
15046
15242
|
* LanguageUnderstanding service.
|
|
15047
15243
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
15048
|
-
* @version
|
|
15244
|
+
* @version 206.0.0
|
|
15049
15245
|
*//**
|
|
15050
15246
|
* Constructs a new LanguageUnderstandingApi.
|
|
15051
15247
|
* @alias module:purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
@@ -15305,7 +15501,7 @@ if(domainVersionId===undefined||domainVersionId===null){throw'Missing the requir
|
|
|
15305
15501
|
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(){/**
|
|
15306
15502
|
* Languages service.
|
|
15307
15503
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
15308
|
-
* @version
|
|
15504
|
+
* @version 206.0.0
|
|
15309
15505
|
*//**
|
|
15310
15506
|
* Constructs a new LanguagesApi.
|
|
15311
15507
|
* @alias module:purecloud-platform-client-v2/api/LanguagesApi
|
|
@@ -15360,7 +15556,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
15360
15556
|
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(){/**
|
|
15361
15557
|
* Learning service.
|
|
15362
15558
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
15363
|
-
* @version
|
|
15559
|
+
* @version 206.0.0
|
|
15364
15560
|
*//**
|
|
15365
15561
|
* Constructs a new LearningApi.
|
|
15366
15562
|
* @alias module:purecloud-platform-client-v2/api/LearningApi
|
|
@@ -15631,7 +15827,7 @@ if(moduleId===undefined||moduleId===null){throw'Missing the required parameter "
|
|
|
15631
15827
|
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(){/**
|
|
15632
15828
|
* License service.
|
|
15633
15829
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
15634
|
-
* @version
|
|
15830
|
+
* @version 206.0.0
|
|
15635
15831
|
*//**
|
|
15636
15832
|
* Constructs a new LicenseApi.
|
|
15637
15833
|
* @alias module:purecloud-platform-client-v2/api/LicenseApi
|
|
@@ -15685,7 +15881,7 @@ if(featureName===undefined||featureName===null){throw'Missing the required param
|
|
|
15685
15881
|
*/},{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(){/**
|
|
15686
15882
|
* Locations service.
|
|
15687
15883
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
15688
|
-
* @version
|
|
15884
|
+
* @version 206.0.0
|
|
15689
15885
|
*//**
|
|
15690
15886
|
* Constructs a new LocationsApi.
|
|
15691
15887
|
* @alias module:purecloud-platform-client-v2/api/LocationsApi
|
|
@@ -15744,7 +15940,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
15744
15940
|
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(){/**
|
|
15745
15941
|
* LogCapture service.
|
|
15746
15942
|
* @module purecloud-platform-client-v2/api/LogCaptureApi
|
|
15747
|
-
* @version
|
|
15943
|
+
* @version 206.0.0
|
|
15748
15944
|
*//**
|
|
15749
15945
|
* Constructs a new LogCaptureApi.
|
|
15750
15946
|
* @alias module:purecloud-platform-client-v2/api/LogCaptureApi
|
|
@@ -15794,7 +15990,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
15794
15990
|
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(){/**
|
|
15795
15991
|
* Messaging service.
|
|
15796
15992
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
15797
|
-
* @version
|
|
15993
|
+
* @version 206.0.0
|
|
15798
15994
|
*//**
|
|
15799
15995
|
* Constructs a new MessagingApi.
|
|
15800
15996
|
* @alias module:purecloud-platform-client-v2/api/MessagingApi
|
|
@@ -15884,7 +16080,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
15884
16080
|
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(){/**
|
|
15885
16081
|
* MobileDevices service.
|
|
15886
16082
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
15887
|
-
* @version
|
|
16083
|
+
* @version 206.0.0
|
|
15888
16084
|
*//**
|
|
15889
16085
|
* Constructs a new MobileDevicesApi.
|
|
15890
16086
|
* @alias module:purecloud-platform-client-v2/api/MobileDevicesApi
|
|
@@ -15923,7 +16119,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
15923
16119
|
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(){/**
|
|
15924
16120
|
* Notifications service.
|
|
15925
16121
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
15926
|
-
* @version
|
|
16122
|
+
* @version 206.0.0
|
|
15927
16123
|
*//**
|
|
15928
16124
|
* Constructs a new NotificationsApi.
|
|
15929
16125
|
* @alias module:purecloud-platform-client-v2/api/NotificationsApi
|
|
@@ -15980,7 +16176,7 @@ if(channelId===undefined||channelId===null){throw'Missing the required parameter
|
|
|
15980
16176
|
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(){/**
|
|
15981
16177
|
* OAuth service.
|
|
15982
16178
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
15983
|
-
* @version
|
|
16179
|
+
* @version 206.0.0
|
|
15984
16180
|
*//**
|
|
15985
16181
|
* Constructs a new OAuthApi.
|
|
15986
16182
|
* @alias module:purecloud-platform-client-v2/api/OAuthApi
|
|
@@ -16065,7 +16261,7 @@ if(clientId===undefined||clientId===null){throw'Missing the required parameter "
|
|
|
16065
16261
|
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(){/**
|
|
16066
16262
|
* Objects service.
|
|
16067
16263
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
16068
|
-
* @version
|
|
16264
|
+
* @version 206.0.0
|
|
16069
16265
|
*//**
|
|
16070
16266
|
* Constructs a new ObjectsApi.
|
|
16071
16267
|
* @alias module:purecloud-platform-client-v2/api/ObjectsApi
|
|
@@ -16136,7 +16332,7 @@ if(divisionId===undefined||divisionId===null){throw'Missing the required paramet
|
|
|
16136
16332
|
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(){/**
|
|
16137
16333
|
* OperationalEvents service.
|
|
16138
16334
|
* @module purecloud-platform-client-v2/api/OperationalEventsApi
|
|
16139
|
-
* @version
|
|
16335
|
+
* @version 206.0.0
|
|
16140
16336
|
*//**
|
|
16141
16337
|
* Constructs a new OperationalEventsApi.
|
|
16142
16338
|
* @alias module:purecloud-platform-client-v2/api/OperationalEventsApi
|
|
@@ -16154,7 +16350,7 @@ if(eventDefinitionId===undefined||eventDefinitionId===null){throw'Missing the re
|
|
|
16154
16350
|
*/},{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(){/**
|
|
16155
16351
|
* Organization service.
|
|
16156
16352
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
16157
|
-
* @version
|
|
16353
|
+
* @version 206.0.0
|
|
16158
16354
|
*//**
|
|
16159
16355
|
* Constructs a new OrganizationApi.
|
|
16160
16356
|
* @alias module:purecloud-platform-client-v2/api/OrganizationApi
|
|
@@ -16279,7 +16475,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
16279
16475
|
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(){/**
|
|
16280
16476
|
* OrganizationAuthorization service.
|
|
16281
16477
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
16282
|
-
* @version
|
|
16478
|
+
* @version 206.0.0
|
|
16283
16479
|
*//**
|
|
16284
16480
|
* Constructs a new OrganizationAuthorizationApi.
|
|
16285
16481
|
* @alias module:purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
@@ -16602,7 +16798,7 @@ if(trustorOrgId===undefined||trustorOrgId===null){throw'Missing the required par
|
|
|
16602
16798
|
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(){/**
|
|
16603
16799
|
* Outbound service.
|
|
16604
16800
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
16605
|
-
* @version
|
|
16801
|
+
* @version 206.0.0
|
|
16606
16802
|
*//**
|
|
16607
16803
|
* Constructs a new OutboundApi.
|
|
16608
16804
|
* @alias module:purecloud-platform-client-v2/api/OutboundApi
|
|
@@ -16855,6 +17051,14 @@ if(campaignId===undefined||campaignId===null){throw'Missing the required paramet
|
|
|
16855
17051
|
* @param {String} campaignId Campaign ID
|
|
16856
17052
|
*/},{key:"getOutboundCampaignProgress",value:function getOutboundCampaignProgress(campaignId){// verify the required parameter 'campaignId' is set
|
|
16857
17053
|
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']);}/**
|
|
17054
|
+
* Get the remaining and total contact count for each skill combination in a skills campaign
|
|
17055
|
+
*
|
|
17056
|
+
* @param {String} campaignId Campaign ID
|
|
17057
|
+
* @param {Object} opts Optional parameters
|
|
17058
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
17059
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
17060
|
+
*/},{key:"getOutboundCampaignSkillcombinations",value:function getOutboundCampaignSkillcombinations(campaignId,opts){opts=opts||{};// verify the required parameter 'campaignId' is set
|
|
17061
|
+
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']);}/**
|
|
16858
17062
|
* Get statistics about a Dialer Campaign
|
|
16859
17063
|
*
|
|
16860
17064
|
* @param {String} campaignId Campaign ID
|
|
@@ -17681,7 +17885,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
17681
17885
|
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(){/**
|
|
17682
17886
|
* Presence service.
|
|
17683
17887
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
17684
|
-
* @version
|
|
17888
|
+
* @version 206.0.0
|
|
17685
17889
|
*//**
|
|
17686
17890
|
* Constructs a new PresenceApi.
|
|
17687
17891
|
* @alias module:purecloud-platform-client-v2/api/PresenceApi
|
|
@@ -17854,7 +18058,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
17854
18058
|
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(){/**
|
|
17855
18059
|
* ProcessAutomation service.
|
|
17856
18060
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
17857
|
-
* @version
|
|
18061
|
+
* @version 206.0.0
|
|
17858
18062
|
*//**
|
|
17859
18063
|
* Constructs a new ProcessAutomationApi.
|
|
17860
18064
|
* @alias module:purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
@@ -17917,7 +18121,7 @@ if(triggerId===undefined||triggerId===null){throw'Missing the required parameter
|
|
|
17917
18121
|
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(){/**
|
|
17918
18122
|
* Quality service.
|
|
17919
18123
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
17920
|
-
* @version
|
|
18124
|
+
* @version 206.0.0
|
|
17921
18125
|
*//**
|
|
17922
18126
|
* Constructs a new QualityApi.
|
|
17923
18127
|
* @alias module:purecloud-platform-client-v2/api/QualityApi
|
|
@@ -18394,7 +18598,7 @@ if(customerSurveyUrl===undefined||customerSurveyUrl===null){throw'Missing the re
|
|
|
18394
18598
|
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(){/**
|
|
18395
18599
|
* Recording service.
|
|
18396
18600
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
18397
|
-
* @version
|
|
18601
|
+
* @version 206.0.0
|
|
18398
18602
|
*//**
|
|
18399
18603
|
* Constructs a new RecordingApi.
|
|
18400
18604
|
* @alias module:purecloud-platform-client-v2/api/RecordingApi
|
|
@@ -18806,7 +19010,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
18806
19010
|
*/},{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(){/**
|
|
18807
19011
|
* ResponseManagement service.
|
|
18808
19012
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
18809
|
-
* @version
|
|
19013
|
+
* @version 206.0.0
|
|
18810
19014
|
*//**
|
|
18811
19015
|
* Constructs a new ResponseManagementApi.
|
|
18812
19016
|
* @alias module:purecloud-platform-client-v2/api/ResponseManagementApi
|
|
@@ -18927,7 +19131,7 @@ if(responseAssetId===undefined||responseAssetId===null){throw'Missing the requir
|
|
|
18927
19131
|
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(){/**
|
|
18928
19132
|
* Routing service.
|
|
18929
19133
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
18930
|
-
* @version
|
|
19134
|
+
* @version 206.0.0
|
|
18931
19135
|
*//**
|
|
18932
19136
|
* Constructs a new RoutingApi.
|
|
18933
19137
|
* @alias module:purecloud-platform-client-v2/api/RoutingApi
|
|
@@ -19931,7 +20135,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
19931
20135
|
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(){/**
|
|
19932
20136
|
* SCIM service.
|
|
19933
20137
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
19934
|
-
* @version
|
|
20138
|
+
* @version 206.0.0
|
|
19935
20139
|
*//**
|
|
19936
20140
|
* Constructs a new SCIMApi.
|
|
19937
20141
|
* @alias module:purecloud-platform-client-v2/api/SCIMApi
|
|
@@ -20156,7 +20360,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
20156
20360
|
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(){/**
|
|
20157
20361
|
* ScreenRecording service.
|
|
20158
20362
|
* @module purecloud-platform-client-v2/api/ScreenRecordingApi
|
|
20159
|
-
* @version
|
|
20363
|
+
* @version 206.0.0
|
|
20160
20364
|
*//**
|
|
20161
20365
|
* Constructs a new ScreenRecordingApi.
|
|
20162
20366
|
* @alias module:purecloud-platform-client-v2/api/ScreenRecordingApi
|
|
@@ -20171,7 +20375,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
20171
20375
|
*/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(){/**
|
|
20172
20376
|
* Scripts service.
|
|
20173
20377
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
20174
|
-
* @version
|
|
20378
|
+
* @version 206.0.0
|
|
20175
20379
|
*//**
|
|
20176
20380
|
* Constructs a new ScriptsApi.
|
|
20177
20381
|
* @alias module:purecloud-platform-client-v2/api/ScriptsApi
|
|
@@ -20307,7 +20511,7 @@ if(scriptId===undefined||scriptId===null){throw'Missing the required parameter "
|
|
|
20307
20511
|
*/},{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(){/**
|
|
20308
20512
|
* Search service.
|
|
20309
20513
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
20310
|
-
* @version
|
|
20514
|
+
* @version 206.0.0
|
|
20311
20515
|
*//**
|
|
20312
20516
|
* Constructs a new SearchApi.
|
|
20313
20517
|
* @alias module:purecloud-platform-client-v2/api/SearchApi
|
|
@@ -20467,7 +20671,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
20467
20671
|
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(){/**
|
|
20468
20672
|
* Settings service.
|
|
20469
20673
|
* @module purecloud-platform-client-v2/api/SettingsApi
|
|
20470
|
-
* @version
|
|
20674
|
+
* @version 206.0.0
|
|
20471
20675
|
*//**
|
|
20472
20676
|
* Constructs a new SettingsApi.
|
|
20473
20677
|
* @alias module:purecloud-platform-client-v2/api/SettingsApi
|
|
@@ -20517,7 +20721,7 @@ if(agentId===undefined||agentId===null){throw'Missing the required parameter "ag
|
|
|
20517
20721
|
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(){/**
|
|
20518
20722
|
* SpeechTextAnalytics service.
|
|
20519
20723
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
20520
|
-
* @version
|
|
20724
|
+
* @version 206.0.0
|
|
20521
20725
|
*//**
|
|
20522
20726
|
* Constructs a new SpeechTextAnalyticsApi.
|
|
20523
20727
|
* @alias module:purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
@@ -20702,6 +20906,21 @@ if(topicId===undefined||topicId===null){throw'Missing the required parameter "to
|
|
|
20702
20906
|
* @param {String} jobId The id of the publish topics job
|
|
20703
20907
|
*/},{key:"getSpeechandtextanalyticsTopicsPublishjob",value:function getSpeechandtextanalyticsTopicsPublishjob(jobId){// verify the required parameter 'jobId' is set
|
|
20704
20908
|
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']);}/**
|
|
20909
|
+
* Translate all communication(s) for an interaction.
|
|
20910
|
+
*
|
|
20911
|
+
* @param {String} languageId Target translation language
|
|
20912
|
+
* @param {String} conversationId Conversation id
|
|
20913
|
+
* @param {Object} opts Optional parameters
|
|
20914
|
+
* @param {String} opts.communicationId Communication id associated with the conversation
|
|
20915
|
+
* @param {String} opts.recordingId Recording id associated with the communication
|
|
20916
|
+
* getSpeechandtextanalyticsTranslationsLanguageConversation is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
20917
|
+
*/},{key:"getSpeechandtextanalyticsTranslationsLanguageConversation",value:function getSpeechandtextanalyticsTranslationsLanguageConversation(languageId,conversationId,opts){opts=opts||{};// verify the required parameter 'languageId' is set
|
|
20918
|
+
if(languageId===undefined||languageId===null){throw'Missing the required parameter "languageId" when calling getSpeechandtextanalyticsTranslationsLanguageConversation';}// verify the required parameter 'conversationId' is set
|
|
20919
|
+
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']);}/**
|
|
20920
|
+
* Get supported translation languages
|
|
20921
|
+
*
|
|
20922
|
+
* getSpeechandtextanalyticsTranslationsLanguages is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
20923
|
+
*/},{key:"getSpeechandtextanalyticsTranslationsLanguages",value:function getSpeechandtextanalyticsTranslationsLanguages(){return this.apiClient.callApi('/api/v2/speechandtextanalytics/translations/languages','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
20705
20924
|
* Patch Speech And Text Analytics Settings
|
|
20706
20925
|
*
|
|
20707
20926
|
* @param {Object} body Speech And Text Analytics Settings
|
|
@@ -20801,7 +21020,7 @@ if(topicId===undefined||topicId===null){throw'Missing the required parameter "to
|
|
|
20801
21020
|
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(){/**
|
|
20802
21021
|
* Stations service.
|
|
20803
21022
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
20804
|
-
* @version
|
|
21023
|
+
* @version 206.0.0
|
|
20805
21024
|
*//**
|
|
20806
21025
|
* Constructs a new StationsApi.
|
|
20807
21026
|
* @alias module:purecloud-platform-client-v2/api/StationsApi
|
|
@@ -20833,7 +21052,7 @@ if(stationId===undefined||stationId===null){throw'Missing the required parameter
|
|
|
20833
21052
|
*/},{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(){/**
|
|
20834
21053
|
* Suggest service.
|
|
20835
21054
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
20836
|
-
* @version
|
|
21055
|
+
* @version 206.0.0
|
|
20837
21056
|
*//**
|
|
20838
21057
|
* Constructs a new SuggestApi.
|
|
20839
21058
|
* @alias module:purecloud-platform-client-v2/api/SuggestApi
|
|
@@ -20873,7 +21092,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
20873
21092
|
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(){/**
|
|
20874
21093
|
* TaskManagement service.
|
|
20875
21094
|
* @module purecloud-platform-client-v2/api/TaskManagementApi
|
|
20876
|
-
* @version
|
|
21095
|
+
* @version 206.0.0
|
|
20877
21096
|
*//**
|
|
20878
21097
|
* Constructs a new TaskManagementApi.
|
|
20879
21098
|
* @alias module:purecloud-platform-client-v2/api/TaskManagementApi
|
|
@@ -20901,6 +21120,20 @@ if(schemaId===undefined||schemaId===null){throw'Missing the required parameter "
|
|
|
20901
21120
|
* @param {String} worktypeId Worktype id
|
|
20902
21121
|
*/},{key:"deleteTaskmanagementWorktype",value:function deleteTaskmanagementWorktype(worktypeId){// verify the required parameter 'worktypeId' is set
|
|
20903
21122
|
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']);}/**
|
|
21123
|
+
* Delete a rule
|
|
21124
|
+
*
|
|
21125
|
+
* @param {String} worktypeId Worktype id
|
|
21126
|
+
* @param {String} ruleId ruleId
|
|
21127
|
+
*/},{key:"deleteTaskmanagementWorktypeFlowsOnattributechangeRule",value:function deleteTaskmanagementWorktypeFlowsOnattributechangeRule(worktypeId,ruleId){// verify the required parameter 'worktypeId' is set
|
|
21128
|
+
if(worktypeId===undefined||worktypeId===null){throw'Missing the required parameter "worktypeId" when calling deleteTaskmanagementWorktypeFlowsOnattributechangeRule';}// verify the required parameter 'ruleId' is set
|
|
21129
|
+
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']);}/**
|
|
21130
|
+
* Delete a rule
|
|
21131
|
+
*
|
|
21132
|
+
* @param {String} worktypeId Worktype id
|
|
21133
|
+
* @param {String} ruleId ruleId
|
|
21134
|
+
*/},{key:"deleteTaskmanagementWorktypeFlowsOncreateRule",value:function deleteTaskmanagementWorktypeFlowsOncreateRule(worktypeId,ruleId){// verify the required parameter 'worktypeId' is set
|
|
21135
|
+
if(worktypeId===undefined||worktypeId===null){throw'Missing the required parameter "worktypeId" when calling deleteTaskmanagementWorktypeFlowsOncreateRule';}// verify the required parameter 'ruleId' is set
|
|
21136
|
+
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']);}/**
|
|
20904
21137
|
* Delete a status
|
|
20905
21138
|
*
|
|
20906
21139
|
* @param {String} worktypeId Worktype id
|
|
@@ -21035,6 +21268,36 @@ if(schemaId===undefined||schemaId===null){throw'Missing the required parameter "
|
|
|
21035
21268
|
* @param {Array.<String>} opts.expands Which fields, if any, to expand.
|
|
21036
21269
|
*/},{key:"getTaskmanagementWorktype",value:function getTaskmanagementWorktype(worktypeId,opts){opts=opts||{};// verify the required parameter 'worktypeId' is set
|
|
21037
21270
|
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']);}/**
|
|
21271
|
+
* Get an attribute change rule
|
|
21272
|
+
*
|
|
21273
|
+
* @param {String} worktypeId Worktype id
|
|
21274
|
+
* @param {String} ruleId ruleId
|
|
21275
|
+
*/},{key:"getTaskmanagementWorktypeFlowsOnattributechangeRule",value:function getTaskmanagementWorktypeFlowsOnattributechangeRule(worktypeId,ruleId){// verify the required parameter 'worktypeId' is set
|
|
21276
|
+
if(worktypeId===undefined||worktypeId===null){throw'Missing the required parameter "worktypeId" when calling getTaskmanagementWorktypeFlowsOnattributechangeRule';}// verify the required parameter 'ruleId' is set
|
|
21277
|
+
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']);}/**
|
|
21278
|
+
* Get all attribute-change rules for a worktype
|
|
21279
|
+
*
|
|
21280
|
+
* @param {String} worktypeId Worktype id
|
|
21281
|
+
* @param {Object} opts Optional parameters
|
|
21282
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
21283
|
+
* @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)
|
|
21284
|
+
*/},{key:"getTaskmanagementWorktypeFlowsOnattributechangeRules",value:function getTaskmanagementWorktypeFlowsOnattributechangeRules(worktypeId,opts){opts=opts||{};// verify the required parameter 'worktypeId' is set
|
|
21285
|
+
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']);}/**
|
|
21286
|
+
* Get an on-create rule
|
|
21287
|
+
*
|
|
21288
|
+
* @param {String} worktypeId Worktype id
|
|
21289
|
+
* @param {String} ruleId ruleId
|
|
21290
|
+
*/},{key:"getTaskmanagementWorktypeFlowsOncreateRule",value:function getTaskmanagementWorktypeFlowsOncreateRule(worktypeId,ruleId){// verify the required parameter 'worktypeId' is set
|
|
21291
|
+
if(worktypeId===undefined||worktypeId===null){throw'Missing the required parameter "worktypeId" when calling getTaskmanagementWorktypeFlowsOncreateRule';}// verify the required parameter 'ruleId' is set
|
|
21292
|
+
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']);}/**
|
|
21293
|
+
* Get all on-create rules for a worktype
|
|
21294
|
+
*
|
|
21295
|
+
* @param {String} worktypeId Worktype id
|
|
21296
|
+
* @param {Object} opts Optional parameters
|
|
21297
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
21298
|
+
* @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)
|
|
21299
|
+
*/},{key:"getTaskmanagementWorktypeFlowsOncreateRules",value:function getTaskmanagementWorktypeFlowsOncreateRules(worktypeId,opts){opts=opts||{};// verify the required parameter 'worktypeId' is set
|
|
21300
|
+
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']);}/**
|
|
21038
21301
|
* Get a listing of a worktype's attribute change history
|
|
21039
21302
|
*
|
|
21040
21303
|
* @param {String} worktypeId Worktype id
|
|
@@ -21120,6 +21383,24 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
21120
21383
|
*/},{key:"patchTaskmanagementWorktype",value:function patchTaskmanagementWorktype(worktypeId,body){// verify the required parameter 'worktypeId' is set
|
|
21121
21384
|
if(worktypeId===undefined||worktypeId===null){throw'Missing the required parameter "worktypeId" when calling patchTaskmanagementWorktype';}// verify the required parameter 'body' is set
|
|
21122
21385
|
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']);}/**
|
|
21386
|
+
* Update the attributes of a rule
|
|
21387
|
+
*
|
|
21388
|
+
* @param {String} worktypeId Worktype id
|
|
21389
|
+
* @param {String} ruleId ruleId
|
|
21390
|
+
* @param {Object} body Rule
|
|
21391
|
+
*/},{key:"patchTaskmanagementWorktypeFlowsOnattributechangeRule",value:function patchTaskmanagementWorktypeFlowsOnattributechangeRule(worktypeId,ruleId,body){// verify the required parameter 'worktypeId' is set
|
|
21392
|
+
if(worktypeId===undefined||worktypeId===null){throw'Missing the required parameter "worktypeId" when calling patchTaskmanagementWorktypeFlowsOnattributechangeRule';}// verify the required parameter 'ruleId' is set
|
|
21393
|
+
if(ruleId===undefined||ruleId===null){throw'Missing the required parameter "ruleId" when calling patchTaskmanagementWorktypeFlowsOnattributechangeRule';}// verify the required parameter 'body' is set
|
|
21394
|
+
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']);}/**
|
|
21395
|
+
* Update the attributes of a rule
|
|
21396
|
+
*
|
|
21397
|
+
* @param {String} worktypeId Worktype id
|
|
21398
|
+
* @param {String} ruleId ruleId
|
|
21399
|
+
* @param {Object} body Rule
|
|
21400
|
+
*/},{key:"patchTaskmanagementWorktypeFlowsOncreateRule",value:function patchTaskmanagementWorktypeFlowsOncreateRule(worktypeId,ruleId,body){// verify the required parameter 'worktypeId' is set
|
|
21401
|
+
if(worktypeId===undefined||worktypeId===null){throw'Missing the required parameter "worktypeId" when calling patchTaskmanagementWorktypeFlowsOncreateRule';}// verify the required parameter 'ruleId' is set
|
|
21402
|
+
if(ruleId===undefined||ruleId===null){throw'Missing the required parameter "ruleId" when calling patchTaskmanagementWorktypeFlowsOncreateRule';}// verify the required parameter 'body' is set
|
|
21403
|
+
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']);}/**
|
|
21123
21404
|
* Update the attributes of a status
|
|
21124
21405
|
*
|
|
21125
21406
|
* @param {String} worktypeId Worktype id
|
|
@@ -21177,6 +21458,20 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
21177
21458
|
* @param {Object} body Schema
|
|
21178
21459
|
*/},{key:"postTaskmanagementWorkitemsSchemas",value:function postTaskmanagementWorkitemsSchemas(body){// verify the required parameter 'body' is set
|
|
21179
21460
|
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']);}/**
|
|
21461
|
+
* Add an attribute-change rule to a worktype
|
|
21462
|
+
*
|
|
21463
|
+
* @param {String} worktypeId Worktype id
|
|
21464
|
+
* @param {Object} body Rule
|
|
21465
|
+
*/},{key:"postTaskmanagementWorktypeFlowsOnattributechangeRules",value:function postTaskmanagementWorktypeFlowsOnattributechangeRules(worktypeId,body){// verify the required parameter 'worktypeId' is set
|
|
21466
|
+
if(worktypeId===undefined||worktypeId===null){throw'Missing the required parameter "worktypeId" when calling postTaskmanagementWorktypeFlowsOnattributechangeRules';}// verify the required parameter 'body' is set
|
|
21467
|
+
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']);}/**
|
|
21468
|
+
* Add an on-create rule to a worktype
|
|
21469
|
+
*
|
|
21470
|
+
* @param {String} worktypeId Worktype id
|
|
21471
|
+
* @param {Object} body Rule
|
|
21472
|
+
*/},{key:"postTaskmanagementWorktypeFlowsOncreateRules",value:function postTaskmanagementWorktypeFlowsOncreateRules(worktypeId,body){// verify the required parameter 'worktypeId' is set
|
|
21473
|
+
if(worktypeId===undefined||worktypeId===null){throw'Missing the required parameter "worktypeId" when calling postTaskmanagementWorktypeFlowsOncreateRules';}// verify the required parameter 'body' is set
|
|
21474
|
+
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']);}/**
|
|
21180
21475
|
* Add a status to a worktype
|
|
21181
21476
|
*
|
|
21182
21477
|
* @param {String} worktypeId Worktype id
|
|
@@ -21203,7 +21498,7 @@ if(schemaId===undefined||schemaId===null){throw'Missing the required parameter "
|
|
|
21203
21498
|
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(){/**
|
|
21204
21499
|
* Teams service.
|
|
21205
21500
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
21206
|
-
* @version
|
|
21501
|
+
* @version 206.0.0
|
|
21207
21502
|
*//**
|
|
21208
21503
|
* Constructs a new TeamsApi.
|
|
21209
21504
|
* @alias module:purecloud-platform-client-v2/api/TeamsApi
|
|
@@ -21281,7 +21576,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
21281
21576
|
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(){/**
|
|
21282
21577
|
* Telephony service.
|
|
21283
21578
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
21284
|
-
* @version
|
|
21579
|
+
* @version 206.0.0
|
|
21285
21580
|
*//**
|
|
21286
21581
|
* Constructs a new TelephonyApi.
|
|
21287
21582
|
* @alias module:purecloud-platform-client-v2/api/TelephonyApi
|
|
@@ -21328,7 +21623,7 @@ if(downloadId===undefined||downloadId===null){throw'Missing the required paramet
|
|
|
21328
21623
|
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(){/**
|
|
21329
21624
|
* TelephonyProvidersEdge service.
|
|
21330
21625
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
21331
|
-
* @version
|
|
21626
|
+
* @version 206.0.0
|
|
21332
21627
|
*//**
|
|
21333
21628
|
* Constructs a new TelephonyProvidersEdgeApi.
|
|
21334
21629
|
* @alias module:purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
@@ -21353,6 +21648,9 @@ if(interfaceId===undefined||interfaceId===null){throw'Missing the required param
|
|
|
21353
21648
|
* @param {String} edgeId Edge ID
|
|
21354
21649
|
*/},{key:"deleteTelephonyProvidersEdgeSoftwareupdate",value:function deleteTelephonyProvidersEdgeSoftwareupdate(edgeId){// verify the required parameter 'edgeId' is set
|
|
21355
21650
|
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']);}/**
|
|
21651
|
+
* Deletes alertable presences overrides.
|
|
21652
|
+
*
|
|
21653
|
+
*/},{key:"deleteTelephonyProvidersEdgesAlertablepresences",value:function deleteTelephonyProvidersEdgesAlertablepresences(){return this.apiClient.callApi('/api/v2/telephony/providers/edges/alertablepresences','DELETE',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
21356
21654
|
* Delete a certificate authority.
|
|
21357
21655
|
*
|
|
21358
21656
|
* @param {String} certificateId Certificate ID
|
|
@@ -21506,6 +21804,11 @@ if(edgeId===undefined||edgeId===null){throw'Missing the required parameter "edge
|
|
|
21506
21804
|
* @param {Boolean} opts.managed Filter by managed
|
|
21507
21805
|
* @param {Boolean} opts.showCloudMedia True to show the cloud media devices in the result. (default to true)
|
|
21508
21806
|
*/},{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']);}/**
|
|
21807
|
+
* 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.
|
|
21808
|
+
*
|
|
21809
|
+
* @param {Object} opts Optional parameters
|
|
21810
|
+
* @param {Object} opts.type
|
|
21811
|
+
*/},{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']);}/**
|
|
21509
21812
|
* Get the list of certificate authorities.
|
|
21510
21813
|
*
|
|
21511
21814
|
*/},{key:"getTelephonyProvidersEdgesCertificateauthorities",value:function getTelephonyProvidersEdgesCertificateauthorities(){return this.apiClient.callApi('/api/v2/telephony/providers/edges/certificateauthorities','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
@@ -22048,6 +22351,11 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
22048
22351
|
if(edgeId===undefined||edgeId===null){throw'Missing the required parameter "edgeId" when calling putTelephonyProvidersEdgeLogicalinterface';}// verify the required parameter 'interfaceId' is set
|
|
22049
22352
|
if(interfaceId===undefined||interfaceId===null){throw'Missing the required parameter "interfaceId" when calling putTelephonyProvidersEdgeLogicalinterface';}// verify the required parameter 'body' is set
|
|
22050
22353
|
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']);}/**
|
|
22354
|
+
* Creates or updates alertable presences overrides.
|
|
22355
|
+
*
|
|
22356
|
+
* @param {Object} body Alertable Presences Overrides
|
|
22357
|
+
*/},{key:"putTelephonyProvidersEdgesAlertablepresences",value:function putTelephonyProvidersEdgesAlertablepresences(body){// verify the required parameter 'body' is set
|
|
22358
|
+
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']);}/**
|
|
22051
22359
|
* Update a certificate authority.
|
|
22052
22360
|
*
|
|
22053
22361
|
* @param {String} certificateId Certificate ID
|
|
@@ -22138,7 +22446,7 @@ if(trunkBaseSettingsId===undefined||trunkBaseSettingsId===null){throw'Missing th
|
|
|
22138
22446
|
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(){/**
|
|
22139
22447
|
* Textbots service.
|
|
22140
22448
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
22141
|
-
* @version
|
|
22449
|
+
* @version 206.0.0
|
|
22142
22450
|
*//**
|
|
22143
22451
|
* Constructs a new TextbotsApi.
|
|
22144
22452
|
* @alias module:purecloud-platform-client-v2/api/TextbotsApi
|
|
@@ -22173,7 +22481,7 @@ if(launchRequest===undefined||launchRequest===null){throw'Missing the required p
|
|
|
22173
22481
|
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(){/**
|
|
22174
22482
|
* Tokens service.
|
|
22175
22483
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
22176
|
-
* @version
|
|
22484
|
+
* @version 206.0.0
|
|
22177
22485
|
*//**
|
|
22178
22486
|
* Constructs a new TokensApi.
|
|
22179
22487
|
* @alias module:purecloud-platform-client-v2/api/TokensApi
|
|
@@ -22207,7 +22515,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
22207
22515
|
*/},{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(){/**
|
|
22208
22516
|
* Uploads service.
|
|
22209
22517
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
22210
|
-
* @version
|
|
22518
|
+
* @version 206.0.0
|
|
22211
22519
|
*//**
|
|
22212
22520
|
* Constructs a new UploadsApi.
|
|
22213
22521
|
* @alias module:purecloud-platform-client-v2/api/UploadsApi
|
|
@@ -22273,7 +22581,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
22273
22581
|
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(){/**
|
|
22274
22582
|
* Usage service.
|
|
22275
22583
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
22276
|
-
* @version
|
|
22584
|
+
* @version 206.0.0
|
|
22277
22585
|
*//**
|
|
22278
22586
|
* Constructs a new UsageApi.
|
|
22279
22587
|
* @alias module:purecloud-platform-client-v2/api/UsageApi
|
|
@@ -22327,7 +22635,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
22327
22635
|
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(){/**
|
|
22328
22636
|
* UserRecordings service.
|
|
22329
22637
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
22330
|
-
* @version
|
|
22638
|
+
* @version 206.0.0
|
|
22331
22639
|
*//**
|
|
22332
22640
|
* Constructs a new UserRecordingsApi.
|
|
22333
22641
|
* @alias module:purecloud-platform-client-v2/api/UserRecordingsApi
|
|
@@ -22384,7 +22692,7 @@ if(recordingId===undefined||recordingId===null){throw'Missing the required param
|
|
|
22384
22692
|
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(){/**
|
|
22385
22693
|
* Users service.
|
|
22386
22694
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
22387
|
-
* @version
|
|
22695
|
+
* @version 206.0.0
|
|
22388
22696
|
*//**
|
|
22389
22697
|
* Constructs a new UsersApi.
|
|
22390
22698
|
* @alias module:purecloud-platform-client-v2/api/UsersApi
|
|
@@ -23074,7 +23382,7 @@ if(verifierId===undefined||verifierId===null){throw'Missing the required paramet
|
|
|
23074
23382
|
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(){/**
|
|
23075
23383
|
* Utilities service.
|
|
23076
23384
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
23077
|
-
* @version
|
|
23385
|
+
* @version 206.0.0
|
|
23078
23386
|
*//**
|
|
23079
23387
|
* Constructs a new UtilitiesApi.
|
|
23080
23388
|
* @alias module:purecloud-platform-client-v2/api/UtilitiesApi
|
|
@@ -23101,7 +23409,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
23101
23409
|
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(){/**
|
|
23102
23410
|
* Voicemail service.
|
|
23103
23411
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
23104
|
-
* @version
|
|
23412
|
+
* @version 206.0.0
|
|
23105
23413
|
*//**
|
|
23106
23414
|
* Constructs a new VoicemailApi.
|
|
23107
23415
|
* @alias module:purecloud-platform-client-v2/api/VoicemailApi
|
|
@@ -23250,7 +23558,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
23250
23558
|
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(){/**
|
|
23251
23559
|
* WebChat service.
|
|
23252
23560
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
23253
|
-
* @version
|
|
23561
|
+
* @version 206.0.0
|
|
23254
23562
|
*//**
|
|
23255
23563
|
* Constructs a new WebChatApi.
|
|
23256
23564
|
* @alias module:purecloud-platform-client-v2/api/WebChatApi
|
|
@@ -23385,7 +23693,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
23385
23693
|
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(){/**
|
|
23386
23694
|
* WebDeployments service.
|
|
23387
23695
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
23388
|
-
* @version
|
|
23696
|
+
* @version 206.0.0
|
|
23389
23697
|
*//**
|
|
23390
23698
|
* Constructs a new WebDeploymentsApi.
|
|
23391
23699
|
* @alias module:purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
@@ -23436,7 +23744,7 @@ if(configurationId===undefined||configurationId===null){throw'Missing the requir
|
|
|
23436
23744
|
* View configuration drafts
|
|
23437
23745
|
*
|
|
23438
23746
|
* @param {Object} opts Optional parameters
|
|
23439
|
-
* @param {Boolean} opts.showOnlyPublished
|
|
23747
|
+
* @param {Boolean} opts.showOnlyPublished Filter by published status.
|
|
23440
23748
|
*/},{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']);}/**
|
|
23441
23749
|
* Get a deployment
|
|
23442
23750
|
*
|
|
@@ -23463,7 +23771,7 @@ if(deploymentId===undefined||deploymentId===null){throw'Missing the required par
|
|
|
23463
23771
|
* Get deployments
|
|
23464
23772
|
*
|
|
23465
23773
|
* @param {Object} opts Optional parameters
|
|
23466
|
-
* @param {Array.<String>} opts.expand The specified entity attributes will be filled. Comma separated values expected.
|
|
23774
|
+
* @param {Array.<String>} opts.expand The specified entity attributes will be filled. Comma separated values expected.
|
|
23467
23775
|
*/},{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']);}/**
|
|
23468
23776
|
* Publish the configuration draft and create a new version
|
|
23469
23777
|
*
|
|
@@ -23506,7 +23814,7 @@ if(deploymentId===undefined||deploymentId===null){throw'Missing the required par
|
|
|
23506
23814
|
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(){/**
|
|
23507
23815
|
* WebMessaging service.
|
|
23508
23816
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
23509
|
-
* @version
|
|
23817
|
+
* @version 206.0.0
|
|
23510
23818
|
*//**
|
|
23511
23819
|
* Constructs a new WebMessagingApi.
|
|
23512
23820
|
* @alias module:purecloud-platform-client-v2/api/WebMessagingApi
|
|
@@ -23522,7 +23830,7 @@ if(deployment===undefined||deployment===null){throw'Missing the required paramet
|
|
|
23522
23830
|
*/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(){/**
|
|
23523
23831
|
* Widgets service.
|
|
23524
23832
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
23525
|
-
* @version
|
|
23833
|
+
* @version 206.0.0
|
|
23526
23834
|
*//**
|
|
23527
23835
|
* Constructs a new WidgetsApi.
|
|
23528
23836
|
* @alias module:purecloud-platform-client-v2/api/WidgetsApi
|
|
@@ -23557,7 +23865,7 @@ if(deploymentId===undefined||deploymentId===null){throw'Missing the required par
|
|
|
23557
23865
|
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(){/**
|
|
23558
23866
|
* WorkforceManagement service.
|
|
23559
23867
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
23560
|
-
* @version
|
|
23868
|
+
* @version 206.0.0
|
|
23561
23869
|
*//**
|
|
23562
23870
|
* Constructs a new WorkforceManagementApi.
|
|
23563
23871
|
* @alias module:purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
@@ -24531,6 +24839,13 @@ if(managementUnitId===undefined||managementUnitId===null){throw'Missing the requ
|
|
|
24531
24839
|
* @param {Object} opts.body body
|
|
24532
24840
|
*/},{key:"patchWorkforcemanagementManagementunitAgents",value:function patchWorkforcemanagementManagementunitAgents(managementUnitId,opts){opts=opts||{};// verify the required parameter 'managementUnitId' is set
|
|
24533
24841
|
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']);}/**
|
|
24842
|
+
* Updates agent work plan configuration
|
|
24843
|
+
*
|
|
24844
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
24845
|
+
* @param {Object} opts Optional parameters
|
|
24846
|
+
* @param {Object} opts.body body
|
|
24847
|
+
*/},{key:"patchWorkforcemanagementManagementunitAgentsWorkplansBulk",value:function patchWorkforcemanagementManagementunitAgentsWorkplansBulk(managementUnitId,opts){opts=opts||{};// verify the required parameter 'managementUnitId' is set
|
|
24848
|
+
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']);}/**
|
|
24534
24849
|
* Updates a time off limit object.
|
|
24535
24850
|
* Updates time off limit object properties, but not daily values.
|
|
24536
24851
|
* @param {String} managementUnitId The ID of the management unit.
|
|
@@ -25015,6 +25330,14 @@ if(businessUnitId===undefined||businessUnitId===null){throw'Missing the required
|
|
|
25015
25330
|
* @param {String} hrisIntegrationId The ID of the HRIS integration for which time off types are queried.
|
|
25016
25331
|
*/},{key:"postWorkforcemanagementIntegrationsHriTimeofftypesJobs",value:function postWorkforcemanagementIntegrationsHriTimeofftypesJobs(hrisIntegrationId){// verify the required parameter 'hrisIntegrationId' is set
|
|
25017
25332
|
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']);}/**
|
|
25333
|
+
* Get agents work plans configuration
|
|
25334
|
+
*
|
|
25335
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
25336
|
+
* @param {Object} opts Optional parameters
|
|
25337
|
+
* @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
|
|
25338
|
+
* @param {Object} opts.body body
|
|
25339
|
+
*/},{key:"postWorkforcemanagementManagementunitAgentsWorkplansQuery",value:function postWorkforcemanagementManagementunitAgentsWorkplansQuery(managementUnitId,opts){opts=opts||{};// verify the required parameter 'managementUnitId' is set
|
|
25340
|
+
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']);}/**
|
|
25018
25341
|
* Query published schedules for given given time range for set of users
|
|
25019
25342
|
*
|
|
25020
25343
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
@@ -25323,7 +25646,7 @@ if(timeOffLimitId===undefined||timeOffLimitId===null){throw'Missing the required
|
|
|
25323
25646
|
* </pre>
|
|
25324
25647
|
* </p>
|
|
25325
25648
|
* @module purecloud-platform-client-v2/index
|
|
25326
|
-
* @version
|
|
25649
|
+
* @version 206.0.0
|
|
25327
25650
|
*/var platformClient=/*#__PURE__*/_createClass(function platformClient(){_classCallCheck(this,platformClient);/**
|
|
25328
25651
|
* The ApiClient constructor.
|
|
25329
25652
|
* @property {module:purecloud-platform-client-v2/ApiClient}
|