purecloud-platform-client-v2 197.0.0 → 199.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 -112
- package/dist/web-amd/purecloud-platform-client-v2.js +401 -112
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +167 -92
- package/dist/web-cjs/purecloud-platform-client-v2.js +170 -93
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +733 -238
- 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 -3
- 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 199.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 199.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 199.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 199.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 199.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 199.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 199.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 199.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 199.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 199.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 199.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 199.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 199.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
|
|
@@ -5204,7 +5214,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
5204
5214
|
* Barge a conversation creating a barged in conference of connected participants.
|
|
5205
5215
|
*
|
|
5206
5216
|
* @param {String} conversationId conversation ID
|
|
5207
|
-
* postConversationBarge is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
5208
5217
|
*/},{key:"postConversationBarge",value:function postConversationBarge(conversationId){// verify the required parameter 'conversationId' is set
|
|
5209
5218
|
if(conversationId===undefined||conversationId===null){throw'Missing the required parameter "conversationId" when calling postConversationBarge';}return this.apiClient.callApi('/api/v2/conversations/{conversationId}/barge','POST',{'conversationId':conversationId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
5210
5219
|
* Creates a cobrowse session. Requires conversation:cobrowse:add (for web messaging) or conversation:cobrowsevoice:add permission.
|
|
@@ -5316,7 +5325,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
5316
5325
|
*
|
|
5317
5326
|
* @param {String} conversationId conversationId
|
|
5318
5327
|
* @param {String} participantId participantId
|
|
5319
|
-
* postConversationsCallParticipantBarge is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
5320
5328
|
*/},{key:"postConversationsCallParticipantBarge",value:function postConversationsCallParticipantBarge(conversationId,participantId){// verify the required parameter 'conversationId' is set
|
|
5321
5329
|
if(conversationId===undefined||conversationId===null){throw'Missing the required parameter "conversationId" when calling postConversationsCallParticipantBarge';}// verify the required parameter 'participantId' is set
|
|
5322
5330
|
if(participantId===undefined||participantId===null){throw'Missing the required parameter "participantId" when calling postConversationsCallParticipantBarge';}return this.apiClient.callApi('/api/v2/conversations/calls/{conversationId}/participants/{participantId}/barge','POST',{'conversationId':conversationId,'participantId':participantId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
@@ -5878,7 +5886,7 @@ if(conversationId===undefined||conversationId===null){throw'Missing the required
|
|
|
5878
5886
|
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
5887
|
* DataExtensions service.
|
|
5880
5888
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
5881
|
-
* @version
|
|
5889
|
+
* @version 199.0.0
|
|
5882
5890
|
*/ /**
|
|
5883
5891
|
* Constructs a new DataExtensionsApi.
|
|
5884
5892
|
* @alias module:purecloud-platform-client-v2/api/DataExtensionsApi
|
|
@@ -5899,7 +5907,7 @@ if(coretypeName===undefined||coretypeName===null){throw'Missing the required par
|
|
|
5899
5907
|
*/},{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
5908
|
* Downloads service.
|
|
5901
5909
|
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
5902
|
-
* @version
|
|
5910
|
+
* @version 199.0.0
|
|
5903
5911
|
*/ /**
|
|
5904
5912
|
* Constructs a new DownloadsApi.
|
|
5905
5913
|
* @alias module:purecloud-platform-client-v2/api/DownloadsApi
|
|
@@ -5918,7 +5926,7 @@ if(coretypeName===undefined||coretypeName===null){throw'Missing the required par
|
|
|
5918
5926
|
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
5927
|
* Emails service.
|
|
5920
5928
|
* @module purecloud-platform-client-v2/api/EmailsApi
|
|
5921
|
-
* @version
|
|
5929
|
+
* @version 199.0.0
|
|
5922
5930
|
*/ /**
|
|
5923
5931
|
* Constructs a new EmailsApi.
|
|
5924
5932
|
* @alias module:purecloud-platform-client-v2/api/EmailsApi
|
|
@@ -5936,7 +5944,7 @@ if(downloadId===undefined||downloadId===null){throw'Missing the required paramet
|
|
|
5936
5944
|
*/},{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
5945
|
* EmployeeEngagement service.
|
|
5938
5946
|
* @module purecloud-platform-client-v2/api/EmployeeEngagementApi
|
|
5939
|
-
* @version
|
|
5947
|
+
* @version 199.0.0
|
|
5940
5948
|
*/ /**
|
|
5941
5949
|
* Constructs a new EmployeeEngagementApi.
|
|
5942
5950
|
* @alias module:purecloud-platform-client-v2/api/EmployeeEngagementApi
|
|
@@ -5974,7 +5982,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
5974
5982
|
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
5983
|
* Events service.
|
|
5976
5984
|
* @module purecloud-platform-client-v2/api/EventsApi
|
|
5977
|
-
* @version
|
|
5985
|
+
* @version 199.0.0
|
|
5978
5986
|
*/ /**
|
|
5979
5987
|
* Constructs a new EventsApi.
|
|
5980
5988
|
* @alias module:purecloud-platform-client-v2/api/EventsApi
|
|
@@ -5999,7 +6007,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
5999
6007
|
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
6008
|
* ExternalContacts service.
|
|
6001
6009
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
6002
|
-
* @version
|
|
6010
|
+
* @version 199.0.0
|
|
6003
6011
|
*/ /**
|
|
6004
6012
|
* Constructs a new ExternalContactsApi.
|
|
6005
6013
|
* @alias module:purecloud-platform-client-v2/api/ExternalContactsApi
|
|
@@ -6090,7 +6098,7 @@ if(contactId===undefined||contactId===null){throw'Missing the required parameter
|
|
|
6090
6098
|
*
|
|
6091
6099
|
* @param {String} contactId ExternalContact ID
|
|
6092
6100
|
* @param {Object} opts Optional parameters
|
|
6093
|
-
* @param {Array.<String>} opts.expand which fields, if any, to expand (externalOrganization,externalDataSources)
|
|
6101
|
+
* @param {Array.<String>} opts.expand which fields, if any, to expand (externalOrganization,externalDataSources,identifiers)
|
|
6094
6102
|
*/},{key:"getExternalcontactsContactUnresolved",value:function getExternalcontactsContactUnresolved(contactId,opts){opts=opts||{};// verify the required parameter 'contactId' is set
|
|
6095
6103
|
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
6104
|
* Search for external contacts
|
|
@@ -6456,7 +6464,7 @@ if(relationshipId===undefined||relationshipId===null){throw'Missing the required
|
|
|
6456
6464
|
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
6465
|
* Fax service.
|
|
6458
6466
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
6459
|
-
* @version
|
|
6467
|
+
* @version 199.0.0
|
|
6460
6468
|
*/ /**
|
|
6461
6469
|
* Constructs a new FaxApi.
|
|
6462
6470
|
* @alias module:purecloud-platform-client-v2/api/FaxApi
|
|
@@ -6505,7 +6513,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
6505
6513
|
*/},{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
6514
|
* Flows service.
|
|
6507
6515
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
6508
|
-
* @version
|
|
6516
|
+
* @version 199.0.0
|
|
6509
6517
|
*/ /**
|
|
6510
6518
|
* Constructs a new FlowsApi.
|
|
6511
6519
|
* @alias module:purecloud-platform-client-v2/api/FlowsApi
|
|
@@ -6553,7 +6561,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
6553
6561
|
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
6562
|
* Gamification service.
|
|
6555
6563
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
6556
|
-
* @version
|
|
6564
|
+
* @version 199.0.0
|
|
6557
6565
|
*/ /**
|
|
6558
6566
|
* Constructs a new GamificationApi.
|
|
6559
6567
|
* @alias module:purecloud-platform-client-v2/api/GamificationApi
|
|
@@ -7093,7 +7101,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
7093
7101
|
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
7102
|
* GeneralDataProtectionRegulation service.
|
|
7095
7103
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
7096
|
-
* @version
|
|
7104
|
+
* @version 199.0.0
|
|
7097
7105
|
*/ /**
|
|
7098
7106
|
* Constructs a new GeneralDataProtectionRegulationApi.
|
|
7099
7107
|
* @alias module:purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
@@ -7128,7 +7136,7 @@ if(searchValue===undefined||searchValue===null){throw'Missing the required param
|
|
|
7128
7136
|
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
7137
|
* Geolocation service.
|
|
7130
7138
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
7131
|
-
* @version
|
|
7139
|
+
* @version 199.0.0
|
|
7132
7140
|
*/ /**
|
|
7133
7141
|
* Constructs a new GeolocationApi.
|
|
7134
7142
|
* @alias module:purecloud-platform-client-v2/api/GeolocationApi
|
|
@@ -7162,7 +7170,7 @@ if(clientId===undefined||clientId===null){throw'Missing the required parameter "
|
|
|
7162
7170
|
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
7171
|
* Greetings service.
|
|
7164
7172
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
7165
|
-
* @version
|
|
7173
|
+
* @version 199.0.0
|
|
7166
7174
|
*/ /**
|
|
7167
7175
|
* Constructs a new GreetingsApi.
|
|
7168
7176
|
* @alias module:purecloud-platform-client-v2/api/GreetingsApi
|
|
@@ -7269,7 +7277,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
7269
7277
|
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
7278
|
* Groups service.
|
|
7271
7279
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
7272
|
-
* @version
|
|
7280
|
+
* @version 199.0.0
|
|
7273
7281
|
*/ /**
|
|
7274
7282
|
* Constructs a new GroupsApi.
|
|
7275
7283
|
* @alias module:purecloud-platform-client-v2/api/GroupsApi
|
|
@@ -7402,7 +7410,7 @@ if(groupId===undefined||groupId===null){throw'Missing the required parameter "gr
|
|
|
7402
7410
|
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
7411
|
* IdentityProvider service.
|
|
7404
7412
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
7405
|
-
* @version
|
|
7413
|
+
* @version 199.0.0
|
|
7406
7414
|
*/ /**
|
|
7407
7415
|
* Constructs a new IdentityProviderApi.
|
|
7408
7416
|
* @alias module:purecloud-platform-client-v2/api/IdentityProviderApi
|
|
@@ -7558,7 +7566,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
7558
7566
|
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
7567
|
* InfrastructureAsCode service.
|
|
7560
7568
|
* @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
7561
|
-
* @version
|
|
7569
|
+
* @version 199.0.0
|
|
7562
7570
|
*/ /**
|
|
7563
7571
|
* Constructs a new InfrastructureAsCodeApi.
|
|
7564
7572
|
* @alias module:purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
@@ -7612,7 +7620,7 @@ if(jobId===undefined||jobId===null){throw'Missing the required parameter "jobId"
|
|
|
7612
7620
|
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
7621
|
* Integrations service.
|
|
7614
7622
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
7615
|
-
* @version
|
|
7623
|
+
* @version 199.0.0
|
|
7616
7624
|
*/ /**
|
|
7617
7625
|
* Constructs a new IntegrationsApi.
|
|
7618
7626
|
* @alias module:purecloud-platform-client-v2/api/IntegrationsApi
|
|
@@ -8223,7 +8231,7 @@ if(ucIntegrationId===undefined||ucIntegrationId===null){throw'Missing the requir
|
|
|
8223
8231
|
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
8232
|
* Journey service.
|
|
8225
8233
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
8226
|
-
* @version
|
|
8234
|
+
* @version 199.0.0
|
|
8227
8235
|
*/ /**
|
|
8228
8236
|
* Constructs a new JourneyApi.
|
|
8229
8237
|
* @alias module:purecloud-platform-client-v2/api/JourneyApi
|
|
@@ -8417,7 +8425,6 @@ if(sessionId===undefined||sessionId===null){throw'Missing the required parameter
|
|
|
8417
8425
|
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
8418
8426
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
8419
8427
|
* @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
8428
|
*/},{key:"getJourneySessionEvents",value:function getJourneySessionEvents(sessionId,opts){opts=opts||{};// verify the required parameter 'sessionId' is set
|
|
8422
8429
|
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
8430
|
* Retrieve latest outcome score associated with a session for all outcomes.
|
|
@@ -8565,6 +8572,13 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
8565
8572
|
* @param {Object} opts.body
|
|
8566
8573
|
*/},{key:"postJourneyDeploymentAppevents",value:function postJourneyDeploymentAppevents(deploymentId,opts){opts=opts||{};// verify the required parameter 'deploymentId' is set
|
|
8567
8574
|
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']);}/**
|
|
8575
|
+
* Send a journey web event, used for tracking customer activity on a website.
|
|
8576
|
+
*
|
|
8577
|
+
* @param {String} deploymentId The ID of the deployment sending the web event.
|
|
8578
|
+
* @param {Object} opts Optional parameters
|
|
8579
|
+
* @param {Object} opts.body
|
|
8580
|
+
*/},{key:"postJourneyDeploymentWebevents",value:function postJourneyDeploymentWebevents(deploymentId,opts){opts=opts||{};// verify the required parameter 'deploymentId' is set
|
|
8581
|
+
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
8582
|
* Query for flow paths.
|
|
8569
8583
|
*
|
|
8570
8584
|
* @param {Object} opts Optional parameters
|
|
@@ -8621,7 +8635,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
8621
8635
|
*/},{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
8636
|
* Knowledge service.
|
|
8623
8637
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
8624
|
-
* @version
|
|
8638
|
+
* @version 199.0.0
|
|
8625
8639
|
*/ /**
|
|
8626
8640
|
* Constructs a new KnowledgeApi.
|
|
8627
8641
|
* @alias module:purecloud-platform-client-v2/api/KnowledgeApi
|
|
@@ -9534,7 +9548,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
9534
9548
|
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
9549
|
* LanguageUnderstanding service.
|
|
9536
9550
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
9537
|
-
* @version
|
|
9551
|
+
* @version 199.0.0
|
|
9538
9552
|
*/ /**
|
|
9539
9553
|
* Constructs a new LanguageUnderstandingApi.
|
|
9540
9554
|
* @alias module:purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
@@ -9794,7 +9808,7 @@ if(domainVersionId===undefined||domainVersionId===null){throw'Missing the requir
|
|
|
9794
9808
|
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
9809
|
* Languages service.
|
|
9796
9810
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
9797
|
-
* @version
|
|
9811
|
+
* @version 199.0.0
|
|
9798
9812
|
*/ /**
|
|
9799
9813
|
* Constructs a new LanguagesApi.
|
|
9800
9814
|
* @alias module:purecloud-platform-client-v2/api/LanguagesApi
|
|
@@ -9849,7 +9863,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
9849
9863
|
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
9864
|
* Learning service.
|
|
9851
9865
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
9852
|
-
* @version
|
|
9866
|
+
* @version 199.0.0
|
|
9853
9867
|
*/ /**
|
|
9854
9868
|
* Constructs a new LearningApi.
|
|
9855
9869
|
* @alias module:purecloud-platform-client-v2/api/LearningApi
|
|
@@ -10120,7 +10134,7 @@ if(moduleId===undefined||moduleId===null){throw'Missing the required parameter "
|
|
|
10120
10134
|
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
10135
|
* License service.
|
|
10122
10136
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
10123
|
-
* @version
|
|
10137
|
+
* @version 199.0.0
|
|
10124
10138
|
*/ /**
|
|
10125
10139
|
* Constructs a new LicenseApi.
|
|
10126
10140
|
* @alias module:purecloud-platform-client-v2/api/LicenseApi
|
|
@@ -10174,7 +10188,7 @@ if(featureName===undefined||featureName===null){throw'Missing the required param
|
|
|
10174
10188
|
*/},{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
10189
|
* Locations service.
|
|
10176
10190
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
10177
|
-
* @version
|
|
10191
|
+
* @version 199.0.0
|
|
10178
10192
|
*/ /**
|
|
10179
10193
|
* Constructs a new LocationsApi.
|
|
10180
10194
|
* @alias module:purecloud-platform-client-v2/api/LocationsApi
|
|
@@ -10233,7 +10247,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
10233
10247
|
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
10248
|
* LogCapture service.
|
|
10235
10249
|
* @module purecloud-platform-client-v2/api/LogCaptureApi
|
|
10236
|
-
* @version
|
|
10250
|
+
* @version 199.0.0
|
|
10237
10251
|
*/ /**
|
|
10238
10252
|
* Constructs a new LogCaptureApi.
|
|
10239
10253
|
* @alias module:purecloud-platform-client-v2/api/LogCaptureApi
|
|
@@ -10283,7 +10297,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
10283
10297
|
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
10298
|
* Messaging service.
|
|
10285
10299
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
10286
|
-
* @version
|
|
10300
|
+
* @version 199.0.0
|
|
10287
10301
|
*/ /**
|
|
10288
10302
|
* Constructs a new MessagingApi.
|
|
10289
10303
|
* @alias module:purecloud-platform-client-v2/api/MessagingApi
|
|
@@ -10373,7 +10387,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
10373
10387
|
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
10388
|
* MobileDevices service.
|
|
10375
10389
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
10376
|
-
* @version
|
|
10390
|
+
* @version 199.0.0
|
|
10377
10391
|
*/ /**
|
|
10378
10392
|
* Constructs a new MobileDevicesApi.
|
|
10379
10393
|
* @alias module:purecloud-platform-client-v2/api/MobileDevicesApi
|
|
@@ -10412,7 +10426,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
10412
10426
|
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
10427
|
* Notifications service.
|
|
10414
10428
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
10415
|
-
* @version
|
|
10429
|
+
* @version 199.0.0
|
|
10416
10430
|
*/ /**
|
|
10417
10431
|
* Constructs a new NotificationsApi.
|
|
10418
10432
|
* @alias module:purecloud-platform-client-v2/api/NotificationsApi
|
|
@@ -10469,7 +10483,7 @@ if(channelId===undefined||channelId===null){throw'Missing the required parameter
|
|
|
10469
10483
|
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
10484
|
* OAuth service.
|
|
10471
10485
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
10472
|
-
* @version
|
|
10486
|
+
* @version 199.0.0
|
|
10473
10487
|
*/ /**
|
|
10474
10488
|
* Constructs a new OAuthApi.
|
|
10475
10489
|
* @alias module:purecloud-platform-client-v2/api/OAuthApi
|
|
@@ -10554,7 +10568,7 @@ if(clientId===undefined||clientId===null){throw'Missing the required parameter "
|
|
|
10554
10568
|
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
10569
|
* Objects service.
|
|
10556
10570
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
10557
|
-
* @version
|
|
10571
|
+
* @version 199.0.0
|
|
10558
10572
|
*/ /**
|
|
10559
10573
|
* Constructs a new ObjectsApi.
|
|
10560
10574
|
* @alias module:purecloud-platform-client-v2/api/ObjectsApi
|
|
@@ -10625,7 +10639,7 @@ if(divisionId===undefined||divisionId===null){throw'Missing the required paramet
|
|
|
10625
10639
|
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
10640
|
* OperationalEvents service.
|
|
10627
10641
|
* @module purecloud-platform-client-v2/api/OperationalEventsApi
|
|
10628
|
-
* @version
|
|
10642
|
+
* @version 199.0.0
|
|
10629
10643
|
*/ /**
|
|
10630
10644
|
* Constructs a new OperationalEventsApi.
|
|
10631
10645
|
* @alias module:purecloud-platform-client-v2/api/OperationalEventsApi
|
|
@@ -10643,7 +10657,7 @@ if(eventDefinitionId===undefined||eventDefinitionId===null){throw'Missing the re
|
|
|
10643
10657
|
*/},{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
10658
|
* Organization service.
|
|
10645
10659
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
10646
|
-
* @version
|
|
10660
|
+
* @version 199.0.0
|
|
10647
10661
|
*/ /**
|
|
10648
10662
|
* Constructs a new OrganizationApi.
|
|
10649
10663
|
* @alias module:purecloud-platform-client-v2/api/OrganizationApi
|
|
@@ -10748,7 +10762,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
10748
10762
|
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
10763
|
* OrganizationAuthorization service.
|
|
10750
10764
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
10751
|
-
* @version
|
|
10765
|
+
* @version 199.0.0
|
|
10752
10766
|
*/ /**
|
|
10753
10767
|
* Constructs a new OrganizationAuthorizationApi.
|
|
10754
10768
|
* @alias module:purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
@@ -11071,7 +11085,7 @@ if(trustorOrgId===undefined||trustorOrgId===null){throw'Missing the required par
|
|
|
11071
11085
|
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
11086
|
* Outbound service.
|
|
11073
11087
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
11074
|
-
* @version
|
|
11088
|
+
* @version 199.0.0
|
|
11075
11089
|
*/ /**
|
|
11076
11090
|
* Constructs a new OutboundApi.
|
|
11077
11091
|
* @alias module:purecloud-platform-client-v2/api/OutboundApi
|
|
@@ -11205,7 +11219,7 @@ if(id===undefined||id===null){throw'Missing the required parameter "id" when cal
|
|
|
11205
11219
|
*/},{key:"deleteOutboundMessagingcampaign",value:function deleteOutboundMessagingcampaign(messagingCampaignId){// verify the required parameter 'messagingCampaignId' is set
|
|
11206
11220
|
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
11221
|
* Reset messaging campaign progress and recycle the messaging campaign
|
|
11208
|
-
*
|
|
11222
|
+
* Documented permissions are applicable based on campaign type.
|
|
11209
11223
|
* @param {String} messagingCampaignId The Messaging Campaign ID
|
|
11210
11224
|
*/},{key:"deleteOutboundMessagingcampaignProgress",value:function deleteOutboundMessagingcampaignProgress(messagingCampaignId){// verify the required parameter 'messagingCampaignId' is set
|
|
11211
11225
|
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 +12152,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
12138
12152
|
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
12153
|
* Presence service.
|
|
12140
12154
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
12141
|
-
* @version
|
|
12155
|
+
* @version 199.0.0
|
|
12142
12156
|
*/ /**
|
|
12143
12157
|
* Constructs a new PresenceApi.
|
|
12144
12158
|
* @alias module:purecloud-platform-client-v2/api/PresenceApi
|
|
@@ -12311,7 +12325,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
12311
12325
|
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
12326
|
* ProcessAutomation service.
|
|
12313
12327
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
12314
|
-
* @version
|
|
12328
|
+
* @version 199.0.0
|
|
12315
12329
|
*/ /**
|
|
12316
12330
|
* Constructs a new ProcessAutomationApi.
|
|
12317
12331
|
* @alias module:purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
@@ -12374,7 +12388,7 @@ if(triggerId===undefined||triggerId===null){throw'Missing the required parameter
|
|
|
12374
12388
|
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
12389
|
* Quality service.
|
|
12376
12390
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
12377
|
-
* @version
|
|
12391
|
+
* @version 199.0.0
|
|
12378
12392
|
*/ /**
|
|
12379
12393
|
* Constructs a new QualityApi.
|
|
12380
12394
|
* @alias module:purecloud-platform-client-v2/api/QualityApi
|
|
@@ -12827,6 +12841,14 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
12827
12841
|
*/},{key:"putQualityFormsEvaluation",value:function putQualityFormsEvaluation(formId,body){// verify the required parameter 'formId' is set
|
|
12828
12842
|
if(formId===undefined||formId===null){throw'Missing the required parameter "formId" when calling putQualityFormsEvaluation';}// verify the required parameter 'body' is set
|
|
12829
12843
|
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']);}/**
|
|
12844
|
+
* Update the AI Scoring settings of an evaluation form.
|
|
12845
|
+
*
|
|
12846
|
+
* @param {String} formId Form ID
|
|
12847
|
+
* @param {Object} body AI Scoring Settings
|
|
12848
|
+
* putQualityFormsEvaluationAiscoringSettings is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
12849
|
+
*/},{key:"putQualityFormsEvaluationAiscoringSettings",value:function putQualityFormsEvaluationAiscoringSettings(formId,body){// verify the required parameter 'formId' is set
|
|
12850
|
+
if(formId===undefined||formId===null){throw'Missing the required parameter "formId" when calling putQualityFormsEvaluationAiscoringSettings';}// verify the required parameter 'body' is set
|
|
12851
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putQualityFormsEvaluationAiscoringSettings';}return this.apiClient.callApi('/api/v2/quality/forms/evaluations/{formId}/aiscoring/settings','PUT',{'formId':formId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
12830
12852
|
* Update a survey form.
|
|
12831
12853
|
*
|
|
12832
12854
|
* @param {String} formId Form ID
|
|
@@ -12843,7 +12865,7 @@ if(customerSurveyUrl===undefined||customerSurveyUrl===null){throw'Missing the re
|
|
|
12843
12865
|
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
12866
|
* Recording service.
|
|
12845
12867
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
12846
|
-
* @version
|
|
12868
|
+
* @version 199.0.0
|
|
12847
12869
|
*/ /**
|
|
12848
12870
|
* Constructs a new RecordingApi.
|
|
12849
12871
|
* @alias module:purecloud-platform-client-v2/api/RecordingApi
|
|
@@ -13254,7 +13276,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
13254
13276
|
*/},{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
13277
|
* ResponseManagement service.
|
|
13256
13278
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
13257
|
-
* @version
|
|
13279
|
+
* @version 199.0.0
|
|
13258
13280
|
*/ /**
|
|
13259
13281
|
* Constructs a new ResponseManagementApi.
|
|
13260
13282
|
* @alias module:purecloud-platform-client-v2/api/ResponseManagementApi
|
|
@@ -13375,7 +13397,7 @@ if(responseAssetId===undefined||responseAssetId===null){throw'Missing the requir
|
|
|
13375
13397
|
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
13398
|
* Routing service.
|
|
13377
13399
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
13378
|
-
* @version
|
|
13400
|
+
* @version 199.0.0
|
|
13379
13401
|
*/ /**
|
|
13380
13402
|
* Constructs a new RoutingApi.
|
|
13381
13403
|
* @alias module:purecloud-platform-client-v2/api/RoutingApi
|
|
@@ -14344,7 +14366,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
14344
14366
|
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
14367
|
* SCIM service.
|
|
14346
14368
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
14347
|
-
* @version
|
|
14369
|
+
* @version 199.0.0
|
|
14348
14370
|
*/ /**
|
|
14349
14371
|
* Constructs a new SCIMApi.
|
|
14350
14372
|
* @alias module:purecloud-platform-client-v2/api/SCIMApi
|
|
@@ -14569,7 +14591,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
14569
14591
|
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
14592
|
* ScreenRecording service.
|
|
14571
14593
|
* @module purecloud-platform-client-v2/api/ScreenRecordingApi
|
|
14572
|
-
* @version
|
|
14594
|
+
* @version 199.0.0
|
|
14573
14595
|
*/ /**
|
|
14574
14596
|
* Constructs a new ScreenRecordingApi.
|
|
14575
14597
|
* @alias module:purecloud-platform-client-v2/api/ScreenRecordingApi
|
|
@@ -14584,7 +14606,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
14584
14606
|
*/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
14607
|
* Scripts service.
|
|
14586
14608
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
14587
|
-
* @version
|
|
14609
|
+
* @version 199.0.0
|
|
14588
14610
|
*/ /**
|
|
14589
14611
|
* Constructs a new ScriptsApi.
|
|
14590
14612
|
* @alias module:purecloud-platform-client-v2/api/ScriptsApi
|
|
@@ -14720,7 +14742,7 @@ if(scriptId===undefined||scriptId===null){throw'Missing the required parameter "
|
|
|
14720
14742
|
*/},{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
14743
|
* Search service.
|
|
14722
14744
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
14723
|
-
* @version
|
|
14745
|
+
* @version 199.0.0
|
|
14724
14746
|
*/ /**
|
|
14725
14747
|
* Constructs a new SearchApi.
|
|
14726
14748
|
* @alias module:purecloud-platform-client-v2/api/SearchApi
|
|
@@ -14880,7 +14902,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
14880
14902
|
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
14903
|
* Settings service.
|
|
14882
14904
|
* @module purecloud-platform-client-v2/api/SettingsApi
|
|
14883
|
-
* @version
|
|
14905
|
+
* @version 199.0.0
|
|
14884
14906
|
*/ /**
|
|
14885
14907
|
* Constructs a new SettingsApi.
|
|
14886
14908
|
* @alias module:purecloud-platform-client-v2/api/SettingsApi
|
|
@@ -14932,7 +14954,7 @@ if(agentId===undefined||agentId===null){throw'Missing the required parameter "ag
|
|
|
14932
14954
|
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
14955
|
* SpeechTextAnalytics service.
|
|
14934
14956
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
14935
|
-
* @version
|
|
14957
|
+
* @version 199.0.0
|
|
14936
14958
|
*/ /**
|
|
14937
14959
|
* Constructs a new SpeechTextAnalyticsApi.
|
|
14938
14960
|
* @alias module:purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
@@ -15216,7 +15238,7 @@ if(topicId===undefined||topicId===null){throw'Missing the required parameter "to
|
|
|
15216
15238
|
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
15239
|
* Stations service.
|
|
15218
15240
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
15219
|
-
* @version
|
|
15241
|
+
* @version 199.0.0
|
|
15220
15242
|
*/ /**
|
|
15221
15243
|
* Constructs a new StationsApi.
|
|
15222
15244
|
* @alias module:purecloud-platform-client-v2/api/StationsApi
|
|
@@ -15248,7 +15270,7 @@ if(stationId===undefined||stationId===null){throw'Missing the required parameter
|
|
|
15248
15270
|
*/},{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
15271
|
* Suggest service.
|
|
15250
15272
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
15251
|
-
* @version
|
|
15273
|
+
* @version 199.0.0
|
|
15252
15274
|
*/ /**
|
|
15253
15275
|
* Constructs a new SuggestApi.
|
|
15254
15276
|
* @alias module:purecloud-platform-client-v2/api/SuggestApi
|
|
@@ -15288,7 +15310,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
15288
15310
|
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
15311
|
* TaskManagement service.
|
|
15290
15312
|
* @module purecloud-platform-client-v2/api/TaskManagementApi
|
|
15291
|
-
* @version
|
|
15313
|
+
* @version 199.0.0
|
|
15292
15314
|
*/ /**
|
|
15293
15315
|
* Constructs a new TaskManagementApi.
|
|
15294
15316
|
* @alias module:purecloud-platform-client-v2/api/TaskManagementApi
|
|
@@ -15457,9 +15479,10 @@ if(worktypeId===undefined||worktypeId===null){throw'Missing the required paramet
|
|
|
15457
15479
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
15458
15480
|
* @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
15481
|
* @param {Object} opts.sortOrder Ascending or descending sort order (default to descending)
|
|
15482
|
+
* @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
15483
|
* getTaskmanagementWorktypeHistory is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
15461
15484
|
*/},{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']);}/**
|
|
15485
|
+
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
15486
|
* Get a status
|
|
15464
15487
|
*
|
|
15465
15488
|
* @param {String} worktypeId Worktype id
|
|
@@ -15617,7 +15640,7 @@ if(schemaId===undefined||schemaId===null){throw'Missing the required parameter "
|
|
|
15617
15640
|
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
15641
|
* Teams service.
|
|
15619
15642
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
15620
|
-
* @version
|
|
15643
|
+
* @version 199.0.0
|
|
15621
15644
|
*/ /**
|
|
15622
15645
|
* Constructs a new TeamsApi.
|
|
15623
15646
|
* @alias module:purecloud-platform-client-v2/api/TeamsApi
|
|
@@ -15695,7 +15718,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
15695
15718
|
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
15719
|
* Telephony service.
|
|
15697
15720
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
15698
|
-
* @version
|
|
15721
|
+
* @version 199.0.0
|
|
15699
15722
|
*/ /**
|
|
15700
15723
|
* Constructs a new TelephonyApi.
|
|
15701
15724
|
* @alias module:purecloud-platform-client-v2/api/TelephonyApi
|
|
@@ -15742,7 +15765,7 @@ if(downloadId===undefined||downloadId===null){throw'Missing the required paramet
|
|
|
15742
15765
|
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
15766
|
* TelephonyProvidersEdge service.
|
|
15744
15767
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
15745
|
-
* @version
|
|
15768
|
+
* @version 199.0.0
|
|
15746
15769
|
*/ /**
|
|
15747
15770
|
* Constructs a new TelephonyProvidersEdgeApi.
|
|
15748
15771
|
* @alias module:purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
@@ -16552,7 +16575,7 @@ if(trunkBaseSettingsId===undefined||trunkBaseSettingsId===null){throw'Missing th
|
|
|
16552
16575
|
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
16576
|
* Textbots service.
|
|
16554
16577
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
16555
|
-
* @version
|
|
16578
|
+
* @version 199.0.0
|
|
16556
16579
|
*/ /**
|
|
16557
16580
|
* Constructs a new TextbotsApi.
|
|
16558
16581
|
* @alias module:purecloud-platform-client-v2/api/TextbotsApi
|
|
@@ -16587,7 +16610,7 @@ if(launchRequest===undefined||launchRequest===null){throw'Missing the required p
|
|
|
16587
16610
|
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
16611
|
* Tokens service.
|
|
16589
16612
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
16590
|
-
* @version
|
|
16613
|
+
* @version 199.0.0
|
|
16591
16614
|
*/ /**
|
|
16592
16615
|
* Constructs a new TokensApi.
|
|
16593
16616
|
* @alias module:purecloud-platform-client-v2/api/TokensApi
|
|
@@ -16621,7 +16644,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
16621
16644
|
*/},{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
16645
|
* Uploads service.
|
|
16623
16646
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
16624
|
-
* @version
|
|
16647
|
+
* @version 199.0.0
|
|
16625
16648
|
*/ /**
|
|
16626
16649
|
* Constructs a new UploadsApi.
|
|
16627
16650
|
* @alias module:purecloud-platform-client-v2/api/UploadsApi
|
|
@@ -16687,7 +16710,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
16687
16710
|
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
16711
|
* Usage service.
|
|
16689
16712
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
16690
|
-
* @version
|
|
16713
|
+
* @version 199.0.0
|
|
16691
16714
|
*/ /**
|
|
16692
16715
|
* Constructs a new UsageApi.
|
|
16693
16716
|
* @alias module:purecloud-platform-client-v2/api/UsageApi
|
|
@@ -16741,7 +16764,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
16741
16764
|
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
16765
|
* UserRecordings service.
|
|
16743
16766
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
16744
|
-
* @version
|
|
16767
|
+
* @version 199.0.0
|
|
16745
16768
|
*/ /**
|
|
16746
16769
|
* Constructs a new UserRecordingsApi.
|
|
16747
16770
|
* @alias module:purecloud-platform-client-v2/api/UserRecordingsApi
|
|
@@ -16790,7 +16813,7 @@ if(recordingId===undefined||recordingId===null){throw'Missing the required param
|
|
|
16790
16813
|
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
16814
|
* Users service.
|
|
16792
16815
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
16793
|
-
* @version
|
|
16816
|
+
* @version 199.0.0
|
|
16794
16817
|
*/ /**
|
|
16795
16818
|
* Constructs a new UsersApi.
|
|
16796
16819
|
* @alias module:purecloud-platform-client-v2/api/UsersApi
|
|
@@ -16949,7 +16972,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
16949
16972
|
*
|
|
16950
16973
|
* @param {String} userId User ID
|
|
16951
16974
|
* @param {Object} opts Optional parameters
|
|
16952
|
-
* @param {Array.<String>} opts.expand Which fields, if any, to expand
|
|
16975
|
+
* @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
16976
|
* @param {Object} opts.integrationPresenceSource Gets an integration presence for a user instead of their default.
|
|
16954
16977
|
* @param {Object} opts.state Search for a user with this state (default to active)
|
|
16955
16978
|
*/},{key:"getUser",value:function getUser(userId,opts){opts=opts||{};// verify the required parameter 'userId' is set
|
|
@@ -17095,7 +17118,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
17095
17118
|
* @param {Array.<String>} opts.id A list of user IDs to fetch by bulk
|
|
17096
17119
|
* @param {Array.<String>} opts.jabberId A list of jabberIds to fetch by bulk (cannot be used with the id parameter)
|
|
17097
17120
|
* @param {Object} opts.sortOrder Ascending or descending sort order (default to ASC)
|
|
17098
|
-
* @param {Array.<String>} opts.expand Which fields, if any, to expand
|
|
17121
|
+
* @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
17122
|
* @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
17123
|
* @param {Object} opts.state Only list users of this state (default to active)
|
|
17101
17124
|
*/},{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 +17475,7 @@ if(verifierId===undefined||verifierId===null){throw'Missing the required paramet
|
|
|
17452
17475
|
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
17476
|
* Utilities service.
|
|
17454
17477
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
17455
|
-
* @version
|
|
17478
|
+
* @version 199.0.0
|
|
17456
17479
|
*/ /**
|
|
17457
17480
|
* Constructs a new UtilitiesApi.
|
|
17458
17481
|
* @alias module:purecloud-platform-client-v2/api/UtilitiesApi
|
|
@@ -17479,7 +17502,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
17479
17502
|
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
17503
|
* Voicemail service.
|
|
17481
17504
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
17482
|
-
* @version
|
|
17505
|
+
* @version 199.0.0
|
|
17483
17506
|
*/ /**
|
|
17484
17507
|
* Constructs a new VoicemailApi.
|
|
17485
17508
|
* @alias module:purecloud-platform-client-v2/api/VoicemailApi
|
|
@@ -17628,7 +17651,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
17628
17651
|
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
17652
|
* WebChat service.
|
|
17630
17653
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
17631
|
-
* @version
|
|
17654
|
+
* @version 199.0.0
|
|
17632
17655
|
*/ /**
|
|
17633
17656
|
* Constructs a new WebChatApi.
|
|
17634
17657
|
* @alias module:purecloud-platform-client-v2/api/WebChatApi
|
|
@@ -17763,7 +17786,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
17763
17786
|
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
17787
|
* WebDeployments service.
|
|
17765
17788
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
17766
|
-
* @version
|
|
17789
|
+
* @version 199.0.0
|
|
17767
17790
|
*/ /**
|
|
17768
17791
|
* Constructs a new WebDeploymentsApi.
|
|
17769
17792
|
* @alias module:purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
@@ -17884,7 +17907,7 @@ if(deploymentId===undefined||deploymentId===null){throw'Missing the required par
|
|
|
17884
17907
|
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
17908
|
* WebMessaging service.
|
|
17886
17909
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
17887
|
-
* @version
|
|
17910
|
+
* @version 199.0.0
|
|
17888
17911
|
*/ /**
|
|
17889
17912
|
* Constructs a new WebMessagingApi.
|
|
17890
17913
|
* @alias module:purecloud-platform-client-v2/api/WebMessagingApi
|
|
@@ -17900,7 +17923,7 @@ if(deployment===undefined||deployment===null){throw'Missing the required paramet
|
|
|
17900
17923
|
*/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
17924
|
* Widgets service.
|
|
17902
17925
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
17903
|
-
* @version
|
|
17926
|
+
* @version 199.0.0
|
|
17904
17927
|
*/ /**
|
|
17905
17928
|
* Constructs a new WidgetsApi.
|
|
17906
17929
|
* @alias module:purecloud-platform-client-v2/api/WidgetsApi
|
|
@@ -17935,7 +17958,7 @@ if(deploymentId===undefined||deploymentId===null){throw'Missing the required par
|
|
|
17935
17958
|
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
17959
|
* WorkforceManagement service.
|
|
17937
17960
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
17938
|
-
* @version
|
|
17961
|
+
* @version 199.0.0
|
|
17939
17962
|
*/ /**
|
|
17940
17963
|
* Constructs a new WorkforceManagementApi.
|
|
17941
17964
|
* @alias module:purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
@@ -18076,12 +18099,6 @@ if(jobId===undefined||jobId===null){throw'Missing the required parameter "jobId"
|
|
|
18076
18099
|
* @param {String} jobId jobId
|
|
18077
18100
|
*/},{key:"getWorkforcemanagementAdherenceHistoricalJob",value:function getWorkforcemanagementAdherenceHistoricalJob(jobId){// verify the required parameter 'jobId' is set
|
|
18078
18101
|
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
18102
|
* Get an adherence explanation
|
|
18086
18103
|
*
|
|
18087
18104
|
* @param {String} agentId The ID of the agent to query
|
|
@@ -18118,6 +18135,38 @@ if(activityCodeId===undefined||activityCodeId===null){throw'Missing the required
|
|
|
18118
18135
|
* @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
|
|
18119
18136
|
*/},{key:"getWorkforcemanagementBusinessunitActivitycodes",value:function getWorkforcemanagementBusinessunitActivitycodes(businessUnitId,opts){opts=opts||{};// verify the required parameter 'businessUnitId' is set
|
|
18120
18137
|
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']);}/**
|
|
18138
|
+
* Get an activity plan
|
|
18139
|
+
*
|
|
18140
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
18141
|
+
* @param {String} activityPlanId The ID of the activity plan to fetch
|
|
18142
|
+
* getWorkforcemanagementBusinessunitActivityplan is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
18143
|
+
*/},{key:"getWorkforcemanagementBusinessunitActivityplan",value:function getWorkforcemanagementBusinessunitActivityplan(businessUnitId,activityPlanId){// verify the required parameter 'businessUnitId' is set
|
|
18144
|
+
if(businessUnitId===undefined||businessUnitId===null){throw'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitActivityplan';}// verify the required parameter 'activityPlanId' is set
|
|
18145
|
+
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']);}/**
|
|
18146
|
+
* Gets an activity plan run job
|
|
18147
|
+
*
|
|
18148
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
18149
|
+
* @param {String} activityPlanId The ID of the activity plan associated with the run job
|
|
18150
|
+
* @param {String} jobId The ID of the activity plan run job
|
|
18151
|
+
* getWorkforcemanagementBusinessunitActivityplanRunsJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
18152
|
+
*/},{key:"getWorkforcemanagementBusinessunitActivityplanRunsJob",value:function getWorkforcemanagementBusinessunitActivityplanRunsJob(businessUnitId,activityPlanId,jobId){// verify the required parameter 'businessUnitId' is set
|
|
18153
|
+
if(businessUnitId===undefined||businessUnitId===null){throw'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitActivityplanRunsJob';}// verify the required parameter 'activityPlanId' is set
|
|
18154
|
+
if(activityPlanId===undefined||activityPlanId===null){throw'Missing the required parameter "activityPlanId" when calling getWorkforcemanagementBusinessunitActivityplanRunsJob';}// verify the required parameter 'jobId' is set
|
|
18155
|
+
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']);}/**
|
|
18156
|
+
* Get activity plans
|
|
18157
|
+
*
|
|
18158
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
18159
|
+
* @param {Object} opts Optional parameters
|
|
18160
|
+
* @param {Object} opts.state Optionally filter by activity plan state
|
|
18161
|
+
* getWorkforcemanagementBusinessunitActivityplans is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
18162
|
+
*/},{key:"getWorkforcemanagementBusinessunitActivityplans",value:function getWorkforcemanagementBusinessunitActivityplans(businessUnitId,opts){opts=opts||{};// verify the required parameter 'businessUnitId' is set
|
|
18163
|
+
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']);}/**
|
|
18164
|
+
* Gets the latest job for all activity plans in the business unit
|
|
18165
|
+
*
|
|
18166
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
18167
|
+
* getWorkforcemanagementBusinessunitActivityplansJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
18168
|
+
*/},{key:"getWorkforcemanagementBusinessunitActivityplansJobs",value:function getWorkforcemanagementBusinessunitActivityplansJobs(businessUnitId){// verify the required parameter 'businessUnitId' is set
|
|
18169
|
+
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
18170
|
* Get intraday planning groups for the given date
|
|
18122
18171
|
*
|
|
18123
18172
|
* @param {String} businessUnitId The ID of the business unit
|
|
@@ -18646,6 +18695,16 @@ if(businessUnitId===undefined||businessUnitId===null){throw'Missing the required
|
|
|
18646
18695
|
*/},{key:"patchWorkforcemanagementBusinessunitActivitycode",value:function patchWorkforcemanagementBusinessunitActivitycode(businessUnitId,activityCodeId,opts){opts=opts||{};// verify the required parameter 'businessUnitId' is set
|
|
18647
18696
|
if(businessUnitId===undefined||businessUnitId===null){throw'Missing the required parameter "businessUnitId" when calling patchWorkforcemanagementBusinessunitActivitycode';}// verify the required parameter 'activityCodeId' is set
|
|
18648
18697
|
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']);}/**
|
|
18698
|
+
* Update an activity plan
|
|
18699
|
+
* If a job associated with the activity plan is in Processing state the activity plan cannot be updated
|
|
18700
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
18701
|
+
* @param {String} activityPlanId The ID of the activity plan to update
|
|
18702
|
+
* @param {Object} body body
|
|
18703
|
+
* patchWorkforcemanagementBusinessunitActivityplan is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
18704
|
+
*/},{key:"patchWorkforcemanagementBusinessunitActivityplan",value:function patchWorkforcemanagementBusinessunitActivityplan(businessUnitId,activityPlanId,body){// verify the required parameter 'businessUnitId' is set
|
|
18705
|
+
if(businessUnitId===undefined||businessUnitId===null){throw'Missing the required parameter "businessUnitId" when calling patchWorkforcemanagementBusinessunitActivityplan';}// verify the required parameter 'activityPlanId' is set
|
|
18706
|
+
if(activityPlanId===undefined||activityPlanId===null){throw'Missing the required parameter "activityPlanId" when calling patchWorkforcemanagementBusinessunitActivityplan';}// verify the required parameter 'body' is set
|
|
18707
|
+
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
18708
|
* Updates the planning group
|
|
18650
18709
|
*
|
|
18651
18710
|
* @param {String} businessUnitId The ID of the business unit.
|
|
@@ -18850,6 +18909,22 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
18850
18909
|
* @param {Object} opts.body body
|
|
18851
18910
|
*/},{key:"postWorkforcemanagementBusinessunitActivitycodes",value:function postWorkforcemanagementBusinessunitActivitycodes(businessUnitId,opts){opts=opts||{};// verify the required parameter 'businessUnitId' is set
|
|
18852
18911
|
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']);}/**
|
|
18912
|
+
* Run an activity plan manually
|
|
18913
|
+
* Triggers a job running the activity plan. The activity plan cannot be updated until the job completes
|
|
18914
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
18915
|
+
* @param {String} activityPlanId The ID of the activity plan to run
|
|
18916
|
+
* postWorkforcemanagementBusinessunitActivityplanRunsJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
18917
|
+
*/},{key:"postWorkforcemanagementBusinessunitActivityplanRunsJobs",value:function postWorkforcemanagementBusinessunitActivityplanRunsJobs(businessUnitId,activityPlanId){// verify the required parameter 'businessUnitId' is set
|
|
18918
|
+
if(businessUnitId===undefined||businessUnitId===null){throw'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitActivityplanRunsJobs';}// verify the required parameter 'activityPlanId' is set
|
|
18919
|
+
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']);}/**
|
|
18920
|
+
* Create an activity plan
|
|
18921
|
+
*
|
|
18922
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
18923
|
+
* @param {Object} body body
|
|
18924
|
+
* postWorkforcemanagementBusinessunitActivityplans is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
18925
|
+
*/},{key:"postWorkforcemanagementBusinessunitActivityplans",value:function postWorkforcemanagementBusinessunitActivityplans(businessUnitId,body){// verify the required parameter 'businessUnitId' is set
|
|
18926
|
+
if(businessUnitId===undefined||businessUnitId===null){throw'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitActivityplans';}// verify the required parameter 'body' is set
|
|
18927
|
+
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
18928
|
* Query adherence explanations across an entire business unit for the requested period
|
|
18854
18929
|
*
|
|
18855
18930
|
* @param {String} businessUnitId The ID of the business unit
|
|
@@ -19415,7 +19490,7 @@ if(timeOffLimitId===undefined||timeOffLimitId===null){throw'Missing the required
|
|
|
19415
19490
|
* </pre>
|
|
19416
19491
|
* </p>
|
|
19417
19492
|
* @module purecloud-platform-client-v2/index
|
|
19418
|
-
* @version
|
|
19493
|
+
* @version 199.0.0
|
|
19419
19494
|
*/var platformClient=/*#__PURE__*/_createClass(function platformClient(){_classCallCheck(this,platformClient);/**
|
|
19420
19495
|
* The ApiClient constructor.
|
|
19421
19496
|
* @property {module:purecloud-platform-client-v2/ApiClient}
|