purecloud-platform-client-v2 215.0.0 → 217.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 215.0.0
+	 * @version 217.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 || {};
@@ -49,6 +49,37 @@ class AuthorizationApi {
 		);
 	}
 
+	/**
+	 * Delete an access control policy
+	 * 
+	 * @param {String} targetName The domain:entity:action target to which the policy is applied
+	 * @param {String} subjectId The ID of the subject to which the policy is applied
+	 * deleteAuthorizationPoliciesTargetSubjectSubjectId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
+	 */
+	deleteAuthorizationPoliciesTargetSubjectSubjectId(targetName, subjectId) { 
+		// verify the required parameter 'targetName' is set
+		if (targetName === undefined || targetName === null) {
+			throw 'Missing the required parameter "targetName" when calling deleteAuthorizationPoliciesTargetSubjectSubjectId';
+		}
+		// verify the required parameter 'subjectId' is set
+		if (subjectId === undefined || subjectId === null) {
+			throw 'Missing the required parameter "subjectId" when calling deleteAuthorizationPoliciesTargetSubjectSubjectId';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/authorization/policies/targets/{targetName}/subject/{subjectId}', 
+			'DELETE', 
+			{ 'targetName': targetName,'subjectId': subjectId },
+			{  },
+			{  },
+			{  },
+			null, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
 	/**
 	 * Delete an organization role.
 	 * 
@@ -363,6 +394,198 @@ class AuthorizationApi {
 		);
 	}
 
+	/**
+	 * Get a page of access policies for an 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 {Number} opts.pageSize Number of entities to return. Maximum of 200. (default to 25)
+	 * getAuthorizationPolicies is a preview method and is subject to both breaking and non-breaking changes at any time without notice
+	 */
+	getAuthorizationPolicies(opts) { 
+		opts = opts || {};
+		
+
+		return this.apiClient.callApi(
+			'/api/v2/authorization/policies', 
+			'GET', 
+			{  },
+			{ 'after': opts['after'],'pageSize': opts['pageSize'] },
+			{  },
+			{  },
+			null, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
+	/**
+	 * Get a page of access policies for a given subject
+	 * 
+	 * @param {String} subjectId The ID of the subject to which policies are applied
+	 * @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 {Number} opts.pageSize Number of entities to return. Maximum of 200. (default to 25)
+	 * getAuthorizationPoliciesSubjectSubjectId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
+	 */
+	getAuthorizationPoliciesSubjectSubjectId(subjectId, opts) { 
+		opts = opts || {};
+		
+		// verify the required parameter 'subjectId' is set
+		if (subjectId === undefined || subjectId === null) {
+			throw 'Missing the required parameter "subjectId" when calling getAuthorizationPoliciesSubjectSubjectId';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/authorization/policies/subject/{subjectId}', 
+			'GET', 
+			{ 'subjectId': subjectId },
+			{ 'after': opts['after'],'pageSize': opts['pageSize'] },
+			{  },
+			{  },
+			null, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
+	/**
+	 * Get a page of access policies for a given policy target
+	 * 
+	 * @param {String} targetName The domain:entity:action resource target to which policies are applied
+	 * @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 {Number} opts.pageSize Number of entities to return. Maximum of 200. (default to 25)
+	 * getAuthorizationPoliciesTarget is a preview method and is subject to both breaking and non-breaking changes at any time without notice
+	 */
+	getAuthorizationPoliciesTarget(targetName, opts) { 
+		opts = opts || {};
+		
+		// verify the required parameter 'targetName' is set
+		if (targetName === undefined || targetName === null) {
+			throw 'Missing the required parameter "targetName" when calling getAuthorizationPoliciesTarget';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/authorization/policies/targets/{targetName}', 
+			'GET', 
+			{ 'targetName': targetName },
+			{ 'after': opts['after'],'pageSize': opts['pageSize'] },
+			{  },
+			{  },
+			null, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
+	/**
+	 * Get an access control policy for a specified resource target and subject
+	 * 
+	 * @param {String} targetName The domain:entity:action resource target to which the policy is applied
+	 * @param {String} subjectId The ID of the subject to which the policy is applied
+	 * getAuthorizationPoliciesTargetSubjectSubjectId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
+	 */
+	getAuthorizationPoliciesTargetSubjectSubjectId(targetName, subjectId) { 
+		// verify the required parameter 'targetName' is set
+		if (targetName === undefined || targetName === null) {
+			throw 'Missing the required parameter "targetName" when calling getAuthorizationPoliciesTargetSubjectSubjectId';
+		}
+		// verify the required parameter 'subjectId' is set
+		if (subjectId === undefined || subjectId === null) {
+			throw 'Missing the required parameter "subjectId" when calling getAuthorizationPoliciesTargetSubjectSubjectId';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/authorization/policies/targets/{targetName}/subject/{subjectId}', 
+			'GET', 
+			{ 'targetName': targetName,'subjectId': subjectId },
+			{  },
+			{  },
+			{  },
+			null, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
+	/**
+	 * Get a map of policy targets to valid attributes for those targets
+	 * 
+	 * getAuthorizationPoliciesTargets is a preview method and is subject to both breaking and non-breaking changes at any time without notice
+	 */
+	getAuthorizationPoliciesTargets() { 
+
+		return this.apiClient.callApi(
+			'/api/v2/authorization/policies/targets', 
+			'GET', 
+			{  },
+			{  },
+			{  },
+			{  },
+			null, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
+	/**
+	 * Get an access control policy with the specified policy ID
+	 * 
+	 * @param {String} policyId The ID of the policy to retrieve
+	 * getAuthorizationPolicy is a preview method and is subject to both breaking and non-breaking changes at any time without notice
+	 */
+	getAuthorizationPolicy(policyId) { 
+		// verify the required parameter 'policyId' is set
+		if (policyId === undefined || policyId === null) {
+			throw 'Missing the required parameter "policyId" when calling getAuthorizationPolicy';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/authorization/policies/{policyId}', 
+			'GET', 
+			{ 'policyId': policyId },
+			{  },
+			{  },
+			{  },
+			null, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
+	/**
+	 * Get the list of attributes used to evaluate an access control policy with the specified policy ID
+	 * 
+	 * @param {String} policyId The ID of the policy to retrieve attributes
+	 * getAuthorizationPolicyAttributes is a preview method and is subject to both breaking and non-breaking changes at any time without notice
+	 */
+	getAuthorizationPolicyAttributes(policyId) { 
+		// verify the required parameter 'policyId' is set
+		if (policyId === undefined || policyId === null) {
+			throw 'Missing the required parameter "policyId" when calling getAuthorizationPolicyAttributes';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/authorization/policies/{policyId}/attributes', 
+			'GET', 
+			{ 'policyId': policyId },
+			{  },
+			{  },
+			{  },
+			null, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
 	/**
 	 * Get the list of enabled products
 	 * Gets the list of enabled products. Some example product names are: collaborateFree, collaboratePro, communicate, and engage.
@@ -777,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', 
@@ -795,7 +1019,7 @@ class AuthorizationApi {
 			{  },
 			{  },
 			{  },
-			opts['body'], 
+			body, 
 			['PureCloud OAuth'], 
 			['application/json'],
 			['application/json']
@@ -827,6 +1051,99 @@ class AuthorizationApi {
 		);
 	}
 
+	/**
+	 * Add an access control policy for a specified resource target and subject
+	 * 
+	 * @param {String} targetName The domain:entity:action target to which the policy will be applied
+	 * @param {Object} body Access control policy
+	 * postAuthorizationPoliciesTarget is a preview method and is subject to both breaking and non-breaking changes at any time without notice
+	 */
+	postAuthorizationPoliciesTarget(targetName, body) { 
+		// verify the required parameter 'targetName' is set
+		if (targetName === undefined || targetName === null) {
+			throw 'Missing the required parameter "targetName" when calling postAuthorizationPoliciesTarget';
+		}
+		// verify the required parameter 'body' is set
+		if (body === undefined || body === null) {
+			throw 'Missing the required parameter "body" when calling postAuthorizationPoliciesTarget';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/authorization/policies/targets/{targetName}', 
+			'POST', 
+			{ 'targetName': targetName },
+			{  },
+			{  },
+			{  },
+			body, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
+	/**
+	 * Validate the conditions and attributes of an access control policy for a specified resource target
+	 * 
+	 * @param {String} targetName The domain:entity:action target to which the policy will be applied
+	 * @param {Object} body Access control policy
+	 * postAuthorizationPoliciesTargetValidate is a preview method and is subject to both breaking and non-breaking changes at any time without notice
+	 */
+	postAuthorizationPoliciesTargetValidate(targetName, body) { 
+		// verify the required parameter 'targetName' is set
+		if (targetName === undefined || targetName === null) {
+			throw 'Missing the required parameter "targetName" when calling postAuthorizationPoliciesTargetValidate';
+		}
+		// verify the required parameter 'body' is set
+		if (body === undefined || body === null) {
+			throw 'Missing the required parameter "body" when calling postAuthorizationPoliciesTargetValidate';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/authorization/policies/targets/{targetName}/validate', 
+			'POST', 
+			{ 'targetName': targetName },
+			{  },
+			{  },
+			{  },
+			body, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
+	/**
+	 * Simulate a request and evaluate the specified policy ID against the provided values
+	 * 
+	 * @param {String} policyId The ID of the policy to test the simulated data against
+	 * @param {Object} body A map of attribute names to type and simulated data value
+	 * postAuthorizationPolicySimulate is a preview method and is subject to both breaking and non-breaking changes at any time without notice
+	 */
+	postAuthorizationPolicySimulate(policyId, body) { 
+		// verify the required parameter 'policyId' is set
+		if (policyId === undefined || policyId === null) {
+			throw 'Missing the required parameter "policyId" when calling postAuthorizationPolicySimulate';
+		}
+		// verify the required parameter 'body' is set
+		if (body === undefined || body === null) {
+			throw 'Missing the required parameter "body" when calling postAuthorizationPolicySimulate';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/authorization/policies/{policyId}/simulate', 
+			'POST', 
+			{ 'policyId': policyId },
+			{  },
+			{  },
+			{  },
+			body, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
 	/**
 	 * Bulk-grant subjects and divisions with an organization role.
 	 * 
@@ -1112,6 +1429,68 @@ class AuthorizationApi {
 		);
 	}
 
+	/**
+	 * Add an access control policy for a specified resource target and subject, overwriting any existing policy
+	 * 
+	 * @param {String} targetName The domain:entity:action target to which the policy will be applied
+	 * @param {Object} body Access control policy
+	 * putAuthorizationPoliciesTarget is a preview method and is subject to both breaking and non-breaking changes at any time without notice
+	 */
+	putAuthorizationPoliciesTarget(targetName, body) { 
+		// verify the required parameter 'targetName' is set
+		if (targetName === undefined || targetName === null) {
+			throw 'Missing the required parameter "targetName" when calling putAuthorizationPoliciesTarget';
+		}
+		// verify the required parameter 'body' is set
+		if (body === undefined || body === null) {
+			throw 'Missing the required parameter "body" when calling putAuthorizationPoliciesTarget';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/authorization/policies/targets/{targetName}', 
+			'PUT', 
+			{ 'targetName': targetName },
+			{  },
+			{  },
+			{  },
+			body, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
+	/**
+	 * Update an access control policy with a given ID
+	 * 
+	 * @param {String} policyId The ID of the policy to update
+	 * @param {Object} body Access control policy
+	 * putAuthorizationPolicy is a preview method and is subject to both breaking and non-breaking changes at any time without notice
+	 */
+	putAuthorizationPolicy(policyId, body) { 
+		// verify the required parameter 'policyId' is set
+		if (policyId === undefined || policyId === null) {
+			throw 'Missing the required parameter "policyId" when calling putAuthorizationPolicy';
+		}
+		// verify the required parameter 'body' is set
+		if (body === undefined || body === null) {
+			throw 'Missing the required parameter "body" when calling putAuthorizationPolicy';
+		}
+
+		return this.apiClient.callApi(
+			'/api/v2/authorization/policies/{policyId}', 
+			'PUT', 
+			{ 'policyId': policyId },
+			{  },
+			{  },
+			{  },
+			body, 
+			['PureCloud OAuth'], 
+			['application/json'],
+			['application/json']
+		);
+	}
+
 	/**
 	 * Update an organization role.
 	 * Update

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 215.0.0
+	 * @version 217.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 215.0.0
+	 * @version 217.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 215.0.0
+	 * @version 217.0.0
 	 */
 
 	/**
@@ -479,7 +479,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 +503,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 +650,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 +679,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

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 215.0.0
+	 * @version 217.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 215.0.0
+	 * @version 217.0.0
 	 */
 
 	/**