purecloud-platform-client-v2 214.0.0 → 216.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "purecloud-platform-client-v2",
-  "version": "214.0.0",
+  "version": "216.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/AbstractHttpClient.js

@@ -21,6 +21,35 @@ class AbstractHttpClient {
     request(httpRequestOptions) {
         throw new Error("method must be implemented");
     }
+
+    enableHooks() {
+        throw new Error("method must be implemented");
+    }
+
+    /**
+     * Set a PreHook function that modifies the request config before execution.
+     * @param {(config: object) => object | Promise<object> | void} hookFunction
+     */
+    setPreHook(hookFunction) {
+        if (typeof hookFunction !== "function" || hookFunction.length !== 1) {
+            throw new Error("preHook must be a function that accepts (config)");
+        }
+        this.preHook = hookFunction;
+        this.enableHooks()
+    }
+
+    /**
+     * Set a PostHook function that processes the response or error after execution.
+     * @param {(response: object | null, error: Error | null) => object | Promise<object> | void} hookFunction
+     */
+    setPostHook(hookFunction) {
+        if (typeof hookFunction !== "function" || hookFunction.length !== 1) {
+            throw new Error("postHook must be a function that accepts (response)");
+        }
+        this.postHook = hookFunction;
+        this.enableHooks()
+    }
+
 }
 
 export default AbstractHttpClient;

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 214.0.0
+ * @version 216.0.0
  */
 class ApiClient {
 	/**
@@ -261,6 +261,24 @@ class ApiClient {
 	    }
     }
 
+    /**
+         * @description Sets preHook functions for the httpClient
+         * @param {string} preHook - method definition for prehook
+         */
+        setPreHook(preHook) {
+    		const httpClient = this.getHttpClient();
+    		httpClient.setPreHook(preHook);
+        }
+
+    /**
+          * @description Sets postHook functions for the httpClient
+          * @param {string} postHook - method definition for posthook
+          */
+         setPostHook(postHook) {
+        	const httpClient = this.getHttpClient();
+        	httpClient.setPostHook(postHook);
+         }
+
     /**
      * @description Sets the certificate content if MTLS authentication is needed
      * @param {string} certContent - content for certs
@@ -292,6 +310,8 @@ class ApiClient {
 	    }
     }
 
+
+
 	/**
 	 * @description Sets the gateway used by the session
 	 * @param {object} gateway - Gateway Configuration interface

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

@@ -14,6 +14,47 @@ class DefaultHttpClient extends AbstractHttpClient{
         this._axiosInstance = axios.create({});
     }
 
+
+    enableHooks() {
+        if (this.preHook && typeof this.preHook === 'function') {
+
+            if (this.requestInterceptorId !== undefined) {
+                axios.interceptors.request.eject(this.requestInterceptorId);
+            }
+
+            this.requestInterceptorId = this._axiosInstance.interceptors.request.use(
+                async (config) => {
+                        config = await this.preHook(config); // Call the custom pre-hook
+                        return config
+                },
+                (error) => {
+                    // Handle errors before the request is sent
+                    console.error('Request Pre-Hook Error:', error.message);
+                    return Promise.reject(error);
+                }
+            );
+        }
+
+        if (this.postHook && typeof this.postHook === 'function') {
+            // Response interceptor (for post-hooks)
+            if (this.responseInterceptorId !== undefined) {
+                axios.interceptors.response.eject(this.responseInterceptorId);
+            }
+
+            this.responseInterceptorId = this._axiosInstance.interceptors.response.use(
+                async (response) => {
+                        response = await this.postHook(response); // Call the custom post-hook
+                        return response
+                },
+                async (error) => {
+                    console.error('Post-Hook: Response Error', error.message);
+                    // Optionally call post-hook in case of errors
+                    return Promise.reject(error);
+                }
+            );
+        }
+    }
+
     request(httpRequestOptions) {
         if(!(httpRequestOptions instanceof HttpRequestOptions)) {
             throw new Error(`httpRequestOptions must be instance of HttpRequestOptions `);

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 214.0.0
+	 * @version 216.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 214.0.0
+	 * @version 216.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 214.0.0
+	 * @version 216.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 214.0.0
+	 * @version 216.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 214.0.0
+	 * @version 216.0.0
 	 */
 
 	/**
@@ -2438,7 +2438,6 @@ class AnalyticsApi {
 	 * Query for summary aggregates
 	 * 
 	 * @param {Object} body query
-	 * postAnalyticsSummariesAggregatesQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
 	 */
 	postAnalyticsSummariesAggregatesQuery(body) { 
 		// verify the required parameter 'body' is set

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 214.0.0
+	 * @version 216.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 214.0.0
+	 * @version 216.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 214.0.0
+	 * @version 216.0.0
 	 */
 
 	/**
@@ -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.
@@ -827,6 +1050,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 +1428,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 214.0.0
+	 * @version 216.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 214.0.0
+	 * @version 216.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 214.0.0
+	 * @version 216.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 214.0.0
+	 * @version 216.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 214.0.0
+	 * @version 216.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 214.0.0
+	 * @version 216.0.0
 	 */
 
 	/**