purecloud-platform-client-v2 158.0.0 → 160.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "purecloud-platform-client-v2",
-  "version": "158.0.0",
+  "version": "160.0.0",
   "description": "A JavaScript library to interface with the PureCloud Platform API",
   "license": "MIT",
   "main": "dist/node/purecloud-platform-client-v2.js",
@@ -33,7 +33,8 @@
     "axios": "^0.27.2",
     "configparser": "^0.3.9",
     "qs": "^6.10.3",
-    "winston": "^3.6.0"
+    "winston": "^3.6.0",
+    "hpagent": "^1.2.0"
   },
   "devDependencies": {
     "mocha": "~9.2.0",

package/src/purecloud-platform-client-v2/ApiClient.js

@@ -1,10 +1,11 @@
 import { default as axios } from 'axios';
 import Configuration from './configuration.js';
 import { default as qs } from 'qs';
+const { HttpsProxyAgent } = require('hpagent')
 
 /**
  * @module purecloud-platform-client-v2/ApiClient
- * @version 158.0.0
+ * @version 160.0.0
  */
 class ApiClient {
 	/**
@@ -273,16 +274,21 @@ class ApiClient {
 				reject(new Error('The client credentials grant is not supported in a browser.'));
 				return;
 			}
-
 			const headers = {
 				'Authorization': `Basic ${authHeader}`
 			}
+			let httpsAgent;
+			if (this.proxy !== undefined){
+				httpsAgent = new HttpsProxyAgent({
+				    proxy : `${this.proxy.protocol}://${this.proxy.host}:${this.proxy.port}`
+				});
+			}
 			axios({
 				method: `POST`,
 				url: `https://login.${this.config.environment}/oauth/token`,
 				headers: headers,
 				data: 'grant_type=client_credentials',
-				proxy: this.proxy
+				httpsAgent: httpsAgent
 			})
 				.then((response) => {
 					// Logging
@@ -979,10 +985,16 @@ class ApiClient {
 			sendRequest(this);
 			function sendRequest(that) {
 				var url = that.buildUrl(path, pathParams);
+				let httpsAgent;
+				if (that.proxy !== undefined){
+				    httpsAgent = new HttpsProxyAgent({
+					proxy : `${that.proxy.protocol}://${that.proxy.host}:${that.proxy.port}`
+				    });
+				}
 				var request = {
 					method: httpMethod,
 					url: url,
-					proxy: that.proxy,
+                    			httpsAgent: httpsAgent,
 					timeout: that.timeout,
 					params: that.serialize(queryParams)
 				};

package/src/purecloud-platform-client-v2/api/AlertingApi.js

@@ -5,7 +5,7 @@ class AlertingApi {
 	/**
 	 * Alerting service.
 	 * @module purecloud-platform-client-v2/api/AlertingApi
-	 * @version 158.0.0
+	 * @version 160.0.0
 	 */
 
 	/**

package/src/purecloud-platform-client-v2/api/AnalyticsApi.js

@@ -5,7 +5,7 @@ class AnalyticsApi {
 	/**
 	 * Analytics service.
 	 * @module purecloud-platform-client-v2/api/AnalyticsApi
-	 * @version 158.0.0
+	 * @version 160.0.0
 	 */
 
 	/**

package/src/purecloud-platform-client-v2/api/ArchitectApi.js

@@ -5,7 +5,7 @@ class ArchitectApi {
 	/**
 	 * Architect service.
 	 * @module purecloud-platform-client-v2/api/ArchitectApi
-	 * @version 158.0.0
+	 * @version 160.0.0
 	 */
 
 	/**

package/src/purecloud-platform-client-v2/api/AuditApi.js

@@ -5,7 +5,7 @@ class AuditApi {
 	/**
 	 * Audit service.
 	 * @module purecloud-platform-client-v2/api/AuditApi
-	 * @version 158.0.0
+	 * @version 160.0.0
 	 */
 
 	/**

package/src/purecloud-platform-client-v2/api/AuthorizationApi.js

@@ -5,7 +5,7 @@ class AuthorizationApi {
 	/**
 	 * Authorization service.
 	 * @module purecloud-platform-client-v2/api/AuthorizationApi
-	 * @version 158.0.0
+	 * @version 160.0.0
 	 */
 
 	/**

package/src/purecloud-platform-client-v2/api/BillingApi.js

@@ -5,7 +5,7 @@ class BillingApi {
 	/**
 	 * Billing service.
 	 * @module purecloud-platform-client-v2/api/BillingApi
-	 * @version 158.0.0
+	 * @version 160.0.0
 	 */
 
 	/**

package/src/purecloud-platform-client-v2/api/ChatApi.js

@@ -5,7 +5,7 @@ class ChatApi {
 	/**
 	 * Chat service.
 	 * @module purecloud-platform-client-v2/api/ChatApi
-	 * @version 158.0.0
+	 * @version 160.0.0
 	 */
 
 	/**

package/src/purecloud-platform-client-v2/api/CoachingApi.js

@@ -5,7 +5,7 @@ class CoachingApi {
 	/**
 	 * Coaching service.
 	 * @module purecloud-platform-client-v2/api/CoachingApi
-	 * @version 158.0.0
+	 * @version 160.0.0
 	 */
 
 	/**

package/src/purecloud-platform-client-v2/api/ContentManagementApi.js

@@ -5,7 +5,7 @@ class ContentManagementApi {
 	/**
 	 * ContentManagement service.
 	 * @module purecloud-platform-client-v2/api/ContentManagementApi
-	 * @version 158.0.0
+	 * @version 160.0.0
 	 */
 
 	/**

package/src/purecloud-platform-client-v2/api/ConversationsApi.js

@@ -5,7 +5,7 @@ class ConversationsApi {
 	/**
 	 * Conversations service.
 	 * @module purecloud-platform-client-v2/api/ConversationsApi
-	 * @version 158.0.0
+	 * @version 160.0.0
 	 */
 
 	/**
@@ -3393,7 +3393,7 @@ class ConversationsApi {
 	}
 
 	/**
-	 * Creates a cobrowse session
+	 * Creates a cobrowse session. Requires conversation:cobrowse:add (for web messaging) or conversation:cobrowsevoice:add permission.
 	 * 
 	 * @param {String} conversationId Conversation ID
 	 */
@@ -4707,6 +4707,31 @@ class ConversationsApi {
 		);
 	}
 
+	/**
+	 * Search conversations
+	 * 
+	 * @param {Object} body Search request options
+	 */
+	postConversationsParticipantsAttributesSearch(body) { 
+		// verify the required parameter 'body' is set
+		if (body === undefined || body === null) {
+			throw 'Missing the required parameter "body" when calling postConversationsParticipantsAttributesSearch';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/conversations/participants/attributes/search', 
+			'POST', 
+			{  },
+			{  },
+			{  },
+			{  },
+			body, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
 	/**
 	 * Set flagged reason on conversation participant to indicate bad conversation quality.
 	 * 

package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js

@@ -5,7 +5,7 @@ class DataExtensionsApi {
 	/**
 	 * DataExtensions service.
 	 * @module purecloud-platform-client-v2/api/DataExtensionsApi
-	 * @version 158.0.0
+	 * @version 160.0.0
 	 */
 
 	/**

package/src/purecloud-platform-client-v2/api/DownloadsApi.js

@@ -5,7 +5,7 @@ class DownloadsApi {
 	/**
 	 * Downloads service.
 	 * @module purecloud-platform-client-v2/api/DownloadsApi
-	 * @version 158.0.0
+	 * @version 160.0.0
 	 */
 
 	/**

package/src/purecloud-platform-client-v2/api/EventsApi.js

@@ -5,7 +5,7 @@ class EventsApi {
 	/**
 	 * Events service.
 	 * @module purecloud-platform-client-v2/api/EventsApi
-	 * @version 158.0.0
+	 * @version 160.0.0
 	 */
 
 	/**

package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js

@@ -5,7 +5,7 @@ class ExternalContactsApi {
 	/**
 	 * ExternalContacts service.
 	 * @module purecloud-platform-client-v2/api/ExternalContactsApi
-	 * @version 158.0.0
+	 * @version 160.0.0
 	 */
 
 	/**

package/src/purecloud-platform-client-v2/api/FaxApi.js

@@ -5,7 +5,7 @@ class FaxApi {
 	/**
 	 * Fax service.
 	 * @module purecloud-platform-client-v2/api/FaxApi
-	 * @version 158.0.0
+	 * @version 160.0.0
 	 */
 
 	/**

package/src/purecloud-platform-client-v2/api/FlowsApi.js

@@ -5,7 +5,7 @@ class FlowsApi {
 	/**
 	 * Flows service.
 	 * @module purecloud-platform-client-v2/api/FlowsApi
-	 * @version 158.0.0
+	 * @version 160.0.0
 	 */
 
 	/**

package/src/purecloud-platform-client-v2/api/GamificationApi.js

@@ -5,7 +5,7 @@ class GamificationApi {
 	/**
 	 * Gamification service.
 	 * @module purecloud-platform-client-v2/api/GamificationApi
-	 * @version 158.0.0
+	 * @version 160.0.0
 	 */
 
 	/**

package/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js

@@ -5,7 +5,7 @@ class GeneralDataProtectionRegulationApi {
 	/**
 	 * GeneralDataProtectionRegulation service.
 	 * @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
-	 * @version 158.0.0
+	 * @version 160.0.0
 	 */
 
 	/**

package/src/purecloud-platform-client-v2/api/GeolocationApi.js

@@ -5,7 +5,7 @@ class GeolocationApi {
 	/**
 	 * Geolocation service.
 	 * @module purecloud-platform-client-v2/api/GeolocationApi
-	 * @version 158.0.0
+	 * @version 160.0.0
 	 */
 
 	/**

package/src/purecloud-platform-client-v2/api/GreetingsApi.js

@@ -5,7 +5,7 @@ class GreetingsApi {
 	/**
 	 * Greetings service.
 	 * @module purecloud-platform-client-v2/api/GreetingsApi
-	 * @version 158.0.0
+	 * @version 160.0.0
 	 */
 
 	/**

package/src/purecloud-platform-client-v2/api/GroupsApi.js

@@ -5,7 +5,7 @@ class GroupsApi {
 	/**
 	 * Groups service.
 	 * @module purecloud-platform-client-v2/api/GroupsApi
-	 * @version 158.0.0
+	 * @version 160.0.0
 	 */
 
 	/**

package/src/purecloud-platform-client-v2/api/IdentityProviderApi.js

@@ -5,7 +5,7 @@ class IdentityProviderApi {
 	/**
 	 * IdentityProvider service.
 	 * @module purecloud-platform-client-v2/api/IdentityProviderApi
-	 * @version 158.0.0
+	 * @version 160.0.0
 	 */
 
 	/**

package/src/purecloud-platform-client-v2/api/InfrastructureAsCodeApi.js

@@ -0,0 +1,107 @@
+import ApiClient from '../ApiClient.js';
+
+
+class InfrastructureAsCodeApi {
+	/**
+	 * InfrastructureAsCode service.
+	 * @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
+	 * @version 160.0.0
+	 */
+
+	/**
+	 * Constructs a new InfrastructureAsCodeApi. 
+	 * @alias module:purecloud-platform-client-v2/api/InfrastructureAsCodeApi
+	 * @class
+	 * @param {module:purecloud-platform-client-v2/ApiClient} apiClient Optional API client implementation to use,
+	 * default to {@link module:purecloud-platform-client-v2/ApiClient#instance} if unspecified.
+	 */
+	constructor(apiClient) {
+		this.apiClient = apiClient || ApiClient.instance;
+	}
+
+
+	/**
+	 * Get job status and results
+	 * Get the execution status of a submitted job, optionally including results and error details.
+	 * @param {String} jobId Job ID
+	 * @param {Object} opts Optional parameters
+	 * @param {Boolean} opts.details Include details of execution, including job results or error information (default to false)
+	 */
+	getInfrastructureascodeJob(jobId, opts) { 
+		opts = opts || {};
+		
+		// verify the required parameter 'jobId' is set
+		if (jobId === undefined || jobId === null) {
+			throw 'Missing the required parameter "jobId" when calling getInfrastructureascodeJob';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/infrastructureascode/jobs/{jobId}', 
+			'GET', 
+			{ 'jobId': jobId },
+			{ 'details': opts['details'] },
+			{  },
+			{  },
+			null, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
+	/**
+	 * Get job history
+	 * Get a history of submitted jobs, optionally including error messages.
+	 * @param {Object} opts Optional parameters
+	 * @param {Number} opts.maxResults Number of jobs to show (default to 1)
+	 * @param {Boolean} opts.includeErrors Include error messages (default to false)
+	 * @param {Object} opts.sortBy Sort by (default to id)
+	 * @param {Object} opts.sortOrder Sort order (default to asc)
+	 */
+	getInfrastructureascodeJobs(opts) { 
+		opts = opts || {};
+		
+
+		return this.apiClient.callApi(
+			'/api/v2/infrastructureascode/jobs', 
+			'GET', 
+			{  },
+			{ 'maxResults': opts['maxResults'],'includeErrors': opts['includeErrors'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'] },
+			{  },
+			{  },
+			null, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
+	/**
+	 * Create a Job
+	 * Create and submit a job for remote execution or see job planning results.
+	 * @param {Object} body 
+	 */
+	postInfrastructureascodeJobs(body) { 
+		// verify the required parameter 'body' is set
+		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']
+		);
+	}
+
+}
+
+
+export default InfrastructureAsCodeApi;

package/src/purecloud-platform-client-v2/api/IntegrationsApi.js

@@ -5,7 +5,7 @@ class IntegrationsApi {
 	/**
 	 * Integrations service.
 	 * @module purecloud-platform-client-v2/api/IntegrationsApi
-	 * @version 158.0.0
+	 * @version 160.0.0
 	 */
 
 	/**

package/src/purecloud-platform-client-v2/api/JourneyApi.js

@@ -5,7 +5,7 @@ class JourneyApi {
 	/**
 	 * Journey service.
 	 * @module purecloud-platform-client-v2/api/JourneyApi
-	 * @version 158.0.0
+	 * @version 160.0.0
 	 */
 
 	/**
@@ -99,6 +99,31 @@ class JourneyApi {
 		);
 	}
 
+	/**
+	 * Delete an outcome predictor.
+	 * 
+	 * @param {String} predictorId ID of predictor
+	 */
+	deleteJourneyOutcomesPredictor(predictorId) { 
+		// verify the required parameter 'predictorId' is set
+		if (predictorId === undefined || predictorId === null) {
+			throw 'Missing the required parameter "predictorId" when calling deleteJourneyOutcomesPredictor';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/journey/outcomes/predictors/{predictorId}', 
+			'DELETE', 
+			{ 'predictorId': predictorId },
+			{  },
+			{  },
+			{  },
+			null, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
 	/**
 	 * Delete a segment.
 	 * 
@@ -389,6 +414,51 @@ class JourneyApi {
 		);
 	}
 
+	/**
+	 * Retrieve a single outcome predictor.
+	 * 
+	 * @param {String} predictorId ID of predictor
+	 */
+	getJourneyOutcomesPredictor(predictorId) { 
+		// verify the required parameter 'predictorId' is set
+		if (predictorId === undefined || predictorId === null) {
+			throw 'Missing the required parameter "predictorId" when calling getJourneyOutcomesPredictor';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/journey/outcomes/predictors/{predictorId}', 
+			'GET', 
+			{ 'predictorId': predictorId },
+			{  },
+			{  },
+			{  },
+			null, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
+	/**
+	 * Retrieve all outcome predictors.
+	 * 
+	 */
+	getJourneyOutcomesPredictors() { 
+
+		return this.apiClient.callApi(
+			'/api/v2/journey/outcomes/predictors', 
+			'GET', 
+			{  },
+			{  },
+			{  },
+			{  },
+			null, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
 	/**
 	 * Retrieve a single segment.
 	 * 
@@ -761,6 +831,30 @@ class JourneyApi {
 		);
 	}
 
+	/**
+	 * Create an outcome predictor.
+	 * 
+	 * @param {Object} opts Optional parameters
+	 * @param {Object} opts.body 
+	 */
+	postJourneyOutcomesPredictors(opts) { 
+		opts = opts || {};
+		
+
+		return this.apiClient.callApi(
+			'/api/v2/journey/outcomes/predictors', 
+			'POST', 
+			{  },
+			{  },
+			{  },
+			{  },
+			opts['body'], 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
 	/**
 	 * Create a segment.
 	 * 

package/src/purecloud-platform-client-v2/api/KnowledgeApi.js

@@ -5,7 +5,7 @@ class KnowledgeApi {
 	/**
 	 * Knowledge service.
 	 * @module purecloud-platform-client-v2/api/KnowledgeApi
-	 * @version 158.0.0
+	 * @version 160.0.0
 	 */
 
 	/**
@@ -408,7 +408,6 @@ class KnowledgeApi {
 	 * @param {String} sessionId Knowledge guest session ID.
 	 * @param {Object} opts Optional parameters
 	 * @param {Array.<String>} opts.categoryId If specified, retrieves documents associated with category ids, comma separated values expected.
-	 * @param {Boolean} opts.includeSubcategories Deprecated - Do Not Use. Works along with 'categoryId' query parameter. If specified, retrieves documents associated with category ids and its children categories.
 	 * @param {Number} opts.pageSize Number of entities to return. Maximum of 200. (default to 10)
 	 */
 	getKnowledgeGuestSessionDocuments(sessionId, opts) { 
@@ -423,7 +422,7 @@ class KnowledgeApi {
 			'/api/v2/knowledge/guest/sessions/{sessionId}/documents', 
 			'GET', 
 			{ 'sessionId': sessionId },
-			{ 'categoryId': this.apiClient.buildCollectionParam(opts['categoryId'], 'multi'),'includeSubcategories': opts['includeSubcategories'],'pageSize': opts['pageSize'] },
+			{ 'categoryId': this.apiClient.buildCollectionParam(opts['categoryId'], 'multi'),'pageSize': opts['pageSize'] },
 			{  },
 			{  },
 			null, 

package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js

@@ -5,7 +5,7 @@ class LanguageUnderstandingApi {
 	/**
 	 * LanguageUnderstanding service.
 	 * @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
-	 * @version 158.0.0
+	 * @version 160.0.0
 	 */
 
 	/**

package/src/purecloud-platform-client-v2/api/LanguagesApi.js

@@ -5,7 +5,7 @@ class LanguagesApi {
 	/**
 	 * Languages service.
 	 * @module purecloud-platform-client-v2/api/LanguagesApi
-	 * @version 158.0.0
+	 * @version 160.0.0
 	 */
 
 	/**