purecloud-platform-client-v2 147.0.0 → 148.0.0

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

@@ -0,0 +1,243 @@
+import ApiClient from '../ApiClient.js';
+
+
+class ProcessAutomationApi {
+	/**
+	 * ProcessAutomation service.
+	 * @module purecloud-platform-client-v2/api/ProcessAutomationApi
+	 * @version 148.0.0
+	 */
+
+	/**
+	 * Constructs a new ProcessAutomationApi. 
+	 * @alias module:purecloud-platform-client-v2/api/ProcessAutomationApi
+	 * @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;
+	}
+
+
+	/**
+	 * Delete a Trigger
+	 * 
+	 * @param {String} triggerId triggerId
+	 */
+	deleteProcessautomationTrigger(triggerId) { 
+		// verify the required parameter 'triggerId' is set
+		if (triggerId === undefined || triggerId === null) {
+			throw 'Missing the required parameter "triggerId" when calling deleteProcessautomationTrigger';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/processautomation/triggers/{triggerId}', 
+			'DELETE', 
+			{ 'triggerId': triggerId },
+			{  },
+			{  },
+			{  },
+			null, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
+	/**
+	 * Retrieve a single Trigger matching id.
+	 * 
+	 * @param {String} triggerId triggerId
+	 */
+	getProcessautomationTrigger(triggerId) { 
+		// verify the required parameter 'triggerId' is set
+		if (triggerId === undefined || triggerId === null) {
+			throw 'Missing the required parameter "triggerId" when calling getProcessautomationTrigger';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/processautomation/triggers/{triggerId}', 
+			'GET', 
+			{ 'triggerId': triggerId },
+			{  },
+			{  },
+			{  },
+			null, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
+	/**
+	 * Retrieves all triggers
+	 * 
+	 * @param {Object} opts Optional parameters
+	 * @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
+	 * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
+	 * @param {String} opts.pageSize Number of entities to return. Maximum of 200.
+	 * @param {String} opts.topicName Topic name
+	 * @param {Boolean} opts.enabled Boolean indicating desired enabled state of triggers
+	 */
+	getProcessautomationTriggers(opts) { 
+		opts = opts || {};
+		
+
+		return this.apiClient.callApi(
+			'/api/v2/processautomation/triggers', 
+			'GET', 
+			{  },
+			{ 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'],'topicName': opts['topicName'],'enabled': opts['enabled'] },
+			{  },
+			{  },
+			null, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
+	/**
+	 * Get topics available for organization
+	 * 
+	 * @param {Object} opts Optional parameters
+	 * @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
+	 * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
+	 * @param {String} opts.pageSize Number of entities to return. Maximum of 200.
+	 */
+	getProcessautomationTriggersTopics(opts) { 
+		opts = opts || {};
+		
+
+		return this.apiClient.callApi(
+			'/api/v2/processautomation/triggers/topics', 
+			'GET', 
+			{  },
+			{ 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'] },
+			{  },
+			{  },
+			null, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
+	/**
+	 * Test the matching of a Trigger based on provided event body
+	 * 
+	 * @param {String} triggerId triggerId
+	 * @param {Object} opts Optional parameters
+	 * @param {String} opts.body eventBody
+	 */
+	postProcessautomationTriggerTest(triggerId, opts) { 
+		opts = opts || {};
+		
+		// verify the required parameter 'triggerId' is set
+		if (triggerId === undefined || triggerId === null) {
+			throw 'Missing the required parameter "triggerId" when calling postProcessautomationTriggerTest';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/processautomation/triggers/{triggerId}/test', 
+			'POST', 
+			{ 'triggerId': triggerId },
+			{  },
+			{  },
+			{  },
+			opts['body'], 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
+	/**
+	 * Create a Trigger
+	 * 
+	 * @param {Object} body Input used to create a Trigger.
+	 */
+	postProcessautomationTriggers(body) { 
+		// verify the required parameter 'body' is set
+		if (body === undefined || body === null) {
+			throw 'Missing the required parameter "body" when calling postProcessautomationTriggers';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/processautomation/triggers', 
+			'POST', 
+			{  },
+			{  },
+			{  },
+			{  },
+			body, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
+	/**
+	 * Test the matching of all organization Triggers on given topic using provided event body
+	 * 
+	 * @param {String} topicName topicName
+	 * @param {Object} opts Optional parameters
+	 * @param {String} opts.body eventBody
+	 */
+	postProcessautomationTriggersTopicTest(topicName, opts) { 
+		opts = opts || {};
+		
+		// verify the required parameter 'topicName' is set
+		if (topicName === undefined || topicName === null) {
+			throw 'Missing the required parameter "topicName" when calling postProcessautomationTriggersTopicTest';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/processautomation/triggers/topics/{topicName}/test', 
+			'POST', 
+			{ 'topicName': topicName },
+			{  },
+			{  },
+			{  },
+			opts['body'], 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
+	/**
+	 * Update a Trigger
+	 * 
+	 * @param {String} triggerId triggerId
+	 * @param {Object} body Input to update Trigger. (topicName cannot be updated, a new trigger must be created to use a new topicName)
+	 */
+	putProcessautomationTrigger(triggerId, body) { 
+		// verify the required parameter 'triggerId' is set
+		if (triggerId === undefined || triggerId === null) {
+			throw 'Missing the required parameter "triggerId" when calling putProcessautomationTrigger';
+		}
+		// verify the required parameter 'body' is set
+		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']
+		);
+	}
+
+}
+
+
+export default ProcessAutomationApi;

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

@@ -5,7 +5,7 @@ class QualityApi {
 	/**
 	 * Quality service.
 	 * @module purecloud-platform-client-v2/api/QualityApi
-	 * @version 147.0.0
+	 * @version 148.0.0
 	 */
 
 	/**

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

@@ -5,7 +5,7 @@ class RecordingApi {
 	/**
 	 * Recording service.
 	 * @module purecloud-platform-client-v2/api/RecordingApi
-	 * @version 147.0.0
+	 * @version 148.0.0
 	 */
 
 	/**

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

@@ -5,7 +5,7 @@ class ResponseManagementApi {
 	/**
 	 * ResponseManagement service.
 	 * @module purecloud-platform-client-v2/api/ResponseManagementApi
-	 * @version 147.0.0
+	 * @version 148.0.0
 	 */
 
 	/**

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

@@ -5,7 +5,7 @@ class RoutingApi {
 	/**
 	 * Routing service.
 	 * @module purecloud-platform-client-v2/api/RoutingApi
-	 * @version 147.0.0
+	 * @version 148.0.0
 	 */
 
 	/**

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

@@ -5,7 +5,7 @@ class SCIMApi {
 	/**
 	 * SCIM service.
 	 * @module purecloud-platform-client-v2/api/SCIMApi
-	 * @version 147.0.0
+	 * @version 148.0.0
 	 */
 
 	/**

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

@@ -5,7 +5,7 @@ class ScriptsApi {
 	/**
 	 * Scripts service.
 	 * @module purecloud-platform-client-v2/api/ScriptsApi
-	 * @version 147.0.0
+	 * @version 148.0.0
 	 */
 
 	/**

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

@@ -5,7 +5,7 @@ class SearchApi {
 	/**
 	 * Search service.
 	 * @module purecloud-platform-client-v2/api/SearchApi
-	 * @version 147.0.0
+	 * @version 148.0.0
 	 */
 
 	/**

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

@@ -5,7 +5,7 @@ class SpeechTextAnalyticsApi {
 	/**
 	 * SpeechTextAnalytics service.
 	 * @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
-	 * @version 147.0.0
+	 * @version 148.0.0
 	 */
 
 	/**

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

@@ -5,7 +5,7 @@ class StationsApi {
 	/**
 	 * Stations service.
 	 * @module purecloud-platform-client-v2/api/StationsApi
-	 * @version 147.0.0
+	 * @version 148.0.0
 	 */
 
 	/**

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

@@ -5,7 +5,7 @@ class SuggestApi {
 	/**
 	 * Suggest service.
 	 * @module purecloud-platform-client-v2/api/SuggestApi
-	 * @version 147.0.0
+	 * @version 148.0.0
 	 */
 
 	/**

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

@@ -5,7 +5,7 @@ class TeamsApi {
 	/**
 	 * Teams service.
 	 * @module purecloud-platform-client-v2/api/TeamsApi
-	 * @version 147.0.0
+	 * @version 148.0.0
 	 */
 
 	/**

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

@@ -5,7 +5,7 @@ class TelephonyApi {
 	/**
 	 * Telephony service.
 	 * @module purecloud-platform-client-v2/api/TelephonyApi
-	 * @version 147.0.0
+	 * @version 148.0.0
 	 */
 
 	/**

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

@@ -5,7 +5,7 @@ class TelephonyProvidersEdgeApi {
 	/**
 	 * TelephonyProvidersEdge service.
 	 * @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
-	 * @version 147.0.0
+	 * @version 148.0.0
 	 */
 
 	/**

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

@@ -5,7 +5,7 @@ class TextbotsApi {
 	/**
 	 * Textbots service.
 	 * @module purecloud-platform-client-v2/api/TextbotsApi
-	 * @version 147.0.0
+	 * @version 148.0.0
 	 */
 
 	/**

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

@@ -5,7 +5,7 @@ class TokensApi {
 	/**
 	 * Tokens service.
 	 * @module purecloud-platform-client-v2/api/TokensApi
-	 * @version 147.0.0
+	 * @version 148.0.0
 	 */
 
 	/**

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

@@ -5,7 +5,7 @@ class UploadsApi {
 	/**
 	 * Uploads service.
 	 * @module purecloud-platform-client-v2/api/UploadsApi
-	 * @version 147.0.0
+	 * @version 148.0.0
 	 */
 
 	/**

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

@@ -5,7 +5,7 @@ class UsageApi {
 	/**
 	 * Usage service.
 	 * @module purecloud-platform-client-v2/api/UsageApi
-	 * @version 147.0.0
+	 * @version 148.0.0
 	 */
 
 	/**

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

@@ -5,7 +5,7 @@ class UserRecordingsApi {
 	/**
 	 * UserRecordings service.
 	 * @module purecloud-platform-client-v2/api/UserRecordingsApi
-	 * @version 147.0.0
+	 * @version 148.0.0
 	 */
 
 	/**
@@ -80,6 +80,7 @@ class UserRecordingsApi {
 	 * @param {String} recordingId User Recording ID
 	 * @param {Object} opts Optional parameters
 	 * @param {Object} opts.formatId The desired media format. (default to WEBM)
+	 * @param {Boolean} opts.async When set to true, api will return 202 response until the recording is ready for download
 	 */
 	getUserrecordingMedia(recordingId, opts) { 
 		opts = opts || {};
@@ -93,7 +94,7 @@ class UserRecordingsApi {
 			'/api/v2/userrecordings/{recordingId}/media', 
 			'GET', 
 			{ 'recordingId': recordingId },
-			{ 'formatId': opts['formatId'] },
+			{ 'formatId': opts['formatId'],'async': opts['async'] },
 			{  },
 			{  },
 			null, 

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

@@ -5,7 +5,7 @@ class UsersApi {
 	/**
 	 * Users service.
 	 * @module purecloud-platform-client-v2/api/UsersApi
-	 * @version 147.0.0
+	 * @version 148.0.0
 	 */
 
 	/**

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

@@ -5,7 +5,7 @@ class UtilitiesApi {
 	/**
 	 * Utilities service.
 	 * @module purecloud-platform-client-v2/api/UtilitiesApi
-	 * @version 147.0.0
+	 * @version 148.0.0
 	 */
 
 	/**

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

@@ -5,7 +5,7 @@ class VoicemailApi {
 	/**
 	 * Voicemail service.
 	 * @module purecloud-platform-client-v2/api/VoicemailApi
-	 * @version 147.0.0
+	 * @version 148.0.0
 	 */
 
 	/**

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

@@ -5,7 +5,7 @@ class WebChatApi {
 	/**
 	 * WebChat service.
 	 * @module purecloud-platform-client-v2/api/WebChatApi
-	 * @version 147.0.0
+	 * @version 148.0.0
 	 */
 
 	/**

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

@@ -5,7 +5,7 @@ class WebDeploymentsApi {
 	/**
 	 * WebDeployments service.
 	 * @module purecloud-platform-client-v2/api/WebDeploymentsApi
-	 * @version 147.0.0
+	 * @version 148.0.0
 	 */
 
 	/**

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

@@ -5,7 +5,7 @@ class WebMessagingApi {
 	/**
 	 * WebMessaging service.
 	 * @module purecloud-platform-client-v2/api/WebMessagingApi
-	 * @version 147.0.0
+	 * @version 148.0.0
 	 */
 
 	/**

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

@@ -5,7 +5,7 @@ class WidgetsApi {
 	/**
 	 * Widgets service.
 	 * @module purecloud-platform-client-v2/api/WidgetsApi
-	 * @version 147.0.0
+	 * @version 148.0.0
 	 */
 
 	/**

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

@@ -5,7 +5,7 @@ class WorkforceManagementApi {
 	/**
 	 * WorkforceManagement service.
 	 * @module purecloud-platform-client-v2/api/WorkforceManagementApi
-	 * @version 147.0.0
+	 * @version 148.0.0
 	 */
 
 	/**

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

@@ -38,6 +38,7 @@ import OrganizationApi from './api/OrganizationApi.js';
 import OrganizationAuthorizationApi from './api/OrganizationAuthorizationApi.js';
 import OutboundApi from './api/OutboundApi.js';
 import PresenceApi from './api/PresenceApi.js';
+import ProcessAutomationApi from './api/ProcessAutomationApi.js';
 import QualityApi from './api/QualityApi.js';
 import RecordingApi from './api/RecordingApi.js';
 import ResponseManagementApi from './api/ResponseManagementApi.js';
@@ -96,7 +97,7 @@ import WorkforceManagementApi from './api/WorkforceManagementApi.js';
  * </pre>
  * </p>
  * @module purecloud-platform-client-v2/index
- * @version 147.0.0
+ * @version 148.0.0
  */
 class platformClient {
 	constructor() {
@@ -295,6 +296,11 @@ class platformClient {
 		 * @property {module:purecloud-platform-client-v2/api/PresenceApi}
 		 */
 		this.PresenceApi = PresenceApi;
+		/**
+		 * The ProcessAutomationApi service constructor.
+		 * @property {module:purecloud-platform-client-v2/api/ProcessAutomationApi}
+		 */
+		this.ProcessAutomationApi = ProcessAutomationApi;
 		/**
 		 * The QualityApi service constructor.
 		 * @property {module:purecloud-platform-client-v2/api/QualityApi}