purecloud-platform-client-v2 209.0.0 → 210.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "purecloud-platform-client-v2",
-  "version": "209.0.0",
+  "version": "210.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 209.0.0
+ * @version 210.0.0
  */
 class ApiClient {
 	/**

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

@@ -5,7 +5,7 @@ class AgentAssistantsApi {
 	/**
 	 * AgentAssistants service.
 	 * @module purecloud-platform-client-v2/api/AgentAssistantsApi
-	 * @version 209.0.0
+	 * @version 210.0.0
 	 */
 
 	/**

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

@@ -5,7 +5,7 @@ class AgentCopilotApi {
 	/**
 	 * AgentCopilot service.
 	 * @module purecloud-platform-client-v2/api/AgentCopilotApi
-	 * @version 209.0.0
+	 * @version 210.0.0
 	 */
 
 	/**

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

@@ -5,7 +5,7 @@ class AgentUIApi {
 	/**
 	 * AgentUI service.
 	 * @module purecloud-platform-client-v2/api/AgentUIApi
-	 * @version 209.0.0
+	 * @version 210.0.0
 	 */
 
 	/**

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 209.0.0
+	 * @version 210.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 209.0.0
+	 * @version 210.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 209.0.0
+	 * @version 210.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 209.0.0
+	 * @version 210.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 209.0.0
+	 * @version 210.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 209.0.0
+	 * @version 210.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 209.0.0
+	 * @version 210.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 209.0.0
+	 * @version 210.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 209.0.0
+	 * @version 210.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 209.0.0
+	 * @version 210.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 209.0.0
+	 * @version 210.0.0
 	 */
 
 	/**

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 209.0.0
+	 * @version 210.0.0
 	 */
 
 	/**

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

@@ -0,0 +1,175 @@
+import ApiClient from '../ApiClient.js';
+
+
+class DataPrivacyApi {
+	/**
+	 * DataPrivacy service.
+	 * @module purecloud-platform-client-v2/api/DataPrivacyApi
+	 * @version 210.0.0
+	 */
+
+	/**
+	 * Constructs a new DataPrivacyApi. 
+	 * @alias module:purecloud-platform-client-v2/api/DataPrivacyApi
+	 * @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 masking rule.
+	 * 
+	 * @param {String} ruleId ruleId
+	 */
+	deleteDataprivacyMaskingrule(ruleId) { 
+		// verify the required parameter 'ruleId' is set
+		if (ruleId === undefined || ruleId === null) {
+			throw 'Missing the required parameter "ruleId" when calling deleteDataprivacyMaskingrule';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/dataprivacy/maskingrules/{ruleId}', 
+			'DELETE', 
+			{ 'ruleId': ruleId },
+			{  },
+			{  },
+			{  },
+			null, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
+	/**
+	 * Fetch details about a masking rule.
+	 * 
+	 * @param {String} ruleId ruleId
+	 */
+	getDataprivacyMaskingrule(ruleId) { 
+		// verify the required parameter 'ruleId' is set
+		if (ruleId === undefined || ruleId === null) {
+			throw 'Missing the required parameter "ruleId" when calling getDataprivacyMaskingrule';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/dataprivacy/maskingrules/{ruleId}', 
+			'GET', 
+			{ 'ruleId': ruleId },
+			{  },
+			{  },
+			{  },
+			null, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
+	/**
+	 * Retrieve the list of masking rules.
+	 * 
+	 */
+	getDataprivacyMaskingrules() { 
+
+		return this.apiClient.callApi(
+			'/api/v2/dataprivacy/maskingrules', 
+			'GET', 
+			{  },
+			{  },
+			{  },
+			{  },
+			null, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
+	/**
+	 * Update information about a masking rule.
+	 * 
+	 * @param {String} ruleId ruleId
+	 * @param {Object} opts Optional parameters
+	 * @param {Object} opts.body 
+	 */
+	patchDataprivacyMaskingrule(ruleId, opts) { 
+		opts = opts || {};
+		
+		// verify the required parameter 'ruleId' is set
+		if (ruleId === undefined || ruleId === null) {
+			throw 'Missing the required parameter "ruleId" when calling patchDataprivacyMaskingrule';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/dataprivacy/maskingrules/{ruleId}', 
+			'PATCH', 
+			{ 'ruleId': ruleId },
+			{  },
+			{  },
+			{  },
+			opts['body'], 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
+	/**
+	 * Create a new masking rule resource.
+	 * 
+	 * @param {Object} body Details for creating masking rule resource
+	 */
+	postDataprivacyMaskingrules(body) { 
+		// verify the required parameter 'body' is set
+		if (body === undefined || body === null) {
+			throw 'Missing the required parameter "body" when calling postDataprivacyMaskingrules';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/dataprivacy/maskingrules', 
+			'POST', 
+			{  },
+			{  },
+			{  },
+			{  },
+			body, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
+	/**
+	 * Validate masking before creating.
+	 * 
+	 * @param {Object} body Text to be masked
+	 */
+	postDataprivacyMaskingrulesValidate(body) { 
+		// verify the required parameter 'body' is set
+		if (body === undefined || body === null) {
+			throw 'Missing the required parameter "body" when calling postDataprivacyMaskingrulesValidate';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/dataprivacy/maskingrules/validate', 
+			'POST', 
+			{  },
+			{  },
+			{  },
+			{  },
+			body, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
+}
+
+
+export default DataPrivacyApi;

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 209.0.0
+	 * @version 210.0.0
 	 */
 
 	/**

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

@@ -5,7 +5,7 @@ class EmailsApi {
 	/**
 	 * Emails service.
 	 * @module purecloud-platform-client-v2/api/EmailsApi
-	 * @version 209.0.0
+	 * @version 210.0.0
 	 */
 
 	/**

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

@@ -5,7 +5,7 @@ class EmployeeEngagementApi {
 	/**
 	 * EmployeeEngagement service.
 	 * @module purecloud-platform-client-v2/api/EmployeeEngagementApi
-	 * @version 209.0.0
+	 * @version 210.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 209.0.0
+	 * @version 210.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 209.0.0
+	 * @version 210.0.0
 	 */
 
 	/**
@@ -150,6 +150,31 @@ class ExternalContactsApi {
 		);
 	}
 
+	/**
+	 * Delete Settings
+	 * 
+	 * @param {String} settingsId Settings id
+	 */
+	deleteExternalcontactsImportSetting(settingsId) { 
+		// verify the required parameter 'settingsId' is set
+		if (settingsId === undefined || settingsId === null) {
+			throw 'Missing the required parameter "settingsId" when calling deleteExternalcontactsImportSetting';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/externalcontacts/import/settings/{settingsId}', 
+			'DELETE', 
+			{ 'settingsId': settingsId },
+			{  },
+			{  },
+			{  },
+			null, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
 	/**
 	 * Delete an external organization
 	 * 
@@ -716,6 +741,110 @@ class ExternalContactsApi {
 		);
 	}
 
+	/**
+	 * Get job based on id
+	 * 
+	 * @param {String} jobId Job id
+	 */
+	getExternalcontactsImportJob(jobId) { 
+		// verify the required parameter 'jobId' is set
+		if (jobId === undefined || jobId === null) {
+			throw 'Missing the required parameter "jobId" when calling getExternalcontactsImportJob';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/externalcontacts/import/jobs/{jobId}', 
+			'GET', 
+			{ 'jobId': jobId },
+			{  },
+			{  },
+			{  },
+			null, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
+	/**
+	 * List jobs for organization
+	 * 
+	 * @param {Object} opts Optional parameters
+	 * @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 100. (default to 25)
+	 * @param {Object} opts.sortOrder Direction of sorting. (default to Ascending)
+	 * @param {Object} opts.jobStatus Search term to filter by jobStatus
+	 */
+	getExternalcontactsImportJobs(opts) { 
+		opts = opts || {};
+		
+
+		return this.apiClient.callApi(
+			'/api/v2/externalcontacts/import/jobs', 
+			'GET', 
+			{  },
+			{ 'after': opts['after'],'pageSize': opts['pageSize'],'sortOrder': opts['sortOrder'],'jobStatus': opts['jobStatus'] },
+			{  },
+			{  },
+			null, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
+	/**
+	 * Get setting based on id
+	 * 
+	 * @param {String} settingsId Settings id
+	 */
+	getExternalcontactsImportSetting(settingsId) { 
+		// verify the required parameter 'settingsId' is set
+		if (settingsId === undefined || settingsId === null) {
+			throw 'Missing the required parameter "settingsId" when calling getExternalcontactsImportSetting';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/externalcontacts/import/settings/{settingsId}', 
+			'GET', 
+			{ 'settingsId': settingsId },
+			{  },
+			{  },
+			{  },
+			null, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
+	/**
+	 * List settings for organization
+	 * 
+	 * @param {Object} opts Optional parameters
+	 * @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 100. (default to 25)
+	 * @param {Object} opts.sortOrder Direction of sorting. (default to Ascending)
+	 * @param {String} opts.name Search term to filter by settings name
+	 */
+	getExternalcontactsImportSettings(opts) { 
+		opts = opts || {};
+		
+
+		return this.apiClient.callApi(
+			'/api/v2/externalcontacts/import/settings', 
+			'GET', 
+			{  },
+			{ 'after': opts['after'],'pageSize': opts['pageSize'],'sortOrder': opts['sortOrder'],'name': opts['name'] },
+			{  },
+			{  },
+			null, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
 	/**
 	 * Fetch an external organization
 	 * 
@@ -1854,6 +1983,56 @@ class ExternalContactsApi {
 		);
 	}
 
+	/**
+	 * Create a new job
+	 * 
+	 * @param {Object} body Job
+	 */
+	postExternalcontactsImportJobs(body) { 
+		// verify the required parameter 'body' is set
+		if (body === undefined || body === null) {
+			throw 'Missing the required parameter "body" when calling postExternalcontactsImportJobs';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/externalcontacts/import/jobs', 
+			'POST', 
+			{  },
+			{  },
+			{  },
+			{  },
+			body, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
+	/**
+	 * Create a new settings
+	 * 
+	 * @param {Object} body Setting
+	 */
+	postExternalcontactsImportSettings(body) { 
+		// verify the required parameter 'body' is set
+		if (body === undefined || body === null) {
+			throw 'Missing the required parameter "body" when calling postExternalcontactsImportSettings';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/externalcontacts/import/settings', 
+			'POST', 
+			{  },
+			{  },
+			{  },
+			{  },
+			body, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
 	/**
 	 * Merge two contacts into a new contact record
 	 * Two curated contacts cannot be merged. Refer to the Contact Merging article on the Developer Center for details
@@ -2169,6 +2348,66 @@ class ExternalContactsApi {
 		);
 	}
 
+	/**
+	 * Update Job's workflow status
+	 * 
+	 * @param {String} jobId Job id
+	 * @param {Object} body Status of the Job's workflow
+	 */
+	putExternalcontactsImportJob(jobId, body) { 
+		// verify the required parameter 'jobId' is set
+		if (jobId === undefined || jobId === null) {
+			throw 'Missing the required parameter "jobId" when calling putExternalcontactsImportJob';
+		}
+		// verify the required parameter 'body' is set
+		if (body === undefined || body === null) {
+			throw 'Missing the required parameter "body" when calling putExternalcontactsImportJob';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/externalcontacts/import/jobs/{jobId}', 
+			'PUT', 
+			{ 'jobId': jobId },
+			{  },
+			{  },
+			{  },
+			body, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
+	/**
+	 * Update settings
+	 * 
+	 * @param {String} settingsId Settings id
+	 * @param {Object} body Setting
+	 */
+	putExternalcontactsImportSetting(settingsId, body) { 
+		// verify the required parameter 'settingsId' is set
+		if (settingsId === undefined || settingsId === null) {
+			throw 'Missing the required parameter "settingsId" when calling putExternalcontactsImportSetting';
+		}
+		// verify the required parameter 'body' is set
+		if (body === undefined || body === null) {
+			throw 'Missing the required parameter "body" when calling putExternalcontactsImportSetting';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/externalcontacts/import/settings/{settingsId}', 
+			'PUT', 
+			{ 'settingsId': settingsId },
+			{  },
+			{  },
+			{  },
+			body, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
 	/**
 	 * Update an external organization
 	 * 

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 209.0.0
+	 * @version 210.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 209.0.0
+	 * @version 210.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 209.0.0
+	 * @version 210.0.0
 	 */
 
 	/**