purecloud-platform-client-v2 216.0.0 → 218.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "purecloud-platform-client-v2",
-  "version": "216.0.0",
+  "version": "218.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

@@ -6,7 +6,7 @@ import { default as qs } from 'qs';
 
 /**
  * @module purecloud-platform-client-v2/ApiClient
- * @version 216.0.0
+ * @version 218.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 216.0.0
+	 * @version 218.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 216.0.0
+	 * @version 218.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 216.0.0
+	 * @version 218.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 216.0.0
+	 * @version 218.0.0
 	 */
 
 	/**
@@ -65,58 +65,6 @@ class AlertingApi {
 		);
 	}
 
-	/**
-	 * Delete an interaction stats alert
-	 * Apps should migrate to use DELETE /api/v2/alerting/alerts/{alertId}.
-	 * @param {String} alertId Alert ID
-	 * @deprecated
-	 */
-	deleteAlertingInteractionstatsAlert(alertId) { 
-		// verify the required parameter 'alertId' is set
-		if (alertId === undefined || alertId === null) {
-			throw 'Missing the required parameter "alertId" when calling deleteAlertingInteractionstatsAlert';
-		}
-
-		return this.apiClient.callApi(
-			'/api/v2/alerting/interactionstats/alerts/{alertId}', 
-			'DELETE', 
-			{ 'alertId': alertId },
-			{  },
-			{  },
-			{  },
-			null, 
-			['PureCloud OAuth'], 
-			['application/json'],
-			['application/json']
-		);
-	}
-
-	/**
-	 * Delete an interaction stats rule
-	 * Apps should migrate to use DELETE /api/v2/alerting/rules/{ruleId}.
-	 * @param {String} ruleId Rule ID
-	 * @deprecated
-	 */
-	deleteAlertingInteractionstatsRule(ruleId) { 
-		// verify the required parameter 'ruleId' is set
-		if (ruleId === undefined || ruleId === null) {
-			throw 'Missing the required parameter "ruleId" when calling deleteAlertingInteractionstatsRule';
-		}
-
-		return this.apiClient.callApi(
-			'/api/v2/alerting/interactionstats/rules/{ruleId}', 
-			'DELETE', 
-			{ 'ruleId': ruleId },
-			{  },
-			{  },
-			{  },
-			null, 
-			['PureCloud OAuth'], 
-			['application/json'],
-			['application/json']
-		);
-	}
-
 	/**
 	 * Delete a rule.
 	 * 
@@ -167,158 +115,6 @@ class AlertingApi {
 		);
 	}
 
-	/**
-	 * Gets active alert count for a user
-	 * Apps should migrate to use POST /api/v2/alerting/alerts/query with the queryType set to Count and alertStatus to Active in the request body.
-	 * @deprecated
-	 */
-	getAlertingAlertsActive() { 
-
-		return this.apiClient.callApi(
-			'/api/v2/alerting/alerts/active', 
-			'GET', 
-			{  },
-			{  },
-			{  },
-			{  },
-			null, 
-			['PureCloud OAuth'], 
-			['application/json'],
-			['application/json']
-		);
-	}
-
-	/**
-	 * Get an interaction stats alert
-	 * Apps should migrate to use GET /api/v2/alerting/alerts/{alertId}.
-	 * @param {String} alertId Alert ID
-	 * @param {Object} opts Optional parameters
-	 * @param {Array.<String>} opts.expand Which fields, if any, to expand
-	 * @deprecated
-	 */
-	getAlertingInteractionstatsAlert(alertId, opts) { 
-		opts = opts || {};
-		
-		// verify the required parameter 'alertId' is set
-		if (alertId === undefined || alertId === null) {
-			throw 'Missing the required parameter "alertId" when calling getAlertingInteractionstatsAlert';
-		}
-
-		return this.apiClient.callApi(
-			'/api/v2/alerting/interactionstats/alerts/{alertId}', 
-			'GET', 
-			{ 'alertId': alertId },
-			{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
-			{  },
-			{  },
-			null, 
-			['PureCloud OAuth'], 
-			['application/json'],
-			['application/json']
-		);
-	}
-
-	/**
-	 * Get interaction stats alert list
-	 * Apps should migrate to use POST /api/v2/alerting/alerts/query.
-	 * @param {Object} opts Optional parameters
-	 * @param {Array.<String>} opts.expand Which fields, if any, to expand
-	 * @deprecated
-	 */
-	getAlertingInteractionstatsAlerts(opts) { 
-		opts = opts || {};
-		
-
-		return this.apiClient.callApi(
-			'/api/v2/alerting/interactionstats/alerts', 
-			'GET', 
-			{  },
-			{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
-			{  },
-			{  },
-			null, 
-			['PureCloud OAuth'], 
-			['application/json'],
-			['application/json']
-		);
-	}
-
-	/**
-	 * Gets user unread count of interaction stats alerts
-	 * Apps should migrate to use POST /api/v2/alerting/alerts/query with the queryType set to Count and viewStatus to Unread in the request body.
-	 * @deprecated
-	 */
-	getAlertingInteractionstatsAlertsUnread() { 
-
-		return this.apiClient.callApi(
-			'/api/v2/alerting/interactionstats/alerts/unread', 
-			'GET', 
-			{  },
-			{  },
-			{  },
-			{  },
-			null, 
-			['PureCloud OAuth'], 
-			['application/json'],
-			['application/json']
-		);
-	}
-
-	/**
-	 * Get an interaction stats rule
-	 * Apps should migrate to use GET /api/v2/alerting/rules/{ruleId}.
-	 * @param {String} ruleId Rule ID
-	 * @param {Object} opts Optional parameters
-	 * @param {Array.<String>} opts.expand Which fields, if any, to expand
-	 * @deprecated
-	 */
-	getAlertingInteractionstatsRule(ruleId, opts) { 
-		opts = opts || {};
-		
-		// verify the required parameter 'ruleId' is set
-		if (ruleId === undefined || ruleId === null) {
-			throw 'Missing the required parameter "ruleId" when calling getAlertingInteractionstatsRule';
-		}
-
-		return this.apiClient.callApi(
-			'/api/v2/alerting/interactionstats/rules/{ruleId}', 
-			'GET', 
-			{ 'ruleId': ruleId },
-			{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
-			{  },
-			{  },
-			null, 
-			['PureCloud OAuth'], 
-			['application/json'],
-			['application/json']
-		);
-	}
-
-	/**
-	 * Get an interaction stats rule list
-	 * Apps should migrate to use POST /api/v2/alerting/rules/query.
-	 * @param {Object} opts Optional parameters
-	 * @param {Array.<String>} opts.expand Which fields, if any, to expand
-	 * @deprecated
-	 */
-	getAlertingInteractionstatsRules(opts) { 
-		opts = opts || {};
-		
-
-		return this.apiClient.callApi(
-			'/api/v2/alerting/interactionstats/rules', 
-			'GET', 
-			{  },
-			{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
-			{  },
-			{  },
-			null, 
-			['PureCloud OAuth'], 
-			['application/json'],
-			['application/json']
-		);
-	}
-
 	/**
 	 * Get a rule.
 	 * 
@@ -471,36 +267,6 @@ class AlertingApi {
 		);
 	}
 
-	/**
-	 * Create an interaction stats rule
-	 * Apps should migrate to use POST /api/v2/alerting/rules.
-	 * @param {Object} body AlertingRule
-	 * @param {Object} opts Optional parameters
-	 * @param {Array.<String>} opts.expand Which fields, if any, to expand
-	 * @deprecated
-	 */
-	postAlertingInteractionstatsRules(body, opts) { 
-		opts = opts || {};
-		
-		// verify the required parameter 'body' is set
-		if (body === undefined || body === null) {
-			throw 'Missing the required parameter "body" when calling postAlertingInteractionstatsRules';
-		}
-
-		return this.apiClient.callApi(
-			'/api/v2/alerting/interactionstats/rules', 
-			'POST', 
-			{  },
-			{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
-			{  },
-			{  },
-			body, 
-			['PureCloud OAuth'], 
-			['application/json'],
-			['application/json']
-		);
-	}
-
 	/**
 	 * Create a Rule.
 	 * 
@@ -604,76 +370,6 @@ class AlertingApi {
 		);
 	}
 
-	/**
-	 * Update an interaction stats alert read status
-	 * Apps should migrate to use PUT /api/v2/alerting/alerts/{alertId}.
-	 * @param {String} alertId Alert ID
-	 * @param {Object} body InteractionStatsAlert
-	 * @param {Object} opts Optional parameters
-	 * @param {Array.<String>} opts.expand Which fields, if any, to expand
-	 * @deprecated
-	 */
-	putAlertingInteractionstatsAlert(alertId, body, opts) { 
-		opts = opts || {};
-		
-		// verify the required parameter 'alertId' is set
-		if (alertId === undefined || alertId === null) {
-			throw 'Missing the required parameter "alertId" when calling putAlertingInteractionstatsAlert';
-		}
-		// verify the required parameter 'body' is set
-		if (body === undefined || body === null) {
-			throw 'Missing the required parameter "body" when calling putAlertingInteractionstatsAlert';
-		}
-
-		return this.apiClient.callApi(
-			'/api/v2/alerting/interactionstats/alerts/{alertId}', 
-			'PUT', 
-			{ 'alertId': alertId },
-			{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
-			{  },
-			{  },
-			body, 
-			['PureCloud OAuth'], 
-			['application/json'],
-			['application/json']
-		);
-	}
-
-	/**
-	 * Update an interaction stats rule
-	 * Apps should migrate to use PUT /api/v2/alerting/rules/{ruleId}.
-	 * @param {String} ruleId Rule ID
-	 * @param {Object} body AlertingRule
-	 * @param {Object} opts Optional parameters
-	 * @param {Array.<String>} opts.expand Which fields, if any, to expand
-	 * @deprecated
-	 */
-	putAlertingInteractionstatsRule(ruleId, body, opts) { 
-		opts = opts || {};
-		
-		// verify the required parameter 'ruleId' is set
-		if (ruleId === undefined || ruleId === null) {
-			throw 'Missing the required parameter "ruleId" when calling putAlertingInteractionstatsRule';
-		}
-		// verify the required parameter 'body' is set
-		if (body === undefined || body === null) {
-			throw 'Missing the required parameter "body" when calling putAlertingInteractionstatsRule';
-		}
-
-		return this.apiClient.callApi(
-			'/api/v2/alerting/interactionstats/rules/{ruleId}', 
-			'PUT', 
-			{ 'ruleId': ruleId },
-			{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
-			{  },
-			{  },
-			body, 
-			['PureCloud OAuth'], 
-			['application/json'],
-			['application/json']
-		);
-	}
-
 	/**
 	 * Update a rule
 	 * 

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 216.0.0
+	 * @version 218.0.0
 	 */
 
 	/**
@@ -882,7 +882,7 @@ class AnalyticsApi {
 	 * @param {Number} opts.pageSize  (default to 25)
 	 * @param {Array.<String>} opts.id A list of user IDs to fetch by bulk
 	 * @param {Object} opts.state Only list users of this state
-	 * @param {Boolean} opts.deletedOnly Only list deleted dashboards that are still recoverable
+	 * @param {Boolean} opts.deletedOnly Only list users with deleted dashboards
 	 */
 	getAnalyticsReportingDashboardsUsers(opts) { 
 		opts = opts || {};

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 216.0.0
+	 * @version 218.0.0
 	 */
 
 	/**
@@ -1035,6 +1035,32 @@ class ArchitectApi {
 		);
 	}
 
+	/**
+	 * Get an IVR IdentityResolutionConfig.
+	 * 
+	 * @param {String} ivrId IVR id
+	 * getArchitectIvrIdentityresolution is a preview method and is subject to both breaking and non-breaking changes at any time without notice
+	 */
+	getArchitectIvrIdentityresolution(ivrId) { 
+		// verify the required parameter 'ivrId' is set
+		if (ivrId === undefined || ivrId === null) {
+			throw 'Missing the required parameter "ivrId" when calling getArchitectIvrIdentityresolution';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/architect/ivrs/{ivrId}/identityresolution', 
+			'GET', 
+			{ 'ivrId': ivrId },
+			{  },
+			{  },
+			{  },
+			null, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
 	/**
 	 * Get IVR configs.
 	 * 
@@ -2309,6 +2335,35 @@ class ArchitectApi {
 		);
 	}
 
+	/**
+	 * Fetch Architect Export Job Status
+	 * 
+	 * @param {String} jobId Job ID
+	 * @param {Object} opts Optional parameters
+	 * @param {Array.<String>} opts.expand Which fields, if any, to expand.
+	 */
+	getFlowsExportJob(jobId, opts) { 
+		opts = opts || {};
+		
+		// verify the required parameter 'jobId' is set
+		if (jobId === undefined || jobId === null) {
+			throw 'Missing the required parameter "jobId" when calling getFlowsExportJob';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/flows/export/jobs/{jobId}', 
+			'GET', 
+			{ 'jobId': jobId },
+			{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
+			{  },
+			{  },
+			null, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
 	/**
 	 * Start a process (job) to prepare a download of a singular flow execution data instance by Id
 	 * Returns a JobResult object that contains an ID that can be used to check status and/or download links when the process (job) is complete.
@@ -3555,6 +3610,31 @@ class ArchitectApi {
 		);
 	}
 
+	/**
+	 * Register Architect Export Job
+	 * 
+	 * @param {Object} body 
+	 */
+	postFlowsExportJobs(body) { 
+		// verify the required parameter 'body' is set
+		if (body === undefined || body === null) {
+			throw 'Missing the required parameter "body" when calling postFlowsExportJobs';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/flows/export/jobs', 
+			'POST', 
+			{  },
+			{  },
+			{  },
+			{  },
+			body, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
 	/**
 	 * Start a process (job) that will prepare a list of execution data IDs for download.
 	 * Returns a JobResult object that contains an ID that can be used to check status and/or download links when the process (job) is complete.
@@ -3742,6 +3822,37 @@ class ArchitectApi {
 		);
 	}
 
+	/**
+	 * Update an IVR IdentityResolutionConfig.
+	 * 
+	 * @param {String} ivrId IVR id
+	 * @param {Object} body 
+	 * putArchitectIvrIdentityresolution is a preview method and is subject to both breaking and non-breaking changes at any time without notice
+	 */
+	putArchitectIvrIdentityresolution(ivrId, body) { 
+		// verify the required parameter 'ivrId' is set
+		if (ivrId === undefined || ivrId === null) {
+			throw 'Missing the required parameter "ivrId" when calling putArchitectIvrIdentityresolution';
+		}
+		// verify the required parameter 'body' is set
+		if (body === undefined || body === null) {
+			throw 'Missing the required parameter "body" when calling putArchitectIvrIdentityresolution';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/architect/ivrs/{ivrId}/identityresolution', 
+			'PUT', 
+			{ 'ivrId': ivrId },
+			{  },
+			{  },
+			{  },
+			body, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
 	/**
 	 * Update specified user prompt
 	 * 

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 216.0.0
+	 * @version 218.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 216.0.0
+	 * @version 218.0.0
 	 */
 
 	/**
@@ -25,7 +25,7 @@ class AuthorizationApi {
 	 * 
 	 * @param {String} divisionId Division ID
 	 * @param {Object} opts Optional parameters
-	 * @param {Boolean} opts.force Force delete this division as well as the grants and objects associated with it (default to false)
+	 * @param {Boolean} opts.force DEPRECATED -  Force delete this division. Warning: This option may cause any remaining objects in this division to be inaccessible. (default to false)
 	 */
 	deleteAuthorizationDivision(divisionId, opts) { 
 		opts = opts || {};
@@ -1000,16 +1000,17 @@ class AuthorizationApi {
 	 * Recreate a previously deleted division.
 	 * 
 	 * @param {String} divisionId Division ID
-	 * @param {Object} opts Optional parameters
-	 * @param {Object} opts.body Recreated division data
+	 * @param {Object} body Recreated division data
 	 */
-	postAuthorizationDivisionRestore(divisionId, opts) { 
-		opts = opts || {};
-		
+	postAuthorizationDivisionRestore(divisionId, body) { 
 		// verify the required parameter 'divisionId' is set
 		if (divisionId === undefined || divisionId === null) {
 			throw 'Missing the required parameter "divisionId" when calling postAuthorizationDivisionRestore';
 		}
+		// verify the required parameter 'body' is set
+		if (body === undefined || body === null) {
+			throw 'Missing the required parameter "body" when calling postAuthorizationDivisionRestore';
+		}
 
 		return this.apiClient.callApi(
 			'/api/v2/authorization/divisions/{divisionId}/restore', 
@@ -1018,7 +1019,7 @@ class AuthorizationApi {
 			{  },
 			{  },
 			{  },
-			opts['body'], 
+			body, 
 			['PureCloud OAuth'], 
 			['application/json'],
 			['application/json']

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 216.0.0
+	 * @version 218.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 216.0.0
+	 * @version 218.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 216.0.0
+	 * @version 218.0.0
 	 */
 
 	/**
@@ -145,7 +145,6 @@ class ChatApi {
 	 * 
 	 * @param {String} userId userId
 	 * @param {String} pinnedMessageId pinnedMessageId
-	 * deleteChatsUserMessagesPin is a preview method and is subject to both breaking and non-breaking changes at any time without notice
 	 */
 	deleteChatsUserMessagesPin(userId, pinnedMessageId) { 
 		// verify the required parameter 'userId' is set
@@ -392,7 +391,6 @@ class ChatApi {
 	 * Get information for a 1on1
 	 * 
 	 * @param {String} userId userId
-	 * getChatsUser is a preview method and is subject to both breaking and non-breaking changes at any time without notice
 	 */
 	getChatsUser(userId) { 
 		// verify the required parameter 'userId' is set
@@ -479,7 +477,6 @@ class ChatApi {
 	 * Get a user's chat settings
 	 * 
 	 * @param {String} userId User ID
-	 * getChatsUserSettings is a preview method and is subject to both breaking and non-breaking changes at any time without notice
 	 */
 	getChatsUserSettings(userId) { 
 		// verify the required parameter 'userId' is set
@@ -504,7 +501,6 @@ class ChatApi {
 	/**
 	 * Get a user's chat settings
 	 * 
-	 * getChatsUsersMeSettings is a preview method and is subject to both breaking and non-breaking changes at any time without notice
 	 */
 	getChatsUsersMeSettings() { 
 
@@ -652,7 +648,6 @@ class ChatApi {
 	 * 
 	 * @param {String} userId User ID
 	 * @param {Object} body 
-	 * patchChatsUserSettings is a preview method and is subject to both breaking and non-breaking changes at any time without notice
 	 */
 	patchChatsUserSettings(userId, body) { 
 		// verify the required parameter 'userId' is set
@@ -682,7 +677,6 @@ class ChatApi {
 	 * Update a user's chat settings
 	 * 
 	 * @param {Object} body 
-	 * patchChatsUsersMeSettings is a preview method and is subject to both breaking and non-breaking changes at any time without notice
 	 */
 	patchChatsUsersMeSettings(body) { 
 		// verify the required parameter 'body' is set
@@ -854,7 +848,6 @@ class ChatApi {
 	 * 
 	 * @param {String} userId userId
 	 * @param {Object} body Pinned Message Ids
-	 * postChatsUserMessagesPins is a preview method and is subject to both breaking and non-breaking changes at any time without notice
 	 */
 	postChatsUserMessagesPins(userId, body) { 
 		// verify the required parameter 'userId' is set