purecloud-platform-client-v2 171.0.0 → 173.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "purecloud-platform-client-v2",
-  "version": "171.0.0",
+  "version": "173.0.0",
   "description": "A JavaScript library to interface with the PureCloud Platform API",
   "license": "MIT",
   "main": "dist/node/purecloud-platform-client-v2.js",

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

@@ -4,7 +4,7 @@ import { default as qs } from 'qs';
 
 /**
  * @module purecloud-platform-client-v2/ApiClient
- * @version 171.0.0
+ * @version 173.0.0
  */
 class ApiClient {
 	/**

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 171.0.0
+	 * @version 173.0.0
 	 */
 
 	/**
@@ -20,6 +20,31 @@ class AlertingApi {
 	}
 
 
+	/**
+	 * Delete an alert
+	 * 
+	 * @param {String} alertId Alert ID
+	 */
+	deleteAlertingAlert(alertId) { 
+		// verify the required parameter 'alertId' is set
+		if (alertId === undefined || alertId === null) {
+			throw 'Missing the required parameter "alertId" when calling deleteAlertingAlert';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/alerting/alerts/{alertId}', 
+			'DELETE', 
+			{ 'alertId': alertId },
+			{  },
+			{  },
+			{  },
+			null, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
 	/**
 	 * Delete an interaction stats alert
 	 * 
@@ -70,6 +95,56 @@ class AlertingApi {
 		);
 	}
 
+	/**
+	 * Delete a rule.
+	 * 
+	 * @param {String} ruleId Rule Id
+	 */
+	deleteAlertingRule(ruleId) { 
+		// verify the required parameter 'ruleId' is set
+		if (ruleId === undefined || ruleId === null) {
+			throw 'Missing the required parameter "ruleId" when calling deleteAlertingRule';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/alerting/rules/{ruleId}', 
+			'DELETE', 
+			{ 'ruleId': ruleId },
+			{  },
+			{  },
+			{  },
+			null, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
+	/**
+	 * Get an alert
+	 * 
+	 * @param {String} alertId Alert ID
+	 */
+	getAlertingAlert(alertId) { 
+		// verify the required parameter 'alertId' is set
+		if (alertId === undefined || alertId === null) {
+			throw 'Missing the required parameter "alertId" when calling getAlertingAlert';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/alerting/alerts/{alertId}', 
+			'GET', 
+			{ 'alertId': alertId },
+			{  },
+			{  },
+			{  },
+			null, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
 	/**
 	 * Gets active alert count for a user.
 	 * 
@@ -216,6 +291,134 @@ class AlertingApi {
 		);
 	}
 
+	/**
+	 * Get a rule.
+	 * 
+	 * @param {String} ruleId Rule Id
+	 */
+	getAlertingRule(ruleId) { 
+		// verify the required parameter 'ruleId' is set
+		if (ruleId === undefined || ruleId === null) {
+			throw 'Missing the required parameter "ruleId" when calling getAlertingRule';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/alerting/rules/{ruleId}', 
+			'GET', 
+			{ 'ruleId': ruleId },
+			{  },
+			{  },
+			{  },
+			null, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
+	/**
+	 * Allows an entity to mute/snooze an alert or update the unread status of the alert.
+	 * Snoozing an alert temporarily stop it from resending notifications to individualsas well as other services within Genesys Cloud for a given period.  Muting an alert will only block the notifications to individuals.
+	 * @param {String} alertId Alert ID
+	 * @param {Object} opts Optional parameters
+	 * @param {Object} opts.body 
+	 */
+	patchAlertingAlert(alertId, opts) { 
+		opts = opts || {};
+		
+		// verify the required parameter 'alertId' is set
+		if (alertId === undefined || alertId === null) {
+			throw 'Missing the required parameter "alertId" when calling patchAlertingAlert';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/alerting/alerts/{alertId}', 
+			'PATCH', 
+			{ 'alertId': alertId },
+			{  },
+			{  },
+			{  },
+			opts['body'], 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
+	/**
+	 * Bulk alert updates
+	 * 
+	 * @param {Object} body 
+	 */
+	patchAlertingAlertsBulk(body) { 
+		// verify the required parameter 'body' is set
+		if (body === undefined || body === null) {
+			throw 'Missing the required parameter "body" when calling patchAlertingAlertsBulk';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/alerting/alerts/bulk', 
+			'PATCH', 
+			{  },
+			{  },
+			{  },
+			{  },
+			body, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
+	/**
+	 * Bulk update of notification lists
+	 * 
+	 * @param {Object} body 
+	 */
+	patchAlertingRulesBulk(body) { 
+		// verify the required parameter 'body' is set
+		if (body === undefined || body === null) {
+			throw 'Missing the required parameter "body" when calling patchAlertingRulesBulk';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/alerting/rules/bulk', 
+			'PATCH', 
+			{  },
+			{  },
+			{  },
+			{  },
+			body, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
+	/**
+	 * Gets a paged list of alerts. The max page size is 50
+	 * 
+	 * @param {Object} opts Optional parameters
+	 * @param {Object} opts.body 
+	 */
+	postAlertingAlertsQuery(opts) { 
+		opts = opts || {};
+		
+
+		return this.apiClient.callApi(
+			'/api/v2/alerting/alerts/query', 
+			'POST', 
+			{  },
+			{  },
+			{  },
+			{  },
+			opts['body'], 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
 	/**
 	 * Create an interaction stats rule.
 	 * 
@@ -245,6 +448,109 @@ class AlertingApi {
 		);
 	}
 
+	/**
+	 * Create a Rule.
+	 * 
+	 * @param {Object} body rule to be created
+	 */
+	postAlertingRules(body) { 
+		// verify the required parameter 'body' is set
+		if (body === undefined || body === null) {
+			throw 'Missing the required parameter "body" when calling postAlertingRules';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/alerting/rules', 
+			'POST', 
+			{  },
+			{  },
+			{  },
+			{  },
+			body, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
+	/**
+	 * Bulk remove rules
+	 * 
+	 * @param {Object} body 
+	 */
+	postAlertingRulesBulkRemove(body) { 
+		// verify the required parameter 'body' is set
+		if (body === undefined || body === null) {
+			throw 'Missing the required parameter "body" when calling postAlertingRulesBulkRemove';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/alerting/rules/bulk/remove', 
+			'POST', 
+			{  },
+			{  },
+			{  },
+			{  },
+			body, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
+	/**
+	 * Get a paged list of rules.  The max size of the page is 50 items.
+	 * 
+	 * @param {Object} opts Optional parameters
+	 * @param {Object} opts.body 
+	 */
+	postAlertingRulesQuery(opts) { 
+		opts = opts || {};
+		
+
+		return this.apiClient.callApi(
+			'/api/v2/alerting/rules/query', 
+			'POST', 
+			{  },
+			{  },
+			{  },
+			{  },
+			opts['body'], 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
+	/**
+	 * Update an alert read status
+	 * 
+	 * @param {String} alertId Alert ID
+	 * @param {Object} opts Optional parameters
+	 * @param {Object} opts.body 
+	 */
+	putAlertingAlert(alertId, opts) { 
+		opts = opts || {};
+		
+		// verify the required parameter 'alertId' is set
+		if (alertId === undefined || alertId === null) {
+			throw 'Missing the required parameter "alertId" when calling putAlertingAlert';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/alerting/alerts/{alertId}', 
+			'PUT', 
+			{ 'alertId': alertId },
+			{  },
+			{  },
+			{  },
+			opts['body'], 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
 	/**
 	 * Update an interaction stats alert read status
 	 * 
@@ -313,6 +619,36 @@ class AlertingApi {
 		);
 	}
 
+	/**
+	 * Update a rule
+	 * 
+	 * @param {String} ruleId Rule Id
+	 * @param {Object} body rule to be updated
+	 */
+	putAlertingRule(ruleId, body) { 
+		// verify the required parameter 'ruleId' is set
+		if (ruleId === undefined || ruleId === null) {
+			throw 'Missing the required parameter "ruleId" when calling putAlertingRule';
+		}
+		// verify the required parameter 'body' is set
+		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']
+		);
+	}
+
 }
 
 

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 171.0.0
+	 * @version 173.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 171.0.0
+	 * @version 173.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 171.0.0
+	 * @version 173.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 171.0.0
+	 * @version 173.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 171.0.0
+	 * @version 173.0.0
 	 */
 
 	/**

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

@@ -5,7 +5,7 @@ class CarrierServicesApi {
 	/**
 	 * CarrierServices service.
 	 * @module purecloud-platform-client-v2/api/CarrierServicesApi
-	 * @version 171.0.0
+	 * @version 173.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 171.0.0
+	 * @version 173.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 171.0.0
+	 * @version 173.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 171.0.0
+	 * @version 173.0.0
 	 */
 
 	/**