purecloud-platform-client-v2 205.0.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 +646 -84
- package/dist/web-amd/purecloud-platform-client-v2.js +646 -84
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +228 -85
- package/dist/web-cjs/purecloud-platform-client-v2.js +228 -85
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +467 -5
- 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 +7 -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 +1 -1
- package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LanguagesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LearningApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LicenseApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LocationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LogCaptureApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/MessagingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/MobileDevicesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/NotificationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OAuthApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ObjectsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OperationalEventsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OrganizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OutboundApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/PresenceApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ProcessAutomationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/QualityApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RecordingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RoutingApi.js +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 +1 -1
- package/src/purecloud-platform-client-v2/api/StationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SuggestApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TaskManagementApi.js +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 +1 -1
- package/src/purecloud-platform-client-v2/api/TextbotsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TokensApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UploadsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsageApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsersApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/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 +2 -2
- 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
|
|
@@ -10499,7 +10499,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
10499
10499
|
* @param {String} conversationId conversationId
|
|
10500
10500
|
* @param {String} participantId participantId
|
|
10501
10501
|
* @param {Object} body Parking update request
|
|
10502
|
-
* patchConversationsEmailParticipantParkingstate is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
10503
10502
|
*/},{key:"patchConversationsEmailParticipantParkingstate",value:function patchConversationsEmailParticipantParkingstate(conversationId,participantId,body){// verify the required parameter 'conversationId' is set
|
|
10504
10503
|
if(conversationId===undefined||conversationId===null){throw'Missing the required parameter "conversationId" when calling patchConversationsEmailParticipantParkingstate';}// verify the required parameter 'participantId' is set
|
|
10505
10504
|
if(participantId===undefined||participantId===null){throw'Missing the required parameter "participantId" when calling patchConversationsEmailParticipantParkingstate';}// verify the required parameter 'body' is set
|
|
@@ -11043,9 +11042,11 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
11043
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.
|
|
11044
11043
|
* @param {String} integrationId integrationId
|
|
11045
11044
|
* @param {Object} body NormalizedMessage
|
|
11046
|
-
|
|
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
|
|
11047
11048
|
if(integrationId===undefined||integrationId===null){throw'Missing the required parameter "integrationId" when calling postConversationsMessageInboundOpenMessage';}// verify the required parameter 'body' is set
|
|
11048
|
-
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']);}/**
|
|
11049
11050
|
* Send an inbound Open Receipt Message
|
|
11050
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.
|
|
11051
11052
|
* @param {String} integrationId integrationId
|
|
@@ -11312,7 +11313,7 @@ if(conversationId===undefined||conversationId===null){throw'Missing the required
|
|
|
11312
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(){/**
|
|
11313
11314
|
* DataExtensions service.
|
|
11314
11315
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
11315
|
-
* @version
|
|
11316
|
+
* @version 206.0.0
|
|
11316
11317
|
*//**
|
|
11317
11318
|
* Constructs a new DataExtensionsApi.
|
|
11318
11319
|
* @alias module:purecloud-platform-client-v2/api/DataExtensionsApi
|
|
@@ -11333,7 +11334,7 @@ if(coretypeName===undefined||coretypeName===null){throw'Missing the required par
|
|
|
11333
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(){/**
|
|
11334
11335
|
* Downloads service.
|
|
11335
11336
|
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
11336
|
-
* @version
|
|
11337
|
+
* @version 206.0.0
|
|
11337
11338
|
*//**
|
|
11338
11339
|
* Constructs a new DownloadsApi.
|
|
11339
11340
|
* @alias module:purecloud-platform-client-v2/api/DownloadsApi
|
|
@@ -11352,7 +11353,7 @@ if(coretypeName===undefined||coretypeName===null){throw'Missing the required par
|
|
|
11352
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(){/**
|
|
11353
11354
|
* Emails service.
|
|
11354
11355
|
* @module purecloud-platform-client-v2/api/EmailsApi
|
|
11355
|
-
* @version
|
|
11356
|
+
* @version 206.0.0
|
|
11356
11357
|
*//**
|
|
11357
11358
|
* Constructs a new EmailsApi.
|
|
11358
11359
|
* @alias module:purecloud-platform-client-v2/api/EmailsApi
|
|
@@ -11370,7 +11371,7 @@ if(downloadId===undefined||downloadId===null){throw'Missing the required paramet
|
|
|
11370
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(){/**
|
|
11371
11372
|
* EmployeeEngagement service.
|
|
11372
11373
|
* @module purecloud-platform-client-v2/api/EmployeeEngagementApi
|
|
11373
|
-
* @version
|
|
11374
|
+
* @version 206.0.0
|
|
11374
11375
|
*//**
|
|
11375
11376
|
* Constructs a new EmployeeEngagementApi.
|
|
11376
11377
|
* @alias module:purecloud-platform-client-v2/api/EmployeeEngagementApi
|
|
@@ -11408,7 +11409,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
11408
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(){/**
|
|
11409
11410
|
* Events service.
|
|
11410
11411
|
* @module purecloud-platform-client-v2/api/EventsApi
|
|
11411
|
-
* @version
|
|
11412
|
+
* @version 206.0.0
|
|
11412
11413
|
*//**
|
|
11413
11414
|
* Constructs a new EventsApi.
|
|
11414
11415
|
* @alias module:purecloud-platform-client-v2/api/EventsApi
|
|
@@ -11433,7 +11434,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
11433
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(){/**
|
|
11434
11435
|
* ExternalContacts service.
|
|
11435
11436
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
11436
|
-
* @version
|
|
11437
|
+
* @version 206.0.0
|
|
11437
11438
|
*//**
|
|
11438
11439
|
* Constructs a new ExternalContactsApi.
|
|
11439
11440
|
* @alias module:purecloud-platform-client-v2/api/ExternalContactsApi
|
|
@@ -11925,7 +11926,7 @@ if(relationshipId===undefined||relationshipId===null){throw'Missing the required
|
|
|
11925
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(){/**
|
|
11926
11927
|
* Fax service.
|
|
11927
11928
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
11928
|
-
* @version
|
|
11929
|
+
* @version 206.0.0
|
|
11929
11930
|
*//**
|
|
11930
11931
|
* Constructs a new FaxApi.
|
|
11931
11932
|
* @alias module:purecloud-platform-client-v2/api/FaxApi
|
|
@@ -11974,7 +11975,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
11974
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(){/**
|
|
11975
11976
|
* Flows service.
|
|
11976
11977
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
11977
|
-
* @version
|
|
11978
|
+
* @version 206.0.0
|
|
11978
11979
|
*//**
|
|
11979
11980
|
* Constructs a new FlowsApi.
|
|
11980
11981
|
* @alias module:purecloud-platform-client-v2/api/FlowsApi
|
|
@@ -12022,7 +12023,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
12022
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(){/**
|
|
12023
12024
|
* Gamification service.
|
|
12024
12025
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
12025
|
-
* @version
|
|
12026
|
+
* @version 206.0.0
|
|
12026
12027
|
*//**
|
|
12027
12028
|
* Constructs a new GamificationApi.
|
|
12028
12029
|
* @alias module:purecloud-platform-client-v2/api/GamificationApi
|
|
@@ -12562,7 +12563,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
12562
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(){/**
|
|
12563
12564
|
* GeneralDataProtectionRegulation service.
|
|
12564
12565
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
12565
|
-
* @version
|
|
12566
|
+
* @version 206.0.0
|
|
12566
12567
|
*//**
|
|
12567
12568
|
* Constructs a new GeneralDataProtectionRegulationApi.
|
|
12568
12569
|
* @alias module:purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
@@ -12597,7 +12598,7 @@ if(searchValue===undefined||searchValue===null){throw'Missing the required param
|
|
|
12597
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(){/**
|
|
12598
12599
|
* Geolocation service.
|
|
12599
12600
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
12600
|
-
* @version
|
|
12601
|
+
* @version 206.0.0
|
|
12601
12602
|
*//**
|
|
12602
12603
|
* Constructs a new GeolocationApi.
|
|
12603
12604
|
* @alias module:purecloud-platform-client-v2/api/GeolocationApi
|
|
@@ -12631,7 +12632,7 @@ if(clientId===undefined||clientId===null){throw'Missing the required parameter "
|
|
|
12631
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(){/**
|
|
12632
12633
|
* Greetings service.
|
|
12633
12634
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
12634
|
-
* @version
|
|
12635
|
+
* @version 206.0.0
|
|
12635
12636
|
*//**
|
|
12636
12637
|
* Constructs a new GreetingsApi.
|
|
12637
12638
|
* @alias module:purecloud-platform-client-v2/api/GreetingsApi
|
|
@@ -12738,7 +12739,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
12738
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(){/**
|
|
12739
12740
|
* Groups service.
|
|
12740
12741
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
12741
|
-
* @version
|
|
12742
|
+
* @version 206.0.0
|
|
12742
12743
|
*//**
|
|
12743
12744
|
* Constructs a new GroupsApi.
|
|
12744
12745
|
* @alias module:purecloud-platform-client-v2/api/GroupsApi
|
|
@@ -12871,7 +12872,7 @@ if(groupId===undefined||groupId===null){throw'Missing the required parameter "gr
|
|
|
12871
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(){/**
|
|
12872
12873
|
* IdentityProvider service.
|
|
12873
12874
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
12874
|
-
* @version
|
|
12875
|
+
* @version 206.0.0
|
|
12875
12876
|
*//**
|
|
12876
12877
|
* Constructs a new IdentityProviderApi.
|
|
12877
12878
|
* @alias module:purecloud-platform-client-v2/api/IdentityProviderApi
|
|
@@ -13027,7 +13028,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
13027
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(){/**
|
|
13028
13029
|
* InfrastructureAsCode service.
|
|
13029
13030
|
* @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
13030
|
-
* @version
|
|
13031
|
+
* @version 206.0.0
|
|
13031
13032
|
*//**
|
|
13032
13033
|
* Constructs a new InfrastructureAsCodeApi.
|
|
13033
13034
|
* @alias module:purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
@@ -13081,7 +13082,7 @@ if(jobId===undefined||jobId===null){throw'Missing the required parameter "jobId"
|
|
|
13081
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(){/**
|
|
13082
13083
|
* Integrations service.
|
|
13083
13084
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
13084
|
-
* @version
|
|
13085
|
+
* @version 206.0.0
|
|
13085
13086
|
*//**
|
|
13086
13087
|
* Constructs a new IntegrationsApi.
|
|
13087
13088
|
* @alias module:purecloud-platform-client-v2/api/IntegrationsApi
|
|
@@ -13706,7 +13707,7 @@ if(ucIntegrationId===undefined||ucIntegrationId===null){throw'Missing the requir
|
|
|
13706
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(){/**
|
|
13707
13708
|
* Journey service.
|
|
13708
13709
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
13709
|
-
* @version
|
|
13710
|
+
* @version 206.0.0
|
|
13710
13711
|
*//**
|
|
13711
13712
|
* Constructs a new JourneyApi.
|
|
13712
13713
|
* @alias module:purecloud-platform-client-v2/api/JourneyApi
|
|
@@ -13918,6 +13919,26 @@ if(viewId===undefined||viewId===null){throw'Missing the required parameter "view
|
|
|
13918
13919
|
*/},{key:"getJourneyViewVersion",value:function getJourneyViewVersion(viewId,versionId){// verify the required parameter 'viewId' is set
|
|
13919
13920
|
if(viewId===undefined||viewId===null){throw'Missing the required parameter "viewId" when calling getJourneyViewVersion';}// verify the required parameter 'versionId' is set
|
|
13920
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']);}/**
|
|
13921
13942
|
* Get the job for a journey view version.
|
|
13922
13943
|
* used for long descriptions
|
|
13923
13944
|
* @param {String} viewId Journey View Id
|
|
@@ -13936,6 +13957,17 @@ if(jobId===undefined||jobId===null){throw'Missing the required parameter "jobId"
|
|
|
13936
13957
|
if(viewId===undefined||viewId===null){throw'Missing the required parameter "viewId" when calling getJourneyViewVersionJobResults';}// verify the required parameter 'journeyViewVersion' is set
|
|
13937
13958
|
if(journeyViewVersion===undefined||journeyViewVersion===null){throw'Missing the required parameter "journeyViewVersion" when calling getJourneyViewVersionJobResults';}// verify the required parameter 'jobId' is set
|
|
13938
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']);}/**
|
|
13939
13971
|
* Get the latest job of a journey view version.
|
|
13940
13972
|
* used for long descriptions
|
|
13941
13973
|
* @param {String} viewId Journey View Id
|
|
@@ -14005,6 +14037,17 @@ if(outcomeId===undefined||outcomeId===null){throw'Missing the required parameter
|
|
|
14005
14037
|
* @param {Object} opts.body
|
|
14006
14038
|
*/},{key:"patchJourneySegment",value:function patchJourneySegment(segmentId,opts){opts=opts||{};// verify the required parameter 'segmentId' is set
|
|
14007
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']);}/**
|
|
14008
14051
|
* Query for journey aggregates asynchronously
|
|
14009
14052
|
*
|
|
14010
14053
|
* @param {Object} body query
|
|
@@ -14102,10 +14145,19 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
14102
14145
|
* @param {Object} opts Optional parameters
|
|
14103
14146
|
* @param {Array.<Object>} opts.body
|
|
14104
14147
|
* postJourneyViewsEncodingsValidate is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
14105
|
-
*/},{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(){/**
|
|
14106
14158
|
* Knowledge service.
|
|
14107
14159
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
14108
|
-
* @version
|
|
14160
|
+
* @version 206.0.0
|
|
14109
14161
|
*//**
|
|
14110
14162
|
* Constructs a new KnowledgeApi.
|
|
14111
14163
|
* @alias module:purecloud-platform-client-v2/api/KnowledgeApi
|
|
@@ -15189,7 +15241,7 @@ if(sourceId===undefined||sourceId===null){throw'Missing the required parameter "
|
|
|
15189
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(){/**
|
|
15190
15242
|
* LanguageUnderstanding service.
|
|
15191
15243
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
15192
|
-
* @version
|
|
15244
|
+
* @version 206.0.0
|
|
15193
15245
|
*//**
|
|
15194
15246
|
* Constructs a new LanguageUnderstandingApi.
|
|
15195
15247
|
* @alias module:purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
@@ -15449,7 +15501,7 @@ if(domainVersionId===undefined||domainVersionId===null){throw'Missing the requir
|
|
|
15449
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(){/**
|
|
15450
15502
|
* Languages service.
|
|
15451
15503
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
15452
|
-
* @version
|
|
15504
|
+
* @version 206.0.0
|
|
15453
15505
|
*//**
|
|
15454
15506
|
* Constructs a new LanguagesApi.
|
|
15455
15507
|
* @alias module:purecloud-platform-client-v2/api/LanguagesApi
|
|
@@ -15504,7 +15556,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
15504
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(){/**
|
|
15505
15557
|
* Learning service.
|
|
15506
15558
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
15507
|
-
* @version
|
|
15559
|
+
* @version 206.0.0
|
|
15508
15560
|
*//**
|
|
15509
15561
|
* Constructs a new LearningApi.
|
|
15510
15562
|
* @alias module:purecloud-platform-client-v2/api/LearningApi
|
|
@@ -15775,7 +15827,7 @@ if(moduleId===undefined||moduleId===null){throw'Missing the required parameter "
|
|
|
15775
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(){/**
|
|
15776
15828
|
* License service.
|
|
15777
15829
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
15778
|
-
* @version
|
|
15830
|
+
* @version 206.0.0
|
|
15779
15831
|
*//**
|
|
15780
15832
|
* Constructs a new LicenseApi.
|
|
15781
15833
|
* @alias module:purecloud-platform-client-v2/api/LicenseApi
|
|
@@ -15829,7 +15881,7 @@ if(featureName===undefined||featureName===null){throw'Missing the required param
|
|
|
15829
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(){/**
|
|
15830
15882
|
* Locations service.
|
|
15831
15883
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
15832
|
-
* @version
|
|
15884
|
+
* @version 206.0.0
|
|
15833
15885
|
*//**
|
|
15834
15886
|
* Constructs a new LocationsApi.
|
|
15835
15887
|
* @alias module:purecloud-platform-client-v2/api/LocationsApi
|
|
@@ -15888,7 +15940,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
15888
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(){/**
|
|
15889
15941
|
* LogCapture service.
|
|
15890
15942
|
* @module purecloud-platform-client-v2/api/LogCaptureApi
|
|
15891
|
-
* @version
|
|
15943
|
+
* @version 206.0.0
|
|
15892
15944
|
*//**
|
|
15893
15945
|
* Constructs a new LogCaptureApi.
|
|
15894
15946
|
* @alias module:purecloud-platform-client-v2/api/LogCaptureApi
|
|
@@ -15938,7 +15990,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
15938
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(){/**
|
|
15939
15991
|
* Messaging service.
|
|
15940
15992
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
15941
|
-
* @version
|
|
15993
|
+
* @version 206.0.0
|
|
15942
15994
|
*//**
|
|
15943
15995
|
* Constructs a new MessagingApi.
|
|
15944
15996
|
* @alias module:purecloud-platform-client-v2/api/MessagingApi
|
|
@@ -16028,7 +16080,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
16028
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(){/**
|
|
16029
16081
|
* MobileDevices service.
|
|
16030
16082
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
16031
|
-
* @version
|
|
16083
|
+
* @version 206.0.0
|
|
16032
16084
|
*//**
|
|
16033
16085
|
* Constructs a new MobileDevicesApi.
|
|
16034
16086
|
* @alias module:purecloud-platform-client-v2/api/MobileDevicesApi
|
|
@@ -16067,7 +16119,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
16067
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(){/**
|
|
16068
16120
|
* Notifications service.
|
|
16069
16121
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
16070
|
-
* @version
|
|
16122
|
+
* @version 206.0.0
|
|
16071
16123
|
*//**
|
|
16072
16124
|
* Constructs a new NotificationsApi.
|
|
16073
16125
|
* @alias module:purecloud-platform-client-v2/api/NotificationsApi
|
|
@@ -16124,7 +16176,7 @@ if(channelId===undefined||channelId===null){throw'Missing the required parameter
|
|
|
16124
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(){/**
|
|
16125
16177
|
* OAuth service.
|
|
16126
16178
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
16127
|
-
* @version
|
|
16179
|
+
* @version 206.0.0
|
|
16128
16180
|
*//**
|
|
16129
16181
|
* Constructs a new OAuthApi.
|
|
16130
16182
|
* @alias module:purecloud-platform-client-v2/api/OAuthApi
|
|
@@ -16209,7 +16261,7 @@ if(clientId===undefined||clientId===null){throw'Missing the required parameter "
|
|
|
16209
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(){/**
|
|
16210
16262
|
* Objects service.
|
|
16211
16263
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
16212
|
-
* @version
|
|
16264
|
+
* @version 206.0.0
|
|
16213
16265
|
*//**
|
|
16214
16266
|
* Constructs a new ObjectsApi.
|
|
16215
16267
|
* @alias module:purecloud-platform-client-v2/api/ObjectsApi
|
|
@@ -16280,7 +16332,7 @@ if(divisionId===undefined||divisionId===null){throw'Missing the required paramet
|
|
|
16280
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(){/**
|
|
16281
16333
|
* OperationalEvents service.
|
|
16282
16334
|
* @module purecloud-platform-client-v2/api/OperationalEventsApi
|
|
16283
|
-
* @version
|
|
16335
|
+
* @version 206.0.0
|
|
16284
16336
|
*//**
|
|
16285
16337
|
* Constructs a new OperationalEventsApi.
|
|
16286
16338
|
* @alias module:purecloud-platform-client-v2/api/OperationalEventsApi
|
|
@@ -16298,7 +16350,7 @@ if(eventDefinitionId===undefined||eventDefinitionId===null){throw'Missing the re
|
|
|
16298
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(){/**
|
|
16299
16351
|
* Organization service.
|
|
16300
16352
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
16301
|
-
* @version
|
|
16353
|
+
* @version 206.0.0
|
|
16302
16354
|
*//**
|
|
16303
16355
|
* Constructs a new OrganizationApi.
|
|
16304
16356
|
* @alias module:purecloud-platform-client-v2/api/OrganizationApi
|
|
@@ -16423,7 +16475,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
16423
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(){/**
|
|
16424
16476
|
* OrganizationAuthorization service.
|
|
16425
16477
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
16426
|
-
* @version
|
|
16478
|
+
* @version 206.0.0
|
|
16427
16479
|
*//**
|
|
16428
16480
|
* Constructs a new OrganizationAuthorizationApi.
|
|
16429
16481
|
* @alias module:purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
@@ -16746,7 +16798,7 @@ if(trustorOrgId===undefined||trustorOrgId===null){throw'Missing the required par
|
|
|
16746
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(){/**
|
|
16747
16799
|
* Outbound service.
|
|
16748
16800
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
16749
|
-
* @version
|
|
16801
|
+
* @version 206.0.0
|
|
16750
16802
|
*//**
|
|
16751
16803
|
* Constructs a new OutboundApi.
|
|
16752
16804
|
* @alias module:purecloud-platform-client-v2/api/OutboundApi
|
|
@@ -17833,7 +17885,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
17833
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(){/**
|
|
17834
17886
|
* Presence service.
|
|
17835
17887
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
17836
|
-
* @version
|
|
17888
|
+
* @version 206.0.0
|
|
17837
17889
|
*//**
|
|
17838
17890
|
* Constructs a new PresenceApi.
|
|
17839
17891
|
* @alias module:purecloud-platform-client-v2/api/PresenceApi
|
|
@@ -18006,7 +18058,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
18006
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(){/**
|
|
18007
18059
|
* ProcessAutomation service.
|
|
18008
18060
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
18009
|
-
* @version
|
|
18061
|
+
* @version 206.0.0
|
|
18010
18062
|
*//**
|
|
18011
18063
|
* Constructs a new ProcessAutomationApi.
|
|
18012
18064
|
* @alias module:purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
@@ -18069,7 +18121,7 @@ if(triggerId===undefined||triggerId===null){throw'Missing the required parameter
|
|
|
18069
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(){/**
|
|
18070
18122
|
* Quality service.
|
|
18071
18123
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
18072
|
-
* @version
|
|
18124
|
+
* @version 206.0.0
|
|
18073
18125
|
*//**
|
|
18074
18126
|
* Constructs a new QualityApi.
|
|
18075
18127
|
* @alias module:purecloud-platform-client-v2/api/QualityApi
|
|
@@ -18546,7 +18598,7 @@ if(customerSurveyUrl===undefined||customerSurveyUrl===null){throw'Missing the re
|
|
|
18546
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(){/**
|
|
18547
18599
|
* Recording service.
|
|
18548
18600
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
18549
|
-
* @version
|
|
18601
|
+
* @version 206.0.0
|
|
18550
18602
|
*//**
|
|
18551
18603
|
* Constructs a new RecordingApi.
|
|
18552
18604
|
* @alias module:purecloud-platform-client-v2/api/RecordingApi
|
|
@@ -18958,7 +19010,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
18958
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(){/**
|
|
18959
19011
|
* ResponseManagement service.
|
|
18960
19012
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
18961
|
-
* @version
|
|
19013
|
+
* @version 206.0.0
|
|
18962
19014
|
*//**
|
|
18963
19015
|
* Constructs a new ResponseManagementApi.
|
|
18964
19016
|
* @alias module:purecloud-platform-client-v2/api/ResponseManagementApi
|
|
@@ -19079,7 +19131,7 @@ if(responseAssetId===undefined||responseAssetId===null){throw'Missing the requir
|
|
|
19079
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(){/**
|
|
19080
19132
|
* Routing service.
|
|
19081
19133
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
19082
|
-
* @version
|
|
19134
|
+
* @version 206.0.0
|
|
19083
19135
|
*//**
|
|
19084
19136
|
* Constructs a new RoutingApi.
|
|
19085
19137
|
* @alias module:purecloud-platform-client-v2/api/RoutingApi
|
|
@@ -20083,7 +20135,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
20083
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(){/**
|
|
20084
20136
|
* SCIM service.
|
|
20085
20137
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
20086
|
-
* @version
|
|
20138
|
+
* @version 206.0.0
|
|
20087
20139
|
*//**
|
|
20088
20140
|
* Constructs a new SCIMApi.
|
|
20089
20141
|
* @alias module:purecloud-platform-client-v2/api/SCIMApi
|
|
@@ -20308,7 +20360,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
20308
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(){/**
|
|
20309
20361
|
* ScreenRecording service.
|
|
20310
20362
|
* @module purecloud-platform-client-v2/api/ScreenRecordingApi
|
|
20311
|
-
* @version
|
|
20363
|
+
* @version 206.0.0
|
|
20312
20364
|
*//**
|
|
20313
20365
|
* Constructs a new ScreenRecordingApi.
|
|
20314
20366
|
* @alias module:purecloud-platform-client-v2/api/ScreenRecordingApi
|
|
@@ -20323,7 +20375,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
20323
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(){/**
|
|
20324
20376
|
* Scripts service.
|
|
20325
20377
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
20326
|
-
* @version
|
|
20378
|
+
* @version 206.0.0
|
|
20327
20379
|
*//**
|
|
20328
20380
|
* Constructs a new ScriptsApi.
|
|
20329
20381
|
* @alias module:purecloud-platform-client-v2/api/ScriptsApi
|
|
@@ -20459,7 +20511,7 @@ if(scriptId===undefined||scriptId===null){throw'Missing the required parameter "
|
|
|
20459
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(){/**
|
|
20460
20512
|
* Search service.
|
|
20461
20513
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
20462
|
-
* @version
|
|
20514
|
+
* @version 206.0.0
|
|
20463
20515
|
*//**
|
|
20464
20516
|
* Constructs a new SearchApi.
|
|
20465
20517
|
* @alias module:purecloud-platform-client-v2/api/SearchApi
|
|
@@ -20619,7 +20671,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
20619
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(){/**
|
|
20620
20672
|
* Settings service.
|
|
20621
20673
|
* @module purecloud-platform-client-v2/api/SettingsApi
|
|
20622
|
-
* @version
|
|
20674
|
+
* @version 206.0.0
|
|
20623
20675
|
*//**
|
|
20624
20676
|
* Constructs a new SettingsApi.
|
|
20625
20677
|
* @alias module:purecloud-platform-client-v2/api/SettingsApi
|
|
@@ -20669,7 +20721,7 @@ if(agentId===undefined||agentId===null){throw'Missing the required parameter "ag
|
|
|
20669
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(){/**
|
|
20670
20722
|
* SpeechTextAnalytics service.
|
|
20671
20723
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
20672
|
-
* @version
|
|
20724
|
+
* @version 206.0.0
|
|
20673
20725
|
*//**
|
|
20674
20726
|
* Constructs a new SpeechTextAnalyticsApi.
|
|
20675
20727
|
* @alias module:purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
@@ -20968,7 +21020,7 @@ if(topicId===undefined||topicId===null){throw'Missing the required parameter "to
|
|
|
20968
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(){/**
|
|
20969
21021
|
* Stations service.
|
|
20970
21022
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
20971
|
-
* @version
|
|
21023
|
+
* @version 206.0.0
|
|
20972
21024
|
*//**
|
|
20973
21025
|
* Constructs a new StationsApi.
|
|
20974
21026
|
* @alias module:purecloud-platform-client-v2/api/StationsApi
|
|
@@ -21000,7 +21052,7 @@ if(stationId===undefined||stationId===null){throw'Missing the required parameter
|
|
|
21000
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(){/**
|
|
21001
21053
|
* Suggest service.
|
|
21002
21054
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
21003
|
-
* @version
|
|
21055
|
+
* @version 206.0.0
|
|
21004
21056
|
*//**
|
|
21005
21057
|
* Constructs a new SuggestApi.
|
|
21006
21058
|
* @alias module:purecloud-platform-client-v2/api/SuggestApi
|
|
@@ -21040,7 +21092,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
21040
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(){/**
|
|
21041
21093
|
* TaskManagement service.
|
|
21042
21094
|
* @module purecloud-platform-client-v2/api/TaskManagementApi
|
|
21043
|
-
* @version
|
|
21095
|
+
* @version 206.0.0
|
|
21044
21096
|
*//**
|
|
21045
21097
|
* Constructs a new TaskManagementApi.
|
|
21046
21098
|
* @alias module:purecloud-platform-client-v2/api/TaskManagementApi
|
|
@@ -21068,6 +21120,20 @@ if(schemaId===undefined||schemaId===null){throw'Missing the required parameter "
|
|
|
21068
21120
|
* @param {String} worktypeId Worktype id
|
|
21069
21121
|
*/},{key:"deleteTaskmanagementWorktype",value:function deleteTaskmanagementWorktype(worktypeId){// verify the required parameter 'worktypeId' is set
|
|
21070
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']);}/**
|
|
21071
21137
|
* Delete a status
|
|
21072
21138
|
*
|
|
21073
21139
|
* @param {String} worktypeId Worktype id
|
|
@@ -21202,6 +21268,36 @@ if(schemaId===undefined||schemaId===null){throw'Missing the required parameter "
|
|
|
21202
21268
|
* @param {Array.<String>} opts.expands Which fields, if any, to expand.
|
|
21203
21269
|
*/},{key:"getTaskmanagementWorktype",value:function getTaskmanagementWorktype(worktypeId,opts){opts=opts||{};// verify the required parameter 'worktypeId' is set
|
|
21204
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']);}/**
|
|
21205
21301
|
* Get a listing of a worktype's attribute change history
|
|
21206
21302
|
*
|
|
21207
21303
|
* @param {String} worktypeId Worktype id
|
|
@@ -21287,6 +21383,24 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
21287
21383
|
*/},{key:"patchTaskmanagementWorktype",value:function patchTaskmanagementWorktype(worktypeId,body){// verify the required parameter 'worktypeId' is set
|
|
21288
21384
|
if(worktypeId===undefined||worktypeId===null){throw'Missing the required parameter "worktypeId" when calling patchTaskmanagementWorktype';}// verify the required parameter 'body' is set
|
|
21289
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']);}/**
|
|
21290
21404
|
* Update the attributes of a status
|
|
21291
21405
|
*
|
|
21292
21406
|
* @param {String} worktypeId Worktype id
|
|
@@ -21344,6 +21458,20 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
21344
21458
|
* @param {Object} body Schema
|
|
21345
21459
|
*/},{key:"postTaskmanagementWorkitemsSchemas",value:function postTaskmanagementWorkitemsSchemas(body){// verify the required parameter 'body' is set
|
|
21346
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']);}/**
|
|
21347
21475
|
* Add a status to a worktype
|
|
21348
21476
|
*
|
|
21349
21477
|
* @param {String} worktypeId Worktype id
|
|
@@ -21370,7 +21498,7 @@ if(schemaId===undefined||schemaId===null){throw'Missing the required parameter "
|
|
|
21370
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(){/**
|
|
21371
21499
|
* Teams service.
|
|
21372
21500
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
21373
|
-
* @version
|
|
21501
|
+
* @version 206.0.0
|
|
21374
21502
|
*//**
|
|
21375
21503
|
* Constructs a new TeamsApi.
|
|
21376
21504
|
* @alias module:purecloud-platform-client-v2/api/TeamsApi
|
|
@@ -21448,7 +21576,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
21448
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(){/**
|
|
21449
21577
|
* Telephony service.
|
|
21450
21578
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
21451
|
-
* @version
|
|
21579
|
+
* @version 206.0.0
|
|
21452
21580
|
*//**
|
|
21453
21581
|
* Constructs a new TelephonyApi.
|
|
21454
21582
|
* @alias module:purecloud-platform-client-v2/api/TelephonyApi
|
|
@@ -21495,7 +21623,7 @@ if(downloadId===undefined||downloadId===null){throw'Missing the required paramet
|
|
|
21495
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(){/**
|
|
21496
21624
|
* TelephonyProvidersEdge service.
|
|
21497
21625
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
21498
|
-
* @version
|
|
21626
|
+
* @version 206.0.0
|
|
21499
21627
|
*//**
|
|
21500
21628
|
* Constructs a new TelephonyProvidersEdgeApi.
|
|
21501
21629
|
* @alias module:purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
@@ -22318,7 +22446,7 @@ if(trunkBaseSettingsId===undefined||trunkBaseSettingsId===null){throw'Missing th
|
|
|
22318
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(){/**
|
|
22319
22447
|
* Textbots service.
|
|
22320
22448
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
22321
|
-
* @version
|
|
22449
|
+
* @version 206.0.0
|
|
22322
22450
|
*//**
|
|
22323
22451
|
* Constructs a new TextbotsApi.
|
|
22324
22452
|
* @alias module:purecloud-platform-client-v2/api/TextbotsApi
|
|
@@ -22353,7 +22481,7 @@ if(launchRequest===undefined||launchRequest===null){throw'Missing the required p
|
|
|
22353
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(){/**
|
|
22354
22482
|
* Tokens service.
|
|
22355
22483
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
22356
|
-
* @version
|
|
22484
|
+
* @version 206.0.0
|
|
22357
22485
|
*//**
|
|
22358
22486
|
* Constructs a new TokensApi.
|
|
22359
22487
|
* @alias module:purecloud-platform-client-v2/api/TokensApi
|
|
@@ -22387,7 +22515,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
22387
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(){/**
|
|
22388
22516
|
* Uploads service.
|
|
22389
22517
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
22390
|
-
* @version
|
|
22518
|
+
* @version 206.0.0
|
|
22391
22519
|
*//**
|
|
22392
22520
|
* Constructs a new UploadsApi.
|
|
22393
22521
|
* @alias module:purecloud-platform-client-v2/api/UploadsApi
|
|
@@ -22453,7 +22581,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
22453
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(){/**
|
|
22454
22582
|
* Usage service.
|
|
22455
22583
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
22456
|
-
* @version
|
|
22584
|
+
* @version 206.0.0
|
|
22457
22585
|
*//**
|
|
22458
22586
|
* Constructs a new UsageApi.
|
|
22459
22587
|
* @alias module:purecloud-platform-client-v2/api/UsageApi
|
|
@@ -22507,7 +22635,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
22507
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(){/**
|
|
22508
22636
|
* UserRecordings service.
|
|
22509
22637
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
22510
|
-
* @version
|
|
22638
|
+
* @version 206.0.0
|
|
22511
22639
|
*//**
|
|
22512
22640
|
* Constructs a new UserRecordingsApi.
|
|
22513
22641
|
* @alias module:purecloud-platform-client-v2/api/UserRecordingsApi
|
|
@@ -22564,7 +22692,7 @@ if(recordingId===undefined||recordingId===null){throw'Missing the required param
|
|
|
22564
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(){/**
|
|
22565
22693
|
* Users service.
|
|
22566
22694
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
22567
|
-
* @version
|
|
22695
|
+
* @version 206.0.0
|
|
22568
22696
|
*//**
|
|
22569
22697
|
* Constructs a new UsersApi.
|
|
22570
22698
|
* @alias module:purecloud-platform-client-v2/api/UsersApi
|
|
@@ -23254,7 +23382,7 @@ if(verifierId===undefined||verifierId===null){throw'Missing the required paramet
|
|
|
23254
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(){/**
|
|
23255
23383
|
* Utilities service.
|
|
23256
23384
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
23257
|
-
* @version
|
|
23385
|
+
* @version 206.0.0
|
|
23258
23386
|
*//**
|
|
23259
23387
|
* Constructs a new UtilitiesApi.
|
|
23260
23388
|
* @alias module:purecloud-platform-client-v2/api/UtilitiesApi
|
|
@@ -23281,7 +23409,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
23281
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(){/**
|
|
23282
23410
|
* Voicemail service.
|
|
23283
23411
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
23284
|
-
* @version
|
|
23412
|
+
* @version 206.0.0
|
|
23285
23413
|
*//**
|
|
23286
23414
|
* Constructs a new VoicemailApi.
|
|
23287
23415
|
* @alias module:purecloud-platform-client-v2/api/VoicemailApi
|
|
@@ -23430,7 +23558,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
23430
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(){/**
|
|
23431
23559
|
* WebChat service.
|
|
23432
23560
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
23433
|
-
* @version
|
|
23561
|
+
* @version 206.0.0
|
|
23434
23562
|
*//**
|
|
23435
23563
|
* Constructs a new WebChatApi.
|
|
23436
23564
|
* @alias module:purecloud-platform-client-v2/api/WebChatApi
|
|
@@ -23565,7 +23693,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
23565
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(){/**
|
|
23566
23694
|
* WebDeployments service.
|
|
23567
23695
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
23568
|
-
* @version
|
|
23696
|
+
* @version 206.0.0
|
|
23569
23697
|
*//**
|
|
23570
23698
|
* Constructs a new WebDeploymentsApi.
|
|
23571
23699
|
* @alias module:purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
@@ -23616,7 +23744,7 @@ if(configurationId===undefined||configurationId===null){throw'Missing the requir
|
|
|
23616
23744
|
* View configuration drafts
|
|
23617
23745
|
*
|
|
23618
23746
|
* @param {Object} opts Optional parameters
|
|
23619
|
-
* @param {Boolean} opts.showOnlyPublished
|
|
23747
|
+
* @param {Boolean} opts.showOnlyPublished Filter by published status.
|
|
23620
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']);}/**
|
|
23621
23749
|
* Get a deployment
|
|
23622
23750
|
*
|
|
@@ -23686,7 +23814,7 @@ if(deploymentId===undefined||deploymentId===null){throw'Missing the required par
|
|
|
23686
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(){/**
|
|
23687
23815
|
* WebMessaging service.
|
|
23688
23816
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
23689
|
-
* @version
|
|
23817
|
+
* @version 206.0.0
|
|
23690
23818
|
*//**
|
|
23691
23819
|
* Constructs a new WebMessagingApi.
|
|
23692
23820
|
* @alias module:purecloud-platform-client-v2/api/WebMessagingApi
|
|
@@ -23702,7 +23830,7 @@ if(deployment===undefined||deployment===null){throw'Missing the required paramet
|
|
|
23702
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(){/**
|
|
23703
23831
|
* Widgets service.
|
|
23704
23832
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
23705
|
-
* @version
|
|
23833
|
+
* @version 206.0.0
|
|
23706
23834
|
*//**
|
|
23707
23835
|
* Constructs a new WidgetsApi.
|
|
23708
23836
|
* @alias module:purecloud-platform-client-v2/api/WidgetsApi
|
|
@@ -23737,7 +23865,7 @@ if(deploymentId===undefined||deploymentId===null){throw'Missing the required par
|
|
|
23737
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(){/**
|
|
23738
23866
|
* WorkforceManagement service.
|
|
23739
23867
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
23740
|
-
* @version
|
|
23868
|
+
* @version 206.0.0
|
|
23741
23869
|
*//**
|
|
23742
23870
|
* Constructs a new WorkforceManagementApi.
|
|
23743
23871
|
* @alias module:purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
@@ -24711,6 +24839,13 @@ if(managementUnitId===undefined||managementUnitId===null){throw'Missing the requ
|
|
|
24711
24839
|
* @param {Object} opts.body body
|
|
24712
24840
|
*/},{key:"patchWorkforcemanagementManagementunitAgents",value:function patchWorkforcemanagementManagementunitAgents(managementUnitId,opts){opts=opts||{};// verify the required parameter 'managementUnitId' is set
|
|
24713
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']);}/**
|
|
24714
24849
|
* Updates a time off limit object.
|
|
24715
24850
|
* Updates time off limit object properties, but not daily values.
|
|
24716
24851
|
* @param {String} managementUnitId The ID of the management unit.
|
|
@@ -25195,6 +25330,14 @@ if(businessUnitId===undefined||businessUnitId===null){throw'Missing the required
|
|
|
25195
25330
|
* @param {String} hrisIntegrationId The ID of the HRIS integration for which time off types are queried.
|
|
25196
25331
|
*/},{key:"postWorkforcemanagementIntegrationsHriTimeofftypesJobs",value:function postWorkforcemanagementIntegrationsHriTimeofftypesJobs(hrisIntegrationId){// verify the required parameter 'hrisIntegrationId' is set
|
|
25197
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']);}/**
|
|
25198
25341
|
* Query published schedules for given given time range for set of users
|
|
25199
25342
|
*
|
|
25200
25343
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
@@ -25503,7 +25646,7 @@ if(timeOffLimitId===undefined||timeOffLimitId===null){throw'Missing the required
|
|
|
25503
25646
|
* </pre>
|
|
25504
25647
|
* </p>
|
|
25505
25648
|
* @module purecloud-platform-client-v2/index
|
|
25506
|
-
* @version
|
|
25649
|
+
* @version 206.0.0
|
|
25507
25650
|
*/var platformClient=/*#__PURE__*/_createClass(function platformClient(){_classCallCheck(this,platformClient);/**
|
|
25508
25651
|
* The ApiClient constructor.
|
|
25509
25652
|
* @property {module:purecloud-platform-client-v2/ApiClient}
|