purecloud-platform-client-v2 197.0.0 → 198.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +2 -2
- package/dist/node/purecloud-platform-client-v2.js +401 -110
- package/dist/web-amd/purecloud-platform-client-v2.js +401 -110
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +167 -90
- package/dist/web-cjs/purecloud-platform-client-v2.js +170 -91
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +520 -29
- package/package.json +1 -1
- package/src/purecloud-platform-client-v2/ApiClient.js +1 -1
- package/src/purecloud-platform-client-v2/api/AgentUIApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AlertingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ArchitectApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AuditApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/BillingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/CarrierServicesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ChatApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/CoachingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ContentManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ConversationsApi.js +37 -1
- package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/DownloadsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EmailsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EmployeeEngagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EventsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +2 -2
- package/src/purecloud-platform-client-v2/api/FaxApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/FlowsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GamificationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GeolocationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GreetingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GroupsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/IdentityProviderApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/InfrastructureAsCodeApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/JourneyApi.js +30 -2
- package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LanguagesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LearningApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LicenseApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LocationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LogCaptureApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/MessagingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/MobileDevicesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/NotificationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OAuthApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ObjectsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OperationalEventsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OrganizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OutboundApi.js +2 -2
- package/src/purecloud-platform-client-v2/api/PresenceApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ProcessAutomationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/QualityApi.js +32 -1
- package/src/purecloud-platform-client-v2/api/RecordingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RoutingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ScreenRecordingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ScriptsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SearchApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SettingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/StationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SuggestApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TaskManagementApi.js +3 -2
- package/src/purecloud-platform-client-v2/api/TeamsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TelephonyApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TextbotsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TokensApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UploadsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsageApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsersApi.js +3 -3
- package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/VoicemailApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebChatApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebMessagingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WidgetsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +222 -27
- package/src/purecloud-platform-client-v2/index.js +1 -1
|
@@ -4242,7 +4242,9 @@ var parseObject = function (chain, val, options, valuesParsed) {
|
|
|
4242
4242
|
var root = chain[i];
|
|
4243
4243
|
|
|
4244
4244
|
if (root === '[]' && options.parseArrays) {
|
|
4245
|
-
obj = options.allowEmptyArrays && leaf === ''
|
|
4245
|
+
obj = options.allowEmptyArrays && (leaf === '' || (options.strictNullHandling && leaf === null))
|
|
4246
|
+
? []
|
|
4247
|
+
: [].concat(leaf);
|
|
4246
4248
|
} else {
|
|
4247
4249
|
obj = options.plainObjects ? Object.create(null) : {};
|
|
4248
4250
|
var cleanRoot = root.charAt(0) === '[' && root.charAt(root.length - 1) === ']' ? root.slice(1, -1) : root;
|
|
@@ -6058,7 +6060,7 @@ if(env)this.environment=env;else this.environment=this.host?this.host:'mypureclo
|
|
|
6058
6060
|
this.environment=this.environment.replace(/\/+$/,'');// Strip protocol and subdomain
|
|
6059
6061
|
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];}}}]);}();/**
|
|
6060
6062
|
* @module purecloud-platform-client-v2/ApiClient
|
|
6061
|
-
* @version
|
|
6063
|
+
* @version 198.0.0
|
|
6062
6064
|
*/var ApiClient=/*#__PURE__*/function(){/**
|
|
6063
6065
|
* Manages low level client-server communications, parameter marshalling, etc. There should not be any need for an
|
|
6064
6066
|
* application to use this class directly - the *Api and model classes provide the public API for the service. The
|
|
@@ -6370,7 +6372,7 @@ resolve(data);})["catch"](function(error){var data=error;if(error.response&&erro
|
|
|
6370
6372
|
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(){/**
|
|
6371
6373
|
* AgentUI service.
|
|
6372
6374
|
* @module purecloud-platform-client-v2/api/AgentUIApi
|
|
6373
|
-
* @version
|
|
6375
|
+
* @version 198.0.0
|
|
6374
6376
|
*/ /**
|
|
6375
6377
|
* Constructs a new AgentUIApi.
|
|
6376
6378
|
* @alias module:purecloud-platform-client-v2/api/AgentUIApi
|
|
@@ -6404,7 +6406,7 @@ if(agentId===undefined||agentId===null){throw'Missing the required parameter "ag
|
|
|
6404
6406
|
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(){/**
|
|
6405
6407
|
* Alerting service.
|
|
6406
6408
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
6407
|
-
* @version
|
|
6409
|
+
* @version 198.0.0
|
|
6408
6410
|
*/ /**
|
|
6409
6411
|
* Constructs a new AlertingApi.
|
|
6410
6412
|
* @alias module:purecloud-platform-client-v2/api/AlertingApi
|
|
@@ -6561,7 +6563,7 @@ if(ruleId===undefined||ruleId===null){throw'Missing the required parameter "rule
|
|
|
6561
6563
|
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(){/**
|
|
6562
6564
|
* Analytics service.
|
|
6563
6565
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
6564
|
-
* @version
|
|
6566
|
+
* @version 198.0.0
|
|
6565
6567
|
*/ /**
|
|
6566
6568
|
* Constructs a new AnalyticsApi.
|
|
6567
6569
|
* @alias module:purecloud-platform-client-v2/api/AnalyticsApi
|
|
@@ -7182,7 +7184,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
7182
7184
|
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(){/**
|
|
7183
7185
|
* Architect service.
|
|
7184
7186
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
7185
|
-
* @version
|
|
7187
|
+
* @version 198.0.0
|
|
7186
7188
|
*/ /**
|
|
7187
7189
|
* Constructs a new ArchitectApi.
|
|
7188
7190
|
* @alias module:purecloud-platform-client-v2/api/ArchitectApi
|
|
@@ -8298,7 +8300,7 @@ if(milestoneId===undefined||milestoneId===null){throw'Missing the required param
|
|
|
8298
8300
|
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(){/**
|
|
8299
8301
|
* Audit service.
|
|
8300
8302
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
8301
|
-
* @version
|
|
8303
|
+
* @version 198.0.0
|
|
8302
8304
|
*/ /**
|
|
8303
8305
|
* Constructs a new AuditApi.
|
|
8304
8306
|
* @alias module:purecloud-platform-client-v2/api/AuditApi
|
|
@@ -8347,7 +8349,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
8347
8349
|
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(){/**
|
|
8348
8350
|
* Authorization service.
|
|
8349
8351
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
8350
|
-
* @version
|
|
8352
|
+
* @version 198.0.0
|
|
8351
8353
|
*/ /**
|
|
8352
8354
|
* Constructs a new AuthorizationApi.
|
|
8353
8355
|
* @alias module:purecloud-platform-client-v2/api/AuthorizationApi
|
|
@@ -8662,7 +8664,7 @@ if(subjectId===undefined||subjectId===null){throw'Missing the required parameter
|
|
|
8662
8664
|
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(){/**
|
|
8663
8665
|
* Billing service.
|
|
8664
8666
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
8665
|
-
* @version
|
|
8667
|
+
* @version 198.0.0
|
|
8666
8668
|
*/ /**
|
|
8667
8669
|
* Constructs a new BillingApi.
|
|
8668
8670
|
* @alias module:purecloud-platform-client-v2/api/BillingApi
|
|
@@ -8686,7 +8688,7 @@ if(endDate===undefined||endDate===null){throw'Missing the required parameter "en
|
|
|
8686
8688
|
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(){/**
|
|
8687
8689
|
* CarrierServices service.
|
|
8688
8690
|
* @module purecloud-platform-client-v2/api/CarrierServicesApi
|
|
8689
|
-
* @version
|
|
8691
|
+
* @version 198.0.0
|
|
8690
8692
|
*/ /**
|
|
8691
8693
|
* Constructs a new CarrierServicesApi.
|
|
8692
8694
|
* @alias module:purecloud-platform-client-v2/api/CarrierServicesApi
|
|
@@ -8706,7 +8708,7 @@ if(phoneNumber===undefined||phoneNumber===null){throw'Missing the required param
|
|
|
8706
8708
|
*/},{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(){/**
|
|
8707
8709
|
* Chat service.
|
|
8708
8710
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
8709
|
-
* @version
|
|
8711
|
+
* @version 198.0.0
|
|
8710
8712
|
*/ /**
|
|
8711
8713
|
* Constructs a new ChatApi.
|
|
8712
8714
|
* @alias module:purecloud-platform-client-v2/api/ChatApi
|
|
@@ -8931,7 +8933,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
8931
8933
|
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(){/**
|
|
8932
8934
|
* Coaching service.
|
|
8933
8935
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
8934
|
-
* @version
|
|
8936
|
+
* @version 198.0.0
|
|
8935
8937
|
*/ /**
|
|
8936
8938
|
* Constructs a new CoachingApi.
|
|
8937
8939
|
* @alias module:purecloud-platform-client-v2/api/CoachingApi
|
|
@@ -9084,7 +9086,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
9084
9086
|
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(){/**
|
|
9085
9087
|
* ContentManagement service.
|
|
9086
9088
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
9087
|
-
* @version
|
|
9089
|
+
* @version 198.0.0
|
|
9088
9090
|
*/ /**
|
|
9089
9091
|
* Constructs a new ContentManagementApi.
|
|
9090
9092
|
* @alias module:purecloud-platform-client-v2/api/ContentManagementApi
|
|
@@ -9367,7 +9369,7 @@ if(tagId===undefined||tagId===null){throw'Missing the required parameter "tagId"
|
|
|
9367
9369
|
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(){/**
|
|
9368
9370
|
* Conversations service.
|
|
9369
9371
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
9370
|
-
* @version
|
|
9372
|
+
* @version 198.0.0
|
|
9371
9373
|
*/ /**
|
|
9372
9374
|
* Constructs a new ConversationsApi.
|
|
9373
9375
|
* @alias module:purecloud-platform-client-v2/api/ConversationsApi
|
|
@@ -10271,6 +10273,16 @@ if(conversationId===undefined||conversationId===null){throw'Missing the required
|
|
|
10271
10273
|
if(participantId===undefined||participantId===null){throw'Missing the required parameter "participantId" when calling patchConversationsEmailParticipantCommunication';}// verify the required parameter 'communicationId' is set
|
|
10272
10274
|
if(communicationId===undefined||communicationId===null){throw'Missing the required parameter "communicationId" when calling patchConversationsEmailParticipantCommunication';}// verify the required parameter 'body' is set
|
|
10273
10275
|
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']);}/**
|
|
10276
|
+
* Update conversation by setting its parking state
|
|
10277
|
+
*
|
|
10278
|
+
* @param {String} conversationId conversationId
|
|
10279
|
+
* @param {String} participantId participantId
|
|
10280
|
+
* @param {Object} body Parking update request
|
|
10281
|
+
* patchConversationsEmailParticipantParkingstate is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
10282
|
+
*/},{key:"patchConversationsEmailParticipantParkingstate",value:function patchConversationsEmailParticipantParkingstate(conversationId,participantId,body){// verify the required parameter 'conversationId' is set
|
|
10283
|
+
if(conversationId===undefined||conversationId===null){throw'Missing the required parameter "conversationId" when calling patchConversationsEmailParticipantParkingstate';}// verify the required parameter 'participantId' is set
|
|
10284
|
+
if(participantId===undefined||participantId===null){throw'Missing the required parameter "participantId" when calling patchConversationsEmailParticipantParkingstate';}// verify the required parameter 'body' is set
|
|
10285
|
+
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']);}/**
|
|
10274
10286
|
* Update a conversation by disconnecting all of the participants
|
|
10275
10287
|
*
|
|
10276
10288
|
* @param {String} conversationId conversationId
|
|
@@ -11081,7 +11093,7 @@ if(conversationId===undefined||conversationId===null){throw'Missing the required
|
|
|
11081
11093
|
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(){/**
|
|
11082
11094
|
* DataExtensions service.
|
|
11083
11095
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
11084
|
-
* @version
|
|
11096
|
+
* @version 198.0.0
|
|
11085
11097
|
*/ /**
|
|
11086
11098
|
* Constructs a new DataExtensionsApi.
|
|
11087
11099
|
* @alias module:purecloud-platform-client-v2/api/DataExtensionsApi
|
|
@@ -11102,7 +11114,7 @@ if(coretypeName===undefined||coretypeName===null){throw'Missing the required par
|
|
|
11102
11114
|
*/},{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(){/**
|
|
11103
11115
|
* Downloads service.
|
|
11104
11116
|
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
11105
|
-
* @version
|
|
11117
|
+
* @version 198.0.0
|
|
11106
11118
|
*/ /**
|
|
11107
11119
|
* Constructs a new DownloadsApi.
|
|
11108
11120
|
* @alias module:purecloud-platform-client-v2/api/DownloadsApi
|
|
@@ -11121,7 +11133,7 @@ if(coretypeName===undefined||coretypeName===null){throw'Missing the required par
|
|
|
11121
11133
|
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(){/**
|
|
11122
11134
|
* Emails service.
|
|
11123
11135
|
* @module purecloud-platform-client-v2/api/EmailsApi
|
|
11124
|
-
* @version
|
|
11136
|
+
* @version 198.0.0
|
|
11125
11137
|
*/ /**
|
|
11126
11138
|
* Constructs a new EmailsApi.
|
|
11127
11139
|
* @alias module:purecloud-platform-client-v2/api/EmailsApi
|
|
@@ -11139,7 +11151,7 @@ if(downloadId===undefined||downloadId===null){throw'Missing the required paramet
|
|
|
11139
11151
|
*/},{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(){/**
|
|
11140
11152
|
* EmployeeEngagement service.
|
|
11141
11153
|
* @module purecloud-platform-client-v2/api/EmployeeEngagementApi
|
|
11142
|
-
* @version
|
|
11154
|
+
* @version 198.0.0
|
|
11143
11155
|
*/ /**
|
|
11144
11156
|
* Constructs a new EmployeeEngagementApi.
|
|
11145
11157
|
* @alias module:purecloud-platform-client-v2/api/EmployeeEngagementApi
|
|
@@ -11177,7 +11189,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
11177
11189
|
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(){/**
|
|
11178
11190
|
* Events service.
|
|
11179
11191
|
* @module purecloud-platform-client-v2/api/EventsApi
|
|
11180
|
-
* @version
|
|
11192
|
+
* @version 198.0.0
|
|
11181
11193
|
*/ /**
|
|
11182
11194
|
* Constructs a new EventsApi.
|
|
11183
11195
|
* @alias module:purecloud-platform-client-v2/api/EventsApi
|
|
@@ -11202,7 +11214,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
11202
11214
|
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(){/**
|
|
11203
11215
|
* ExternalContacts service.
|
|
11204
11216
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
11205
|
-
* @version
|
|
11217
|
+
* @version 198.0.0
|
|
11206
11218
|
*/ /**
|
|
11207
11219
|
* Constructs a new ExternalContactsApi.
|
|
11208
11220
|
* @alias module:purecloud-platform-client-v2/api/ExternalContactsApi
|
|
@@ -11293,7 +11305,7 @@ if(contactId===undefined||contactId===null){throw'Missing the required parameter
|
|
|
11293
11305
|
*
|
|
11294
11306
|
* @param {String} contactId ExternalContact ID
|
|
11295
11307
|
* @param {Object} opts Optional parameters
|
|
11296
|
-
* @param {Array.<String>} opts.expand which fields, if any, to expand (externalOrganization,externalDataSources)
|
|
11308
|
+
* @param {Array.<String>} opts.expand which fields, if any, to expand (externalOrganization,externalDataSources,identifiers)
|
|
11297
11309
|
*/},{key:"getExternalcontactsContactUnresolved",value:function getExternalcontactsContactUnresolved(contactId,opts){opts=opts||{};// verify the required parameter 'contactId' is set
|
|
11298
11310
|
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']);}/**
|
|
11299
11311
|
* Search for external contacts
|
|
@@ -11659,7 +11671,7 @@ if(relationshipId===undefined||relationshipId===null){throw'Missing the required
|
|
|
11659
11671
|
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(){/**
|
|
11660
11672
|
* Fax service.
|
|
11661
11673
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
11662
|
-
* @version
|
|
11674
|
+
* @version 198.0.0
|
|
11663
11675
|
*/ /**
|
|
11664
11676
|
* Constructs a new FaxApi.
|
|
11665
11677
|
* @alias module:purecloud-platform-client-v2/api/FaxApi
|
|
@@ -11708,7 +11720,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
11708
11720
|
*/},{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(){/**
|
|
11709
11721
|
* Flows service.
|
|
11710
11722
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
11711
|
-
* @version
|
|
11723
|
+
* @version 198.0.0
|
|
11712
11724
|
*/ /**
|
|
11713
11725
|
* Constructs a new FlowsApi.
|
|
11714
11726
|
* @alias module:purecloud-platform-client-v2/api/FlowsApi
|
|
@@ -11756,7 +11768,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
11756
11768
|
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(){/**
|
|
11757
11769
|
* Gamification service.
|
|
11758
11770
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
11759
|
-
* @version
|
|
11771
|
+
* @version 198.0.0
|
|
11760
11772
|
*/ /**
|
|
11761
11773
|
* Constructs a new GamificationApi.
|
|
11762
11774
|
* @alias module:purecloud-platform-client-v2/api/GamificationApi
|
|
@@ -12296,7 +12308,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
12296
12308
|
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(){/**
|
|
12297
12309
|
* GeneralDataProtectionRegulation service.
|
|
12298
12310
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
12299
|
-
* @version
|
|
12311
|
+
* @version 198.0.0
|
|
12300
12312
|
*/ /**
|
|
12301
12313
|
* Constructs a new GeneralDataProtectionRegulationApi.
|
|
12302
12314
|
* @alias module:purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
@@ -12331,7 +12343,7 @@ if(searchValue===undefined||searchValue===null){throw'Missing the required param
|
|
|
12331
12343
|
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(){/**
|
|
12332
12344
|
* Geolocation service.
|
|
12333
12345
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
12334
|
-
* @version
|
|
12346
|
+
* @version 198.0.0
|
|
12335
12347
|
*/ /**
|
|
12336
12348
|
* Constructs a new GeolocationApi.
|
|
12337
12349
|
* @alias module:purecloud-platform-client-v2/api/GeolocationApi
|
|
@@ -12365,7 +12377,7 @@ if(clientId===undefined||clientId===null){throw'Missing the required parameter "
|
|
|
12365
12377
|
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(){/**
|
|
12366
12378
|
* Greetings service.
|
|
12367
12379
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
12368
|
-
* @version
|
|
12380
|
+
* @version 198.0.0
|
|
12369
12381
|
*/ /**
|
|
12370
12382
|
* Constructs a new GreetingsApi.
|
|
12371
12383
|
* @alias module:purecloud-platform-client-v2/api/GreetingsApi
|
|
@@ -12472,7 +12484,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
12472
12484
|
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(){/**
|
|
12473
12485
|
* Groups service.
|
|
12474
12486
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
12475
|
-
* @version
|
|
12487
|
+
* @version 198.0.0
|
|
12476
12488
|
*/ /**
|
|
12477
12489
|
* Constructs a new GroupsApi.
|
|
12478
12490
|
* @alias module:purecloud-platform-client-v2/api/GroupsApi
|
|
@@ -12605,7 +12617,7 @@ if(groupId===undefined||groupId===null){throw'Missing the required parameter "gr
|
|
|
12605
12617
|
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(){/**
|
|
12606
12618
|
* IdentityProvider service.
|
|
12607
12619
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
12608
|
-
* @version
|
|
12620
|
+
* @version 198.0.0
|
|
12609
12621
|
*/ /**
|
|
12610
12622
|
* Constructs a new IdentityProviderApi.
|
|
12611
12623
|
* @alias module:purecloud-platform-client-v2/api/IdentityProviderApi
|
|
@@ -12761,7 +12773,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
12761
12773
|
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(){/**
|
|
12762
12774
|
* InfrastructureAsCode service.
|
|
12763
12775
|
* @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
12764
|
-
* @version
|
|
12776
|
+
* @version 198.0.0
|
|
12765
12777
|
*/ /**
|
|
12766
12778
|
* Constructs a new InfrastructureAsCodeApi.
|
|
12767
12779
|
* @alias module:purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
@@ -12815,7 +12827,7 @@ if(jobId===undefined||jobId===null){throw'Missing the required parameter "jobId"
|
|
|
12815
12827
|
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(){/**
|
|
12816
12828
|
* Integrations service.
|
|
12817
12829
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
12818
|
-
* @version
|
|
12830
|
+
* @version 198.0.0
|
|
12819
12831
|
*/ /**
|
|
12820
12832
|
* Constructs a new IntegrationsApi.
|
|
12821
12833
|
* @alias module:purecloud-platform-client-v2/api/IntegrationsApi
|
|
@@ -13426,7 +13438,7 @@ if(ucIntegrationId===undefined||ucIntegrationId===null){throw'Missing the requir
|
|
|
13426
13438
|
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(){/**
|
|
13427
13439
|
* Journey service.
|
|
13428
13440
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
13429
|
-
* @version
|
|
13441
|
+
* @version 198.0.0
|
|
13430
13442
|
*/ /**
|
|
13431
13443
|
* Constructs a new JourneyApi.
|
|
13432
13444
|
* @alias module:purecloud-platform-client-v2/api/JourneyApi
|
|
@@ -13620,7 +13632,6 @@ if(sessionId===undefined||sessionId===null){throw'Missing the required parameter
|
|
|
13620
13632
|
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
13621
13633
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
13622
13634
|
* @param {Object} opts.eventType A comma separated list of journey event types to include in the results.
|
|
13623
|
-
* getJourneySessionEvents is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
13624
13635
|
*/},{key:"getJourneySessionEvents",value:function getJourneySessionEvents(sessionId,opts){opts=opts||{};// verify the required parameter 'sessionId' is set
|
|
13625
13636
|
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']);}/**
|
|
13626
13637
|
* Retrieve latest outcome score associated with a session for all outcomes.
|
|
@@ -13768,6 +13779,13 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
13768
13779
|
* @param {Object} opts.body
|
|
13769
13780
|
*/},{key:"postJourneyDeploymentAppevents",value:function postJourneyDeploymentAppevents(deploymentId,opts){opts=opts||{};// verify the required parameter 'deploymentId' is set
|
|
13770
13781
|
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']);}/**
|
|
13782
|
+
* Send a journey web event, used for tracking customer activity on a website.
|
|
13783
|
+
*
|
|
13784
|
+
* @param {String} deploymentId The ID of the deployment sending the web event.
|
|
13785
|
+
* @param {Object} opts Optional parameters
|
|
13786
|
+
* @param {Object} opts.body
|
|
13787
|
+
*/},{key:"postJourneyDeploymentWebevents",value:function postJourneyDeploymentWebevents(deploymentId,opts){opts=opts||{};// verify the required parameter 'deploymentId' is set
|
|
13788
|
+
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']);}/**
|
|
13771
13789
|
* Query for flow paths.
|
|
13772
13790
|
*
|
|
13773
13791
|
* @param {Object} opts Optional parameters
|
|
@@ -13824,7 +13842,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
13824
13842
|
*/},{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(){/**
|
|
13825
13843
|
* Knowledge service.
|
|
13826
13844
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
13827
|
-
* @version
|
|
13845
|
+
* @version 198.0.0
|
|
13828
13846
|
*/ /**
|
|
13829
13847
|
* Constructs a new KnowledgeApi.
|
|
13830
13848
|
* @alias module:purecloud-platform-client-v2/api/KnowledgeApi
|
|
@@ -14737,7 +14755,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
14737
14755
|
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(){/**
|
|
14738
14756
|
* LanguageUnderstanding service.
|
|
14739
14757
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
14740
|
-
* @version
|
|
14758
|
+
* @version 198.0.0
|
|
14741
14759
|
*/ /**
|
|
14742
14760
|
* Constructs a new LanguageUnderstandingApi.
|
|
14743
14761
|
* @alias module:purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
@@ -14997,7 +15015,7 @@ if(domainVersionId===undefined||domainVersionId===null){throw'Missing the requir
|
|
|
14997
15015
|
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(){/**
|
|
14998
15016
|
* Languages service.
|
|
14999
15017
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
15000
|
-
* @version
|
|
15018
|
+
* @version 198.0.0
|
|
15001
15019
|
*/ /**
|
|
15002
15020
|
* Constructs a new LanguagesApi.
|
|
15003
15021
|
* @alias module:purecloud-platform-client-v2/api/LanguagesApi
|
|
@@ -15052,7 +15070,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
15052
15070
|
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(){/**
|
|
15053
15071
|
* Learning service.
|
|
15054
15072
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
15055
|
-
* @version
|
|
15073
|
+
* @version 198.0.0
|
|
15056
15074
|
*/ /**
|
|
15057
15075
|
* Constructs a new LearningApi.
|
|
15058
15076
|
* @alias module:purecloud-platform-client-v2/api/LearningApi
|
|
@@ -15323,7 +15341,7 @@ if(moduleId===undefined||moduleId===null){throw'Missing the required parameter "
|
|
|
15323
15341
|
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(){/**
|
|
15324
15342
|
* License service.
|
|
15325
15343
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
15326
|
-
* @version
|
|
15344
|
+
* @version 198.0.0
|
|
15327
15345
|
*/ /**
|
|
15328
15346
|
* Constructs a new LicenseApi.
|
|
15329
15347
|
* @alias module:purecloud-platform-client-v2/api/LicenseApi
|
|
@@ -15377,7 +15395,7 @@ if(featureName===undefined||featureName===null){throw'Missing the required param
|
|
|
15377
15395
|
*/},{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(){/**
|
|
15378
15396
|
* Locations service.
|
|
15379
15397
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
15380
|
-
* @version
|
|
15398
|
+
* @version 198.0.0
|
|
15381
15399
|
*/ /**
|
|
15382
15400
|
* Constructs a new LocationsApi.
|
|
15383
15401
|
* @alias module:purecloud-platform-client-v2/api/LocationsApi
|
|
@@ -15436,7 +15454,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
15436
15454
|
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(){/**
|
|
15437
15455
|
* LogCapture service.
|
|
15438
15456
|
* @module purecloud-platform-client-v2/api/LogCaptureApi
|
|
15439
|
-
* @version
|
|
15457
|
+
* @version 198.0.0
|
|
15440
15458
|
*/ /**
|
|
15441
15459
|
* Constructs a new LogCaptureApi.
|
|
15442
15460
|
* @alias module:purecloud-platform-client-v2/api/LogCaptureApi
|
|
@@ -15486,7 +15504,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
15486
15504
|
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(){/**
|
|
15487
15505
|
* Messaging service.
|
|
15488
15506
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
15489
|
-
* @version
|
|
15507
|
+
* @version 198.0.0
|
|
15490
15508
|
*/ /**
|
|
15491
15509
|
* Constructs a new MessagingApi.
|
|
15492
15510
|
* @alias module:purecloud-platform-client-v2/api/MessagingApi
|
|
@@ -15576,7 +15594,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
15576
15594
|
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(){/**
|
|
15577
15595
|
* MobileDevices service.
|
|
15578
15596
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
15579
|
-
* @version
|
|
15597
|
+
* @version 198.0.0
|
|
15580
15598
|
*/ /**
|
|
15581
15599
|
* Constructs a new MobileDevicesApi.
|
|
15582
15600
|
* @alias module:purecloud-platform-client-v2/api/MobileDevicesApi
|
|
@@ -15615,7 +15633,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
15615
15633
|
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(){/**
|
|
15616
15634
|
* Notifications service.
|
|
15617
15635
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
15618
|
-
* @version
|
|
15636
|
+
* @version 198.0.0
|
|
15619
15637
|
*/ /**
|
|
15620
15638
|
* Constructs a new NotificationsApi.
|
|
15621
15639
|
* @alias module:purecloud-platform-client-v2/api/NotificationsApi
|
|
@@ -15672,7 +15690,7 @@ if(channelId===undefined||channelId===null){throw'Missing the required parameter
|
|
|
15672
15690
|
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(){/**
|
|
15673
15691
|
* OAuth service.
|
|
15674
15692
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
15675
|
-
* @version
|
|
15693
|
+
* @version 198.0.0
|
|
15676
15694
|
*/ /**
|
|
15677
15695
|
* Constructs a new OAuthApi.
|
|
15678
15696
|
* @alias module:purecloud-platform-client-v2/api/OAuthApi
|
|
@@ -15757,7 +15775,7 @@ if(clientId===undefined||clientId===null){throw'Missing the required parameter "
|
|
|
15757
15775
|
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(){/**
|
|
15758
15776
|
* Objects service.
|
|
15759
15777
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
15760
|
-
* @version
|
|
15778
|
+
* @version 198.0.0
|
|
15761
15779
|
*/ /**
|
|
15762
15780
|
* Constructs a new ObjectsApi.
|
|
15763
15781
|
* @alias module:purecloud-platform-client-v2/api/ObjectsApi
|
|
@@ -15828,7 +15846,7 @@ if(divisionId===undefined||divisionId===null){throw'Missing the required paramet
|
|
|
15828
15846
|
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(){/**
|
|
15829
15847
|
* OperationalEvents service.
|
|
15830
15848
|
* @module purecloud-platform-client-v2/api/OperationalEventsApi
|
|
15831
|
-
* @version
|
|
15849
|
+
* @version 198.0.0
|
|
15832
15850
|
*/ /**
|
|
15833
15851
|
* Constructs a new OperationalEventsApi.
|
|
15834
15852
|
* @alias module:purecloud-platform-client-v2/api/OperationalEventsApi
|
|
@@ -15846,7 +15864,7 @@ if(eventDefinitionId===undefined||eventDefinitionId===null){throw'Missing the re
|
|
|
15846
15864
|
*/},{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(){/**
|
|
15847
15865
|
* Organization service.
|
|
15848
15866
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
15849
|
-
* @version
|
|
15867
|
+
* @version 198.0.0
|
|
15850
15868
|
*/ /**
|
|
15851
15869
|
* Constructs a new OrganizationApi.
|
|
15852
15870
|
* @alias module:purecloud-platform-client-v2/api/OrganizationApi
|
|
@@ -15951,7 +15969,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
15951
15969
|
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(){/**
|
|
15952
15970
|
* OrganizationAuthorization service.
|
|
15953
15971
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
15954
|
-
* @version
|
|
15972
|
+
* @version 198.0.0
|
|
15955
15973
|
*/ /**
|
|
15956
15974
|
* Constructs a new OrganizationAuthorizationApi.
|
|
15957
15975
|
* @alias module:purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
@@ -16274,7 +16292,7 @@ if(trustorOrgId===undefined||trustorOrgId===null){throw'Missing the required par
|
|
|
16274
16292
|
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(){/**
|
|
16275
16293
|
* Outbound service.
|
|
16276
16294
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
16277
|
-
* @version
|
|
16295
|
+
* @version 198.0.0
|
|
16278
16296
|
*/ /**
|
|
16279
16297
|
* Constructs a new OutboundApi.
|
|
16280
16298
|
* @alias module:purecloud-platform-client-v2/api/OutboundApi
|
|
@@ -16408,7 +16426,7 @@ if(id===undefined||id===null){throw'Missing the required parameter "id" when cal
|
|
|
16408
16426
|
*/},{key:"deleteOutboundMessagingcampaign",value:function deleteOutboundMessagingcampaign(messagingCampaignId){// verify the required parameter 'messagingCampaignId' is set
|
|
16409
16427
|
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']);}/**
|
|
16410
16428
|
* Reset messaging campaign progress and recycle the messaging campaign
|
|
16411
|
-
*
|
|
16429
|
+
* Documented permissions are applicable based on campaign type.
|
|
16412
16430
|
* @param {String} messagingCampaignId The Messaging Campaign ID
|
|
16413
16431
|
*/},{key:"deleteOutboundMessagingcampaignProgress",value:function deleteOutboundMessagingcampaignProgress(messagingCampaignId){// verify the required parameter 'messagingCampaignId' is set
|
|
16414
16432
|
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']);}/**
|
|
@@ -17341,7 +17359,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
17341
17359
|
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(){/**
|
|
17342
17360
|
* Presence service.
|
|
17343
17361
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
17344
|
-
* @version
|
|
17362
|
+
* @version 198.0.0
|
|
17345
17363
|
*/ /**
|
|
17346
17364
|
* Constructs a new PresenceApi.
|
|
17347
17365
|
* @alias module:purecloud-platform-client-v2/api/PresenceApi
|
|
@@ -17514,7 +17532,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
17514
17532
|
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(){/**
|
|
17515
17533
|
* ProcessAutomation service.
|
|
17516
17534
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
17517
|
-
* @version
|
|
17535
|
+
* @version 198.0.0
|
|
17518
17536
|
*/ /**
|
|
17519
17537
|
* Constructs a new ProcessAutomationApi.
|
|
17520
17538
|
* @alias module:purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
@@ -17577,7 +17595,7 @@ if(triggerId===undefined||triggerId===null){throw'Missing the required parameter
|
|
|
17577
17595
|
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(){/**
|
|
17578
17596
|
* Quality service.
|
|
17579
17597
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
17580
|
-
* @version
|
|
17598
|
+
* @version 198.0.0
|
|
17581
17599
|
*/ /**
|
|
17582
17600
|
* Constructs a new QualityApi.
|
|
17583
17601
|
* @alias module:purecloud-platform-client-v2/api/QualityApi
|
|
@@ -18030,6 +18048,14 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
18030
18048
|
*/},{key:"putQualityFormsEvaluation",value:function putQualityFormsEvaluation(formId,body){// verify the required parameter 'formId' is set
|
|
18031
18049
|
if(formId===undefined||formId===null){throw'Missing the required parameter "formId" when calling putQualityFormsEvaluation';}// verify the required parameter 'body' is set
|
|
18032
18050
|
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']);}/**
|
|
18051
|
+
* Update the Predictive Scoring settings of an evaluation form.
|
|
18052
|
+
*
|
|
18053
|
+
* @param {String} formId Form ID
|
|
18054
|
+
* @param {Object} body Predictive Scoring Settings
|
|
18055
|
+
* putQualityFormsEvaluationPredictivescoringSettings is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
18056
|
+
*/},{key:"putQualityFormsEvaluationPredictivescoringSettings",value:function putQualityFormsEvaluationPredictivescoringSettings(formId,body){// verify the required parameter 'formId' is set
|
|
18057
|
+
if(formId===undefined||formId===null){throw'Missing the required parameter "formId" when calling putQualityFormsEvaluationPredictivescoringSettings';}// verify the required parameter 'body' is set
|
|
18058
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putQualityFormsEvaluationPredictivescoringSettings';}return this.apiClient.callApi('/api/v2/quality/forms/evaluations/{formId}/predictivescoring/settings','PUT',{'formId':formId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
18033
18059
|
* Update a survey form.
|
|
18034
18060
|
*
|
|
18035
18061
|
* @param {String} formId Form ID
|
|
@@ -18046,7 +18072,7 @@ if(customerSurveyUrl===undefined||customerSurveyUrl===null){throw'Missing the re
|
|
|
18046
18072
|
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(){/**
|
|
18047
18073
|
* Recording service.
|
|
18048
18074
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
18049
|
-
* @version
|
|
18075
|
+
* @version 198.0.0
|
|
18050
18076
|
*/ /**
|
|
18051
18077
|
* Constructs a new RecordingApi.
|
|
18052
18078
|
* @alias module:purecloud-platform-client-v2/api/RecordingApi
|
|
@@ -18457,7 +18483,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
18457
18483
|
*/},{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(){/**
|
|
18458
18484
|
* ResponseManagement service.
|
|
18459
18485
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
18460
|
-
* @version
|
|
18486
|
+
* @version 198.0.0
|
|
18461
18487
|
*/ /**
|
|
18462
18488
|
* Constructs a new ResponseManagementApi.
|
|
18463
18489
|
* @alias module:purecloud-platform-client-v2/api/ResponseManagementApi
|
|
@@ -18578,7 +18604,7 @@ if(responseAssetId===undefined||responseAssetId===null){throw'Missing the requir
|
|
|
18578
18604
|
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(){/**
|
|
18579
18605
|
* Routing service.
|
|
18580
18606
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
18581
|
-
* @version
|
|
18607
|
+
* @version 198.0.0
|
|
18582
18608
|
*/ /**
|
|
18583
18609
|
* Constructs a new RoutingApi.
|
|
18584
18610
|
* @alias module:purecloud-platform-client-v2/api/RoutingApi
|
|
@@ -19547,7 +19573,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
19547
19573
|
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(){/**
|
|
19548
19574
|
* SCIM service.
|
|
19549
19575
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
19550
|
-
* @version
|
|
19576
|
+
* @version 198.0.0
|
|
19551
19577
|
*/ /**
|
|
19552
19578
|
* Constructs a new SCIMApi.
|
|
19553
19579
|
* @alias module:purecloud-platform-client-v2/api/SCIMApi
|
|
@@ -19772,7 +19798,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
19772
19798
|
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(){/**
|
|
19773
19799
|
* ScreenRecording service.
|
|
19774
19800
|
* @module purecloud-platform-client-v2/api/ScreenRecordingApi
|
|
19775
|
-
* @version
|
|
19801
|
+
* @version 198.0.0
|
|
19776
19802
|
*/ /**
|
|
19777
19803
|
* Constructs a new ScreenRecordingApi.
|
|
19778
19804
|
* @alias module:purecloud-platform-client-v2/api/ScreenRecordingApi
|
|
@@ -19787,7 +19813,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
19787
19813
|
*/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(){/**
|
|
19788
19814
|
* Scripts service.
|
|
19789
19815
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
19790
|
-
* @version
|
|
19816
|
+
* @version 198.0.0
|
|
19791
19817
|
*/ /**
|
|
19792
19818
|
* Constructs a new ScriptsApi.
|
|
19793
19819
|
* @alias module:purecloud-platform-client-v2/api/ScriptsApi
|
|
@@ -19923,7 +19949,7 @@ if(scriptId===undefined||scriptId===null){throw'Missing the required parameter "
|
|
|
19923
19949
|
*/},{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(){/**
|
|
19924
19950
|
* Search service.
|
|
19925
19951
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
19926
|
-
* @version
|
|
19952
|
+
* @version 198.0.0
|
|
19927
19953
|
*/ /**
|
|
19928
19954
|
* Constructs a new SearchApi.
|
|
19929
19955
|
* @alias module:purecloud-platform-client-v2/api/SearchApi
|
|
@@ -20083,7 +20109,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
20083
20109
|
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(){/**
|
|
20084
20110
|
* Settings service.
|
|
20085
20111
|
* @module purecloud-platform-client-v2/api/SettingsApi
|
|
20086
|
-
* @version
|
|
20112
|
+
* @version 198.0.0
|
|
20087
20113
|
*/ /**
|
|
20088
20114
|
* Constructs a new SettingsApi.
|
|
20089
20115
|
* @alias module:purecloud-platform-client-v2/api/SettingsApi
|
|
@@ -20135,7 +20161,7 @@ if(agentId===undefined||agentId===null){throw'Missing the required parameter "ag
|
|
|
20135
20161
|
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(){/**
|
|
20136
20162
|
* SpeechTextAnalytics service.
|
|
20137
20163
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
20138
|
-
* @version
|
|
20164
|
+
* @version 198.0.0
|
|
20139
20165
|
*/ /**
|
|
20140
20166
|
* Constructs a new SpeechTextAnalyticsApi.
|
|
20141
20167
|
* @alias module:purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
@@ -20419,7 +20445,7 @@ if(topicId===undefined||topicId===null){throw'Missing the required parameter "to
|
|
|
20419
20445
|
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(){/**
|
|
20420
20446
|
* Stations service.
|
|
20421
20447
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
20422
|
-
* @version
|
|
20448
|
+
* @version 198.0.0
|
|
20423
20449
|
*/ /**
|
|
20424
20450
|
* Constructs a new StationsApi.
|
|
20425
20451
|
* @alias module:purecloud-platform-client-v2/api/StationsApi
|
|
@@ -20451,7 +20477,7 @@ if(stationId===undefined||stationId===null){throw'Missing the required parameter
|
|
|
20451
20477
|
*/},{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(){/**
|
|
20452
20478
|
* Suggest service.
|
|
20453
20479
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
20454
|
-
* @version
|
|
20480
|
+
* @version 198.0.0
|
|
20455
20481
|
*/ /**
|
|
20456
20482
|
* Constructs a new SuggestApi.
|
|
20457
20483
|
* @alias module:purecloud-platform-client-v2/api/SuggestApi
|
|
@@ -20491,7 +20517,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
20491
20517
|
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(){/**
|
|
20492
20518
|
* TaskManagement service.
|
|
20493
20519
|
* @module purecloud-platform-client-v2/api/TaskManagementApi
|
|
20494
|
-
* @version
|
|
20520
|
+
* @version 198.0.0
|
|
20495
20521
|
*/ /**
|
|
20496
20522
|
* Constructs a new TaskManagementApi.
|
|
20497
20523
|
* @alias module:purecloud-platform-client-v2/api/TaskManagementApi
|
|
@@ -20660,9 +20686,10 @@ if(worktypeId===undefined||worktypeId===null){throw'Missing the required paramet
|
|
|
20660
20686
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
20661
20687
|
* @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)
|
|
20662
20688
|
* @param {Object} opts.sortOrder Ascending or descending sort order (default to descending)
|
|
20689
|
+
* @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.
|
|
20663
20690
|
* getTaskmanagementWorktypeHistory is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
20664
20691
|
*/},{key:"getTaskmanagementWorktypeHistory",value:function getTaskmanagementWorktypeHistory(worktypeId,opts){opts=opts||{};// verify the required parameter 'worktypeId' is set
|
|
20665
|
-
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']);}/**
|
|
20692
|
+
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']);}/**
|
|
20666
20693
|
* Get a status
|
|
20667
20694
|
*
|
|
20668
20695
|
* @param {String} worktypeId Worktype id
|
|
@@ -20820,7 +20847,7 @@ if(schemaId===undefined||schemaId===null){throw'Missing the required parameter "
|
|
|
20820
20847
|
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(){/**
|
|
20821
20848
|
* Teams service.
|
|
20822
20849
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
20823
|
-
* @version
|
|
20850
|
+
* @version 198.0.0
|
|
20824
20851
|
*/ /**
|
|
20825
20852
|
* Constructs a new TeamsApi.
|
|
20826
20853
|
* @alias module:purecloud-platform-client-v2/api/TeamsApi
|
|
@@ -20898,7 +20925,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
20898
20925
|
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(){/**
|
|
20899
20926
|
* Telephony service.
|
|
20900
20927
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
20901
|
-
* @version
|
|
20928
|
+
* @version 198.0.0
|
|
20902
20929
|
*/ /**
|
|
20903
20930
|
* Constructs a new TelephonyApi.
|
|
20904
20931
|
* @alias module:purecloud-platform-client-v2/api/TelephonyApi
|
|
@@ -20945,7 +20972,7 @@ if(downloadId===undefined||downloadId===null){throw'Missing the required paramet
|
|
|
20945
20972
|
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(){/**
|
|
20946
20973
|
* TelephonyProvidersEdge service.
|
|
20947
20974
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
20948
|
-
* @version
|
|
20975
|
+
* @version 198.0.0
|
|
20949
20976
|
*/ /**
|
|
20950
20977
|
* Constructs a new TelephonyProvidersEdgeApi.
|
|
20951
20978
|
* @alias module:purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
@@ -21755,7 +21782,7 @@ if(trunkBaseSettingsId===undefined||trunkBaseSettingsId===null){throw'Missing th
|
|
|
21755
21782
|
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(){/**
|
|
21756
21783
|
* Textbots service.
|
|
21757
21784
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
21758
|
-
* @version
|
|
21785
|
+
* @version 198.0.0
|
|
21759
21786
|
*/ /**
|
|
21760
21787
|
* Constructs a new TextbotsApi.
|
|
21761
21788
|
* @alias module:purecloud-platform-client-v2/api/TextbotsApi
|
|
@@ -21790,7 +21817,7 @@ if(launchRequest===undefined||launchRequest===null){throw'Missing the required p
|
|
|
21790
21817
|
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(){/**
|
|
21791
21818
|
* Tokens service.
|
|
21792
21819
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
21793
|
-
* @version
|
|
21820
|
+
* @version 198.0.0
|
|
21794
21821
|
*/ /**
|
|
21795
21822
|
* Constructs a new TokensApi.
|
|
21796
21823
|
* @alias module:purecloud-platform-client-v2/api/TokensApi
|
|
@@ -21824,7 +21851,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
21824
21851
|
*/},{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(){/**
|
|
21825
21852
|
* Uploads service.
|
|
21826
21853
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
21827
|
-
* @version
|
|
21854
|
+
* @version 198.0.0
|
|
21828
21855
|
*/ /**
|
|
21829
21856
|
* Constructs a new UploadsApi.
|
|
21830
21857
|
* @alias module:purecloud-platform-client-v2/api/UploadsApi
|
|
@@ -21890,7 +21917,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
21890
21917
|
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(){/**
|
|
21891
21918
|
* Usage service.
|
|
21892
21919
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
21893
|
-
* @version
|
|
21920
|
+
* @version 198.0.0
|
|
21894
21921
|
*/ /**
|
|
21895
21922
|
* Constructs a new UsageApi.
|
|
21896
21923
|
* @alias module:purecloud-platform-client-v2/api/UsageApi
|
|
@@ -21944,7 +21971,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
21944
21971
|
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(){/**
|
|
21945
21972
|
* UserRecordings service.
|
|
21946
21973
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
21947
|
-
* @version
|
|
21974
|
+
* @version 198.0.0
|
|
21948
21975
|
*/ /**
|
|
21949
21976
|
* Constructs a new UserRecordingsApi.
|
|
21950
21977
|
* @alias module:purecloud-platform-client-v2/api/UserRecordingsApi
|
|
@@ -21993,7 +22020,7 @@ if(recordingId===undefined||recordingId===null){throw'Missing the required param
|
|
|
21993
22020
|
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(){/**
|
|
21994
22021
|
* Users service.
|
|
21995
22022
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
21996
|
-
* @version
|
|
22023
|
+
* @version 198.0.0
|
|
21997
22024
|
*/ /**
|
|
21998
22025
|
* Constructs a new UsersApi.
|
|
21999
22026
|
* @alias module:purecloud-platform-client-v2/api/UsersApi
|
|
@@ -22152,7 +22179,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
22152
22179
|
*
|
|
22153
22180
|
* @param {String} userId User ID
|
|
22154
22181
|
* @param {Object} opts Optional parameters
|
|
22155
|
-
* @param {Array.<String>} opts.expand Which fields, if any, to expand
|
|
22182
|
+
* @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.
|
|
22156
22183
|
* @param {Object} opts.integrationPresenceSource Gets an integration presence for a user instead of their default.
|
|
22157
22184
|
* @param {Object} opts.state Search for a user with this state (default to active)
|
|
22158
22185
|
*/},{key:"getUser",value:function getUser(userId,opts){opts=opts||{};// verify the required parameter 'userId' is set
|
|
@@ -22298,7 +22325,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
22298
22325
|
* @param {Array.<String>} opts.id A list of user IDs to fetch by bulk
|
|
22299
22326
|
* @param {Array.<String>} opts.jabberId A list of jabberIds to fetch by bulk (cannot be used with the id parameter)
|
|
22300
22327
|
* @param {Object} opts.sortOrder Ascending or descending sort order (default to ASC)
|
|
22301
|
-
* @param {Array.<String>} opts.expand Which fields, if any, to expand
|
|
22328
|
+
* @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.
|
|
22302
22329
|
* @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.
|
|
22303
22330
|
* @param {Object} opts.state Only list users of this state (default to active)
|
|
22304
22331
|
*/},{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']);}/**
|
|
@@ -22655,7 +22682,7 @@ if(verifierId===undefined||verifierId===null){throw'Missing the required paramet
|
|
|
22655
22682
|
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(){/**
|
|
22656
22683
|
* Utilities service.
|
|
22657
22684
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
22658
|
-
* @version
|
|
22685
|
+
* @version 198.0.0
|
|
22659
22686
|
*/ /**
|
|
22660
22687
|
* Constructs a new UtilitiesApi.
|
|
22661
22688
|
* @alias module:purecloud-platform-client-v2/api/UtilitiesApi
|
|
@@ -22682,7 +22709,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
22682
22709
|
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(){/**
|
|
22683
22710
|
* Voicemail service.
|
|
22684
22711
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
22685
|
-
* @version
|
|
22712
|
+
* @version 198.0.0
|
|
22686
22713
|
*/ /**
|
|
22687
22714
|
* Constructs a new VoicemailApi.
|
|
22688
22715
|
* @alias module:purecloud-platform-client-v2/api/VoicemailApi
|
|
@@ -22831,7 +22858,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
22831
22858
|
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(){/**
|
|
22832
22859
|
* WebChat service.
|
|
22833
22860
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
22834
|
-
* @version
|
|
22861
|
+
* @version 198.0.0
|
|
22835
22862
|
*/ /**
|
|
22836
22863
|
* Constructs a new WebChatApi.
|
|
22837
22864
|
* @alias module:purecloud-platform-client-v2/api/WebChatApi
|
|
@@ -22966,7 +22993,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
22966
22993
|
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(){/**
|
|
22967
22994
|
* WebDeployments service.
|
|
22968
22995
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
22969
|
-
* @version
|
|
22996
|
+
* @version 198.0.0
|
|
22970
22997
|
*/ /**
|
|
22971
22998
|
* Constructs a new WebDeploymentsApi.
|
|
22972
22999
|
* @alias module:purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
@@ -23087,7 +23114,7 @@ if(deploymentId===undefined||deploymentId===null){throw'Missing the required par
|
|
|
23087
23114
|
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(){/**
|
|
23088
23115
|
* WebMessaging service.
|
|
23089
23116
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
23090
|
-
* @version
|
|
23117
|
+
* @version 198.0.0
|
|
23091
23118
|
*/ /**
|
|
23092
23119
|
* Constructs a new WebMessagingApi.
|
|
23093
23120
|
* @alias module:purecloud-platform-client-v2/api/WebMessagingApi
|
|
@@ -23103,7 +23130,7 @@ if(deployment===undefined||deployment===null){throw'Missing the required paramet
|
|
|
23103
23130
|
*/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(){/**
|
|
23104
23131
|
* Widgets service.
|
|
23105
23132
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
23106
|
-
* @version
|
|
23133
|
+
* @version 198.0.0
|
|
23107
23134
|
*/ /**
|
|
23108
23135
|
* Constructs a new WidgetsApi.
|
|
23109
23136
|
* @alias module:purecloud-platform-client-v2/api/WidgetsApi
|
|
@@ -23138,7 +23165,7 @@ if(deploymentId===undefined||deploymentId===null){throw'Missing the required par
|
|
|
23138
23165
|
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(){/**
|
|
23139
23166
|
* WorkforceManagement service.
|
|
23140
23167
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
23141
|
-
* @version
|
|
23168
|
+
* @version 198.0.0
|
|
23142
23169
|
*/ /**
|
|
23143
23170
|
* Constructs a new WorkforceManagementApi.
|
|
23144
23171
|
* @alias module:purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
@@ -23279,12 +23306,6 @@ if(jobId===undefined||jobId===null){throw'Missing the required parameter "jobId"
|
|
|
23279
23306
|
* @param {String} jobId jobId
|
|
23280
23307
|
*/},{key:"getWorkforcemanagementAdherenceHistoricalJob",value:function getWorkforcemanagementAdherenceHistoricalJob(jobId){// verify the required parameter 'jobId' is set
|
|
23281
23308
|
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']);}/**
|
|
23282
|
-
* To get status of the modeling job.
|
|
23283
|
-
* This Endpoint is Deprecated, and not recommended to be used.
|
|
23284
|
-
* @param {String} jobId The id of the modeling job
|
|
23285
|
-
* @deprecated
|
|
23286
|
-
*/},{key:"getWorkforcemanagementAdhocmodelingjob",value:function getWorkforcemanagementAdhocmodelingjob(jobId){// verify the required parameter 'jobId' is set
|
|
23287
|
-
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']);}/**
|
|
23288
23309
|
* Get an adherence explanation
|
|
23289
23310
|
*
|
|
23290
23311
|
* @param {String} agentId The ID of the agent to query
|
|
@@ -23321,6 +23342,38 @@ if(activityCodeId===undefined||activityCodeId===null){throw'Missing the required
|
|
|
23321
23342
|
* @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
|
|
23322
23343
|
*/},{key:"getWorkforcemanagementBusinessunitActivitycodes",value:function getWorkforcemanagementBusinessunitActivitycodes(businessUnitId,opts){opts=opts||{};// verify the required parameter 'businessUnitId' is set
|
|
23323
23344
|
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']);}/**
|
|
23345
|
+
* Get an activity plan
|
|
23346
|
+
*
|
|
23347
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
23348
|
+
* @param {String} activityPlanId The ID of the activity plan to fetch
|
|
23349
|
+
* getWorkforcemanagementBusinessunitActivityplan is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
23350
|
+
*/},{key:"getWorkforcemanagementBusinessunitActivityplan",value:function getWorkforcemanagementBusinessunitActivityplan(businessUnitId,activityPlanId){// verify the required parameter 'businessUnitId' is set
|
|
23351
|
+
if(businessUnitId===undefined||businessUnitId===null){throw'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitActivityplan';}// verify the required parameter 'activityPlanId' is set
|
|
23352
|
+
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']);}/**
|
|
23353
|
+
* Gets an activity plan run job
|
|
23354
|
+
*
|
|
23355
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
23356
|
+
* @param {String} activityPlanId The ID of the activity plan associated with the run job
|
|
23357
|
+
* @param {String} jobId The ID of the activity plan run job
|
|
23358
|
+
* getWorkforcemanagementBusinessunitActivityplanRunsJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
23359
|
+
*/},{key:"getWorkforcemanagementBusinessunitActivityplanRunsJob",value:function getWorkforcemanagementBusinessunitActivityplanRunsJob(businessUnitId,activityPlanId,jobId){// verify the required parameter 'businessUnitId' is set
|
|
23360
|
+
if(businessUnitId===undefined||businessUnitId===null){throw'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitActivityplanRunsJob';}// verify the required parameter 'activityPlanId' is set
|
|
23361
|
+
if(activityPlanId===undefined||activityPlanId===null){throw'Missing the required parameter "activityPlanId" when calling getWorkforcemanagementBusinessunitActivityplanRunsJob';}// verify the required parameter 'jobId' is set
|
|
23362
|
+
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']);}/**
|
|
23363
|
+
* Get activity plans
|
|
23364
|
+
*
|
|
23365
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
23366
|
+
* @param {Object} opts Optional parameters
|
|
23367
|
+
* @param {Object} opts.state Optionally filter by activity plan state
|
|
23368
|
+
* getWorkforcemanagementBusinessunitActivityplans is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
23369
|
+
*/},{key:"getWorkforcemanagementBusinessunitActivityplans",value:function getWorkforcemanagementBusinessunitActivityplans(businessUnitId,opts){opts=opts||{};// verify the required parameter 'businessUnitId' is set
|
|
23370
|
+
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']);}/**
|
|
23371
|
+
* Gets the latest job for all activity plans in the business unit
|
|
23372
|
+
*
|
|
23373
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
23374
|
+
* getWorkforcemanagementBusinessunitActivityplansJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
23375
|
+
*/},{key:"getWorkforcemanagementBusinessunitActivityplansJobs",value:function getWorkforcemanagementBusinessunitActivityplansJobs(businessUnitId){// verify the required parameter 'businessUnitId' is set
|
|
23376
|
+
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']);}/**
|
|
23324
23377
|
* Get intraday planning groups for the given date
|
|
23325
23378
|
*
|
|
23326
23379
|
* @param {String} businessUnitId The ID of the business unit
|
|
@@ -23849,6 +23902,16 @@ if(businessUnitId===undefined||businessUnitId===null){throw'Missing the required
|
|
|
23849
23902
|
*/},{key:"patchWorkforcemanagementBusinessunitActivitycode",value:function patchWorkforcemanagementBusinessunitActivitycode(businessUnitId,activityCodeId,opts){opts=opts||{};// verify the required parameter 'businessUnitId' is set
|
|
23850
23903
|
if(businessUnitId===undefined||businessUnitId===null){throw'Missing the required parameter "businessUnitId" when calling patchWorkforcemanagementBusinessunitActivitycode';}// verify the required parameter 'activityCodeId' is set
|
|
23851
23904
|
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']);}/**
|
|
23905
|
+
* Update an activity plan
|
|
23906
|
+
* If a job associated with the activity plan is in Processing state the activity plan cannot be updated
|
|
23907
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
23908
|
+
* @param {String} activityPlanId The ID of the activity plan to update
|
|
23909
|
+
* @param {Object} body body
|
|
23910
|
+
* patchWorkforcemanagementBusinessunitActivityplan is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
23911
|
+
*/},{key:"patchWorkforcemanagementBusinessunitActivityplan",value:function patchWorkforcemanagementBusinessunitActivityplan(businessUnitId,activityPlanId,body){// verify the required parameter 'businessUnitId' is set
|
|
23912
|
+
if(businessUnitId===undefined||businessUnitId===null){throw'Missing the required parameter "businessUnitId" when calling patchWorkforcemanagementBusinessunitActivityplan';}// verify the required parameter 'activityPlanId' is set
|
|
23913
|
+
if(activityPlanId===undefined||activityPlanId===null){throw'Missing the required parameter "activityPlanId" when calling patchWorkforcemanagementBusinessunitActivityplan';}// verify the required parameter 'body' is set
|
|
23914
|
+
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']);}/**
|
|
23852
23915
|
* Updates the planning group
|
|
23853
23916
|
*
|
|
23854
23917
|
* @param {String} businessUnitId The ID of the business unit.
|
|
@@ -24053,6 +24116,22 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
24053
24116
|
* @param {Object} opts.body body
|
|
24054
24117
|
*/},{key:"postWorkforcemanagementBusinessunitActivitycodes",value:function postWorkforcemanagementBusinessunitActivitycodes(businessUnitId,opts){opts=opts||{};// verify the required parameter 'businessUnitId' is set
|
|
24055
24118
|
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']);}/**
|
|
24119
|
+
* Run an activity plan manually
|
|
24120
|
+
* Triggers a job running the activity plan. The activity plan cannot be updated until the job completes
|
|
24121
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
24122
|
+
* @param {String} activityPlanId The ID of the activity plan to run
|
|
24123
|
+
* postWorkforcemanagementBusinessunitActivityplanRunsJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
24124
|
+
*/},{key:"postWorkforcemanagementBusinessunitActivityplanRunsJobs",value:function postWorkforcemanagementBusinessunitActivityplanRunsJobs(businessUnitId,activityPlanId){// verify the required parameter 'businessUnitId' is set
|
|
24125
|
+
if(businessUnitId===undefined||businessUnitId===null){throw'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitActivityplanRunsJobs';}// verify the required parameter 'activityPlanId' is set
|
|
24126
|
+
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']);}/**
|
|
24127
|
+
* Create an activity plan
|
|
24128
|
+
*
|
|
24129
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
24130
|
+
* @param {Object} body body
|
|
24131
|
+
* postWorkforcemanagementBusinessunitActivityplans is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
24132
|
+
*/},{key:"postWorkforcemanagementBusinessunitActivityplans",value:function postWorkforcemanagementBusinessunitActivityplans(businessUnitId,body){// verify the required parameter 'businessUnitId' is set
|
|
24133
|
+
if(businessUnitId===undefined||businessUnitId===null){throw'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitActivityplans';}// verify the required parameter 'body' is set
|
|
24134
|
+
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']);}/**
|
|
24056
24135
|
* Query adherence explanations across an entire business unit for the requested period
|
|
24057
24136
|
*
|
|
24058
24137
|
* @param {String} businessUnitId The ID of the business unit
|
|
@@ -24618,7 +24697,7 @@ if(timeOffLimitId===undefined||timeOffLimitId===null){throw'Missing the required
|
|
|
24618
24697
|
* </pre>
|
|
24619
24698
|
* </p>
|
|
24620
24699
|
* @module purecloud-platform-client-v2/index
|
|
24621
|
-
* @version
|
|
24700
|
+
* @version 198.0.0
|
|
24622
24701
|
*/var platformClient=/*#__PURE__*/_createClass(function platformClient(){_classCallCheck(this,platformClient);/**
|
|
24623
24702
|
* The ApiClient constructor.
|
|
24624
24703
|
* @property {module:purecloud-platform-client-v2/ApiClient}
|