purecloud-platform-client-v2 197.0.0 → 198.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 +2 -2
- package/dist/node/purecloud-platform-client-v2.js +401 -110
- package/dist/web-amd/purecloud-platform-client-v2.js +401 -110
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +167 -90
- package/dist/web-cjs/purecloud-platform-client-v2.js +170 -91
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +520 -29
- package/package.json +1 -1
- package/src/purecloud-platform-client-v2/ApiClient.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 +37 -1
- 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 +2 -2
- 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 +30 -2
- 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 +2 -2
- 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 +32 -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 +3 -2
- 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 +3 -3
- package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/VoicemailApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebChatApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebMessagingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WidgetsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +222 -27
- package/src/purecloud-platform-client-v2/index.js +1 -1
package/dist/web-cjs/bundle.js
CHANGED
|
@@ -855,7 +855,7 @@ if(env)this.environment=env;else this.environment=this.host?this.host:'mypureclo
|
|
|
855
855
|
this.environment=this.environment.replace(/\/+$/,'');// Strip protocol and subdomain
|
|
856
856
|
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];}}}]);}();/**
|
|
857
857
|
* @module purecloud-platform-client-v2/ApiClient
|
|
858
|
-
* @version
|
|
858
|
+
* @version 198.0.0
|
|
859
859
|
*/var ApiClient=/*#__PURE__*/function(){/**
|
|
860
860
|
* Manages low level client-server communications, parameter marshalling, etc. There should not be any need for an
|
|
861
861
|
* application to use this class directly - the *Api and model classes provide the public API for the service. The
|
|
@@ -1167,7 +1167,7 @@ resolve(data);})["catch"](function(error){var data=error;if(error.response&&erro
|
|
|
1167
1167
|
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 AgentUIApi=/*#__PURE__*/function(){/**
|
|
1168
1168
|
* AgentUI service.
|
|
1169
1169
|
* @module purecloud-platform-client-v2/api/AgentUIApi
|
|
1170
|
-
* @version
|
|
1170
|
+
* @version 198.0.0
|
|
1171
1171
|
*/ /**
|
|
1172
1172
|
* Constructs a new AgentUIApi.
|
|
1173
1173
|
* @alias module:purecloud-platform-client-v2/api/AgentUIApi
|
|
@@ -1201,7 +1201,7 @@ if(agentId===undefined||agentId===null){throw'Missing the required parameter "ag
|
|
|
1201
1201
|
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(){/**
|
|
1202
1202
|
* Alerting service.
|
|
1203
1203
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
1204
|
-
* @version
|
|
1204
|
+
* @version 198.0.0
|
|
1205
1205
|
*/ /**
|
|
1206
1206
|
* Constructs a new AlertingApi.
|
|
1207
1207
|
* @alias module:purecloud-platform-client-v2/api/AlertingApi
|
|
@@ -1358,7 +1358,7 @@ if(ruleId===undefined||ruleId===null){throw'Missing the required parameter "rule
|
|
|
1358
1358
|
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(){/**
|
|
1359
1359
|
* Analytics service.
|
|
1360
1360
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
1361
|
-
* @version
|
|
1361
|
+
* @version 198.0.0
|
|
1362
1362
|
*/ /**
|
|
1363
1363
|
* Constructs a new AnalyticsApi.
|
|
1364
1364
|
* @alias module:purecloud-platform-client-v2/api/AnalyticsApi
|
|
@@ -1979,7 +1979,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
1979
1979
|
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(){/**
|
|
1980
1980
|
* Architect service.
|
|
1981
1981
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
1982
|
-
* @version
|
|
1982
|
+
* @version 198.0.0
|
|
1983
1983
|
*/ /**
|
|
1984
1984
|
* Constructs a new ArchitectApi.
|
|
1985
1985
|
* @alias module:purecloud-platform-client-v2/api/ArchitectApi
|
|
@@ -3095,7 +3095,7 @@ if(milestoneId===undefined||milestoneId===null){throw'Missing the required param
|
|
|
3095
3095
|
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(){/**
|
|
3096
3096
|
* Audit service.
|
|
3097
3097
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
3098
|
-
* @version
|
|
3098
|
+
* @version 198.0.0
|
|
3099
3099
|
*/ /**
|
|
3100
3100
|
* Constructs a new AuditApi.
|
|
3101
3101
|
* @alias module:purecloud-platform-client-v2/api/AuditApi
|
|
@@ -3144,7 +3144,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
3144
3144
|
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(){/**
|
|
3145
3145
|
* Authorization service.
|
|
3146
3146
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
3147
|
-
* @version
|
|
3147
|
+
* @version 198.0.0
|
|
3148
3148
|
*/ /**
|
|
3149
3149
|
* Constructs a new AuthorizationApi.
|
|
3150
3150
|
* @alias module:purecloud-platform-client-v2/api/AuthorizationApi
|
|
@@ -3459,7 +3459,7 @@ if(subjectId===undefined||subjectId===null){throw'Missing the required parameter
|
|
|
3459
3459
|
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(){/**
|
|
3460
3460
|
* Billing service.
|
|
3461
3461
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
3462
|
-
* @version
|
|
3462
|
+
* @version 198.0.0
|
|
3463
3463
|
*/ /**
|
|
3464
3464
|
* Constructs a new BillingApi.
|
|
3465
3465
|
* @alias module:purecloud-platform-client-v2/api/BillingApi
|
|
@@ -3483,7 +3483,7 @@ if(endDate===undefined||endDate===null){throw'Missing the required parameter "en
|
|
|
3483
3483
|
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(){/**
|
|
3484
3484
|
* CarrierServices service.
|
|
3485
3485
|
* @module purecloud-platform-client-v2/api/CarrierServicesApi
|
|
3486
|
-
* @version
|
|
3486
|
+
* @version 198.0.0
|
|
3487
3487
|
*/ /**
|
|
3488
3488
|
* Constructs a new CarrierServicesApi.
|
|
3489
3489
|
* @alias module:purecloud-platform-client-v2/api/CarrierServicesApi
|
|
@@ -3503,7 +3503,7 @@ if(phoneNumber===undefined||phoneNumber===null){throw'Missing the required param
|
|
|
3503
3503
|
*/},{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(){/**
|
|
3504
3504
|
* Chat service.
|
|
3505
3505
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
3506
|
-
* @version
|
|
3506
|
+
* @version 198.0.0
|
|
3507
3507
|
*/ /**
|
|
3508
3508
|
* Constructs a new ChatApi.
|
|
3509
3509
|
* @alias module:purecloud-platform-client-v2/api/ChatApi
|
|
@@ -3728,7 +3728,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
3728
3728
|
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(){/**
|
|
3729
3729
|
* Coaching service.
|
|
3730
3730
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
3731
|
-
* @version
|
|
3731
|
+
* @version 198.0.0
|
|
3732
3732
|
*/ /**
|
|
3733
3733
|
* Constructs a new CoachingApi.
|
|
3734
3734
|
* @alias module:purecloud-platform-client-v2/api/CoachingApi
|
|
@@ -3881,7 +3881,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
3881
3881
|
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(){/**
|
|
3882
3882
|
* ContentManagement service.
|
|
3883
3883
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
3884
|
-
* @version
|
|
3884
|
+
* @version 198.0.0
|
|
3885
3885
|
*/ /**
|
|
3886
3886
|
* Constructs a new ContentManagementApi.
|
|
3887
3887
|
* @alias module:purecloud-platform-client-v2/api/ContentManagementApi
|
|
@@ -4164,7 +4164,7 @@ if(tagId===undefined||tagId===null){throw'Missing the required parameter "tagId"
|
|
|
4164
4164
|
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(){/**
|
|
4165
4165
|
* Conversations service.
|
|
4166
4166
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
4167
|
-
* @version
|
|
4167
|
+
* @version 198.0.0
|
|
4168
4168
|
*/ /**
|
|
4169
4169
|
* Constructs a new ConversationsApi.
|
|
4170
4170
|
* @alias module:purecloud-platform-client-v2/api/ConversationsApi
|
|
@@ -5068,6 +5068,16 @@ if(conversationId===undefined||conversationId===null){throw'Missing the required
|
|
|
5068
5068
|
if(participantId===undefined||participantId===null){throw'Missing the required parameter "participantId" when calling patchConversationsEmailParticipantCommunication';}// verify the required parameter 'communicationId' is set
|
|
5069
5069
|
if(communicationId===undefined||communicationId===null){throw'Missing the required parameter "communicationId" when calling patchConversationsEmailParticipantCommunication';}// verify the required parameter 'body' is set
|
|
5070
5070
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling patchConversationsEmailParticipantCommunication';}return this.apiClient.callApi('/api/v2/conversations/emails/{conversationId}/participants/{participantId}/communications/{communicationId}','PATCH',{'conversationId':conversationId,'participantId':participantId,'communicationId':communicationId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
5071
|
+
* Update conversation by setting its parking state
|
|
5072
|
+
*
|
|
5073
|
+
* @param {String} conversationId conversationId
|
|
5074
|
+
* @param {String} participantId participantId
|
|
5075
|
+
* @param {Object} body Parking update request
|
|
5076
|
+
* patchConversationsEmailParticipantParkingstate is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
5077
|
+
*/},{key:"patchConversationsEmailParticipantParkingstate",value:function patchConversationsEmailParticipantParkingstate(conversationId,participantId,body){// verify the required parameter 'conversationId' is set
|
|
5078
|
+
if(conversationId===undefined||conversationId===null){throw'Missing the required parameter "conversationId" when calling patchConversationsEmailParticipantParkingstate';}// verify the required parameter 'participantId' is set
|
|
5079
|
+
if(participantId===undefined||participantId===null){throw'Missing the required parameter "participantId" when calling patchConversationsEmailParticipantParkingstate';}// verify the required parameter 'body' is set
|
|
5080
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling patchConversationsEmailParticipantParkingstate';}return this.apiClient.callApi('/api/v2/conversations/emails/{conversationId}/participants/{participantId}/parkingstate','PATCH',{'conversationId':conversationId,'participantId':participantId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
5071
5081
|
* Update a conversation by disconnecting all of the participants
|
|
5072
5082
|
*
|
|
5073
5083
|
* @param {String} conversationId conversationId
|
|
@@ -5878,7 +5888,7 @@ if(conversationId===undefined||conversationId===null){throw'Missing the required
|
|
|
5878
5888
|
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(){/**
|
|
5879
5889
|
* DataExtensions service.
|
|
5880
5890
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
5881
|
-
* @version
|
|
5891
|
+
* @version 198.0.0
|
|
5882
5892
|
*/ /**
|
|
5883
5893
|
* Constructs a new DataExtensionsApi.
|
|
5884
5894
|
* @alias module:purecloud-platform-client-v2/api/DataExtensionsApi
|
|
@@ -5899,7 +5909,7 @@ if(coretypeName===undefined||coretypeName===null){throw'Missing the required par
|
|
|
5899
5909
|
*/},{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(){/**
|
|
5900
5910
|
* Downloads service.
|
|
5901
5911
|
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
5902
|
-
* @version
|
|
5912
|
+
* @version 198.0.0
|
|
5903
5913
|
*/ /**
|
|
5904
5914
|
* Constructs a new DownloadsApi.
|
|
5905
5915
|
* @alias module:purecloud-platform-client-v2/api/DownloadsApi
|
|
@@ -5918,7 +5928,7 @@ if(coretypeName===undefined||coretypeName===null){throw'Missing the required par
|
|
|
5918
5928
|
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(){/**
|
|
5919
5929
|
* Emails service.
|
|
5920
5930
|
* @module purecloud-platform-client-v2/api/EmailsApi
|
|
5921
|
-
* @version
|
|
5931
|
+
* @version 198.0.0
|
|
5922
5932
|
*/ /**
|
|
5923
5933
|
* Constructs a new EmailsApi.
|
|
5924
5934
|
* @alias module:purecloud-platform-client-v2/api/EmailsApi
|
|
@@ -5936,7 +5946,7 @@ if(downloadId===undefined||downloadId===null){throw'Missing the required paramet
|
|
|
5936
5946
|
*/},{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(){/**
|
|
5937
5947
|
* EmployeeEngagement service.
|
|
5938
5948
|
* @module purecloud-platform-client-v2/api/EmployeeEngagementApi
|
|
5939
|
-
* @version
|
|
5949
|
+
* @version 198.0.0
|
|
5940
5950
|
*/ /**
|
|
5941
5951
|
* Constructs a new EmployeeEngagementApi.
|
|
5942
5952
|
* @alias module:purecloud-platform-client-v2/api/EmployeeEngagementApi
|
|
@@ -5974,7 +5984,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
5974
5984
|
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(){/**
|
|
5975
5985
|
* Events service.
|
|
5976
5986
|
* @module purecloud-platform-client-v2/api/EventsApi
|
|
5977
|
-
* @version
|
|
5987
|
+
* @version 198.0.0
|
|
5978
5988
|
*/ /**
|
|
5979
5989
|
* Constructs a new EventsApi.
|
|
5980
5990
|
* @alias module:purecloud-platform-client-v2/api/EventsApi
|
|
@@ -5999,7 +6009,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
5999
6009
|
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(){/**
|
|
6000
6010
|
* ExternalContacts service.
|
|
6001
6011
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
6002
|
-
* @version
|
|
6012
|
+
* @version 198.0.0
|
|
6003
6013
|
*/ /**
|
|
6004
6014
|
* Constructs a new ExternalContactsApi.
|
|
6005
6015
|
* @alias module:purecloud-platform-client-v2/api/ExternalContactsApi
|
|
@@ -6090,7 +6100,7 @@ if(contactId===undefined||contactId===null){throw'Missing the required parameter
|
|
|
6090
6100
|
*
|
|
6091
6101
|
* @param {String} contactId ExternalContact ID
|
|
6092
6102
|
* @param {Object} opts Optional parameters
|
|
6093
|
-
* @param {Array.<String>} opts.expand which fields, if any, to expand (externalOrganization,externalDataSources)
|
|
6103
|
+
* @param {Array.<String>} opts.expand which fields, if any, to expand (externalOrganization,externalDataSources,identifiers)
|
|
6094
6104
|
*/},{key:"getExternalcontactsContactUnresolved",value:function getExternalcontactsContactUnresolved(contactId,opts){opts=opts||{};// verify the required parameter 'contactId' is set
|
|
6095
6105
|
if(contactId===undefined||contactId===null){throw'Missing the required parameter "contactId" when calling getExternalcontactsContactUnresolved';}return this.apiClient.callApi('/api/v2/externalcontacts/contacts/{contactId}/unresolved','GET',{'contactId':contactId},{'expand':this.apiClient.buildCollectionParam(opts['expand'],'multi')},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
6096
6106
|
* Search for external contacts
|
|
@@ -6456,7 +6466,7 @@ if(relationshipId===undefined||relationshipId===null){throw'Missing the required
|
|
|
6456
6466
|
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(){/**
|
|
6457
6467
|
* Fax service.
|
|
6458
6468
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
6459
|
-
* @version
|
|
6469
|
+
* @version 198.0.0
|
|
6460
6470
|
*/ /**
|
|
6461
6471
|
* Constructs a new FaxApi.
|
|
6462
6472
|
* @alias module:purecloud-platform-client-v2/api/FaxApi
|
|
@@ -6505,7 +6515,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
6505
6515
|
*/},{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(){/**
|
|
6506
6516
|
* Flows service.
|
|
6507
6517
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
6508
|
-
* @version
|
|
6518
|
+
* @version 198.0.0
|
|
6509
6519
|
*/ /**
|
|
6510
6520
|
* Constructs a new FlowsApi.
|
|
6511
6521
|
* @alias module:purecloud-platform-client-v2/api/FlowsApi
|
|
@@ -6553,7 +6563,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
6553
6563
|
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(){/**
|
|
6554
6564
|
* Gamification service.
|
|
6555
6565
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
6556
|
-
* @version
|
|
6566
|
+
* @version 198.0.0
|
|
6557
6567
|
*/ /**
|
|
6558
6568
|
* Constructs a new GamificationApi.
|
|
6559
6569
|
* @alias module:purecloud-platform-client-v2/api/GamificationApi
|
|
@@ -7093,7 +7103,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
7093
7103
|
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(){/**
|
|
7094
7104
|
* GeneralDataProtectionRegulation service.
|
|
7095
7105
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
7096
|
-
* @version
|
|
7106
|
+
* @version 198.0.0
|
|
7097
7107
|
*/ /**
|
|
7098
7108
|
* Constructs a new GeneralDataProtectionRegulationApi.
|
|
7099
7109
|
* @alias module:purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
@@ -7128,7 +7138,7 @@ if(searchValue===undefined||searchValue===null){throw'Missing the required param
|
|
|
7128
7138
|
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(){/**
|
|
7129
7139
|
* Geolocation service.
|
|
7130
7140
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
7131
|
-
* @version
|
|
7141
|
+
* @version 198.0.0
|
|
7132
7142
|
*/ /**
|
|
7133
7143
|
* Constructs a new GeolocationApi.
|
|
7134
7144
|
* @alias module:purecloud-platform-client-v2/api/GeolocationApi
|
|
@@ -7162,7 +7172,7 @@ if(clientId===undefined||clientId===null){throw'Missing the required parameter "
|
|
|
7162
7172
|
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(){/**
|
|
7163
7173
|
* Greetings service.
|
|
7164
7174
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
7165
|
-
* @version
|
|
7175
|
+
* @version 198.0.0
|
|
7166
7176
|
*/ /**
|
|
7167
7177
|
* Constructs a new GreetingsApi.
|
|
7168
7178
|
* @alias module:purecloud-platform-client-v2/api/GreetingsApi
|
|
@@ -7269,7 +7279,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
7269
7279
|
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(){/**
|
|
7270
7280
|
* Groups service.
|
|
7271
7281
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
7272
|
-
* @version
|
|
7282
|
+
* @version 198.0.0
|
|
7273
7283
|
*/ /**
|
|
7274
7284
|
* Constructs a new GroupsApi.
|
|
7275
7285
|
* @alias module:purecloud-platform-client-v2/api/GroupsApi
|
|
@@ -7402,7 +7412,7 @@ if(groupId===undefined||groupId===null){throw'Missing the required parameter "gr
|
|
|
7402
7412
|
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(){/**
|
|
7403
7413
|
* IdentityProvider service.
|
|
7404
7414
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
7405
|
-
* @version
|
|
7415
|
+
* @version 198.0.0
|
|
7406
7416
|
*/ /**
|
|
7407
7417
|
* Constructs a new IdentityProviderApi.
|
|
7408
7418
|
* @alias module:purecloud-platform-client-v2/api/IdentityProviderApi
|
|
@@ -7558,7 +7568,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
7558
7568
|
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(){/**
|
|
7559
7569
|
* InfrastructureAsCode service.
|
|
7560
7570
|
* @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
7561
|
-
* @version
|
|
7571
|
+
* @version 198.0.0
|
|
7562
7572
|
*/ /**
|
|
7563
7573
|
* Constructs a new InfrastructureAsCodeApi.
|
|
7564
7574
|
* @alias module:purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
@@ -7612,7 +7622,7 @@ if(jobId===undefined||jobId===null){throw'Missing the required parameter "jobId"
|
|
|
7612
7622
|
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(){/**
|
|
7613
7623
|
* Integrations service.
|
|
7614
7624
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
7615
|
-
* @version
|
|
7625
|
+
* @version 198.0.0
|
|
7616
7626
|
*/ /**
|
|
7617
7627
|
* Constructs a new IntegrationsApi.
|
|
7618
7628
|
* @alias module:purecloud-platform-client-v2/api/IntegrationsApi
|
|
@@ -8223,7 +8233,7 @@ if(ucIntegrationId===undefined||ucIntegrationId===null){throw'Missing the requir
|
|
|
8223
8233
|
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(){/**
|
|
8224
8234
|
* Journey service.
|
|
8225
8235
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
8226
|
-
* @version
|
|
8236
|
+
* @version 198.0.0
|
|
8227
8237
|
*/ /**
|
|
8228
8238
|
* Constructs a new JourneyApi.
|
|
8229
8239
|
* @alias module:purecloud-platform-client-v2/api/JourneyApi
|
|
@@ -8417,7 +8427,6 @@ if(sessionId===undefined||sessionId===null){throw'Missing the required parameter
|
|
|
8417
8427
|
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
8418
8428
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
8419
8429
|
* @param {Object} opts.eventType A comma separated list of journey event types to include in the results.
|
|
8420
|
-
* getJourneySessionEvents is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
8421
8430
|
*/},{key:"getJourneySessionEvents",value:function getJourneySessionEvents(sessionId,opts){opts=opts||{};// verify the required parameter 'sessionId' is set
|
|
8422
8431
|
if(sessionId===undefined||sessionId===null){throw'Missing the required parameter "sessionId" when calling getJourneySessionEvents';}return this.apiClient.callApi('/api/v2/journey/sessions/{sessionId}/events','GET',{'sessionId':sessionId},{'pageSize':opts['pageSize'],'after':opts['after'],'eventType':opts['eventType']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
8423
8432
|
* Retrieve latest outcome score associated with a session for all outcomes.
|
|
@@ -8565,6 +8574,13 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
8565
8574
|
* @param {Object} opts.body
|
|
8566
8575
|
*/},{key:"postJourneyDeploymentAppevents",value:function postJourneyDeploymentAppevents(deploymentId,opts){opts=opts||{};// verify the required parameter 'deploymentId' is set
|
|
8567
8576
|
if(deploymentId===undefined||deploymentId===null){throw'Missing the required parameter "deploymentId" when calling postJourneyDeploymentAppevents';}return this.apiClient.callApi('/api/v2/journey/deployments/{deploymentId}/appevents','POST',{'deploymentId':deploymentId},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
8577
|
+
* Send a journey web event, used for tracking customer activity on a website.
|
|
8578
|
+
*
|
|
8579
|
+
* @param {String} deploymentId The ID of the deployment sending the web event.
|
|
8580
|
+
* @param {Object} opts Optional parameters
|
|
8581
|
+
* @param {Object} opts.body
|
|
8582
|
+
*/},{key:"postJourneyDeploymentWebevents",value:function postJourneyDeploymentWebevents(deploymentId,opts){opts=opts||{};// verify the required parameter 'deploymentId' is set
|
|
8583
|
+
if(deploymentId===undefined||deploymentId===null){throw'Missing the required parameter "deploymentId" when calling postJourneyDeploymentWebevents';}return this.apiClient.callApi('/api/v2/journey/deployments/{deploymentId}/webevents','POST',{'deploymentId':deploymentId},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
8568
8584
|
* Query for flow paths.
|
|
8569
8585
|
*
|
|
8570
8586
|
* @param {Object} opts Optional parameters
|
|
@@ -8621,7 +8637,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
8621
8637
|
*/},{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']);}}]);}();var KnowledgeApi=/*#__PURE__*/function(){/**
|
|
8622
8638
|
* Knowledge service.
|
|
8623
8639
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
8624
|
-
* @version
|
|
8640
|
+
* @version 198.0.0
|
|
8625
8641
|
*/ /**
|
|
8626
8642
|
* Constructs a new KnowledgeApi.
|
|
8627
8643
|
* @alias module:purecloud-platform-client-v2/api/KnowledgeApi
|
|
@@ -9534,7 +9550,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
9534
9550
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postKnowledgeKnowledgebases';}return this.apiClient.callApi('/api/v2/knowledge/knowledgebases','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);}();var LanguageUnderstandingApi=/*#__PURE__*/function(){/**
|
|
9535
9551
|
* LanguageUnderstanding service.
|
|
9536
9552
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
9537
|
-
* @version
|
|
9553
|
+
* @version 198.0.0
|
|
9538
9554
|
*/ /**
|
|
9539
9555
|
* Constructs a new LanguageUnderstandingApi.
|
|
9540
9556
|
* @alias module:purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
@@ -9794,7 +9810,7 @@ if(domainVersionId===undefined||domainVersionId===null){throw'Missing the requir
|
|
|
9794
9810
|
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(){/**
|
|
9795
9811
|
* Languages service.
|
|
9796
9812
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
9797
|
-
* @version
|
|
9813
|
+
* @version 198.0.0
|
|
9798
9814
|
*/ /**
|
|
9799
9815
|
* Constructs a new LanguagesApi.
|
|
9800
9816
|
* @alias module:purecloud-platform-client-v2/api/LanguagesApi
|
|
@@ -9849,7 +9865,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
9849
9865
|
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(){/**
|
|
9850
9866
|
* Learning service.
|
|
9851
9867
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
9852
|
-
* @version
|
|
9868
|
+
* @version 198.0.0
|
|
9853
9869
|
*/ /**
|
|
9854
9870
|
* Constructs a new LearningApi.
|
|
9855
9871
|
* @alias module:purecloud-platform-client-v2/api/LearningApi
|
|
@@ -10120,7 +10136,7 @@ if(moduleId===undefined||moduleId===null){throw'Missing the required parameter "
|
|
|
10120
10136
|
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(){/**
|
|
10121
10137
|
* License service.
|
|
10122
10138
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
10123
|
-
* @version
|
|
10139
|
+
* @version 198.0.0
|
|
10124
10140
|
*/ /**
|
|
10125
10141
|
* Constructs a new LicenseApi.
|
|
10126
10142
|
* @alias module:purecloud-platform-client-v2/api/LicenseApi
|
|
@@ -10174,7 +10190,7 @@ if(featureName===undefined||featureName===null){throw'Missing the required param
|
|
|
10174
10190
|
*/},{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(){/**
|
|
10175
10191
|
* Locations service.
|
|
10176
10192
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
10177
|
-
* @version
|
|
10193
|
+
* @version 198.0.0
|
|
10178
10194
|
*/ /**
|
|
10179
10195
|
* Constructs a new LocationsApi.
|
|
10180
10196
|
* @alias module:purecloud-platform-client-v2/api/LocationsApi
|
|
@@ -10233,7 +10249,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
10233
10249
|
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(){/**
|
|
10234
10250
|
* LogCapture service.
|
|
10235
10251
|
* @module purecloud-platform-client-v2/api/LogCaptureApi
|
|
10236
|
-
* @version
|
|
10252
|
+
* @version 198.0.0
|
|
10237
10253
|
*/ /**
|
|
10238
10254
|
* Constructs a new LogCaptureApi.
|
|
10239
10255
|
* @alias module:purecloud-platform-client-v2/api/LogCaptureApi
|
|
@@ -10283,7 +10299,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
10283
10299
|
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(){/**
|
|
10284
10300
|
* Messaging service.
|
|
10285
10301
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
10286
|
-
* @version
|
|
10302
|
+
* @version 198.0.0
|
|
10287
10303
|
*/ /**
|
|
10288
10304
|
* Constructs a new MessagingApi.
|
|
10289
10305
|
* @alias module:purecloud-platform-client-v2/api/MessagingApi
|
|
@@ -10373,7 +10389,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
10373
10389
|
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(){/**
|
|
10374
10390
|
* MobileDevices service.
|
|
10375
10391
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
10376
|
-
* @version
|
|
10392
|
+
* @version 198.0.0
|
|
10377
10393
|
*/ /**
|
|
10378
10394
|
* Constructs a new MobileDevicesApi.
|
|
10379
10395
|
* @alias module:purecloud-platform-client-v2/api/MobileDevicesApi
|
|
@@ -10412,7 +10428,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
10412
10428
|
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(){/**
|
|
10413
10429
|
* Notifications service.
|
|
10414
10430
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
10415
|
-
* @version
|
|
10431
|
+
* @version 198.0.0
|
|
10416
10432
|
*/ /**
|
|
10417
10433
|
* Constructs a new NotificationsApi.
|
|
10418
10434
|
* @alias module:purecloud-platform-client-v2/api/NotificationsApi
|
|
@@ -10469,7 +10485,7 @@ if(channelId===undefined||channelId===null){throw'Missing the required parameter
|
|
|
10469
10485
|
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(){/**
|
|
10470
10486
|
* OAuth service.
|
|
10471
10487
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
10472
|
-
* @version
|
|
10488
|
+
* @version 198.0.0
|
|
10473
10489
|
*/ /**
|
|
10474
10490
|
* Constructs a new OAuthApi.
|
|
10475
10491
|
* @alias module:purecloud-platform-client-v2/api/OAuthApi
|
|
@@ -10554,7 +10570,7 @@ if(clientId===undefined||clientId===null){throw'Missing the required parameter "
|
|
|
10554
10570
|
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(){/**
|
|
10555
10571
|
* Objects service.
|
|
10556
10572
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
10557
|
-
* @version
|
|
10573
|
+
* @version 198.0.0
|
|
10558
10574
|
*/ /**
|
|
10559
10575
|
* Constructs a new ObjectsApi.
|
|
10560
10576
|
* @alias module:purecloud-platform-client-v2/api/ObjectsApi
|
|
@@ -10625,7 +10641,7 @@ if(divisionId===undefined||divisionId===null){throw'Missing the required paramet
|
|
|
10625
10641
|
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(){/**
|
|
10626
10642
|
* OperationalEvents service.
|
|
10627
10643
|
* @module purecloud-platform-client-v2/api/OperationalEventsApi
|
|
10628
|
-
* @version
|
|
10644
|
+
* @version 198.0.0
|
|
10629
10645
|
*/ /**
|
|
10630
10646
|
* Constructs a new OperationalEventsApi.
|
|
10631
10647
|
* @alias module:purecloud-platform-client-v2/api/OperationalEventsApi
|
|
@@ -10643,7 +10659,7 @@ if(eventDefinitionId===undefined||eventDefinitionId===null){throw'Missing the re
|
|
|
10643
10659
|
*/},{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(){/**
|
|
10644
10660
|
* Organization service.
|
|
10645
10661
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
10646
|
-
* @version
|
|
10662
|
+
* @version 198.0.0
|
|
10647
10663
|
*/ /**
|
|
10648
10664
|
* Constructs a new OrganizationApi.
|
|
10649
10665
|
* @alias module:purecloud-platform-client-v2/api/OrganizationApi
|
|
@@ -10748,7 +10764,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
10748
10764
|
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(){/**
|
|
10749
10765
|
* OrganizationAuthorization service.
|
|
10750
10766
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
10751
|
-
* @version
|
|
10767
|
+
* @version 198.0.0
|
|
10752
10768
|
*/ /**
|
|
10753
10769
|
* Constructs a new OrganizationAuthorizationApi.
|
|
10754
10770
|
* @alias module:purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
@@ -11071,7 +11087,7 @@ if(trustorOrgId===undefined||trustorOrgId===null){throw'Missing the required par
|
|
|
11071
11087
|
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(){/**
|
|
11072
11088
|
* Outbound service.
|
|
11073
11089
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
11074
|
-
* @version
|
|
11090
|
+
* @version 198.0.0
|
|
11075
11091
|
*/ /**
|
|
11076
11092
|
* Constructs a new OutboundApi.
|
|
11077
11093
|
* @alias module:purecloud-platform-client-v2/api/OutboundApi
|
|
@@ -11205,7 +11221,7 @@ if(id===undefined||id===null){throw'Missing the required parameter "id" when cal
|
|
|
11205
11221
|
*/},{key:"deleteOutboundMessagingcampaign",value:function deleteOutboundMessagingcampaign(messagingCampaignId){// verify the required parameter 'messagingCampaignId' is set
|
|
11206
11222
|
if(messagingCampaignId===undefined||messagingCampaignId===null){throw'Missing the required parameter "messagingCampaignId" when calling deleteOutboundMessagingcampaign';}return this.apiClient.callApi('/api/v2/outbound/messagingcampaigns/{messagingCampaignId}','DELETE',{'messagingCampaignId':messagingCampaignId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
11207
11223
|
* Reset messaging campaign progress and recycle the messaging campaign
|
|
11208
|
-
*
|
|
11224
|
+
* Documented permissions are applicable based on campaign type.
|
|
11209
11225
|
* @param {String} messagingCampaignId The Messaging Campaign ID
|
|
11210
11226
|
*/},{key:"deleteOutboundMessagingcampaignProgress",value:function deleteOutboundMessagingcampaignProgress(messagingCampaignId){// verify the required parameter 'messagingCampaignId' is set
|
|
11211
11227
|
if(messagingCampaignId===undefined||messagingCampaignId===null){throw'Missing the required parameter "messagingCampaignId" when calling deleteOutboundMessagingcampaignProgress';}return this.apiClient.callApi('/api/v2/outbound/messagingcampaigns/{messagingCampaignId}/progress','DELETE',{'messagingCampaignId':messagingCampaignId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
@@ -12138,7 +12154,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
12138
12154
|
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(){/**
|
|
12139
12155
|
* Presence service.
|
|
12140
12156
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
12141
|
-
* @version
|
|
12157
|
+
* @version 198.0.0
|
|
12142
12158
|
*/ /**
|
|
12143
12159
|
* Constructs a new PresenceApi.
|
|
12144
12160
|
* @alias module:purecloud-platform-client-v2/api/PresenceApi
|
|
@@ -12311,7 +12327,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
12311
12327
|
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(){/**
|
|
12312
12328
|
* ProcessAutomation service.
|
|
12313
12329
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
12314
|
-
* @version
|
|
12330
|
+
* @version 198.0.0
|
|
12315
12331
|
*/ /**
|
|
12316
12332
|
* Constructs a new ProcessAutomationApi.
|
|
12317
12333
|
* @alias module:purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
@@ -12374,7 +12390,7 @@ if(triggerId===undefined||triggerId===null){throw'Missing the required parameter
|
|
|
12374
12390
|
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(){/**
|
|
12375
12391
|
* Quality service.
|
|
12376
12392
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
12377
|
-
* @version
|
|
12393
|
+
* @version 198.0.0
|
|
12378
12394
|
*/ /**
|
|
12379
12395
|
* Constructs a new QualityApi.
|
|
12380
12396
|
* @alias module:purecloud-platform-client-v2/api/QualityApi
|
|
@@ -12827,6 +12843,14 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
12827
12843
|
*/},{key:"putQualityFormsEvaluation",value:function putQualityFormsEvaluation(formId,body){// verify the required parameter 'formId' is set
|
|
12828
12844
|
if(formId===undefined||formId===null){throw'Missing the required parameter "formId" when calling putQualityFormsEvaluation';}// verify the required parameter 'body' is set
|
|
12829
12845
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putQualityFormsEvaluation';}return this.apiClient.callApi('/api/v2/quality/forms/evaluations/{formId}','PUT',{'formId':formId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
12846
|
+
* Update the Predictive Scoring settings of an evaluation form.
|
|
12847
|
+
*
|
|
12848
|
+
* @param {String} formId Form ID
|
|
12849
|
+
* @param {Object} body Predictive Scoring Settings
|
|
12850
|
+
* putQualityFormsEvaluationPredictivescoringSettings is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
12851
|
+
*/},{key:"putQualityFormsEvaluationPredictivescoringSettings",value:function putQualityFormsEvaluationPredictivescoringSettings(formId,body){// verify the required parameter 'formId' is set
|
|
12852
|
+
if(formId===undefined||formId===null){throw'Missing the required parameter "formId" when calling putQualityFormsEvaluationPredictivescoringSettings';}// verify the required parameter 'body' is set
|
|
12853
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putQualityFormsEvaluationPredictivescoringSettings';}return this.apiClient.callApi('/api/v2/quality/forms/evaluations/{formId}/predictivescoring/settings','PUT',{'formId':formId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
12830
12854
|
* Update a survey form.
|
|
12831
12855
|
*
|
|
12832
12856
|
* @param {String} formId Form ID
|
|
@@ -12843,7 +12867,7 @@ if(customerSurveyUrl===undefined||customerSurveyUrl===null){throw'Missing the re
|
|
|
12843
12867
|
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(){/**
|
|
12844
12868
|
* Recording service.
|
|
12845
12869
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
12846
|
-
* @version
|
|
12870
|
+
* @version 198.0.0
|
|
12847
12871
|
*/ /**
|
|
12848
12872
|
* Constructs a new RecordingApi.
|
|
12849
12873
|
* @alias module:purecloud-platform-client-v2/api/RecordingApi
|
|
@@ -13254,7 +13278,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
13254
13278
|
*/},{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(){/**
|
|
13255
13279
|
* ResponseManagement service.
|
|
13256
13280
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
13257
|
-
* @version
|
|
13281
|
+
* @version 198.0.0
|
|
13258
13282
|
*/ /**
|
|
13259
13283
|
* Constructs a new ResponseManagementApi.
|
|
13260
13284
|
* @alias module:purecloud-platform-client-v2/api/ResponseManagementApi
|
|
@@ -13375,7 +13399,7 @@ if(responseAssetId===undefined||responseAssetId===null){throw'Missing the requir
|
|
|
13375
13399
|
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(){/**
|
|
13376
13400
|
* Routing service.
|
|
13377
13401
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
13378
|
-
* @version
|
|
13402
|
+
* @version 198.0.0
|
|
13379
13403
|
*/ /**
|
|
13380
13404
|
* Constructs a new RoutingApi.
|
|
13381
13405
|
* @alias module:purecloud-platform-client-v2/api/RoutingApi
|
|
@@ -14344,7 +14368,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
14344
14368
|
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(){/**
|
|
14345
14369
|
* SCIM service.
|
|
14346
14370
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
14347
|
-
* @version
|
|
14371
|
+
* @version 198.0.0
|
|
14348
14372
|
*/ /**
|
|
14349
14373
|
* Constructs a new SCIMApi.
|
|
14350
14374
|
* @alias module:purecloud-platform-client-v2/api/SCIMApi
|
|
@@ -14569,7 +14593,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
14569
14593
|
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(){/**
|
|
14570
14594
|
* ScreenRecording service.
|
|
14571
14595
|
* @module purecloud-platform-client-v2/api/ScreenRecordingApi
|
|
14572
|
-
* @version
|
|
14596
|
+
* @version 198.0.0
|
|
14573
14597
|
*/ /**
|
|
14574
14598
|
* Constructs a new ScreenRecordingApi.
|
|
14575
14599
|
* @alias module:purecloud-platform-client-v2/api/ScreenRecordingApi
|
|
@@ -14584,7 +14608,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
14584
14608
|
*/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(){/**
|
|
14585
14609
|
* Scripts service.
|
|
14586
14610
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
14587
|
-
* @version
|
|
14611
|
+
* @version 198.0.0
|
|
14588
14612
|
*/ /**
|
|
14589
14613
|
* Constructs a new ScriptsApi.
|
|
14590
14614
|
* @alias module:purecloud-platform-client-v2/api/ScriptsApi
|
|
@@ -14720,7 +14744,7 @@ if(scriptId===undefined||scriptId===null){throw'Missing the required parameter "
|
|
|
14720
14744
|
*/},{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(){/**
|
|
14721
14745
|
* Search service.
|
|
14722
14746
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
14723
|
-
* @version
|
|
14747
|
+
* @version 198.0.0
|
|
14724
14748
|
*/ /**
|
|
14725
14749
|
* Constructs a new SearchApi.
|
|
14726
14750
|
* @alias module:purecloud-platform-client-v2/api/SearchApi
|
|
@@ -14880,7 +14904,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
14880
14904
|
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(){/**
|
|
14881
14905
|
* Settings service.
|
|
14882
14906
|
* @module purecloud-platform-client-v2/api/SettingsApi
|
|
14883
|
-
* @version
|
|
14907
|
+
* @version 198.0.0
|
|
14884
14908
|
*/ /**
|
|
14885
14909
|
* Constructs a new SettingsApi.
|
|
14886
14910
|
* @alias module:purecloud-platform-client-v2/api/SettingsApi
|
|
@@ -14932,7 +14956,7 @@ if(agentId===undefined||agentId===null){throw'Missing the required parameter "ag
|
|
|
14932
14956
|
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(){/**
|
|
14933
14957
|
* SpeechTextAnalytics service.
|
|
14934
14958
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
14935
|
-
* @version
|
|
14959
|
+
* @version 198.0.0
|
|
14936
14960
|
*/ /**
|
|
14937
14961
|
* Constructs a new SpeechTextAnalyticsApi.
|
|
14938
14962
|
* @alias module:purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
@@ -15216,7 +15240,7 @@ if(topicId===undefined||topicId===null){throw'Missing the required parameter "to
|
|
|
15216
15240
|
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(){/**
|
|
15217
15241
|
* Stations service.
|
|
15218
15242
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
15219
|
-
* @version
|
|
15243
|
+
* @version 198.0.0
|
|
15220
15244
|
*/ /**
|
|
15221
15245
|
* Constructs a new StationsApi.
|
|
15222
15246
|
* @alias module:purecloud-platform-client-v2/api/StationsApi
|
|
@@ -15248,7 +15272,7 @@ if(stationId===undefined||stationId===null){throw'Missing the required parameter
|
|
|
15248
15272
|
*/},{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(){/**
|
|
15249
15273
|
* Suggest service.
|
|
15250
15274
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
15251
|
-
* @version
|
|
15275
|
+
* @version 198.0.0
|
|
15252
15276
|
*/ /**
|
|
15253
15277
|
* Constructs a new SuggestApi.
|
|
15254
15278
|
* @alias module:purecloud-platform-client-v2/api/SuggestApi
|
|
@@ -15288,7 +15312,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
15288
15312
|
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(){/**
|
|
15289
15313
|
* TaskManagement service.
|
|
15290
15314
|
* @module purecloud-platform-client-v2/api/TaskManagementApi
|
|
15291
|
-
* @version
|
|
15315
|
+
* @version 198.0.0
|
|
15292
15316
|
*/ /**
|
|
15293
15317
|
* Constructs a new TaskManagementApi.
|
|
15294
15318
|
* @alias module:purecloud-platform-client-v2/api/TaskManagementApi
|
|
@@ -15457,9 +15481,10 @@ if(worktypeId===undefined||worktypeId===null){throw'Missing the required paramet
|
|
|
15457
15481
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
15458
15482
|
* @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)
|
|
15459
15483
|
* @param {Object} opts.sortOrder Ascending or descending sort order (default to descending)
|
|
15484
|
+
* @param {Array.<String>} opts.fields Comma-separated list of fields. The response will contain only versions created as a result of changes to these fields.
|
|
15460
15485
|
* getTaskmanagementWorktypeHistory is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
15461
15486
|
*/},{key:"getTaskmanagementWorktypeHistory",value:function getTaskmanagementWorktypeHistory(worktypeId,opts){opts=opts||{};// verify the required parameter 'worktypeId' is set
|
|
15462
|
-
if(worktypeId===undefined||worktypeId===null){throw'Missing the required parameter "worktypeId" when calling getTaskmanagementWorktypeHistory';}return this.apiClient.callApi('/api/v2/taskmanagement/worktypes/{worktypeId}/history','GET',{'worktypeId':worktypeId},{'after':opts['after'],'pageSize':opts['pageSize'],'sortOrder':opts['sortOrder']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
15487
|
+
if(worktypeId===undefined||worktypeId===null){throw'Missing the required parameter "worktypeId" when calling getTaskmanagementWorktypeHistory';}return this.apiClient.callApi('/api/v2/taskmanagement/worktypes/{worktypeId}/history','GET',{'worktypeId':worktypeId},{'after':opts['after'],'pageSize':opts['pageSize'],'sortOrder':opts['sortOrder'],'fields':this.apiClient.buildCollectionParam(opts['fields'],'multi')},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
15463
15488
|
* Get a status
|
|
15464
15489
|
*
|
|
15465
15490
|
* @param {String} worktypeId Worktype id
|
|
@@ -15617,7 +15642,7 @@ if(schemaId===undefined||schemaId===null){throw'Missing the required parameter "
|
|
|
15617
15642
|
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(){/**
|
|
15618
15643
|
* Teams service.
|
|
15619
15644
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
15620
|
-
* @version
|
|
15645
|
+
* @version 198.0.0
|
|
15621
15646
|
*/ /**
|
|
15622
15647
|
* Constructs a new TeamsApi.
|
|
15623
15648
|
* @alias module:purecloud-platform-client-v2/api/TeamsApi
|
|
@@ -15695,7 +15720,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
15695
15720
|
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(){/**
|
|
15696
15721
|
* Telephony service.
|
|
15697
15722
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
15698
|
-
* @version
|
|
15723
|
+
* @version 198.0.0
|
|
15699
15724
|
*/ /**
|
|
15700
15725
|
* Constructs a new TelephonyApi.
|
|
15701
15726
|
* @alias module:purecloud-platform-client-v2/api/TelephonyApi
|
|
@@ -15742,7 +15767,7 @@ if(downloadId===undefined||downloadId===null){throw'Missing the required paramet
|
|
|
15742
15767
|
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(){/**
|
|
15743
15768
|
* TelephonyProvidersEdge service.
|
|
15744
15769
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
15745
|
-
* @version
|
|
15770
|
+
* @version 198.0.0
|
|
15746
15771
|
*/ /**
|
|
15747
15772
|
* Constructs a new TelephonyProvidersEdgeApi.
|
|
15748
15773
|
* @alias module:purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
@@ -16552,7 +16577,7 @@ if(trunkBaseSettingsId===undefined||trunkBaseSettingsId===null){throw'Missing th
|
|
|
16552
16577
|
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(){/**
|
|
16553
16578
|
* Textbots service.
|
|
16554
16579
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
16555
|
-
* @version
|
|
16580
|
+
* @version 198.0.0
|
|
16556
16581
|
*/ /**
|
|
16557
16582
|
* Constructs a new TextbotsApi.
|
|
16558
16583
|
* @alias module:purecloud-platform-client-v2/api/TextbotsApi
|
|
@@ -16587,7 +16612,7 @@ if(launchRequest===undefined||launchRequest===null){throw'Missing the required p
|
|
|
16587
16612
|
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(){/**
|
|
16588
16613
|
* Tokens service.
|
|
16589
16614
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
16590
|
-
* @version
|
|
16615
|
+
* @version 198.0.0
|
|
16591
16616
|
*/ /**
|
|
16592
16617
|
* Constructs a new TokensApi.
|
|
16593
16618
|
* @alias module:purecloud-platform-client-v2/api/TokensApi
|
|
@@ -16621,7 +16646,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
16621
16646
|
*/},{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(){/**
|
|
16622
16647
|
* Uploads service.
|
|
16623
16648
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
16624
|
-
* @version
|
|
16649
|
+
* @version 198.0.0
|
|
16625
16650
|
*/ /**
|
|
16626
16651
|
* Constructs a new UploadsApi.
|
|
16627
16652
|
* @alias module:purecloud-platform-client-v2/api/UploadsApi
|
|
@@ -16687,7 +16712,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
16687
16712
|
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(){/**
|
|
16688
16713
|
* Usage service.
|
|
16689
16714
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
16690
|
-
* @version
|
|
16715
|
+
* @version 198.0.0
|
|
16691
16716
|
*/ /**
|
|
16692
16717
|
* Constructs a new UsageApi.
|
|
16693
16718
|
* @alias module:purecloud-platform-client-v2/api/UsageApi
|
|
@@ -16741,7 +16766,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
16741
16766
|
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(){/**
|
|
16742
16767
|
* UserRecordings service.
|
|
16743
16768
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
16744
|
-
* @version
|
|
16769
|
+
* @version 198.0.0
|
|
16745
16770
|
*/ /**
|
|
16746
16771
|
* Constructs a new UserRecordingsApi.
|
|
16747
16772
|
* @alias module:purecloud-platform-client-v2/api/UserRecordingsApi
|
|
@@ -16790,7 +16815,7 @@ if(recordingId===undefined||recordingId===null){throw'Missing the required param
|
|
|
16790
16815
|
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(){/**
|
|
16791
16816
|
* Users service.
|
|
16792
16817
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
16793
|
-
* @version
|
|
16818
|
+
* @version 198.0.0
|
|
16794
16819
|
*/ /**
|
|
16795
16820
|
* Constructs a new UsersApi.
|
|
16796
16821
|
* @alias module:purecloud-platform-client-v2/api/UsersApi
|
|
@@ -16949,7 +16974,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
16949
16974
|
*
|
|
16950
16975
|
* @param {String} userId User ID
|
|
16951
16976
|
* @param {Object} opts Optional parameters
|
|
16952
|
-
* @param {Array.<String>} opts.expand Which fields, if any, to expand
|
|
16977
|
+
* @param {Array.<String>} opts.expand Which fields, if any, to expand. Note, expand parameters are resolved with a best effort approach and not guaranteed to be returned. If requested expand information is absolutely required, it's recommended to use specific API requests instead.
|
|
16953
16978
|
* @param {Object} opts.integrationPresenceSource Gets an integration presence for a user instead of their default.
|
|
16954
16979
|
* @param {Object} opts.state Search for a user with this state (default to active)
|
|
16955
16980
|
*/},{key:"getUser",value:function getUser(userId,opts){opts=opts||{};// verify the required parameter 'userId' is set
|
|
@@ -17095,7 +17120,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
17095
17120
|
* @param {Array.<String>} opts.id A list of user IDs to fetch by bulk
|
|
17096
17121
|
* @param {Array.<String>} opts.jabberId A list of jabberIds to fetch by bulk (cannot be used with the id parameter)
|
|
17097
17122
|
* @param {Object} opts.sortOrder Ascending or descending sort order (default to ASC)
|
|
17098
|
-
* @param {Array.<String>} opts.expand Which fields, if any, to expand
|
|
17123
|
+
* @param {Array.<String>} opts.expand Which fields, if any, to expand. Note, expand parameters are resolved with a best effort approach and not guaranteed to be returned. If requested expand information is absolutely required, it's recommended to use specific API requests instead.
|
|
17099
17124
|
* @param {Object} opts.integrationPresenceSource Gets an integration presence for users instead of their defaults. This parameter will only be used when presence is provided as an expand. When using this parameter the maximum number of users that can be returned is 100.
|
|
17100
17125
|
* @param {Object} opts.state Only list users of this state (default to active)
|
|
17101
17126
|
*/},{key:"getUsers",value:function getUsers(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/users','GET',{},{'pageSize':opts['pageSize'],'pageNumber':opts['pageNumber'],'id':this.apiClient.buildCollectionParam(opts['id'],'multi'),'jabberId':this.apiClient.buildCollectionParam(opts['jabberId'],'multi'),'sortOrder':opts['sortOrder'],'expand':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'integrationPresenceSource':opts['integrationPresenceSource'],'state':opts['state']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
@@ -17452,7 +17477,7 @@ if(verifierId===undefined||verifierId===null){throw'Missing the required paramet
|
|
|
17452
17477
|
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(){/**
|
|
17453
17478
|
* Utilities service.
|
|
17454
17479
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
17455
|
-
* @version
|
|
17480
|
+
* @version 198.0.0
|
|
17456
17481
|
*/ /**
|
|
17457
17482
|
* Constructs a new UtilitiesApi.
|
|
17458
17483
|
* @alias module:purecloud-platform-client-v2/api/UtilitiesApi
|
|
@@ -17479,7 +17504,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
17479
17504
|
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(){/**
|
|
17480
17505
|
* Voicemail service.
|
|
17481
17506
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
17482
|
-
* @version
|
|
17507
|
+
* @version 198.0.0
|
|
17483
17508
|
*/ /**
|
|
17484
17509
|
* Constructs a new VoicemailApi.
|
|
17485
17510
|
* @alias module:purecloud-platform-client-v2/api/VoicemailApi
|
|
@@ -17628,7 +17653,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
17628
17653
|
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(){/**
|
|
17629
17654
|
* WebChat service.
|
|
17630
17655
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
17631
|
-
* @version
|
|
17656
|
+
* @version 198.0.0
|
|
17632
17657
|
*/ /**
|
|
17633
17658
|
* Constructs a new WebChatApi.
|
|
17634
17659
|
* @alias module:purecloud-platform-client-v2/api/WebChatApi
|
|
@@ -17763,7 +17788,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
17763
17788
|
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(){/**
|
|
17764
17789
|
* WebDeployments service.
|
|
17765
17790
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
17766
|
-
* @version
|
|
17791
|
+
* @version 198.0.0
|
|
17767
17792
|
*/ /**
|
|
17768
17793
|
* Constructs a new WebDeploymentsApi.
|
|
17769
17794
|
* @alias module:purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
@@ -17884,7 +17909,7 @@ if(deploymentId===undefined||deploymentId===null){throw'Missing the required par
|
|
|
17884
17909
|
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(){/**
|
|
17885
17910
|
* WebMessaging service.
|
|
17886
17911
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
17887
|
-
* @version
|
|
17912
|
+
* @version 198.0.0
|
|
17888
17913
|
*/ /**
|
|
17889
17914
|
* Constructs a new WebMessagingApi.
|
|
17890
17915
|
* @alias module:purecloud-platform-client-v2/api/WebMessagingApi
|
|
@@ -17900,7 +17925,7 @@ if(deployment===undefined||deployment===null){throw'Missing the required paramet
|
|
|
17900
17925
|
*/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(){/**
|
|
17901
17926
|
* Widgets service.
|
|
17902
17927
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
17903
|
-
* @version
|
|
17928
|
+
* @version 198.0.0
|
|
17904
17929
|
*/ /**
|
|
17905
17930
|
* Constructs a new WidgetsApi.
|
|
17906
17931
|
* @alias module:purecloud-platform-client-v2/api/WidgetsApi
|
|
@@ -17935,7 +17960,7 @@ if(deploymentId===undefined||deploymentId===null){throw'Missing the required par
|
|
|
17935
17960
|
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(){/**
|
|
17936
17961
|
* WorkforceManagement service.
|
|
17937
17962
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
17938
|
-
* @version
|
|
17963
|
+
* @version 198.0.0
|
|
17939
17964
|
*/ /**
|
|
17940
17965
|
* Constructs a new WorkforceManagementApi.
|
|
17941
17966
|
* @alias module:purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
@@ -18076,12 +18101,6 @@ if(jobId===undefined||jobId===null){throw'Missing the required parameter "jobId"
|
|
|
18076
18101
|
* @param {String} jobId jobId
|
|
18077
18102
|
*/},{key:"getWorkforcemanagementAdherenceHistoricalJob",value:function getWorkforcemanagementAdherenceHistoricalJob(jobId){// verify the required parameter 'jobId' is set
|
|
18078
18103
|
if(jobId===undefined||jobId===null){throw'Missing the required parameter "jobId" when calling getWorkforcemanagementAdherenceHistoricalJob';}return this.apiClient.callApi('/api/v2/workforcemanagement/adherence/historical/jobs/{jobId}','GET',{'jobId':jobId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
18079
|
-
* To get status of the modeling job.
|
|
18080
|
-
* This Endpoint is Deprecated, and not recommended to be used.
|
|
18081
|
-
* @param {String} jobId The id of the modeling job
|
|
18082
|
-
* @deprecated
|
|
18083
|
-
*/},{key:"getWorkforcemanagementAdhocmodelingjob",value:function getWorkforcemanagementAdhocmodelingjob(jobId){// verify the required parameter 'jobId' is set
|
|
18084
|
-
if(jobId===undefined||jobId===null){throw'Missing the required parameter "jobId" when calling getWorkforcemanagementAdhocmodelingjob';}return this.apiClient.callApi('/api/v2/workforcemanagement/adhocmodelingjobs/{jobId}','GET',{'jobId':jobId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
18085
18104
|
* Get an adherence explanation
|
|
18086
18105
|
*
|
|
18087
18106
|
* @param {String} agentId The ID of the agent to query
|
|
@@ -18118,6 +18137,38 @@ if(activityCodeId===undefined||activityCodeId===null){throw'Missing the required
|
|
|
18118
18137
|
* @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
|
|
18119
18138
|
*/},{key:"getWorkforcemanagementBusinessunitActivitycodes",value:function getWorkforcemanagementBusinessunitActivitycodes(businessUnitId,opts){opts=opts||{};// verify the required parameter 'businessUnitId' is set
|
|
18120
18139
|
if(businessUnitId===undefined||businessUnitId===null){throw'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitActivitycodes';}return this.apiClient.callApi('/api/v2/workforcemanagement/businessunits/{businessUnitId}/activitycodes','GET',{'businessUnitId':businessUnitId},{'forceDownloadService':opts['forceDownloadService']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
18140
|
+
* Get an activity plan
|
|
18141
|
+
*
|
|
18142
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
18143
|
+
* @param {String} activityPlanId The ID of the activity plan to fetch
|
|
18144
|
+
* getWorkforcemanagementBusinessunitActivityplan is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
18145
|
+
*/},{key:"getWorkforcemanagementBusinessunitActivityplan",value:function getWorkforcemanagementBusinessunitActivityplan(businessUnitId,activityPlanId){// verify the required parameter 'businessUnitId' is set
|
|
18146
|
+
if(businessUnitId===undefined||businessUnitId===null){throw'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitActivityplan';}// verify the required parameter 'activityPlanId' is set
|
|
18147
|
+
if(activityPlanId===undefined||activityPlanId===null){throw'Missing the required parameter "activityPlanId" when calling getWorkforcemanagementBusinessunitActivityplan';}return this.apiClient.callApi('/api/v2/workforcemanagement/businessunits/{businessUnitId}/activityplans/{activityPlanId}','GET',{'businessUnitId':businessUnitId,'activityPlanId':activityPlanId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
18148
|
+
* Gets an activity plan run job
|
|
18149
|
+
*
|
|
18150
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
18151
|
+
* @param {String} activityPlanId The ID of the activity plan associated with the run job
|
|
18152
|
+
* @param {String} jobId The ID of the activity plan run job
|
|
18153
|
+
* getWorkforcemanagementBusinessunitActivityplanRunsJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
18154
|
+
*/},{key:"getWorkforcemanagementBusinessunitActivityplanRunsJob",value:function getWorkforcemanagementBusinessunitActivityplanRunsJob(businessUnitId,activityPlanId,jobId){// verify the required parameter 'businessUnitId' is set
|
|
18155
|
+
if(businessUnitId===undefined||businessUnitId===null){throw'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitActivityplanRunsJob';}// verify the required parameter 'activityPlanId' is set
|
|
18156
|
+
if(activityPlanId===undefined||activityPlanId===null){throw'Missing the required parameter "activityPlanId" when calling getWorkforcemanagementBusinessunitActivityplanRunsJob';}// verify the required parameter 'jobId' is set
|
|
18157
|
+
if(jobId===undefined||jobId===null){throw'Missing the required parameter "jobId" when calling getWorkforcemanagementBusinessunitActivityplanRunsJob';}return this.apiClient.callApi('/api/v2/workforcemanagement/businessunits/{businessUnitId}/activityplans/{activityPlanId}/runs/jobs/{jobId}','GET',{'businessUnitId':businessUnitId,'activityPlanId':activityPlanId,'jobId':jobId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
18158
|
+
* Get activity plans
|
|
18159
|
+
*
|
|
18160
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
18161
|
+
* @param {Object} opts Optional parameters
|
|
18162
|
+
* @param {Object} opts.state Optionally filter by activity plan state
|
|
18163
|
+
* getWorkforcemanagementBusinessunitActivityplans is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
18164
|
+
*/},{key:"getWorkforcemanagementBusinessunitActivityplans",value:function getWorkforcemanagementBusinessunitActivityplans(businessUnitId,opts){opts=opts||{};// verify the required parameter 'businessUnitId' is set
|
|
18165
|
+
if(businessUnitId===undefined||businessUnitId===null){throw'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitActivityplans';}return this.apiClient.callApi('/api/v2/workforcemanagement/businessunits/{businessUnitId}/activityplans','GET',{'businessUnitId':businessUnitId},{'state':opts['state']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
18166
|
+
* Gets the latest job for all activity plans in the business unit
|
|
18167
|
+
*
|
|
18168
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
18169
|
+
* getWorkforcemanagementBusinessunitActivityplansJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
18170
|
+
*/},{key:"getWorkforcemanagementBusinessunitActivityplansJobs",value:function getWorkforcemanagementBusinessunitActivityplansJobs(businessUnitId){// verify the required parameter 'businessUnitId' is set
|
|
18171
|
+
if(businessUnitId===undefined||businessUnitId===null){throw'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitActivityplansJobs';}return this.apiClient.callApi('/api/v2/workforcemanagement/businessunits/{businessUnitId}/activityplans/jobs','GET',{'businessUnitId':businessUnitId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
18121
18172
|
* Get intraday planning groups for the given date
|
|
18122
18173
|
*
|
|
18123
18174
|
* @param {String} businessUnitId The ID of the business unit
|
|
@@ -18646,6 +18697,16 @@ if(businessUnitId===undefined||businessUnitId===null){throw'Missing the required
|
|
|
18646
18697
|
*/},{key:"patchWorkforcemanagementBusinessunitActivitycode",value:function patchWorkforcemanagementBusinessunitActivitycode(businessUnitId,activityCodeId,opts){opts=opts||{};// verify the required parameter 'businessUnitId' is set
|
|
18647
18698
|
if(businessUnitId===undefined||businessUnitId===null){throw'Missing the required parameter "businessUnitId" when calling patchWorkforcemanagementBusinessunitActivitycode';}// verify the required parameter 'activityCodeId' is set
|
|
18648
18699
|
if(activityCodeId===undefined||activityCodeId===null){throw'Missing the required parameter "activityCodeId" when calling patchWorkforcemanagementBusinessunitActivitycode';}return this.apiClient.callApi('/api/v2/workforcemanagement/businessunits/{businessUnitId}/activitycodes/{activityCodeId}','PATCH',{'businessUnitId':businessUnitId,'activityCodeId':activityCodeId},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
18700
|
+
* Update an activity plan
|
|
18701
|
+
* If a job associated with the activity plan is in Processing state the activity plan cannot be updated
|
|
18702
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
18703
|
+
* @param {String} activityPlanId The ID of the activity plan to update
|
|
18704
|
+
* @param {Object} body body
|
|
18705
|
+
* patchWorkforcemanagementBusinessunitActivityplan is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
18706
|
+
*/},{key:"patchWorkforcemanagementBusinessunitActivityplan",value:function patchWorkforcemanagementBusinessunitActivityplan(businessUnitId,activityPlanId,body){// verify the required parameter 'businessUnitId' is set
|
|
18707
|
+
if(businessUnitId===undefined||businessUnitId===null){throw'Missing the required parameter "businessUnitId" when calling patchWorkforcemanagementBusinessunitActivityplan';}// verify the required parameter 'activityPlanId' is set
|
|
18708
|
+
if(activityPlanId===undefined||activityPlanId===null){throw'Missing the required parameter "activityPlanId" when calling patchWorkforcemanagementBusinessunitActivityplan';}// verify the required parameter 'body' is set
|
|
18709
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling patchWorkforcemanagementBusinessunitActivityplan';}return this.apiClient.callApi('/api/v2/workforcemanagement/businessunits/{businessUnitId}/activityplans/{activityPlanId}','PATCH',{'businessUnitId':businessUnitId,'activityPlanId':activityPlanId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
18649
18710
|
* Updates the planning group
|
|
18650
18711
|
*
|
|
18651
18712
|
* @param {String} businessUnitId The ID of the business unit.
|
|
@@ -18850,6 +18911,22 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
18850
18911
|
* @param {Object} opts.body body
|
|
18851
18912
|
*/},{key:"postWorkforcemanagementBusinessunitActivitycodes",value:function postWorkforcemanagementBusinessunitActivitycodes(businessUnitId,opts){opts=opts||{};// verify the required parameter 'businessUnitId' is set
|
|
18852
18913
|
if(businessUnitId===undefined||businessUnitId===null){throw'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitActivitycodes';}return this.apiClient.callApi('/api/v2/workforcemanagement/businessunits/{businessUnitId}/activitycodes','POST',{'businessUnitId':businessUnitId},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
18914
|
+
* Run an activity plan manually
|
|
18915
|
+
* Triggers a job running the activity plan. The activity plan cannot be updated until the job completes
|
|
18916
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
18917
|
+
* @param {String} activityPlanId The ID of the activity plan to run
|
|
18918
|
+
* postWorkforcemanagementBusinessunitActivityplanRunsJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
18919
|
+
*/},{key:"postWorkforcemanagementBusinessunitActivityplanRunsJobs",value:function postWorkforcemanagementBusinessunitActivityplanRunsJobs(businessUnitId,activityPlanId){// verify the required parameter 'businessUnitId' is set
|
|
18920
|
+
if(businessUnitId===undefined||businessUnitId===null){throw'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitActivityplanRunsJobs';}// verify the required parameter 'activityPlanId' is set
|
|
18921
|
+
if(activityPlanId===undefined||activityPlanId===null){throw'Missing the required parameter "activityPlanId" when calling postWorkforcemanagementBusinessunitActivityplanRunsJobs';}return this.apiClient.callApi('/api/v2/workforcemanagement/businessunits/{businessUnitId}/activityplans/{activityPlanId}/runs/jobs','POST',{'businessUnitId':businessUnitId,'activityPlanId':activityPlanId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
18922
|
+
* Create an activity plan
|
|
18923
|
+
*
|
|
18924
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
18925
|
+
* @param {Object} body body
|
|
18926
|
+
* postWorkforcemanagementBusinessunitActivityplans is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
18927
|
+
*/},{key:"postWorkforcemanagementBusinessunitActivityplans",value:function postWorkforcemanagementBusinessunitActivityplans(businessUnitId,body){// verify the required parameter 'businessUnitId' is set
|
|
18928
|
+
if(businessUnitId===undefined||businessUnitId===null){throw'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitActivityplans';}// verify the required parameter 'body' is set
|
|
18929
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitActivityplans';}return this.apiClient.callApi('/api/v2/workforcemanagement/businessunits/{businessUnitId}/activityplans','POST',{'businessUnitId':businessUnitId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
18853
18930
|
* Query adherence explanations across an entire business unit for the requested period
|
|
18854
18931
|
*
|
|
18855
18932
|
* @param {String} businessUnitId The ID of the business unit
|
|
@@ -19415,7 +19492,7 @@ if(timeOffLimitId===undefined||timeOffLimitId===null){throw'Missing the required
|
|
|
19415
19492
|
* </pre>
|
|
19416
19493
|
* </p>
|
|
19417
19494
|
* @module purecloud-platform-client-v2/index
|
|
19418
|
-
* @version
|
|
19495
|
+
* @version 198.0.0
|
|
19419
19496
|
*/var platformClient=/*#__PURE__*/_createClass(function platformClient(){_classCallCheck(this,platformClient);/**
|
|
19420
19497
|
* The ApiClient constructor.
|
|
19421
19498
|
* @property {module:purecloud-platform-client-v2/ApiClient}
|