purecloud-platform-client-v2 214.0.0 → 215.0.0

package/index.d.ts

@@ -111,6 +111,9 @@ declare abstract class AbstractHttpClient {
 	setTimeout(timeout: number): void;
 	setHttpsAgent(httpsAgent: any): void;
 	abstract request(httpRequestOptions: HttpRequestOptions): Promise<any>;
+    setPreHook(hookFunction: (config: any) =>  Promise<any>): void;
+    setPostHook(hookFunction: (response: any) => Promise<any>): void;
+    abstract enableHooks(): void;
 }
 
 declare class DefaultHttpClient {
@@ -121,8 +124,11 @@ declare class DefaultHttpClient {
     constructor(timeout?: number, httpsAgent?: any);
 	setTimeout(timeout: number): void;
 	setHttpsAgent(httpsAgent: any): void;
+	setPreHook(hookFunction: (config: any) =>   Promise<any>): void;
+    setPostHook(hookFunction: (response: any) => Promise<any>): void;
 	request(httpRequestOptions: HttpRequestOptions): Promise<any>;
     toAxiosConfig(httpRequestOptions: HttpRequestOptions): any;
+    enableHooks(): void;
 }
 
 declare class Logger {

package/package.json

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

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

@@ -5,7 +5,7 @@ class DataPrivacyApi {
 	/**
 	 * DataPrivacy service.
 	 * @module purecloud-platform-client-v2/api/DataPrivacyApi
-	 * @version 214.0.0
+	 * @version 215.0.0
 	 */
 
 	/**

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 214.0.0
+	 * @version 215.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 214.0.0
+	 * @version 215.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 214.0.0
+	 * @version 215.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 214.0.0
+	 * @version 215.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 214.0.0
+	 * @version 215.0.0
 	 */
 
 	/**

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 214.0.0
+	 * @version 215.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 214.0.0
+	 * @version 215.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 214.0.0
+	 * @version 215.0.0
 	 */
 
 	/**

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

@@ -5,7 +5,7 @@ class GeneralDataProtectionRegulationApi {
 	/**
 	 * GeneralDataProtectionRegulation service.
 	 * @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
-	 * @version 214.0.0
+	 * @version 215.0.0
 	 */
 
 	/**

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

@@ -5,7 +5,7 @@ class GeolocationApi {
 	/**
 	 * Geolocation service.
 	 * @module purecloud-platform-client-v2/api/GeolocationApi
-	 * @version 214.0.0
+	 * @version 215.0.0
 	 */
 
 	/**

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

@@ -5,7 +5,7 @@ class GreetingsApi {
 	/**
 	 * Greetings service.
 	 * @module purecloud-platform-client-v2/api/GreetingsApi
-	 * @version 214.0.0
+	 * @version 215.0.0
 	 */
 
 	/**

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

@@ -5,7 +5,7 @@ class GroupsApi {
 	/**
 	 * Groups service.
 	 * @module purecloud-platform-client-v2/api/GroupsApi
-	 * @version 214.0.0
+	 * @version 215.0.0
 	 */
 
 	/**

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

@@ -5,7 +5,7 @@ class IdentityProviderApi {
 	/**
 	 * IdentityProvider service.
 	 * @module purecloud-platform-client-v2/api/IdentityProviderApi
-	 * @version 214.0.0
+	 * @version 215.0.0
 	 */
 
 	/**

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

@@ -5,7 +5,7 @@ class InfrastructureAsCodeApi {
 	/**
 	 * InfrastructureAsCode service.
 	 * @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
-	 * @version 214.0.0
+	 * @version 215.0.0
 	 */
 
 	/**

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

@@ -5,7 +5,7 @@ class IntegrationsApi {
 	/**
 	 * Integrations service.
 	 * @module purecloud-platform-client-v2/api/IntegrationsApi
-	 * @version 214.0.0
+	 * @version 215.0.0
 	 */
 
 	/**

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

@@ -5,7 +5,7 @@ class JourneyApi {
 	/**
 	 * Journey service.
 	 * @module purecloud-platform-client-v2/api/JourneyApi
-	 * @version 214.0.0
+	 * @version 215.0.0
 	 */
 
 	/**

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

@@ -5,7 +5,7 @@ class KnowledgeApi {
 	/**
 	 * Knowledge service.
 	 * @module purecloud-platform-client-v2/api/KnowledgeApi
-	 * @version 214.0.0
+	 * @version 215.0.0
 	 */
 
 	/**

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

@@ -5,7 +5,7 @@ class LanguageUnderstandingApi {
 	/**
 	 * LanguageUnderstanding service.
 	 * @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
-	 * @version 214.0.0
+	 * @version 215.0.0
 	 */
 
 	/**

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

@@ -5,7 +5,7 @@ class LanguagesApi {
 	/**
 	 * Languages service.
 	 * @module purecloud-platform-client-v2/api/LanguagesApi
-	 * @version 214.0.0
+	 * @version 215.0.0
 	 */
 
 	/**

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

@@ -5,7 +5,7 @@ class LearningApi {
 	/**
 	 * Learning service.
 	 * @module purecloud-platform-client-v2/api/LearningApi
-	 * @version 214.0.0
+	 * @version 215.0.0
 	 */
 
 	/**

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

@@ -5,7 +5,7 @@ class LicenseApi {
 	/**
 	 * License service.
 	 * @module purecloud-platform-client-v2/api/LicenseApi
-	 * @version 214.0.0
+	 * @version 215.0.0
 	 */
 
 	/**

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

@@ -5,7 +5,7 @@ class LocationsApi {
 	/**
 	 * Locations service.
 	 * @module purecloud-platform-client-v2/api/LocationsApi
-	 * @version 214.0.0
+	 * @version 215.0.0
 	 */
 
 	/**

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

@@ -5,7 +5,7 @@ class LogCaptureApi {
 	/**
 	 * LogCapture service.
 	 * @module purecloud-platform-client-v2/api/LogCaptureApi
-	 * @version 214.0.0
+	 * @version 215.0.0
 	 */
 
 	/**

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

@@ -5,7 +5,7 @@ class MessagingApi {
 	/**
 	 * Messaging service.
 	 * @module purecloud-platform-client-v2/api/MessagingApi
-	 * @version 214.0.0
+	 * @version 215.0.0
 	 */
 
 	/**

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

@@ -5,7 +5,7 @@ class MobileDevicesApi {
 	/**
 	 * MobileDevices service.
 	 * @module purecloud-platform-client-v2/api/MobileDevicesApi
-	 * @version 214.0.0
+	 * @version 215.0.0
 	 */
 
 	/**

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

@@ -5,7 +5,7 @@ class NotificationsApi {
 	/**
 	 * Notifications service.
 	 * @module purecloud-platform-client-v2/api/NotificationsApi
-	 * @version 214.0.0
+	 * @version 215.0.0
 	 */
 
 	/**

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

@@ -5,7 +5,7 @@ class OAuthApi {
 	/**
 	 * OAuth service.
 	 * @module purecloud-platform-client-v2/api/OAuthApi
-	 * @version 214.0.0
+	 * @version 215.0.0
 	 */
 
 	/**

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

@@ -5,7 +5,7 @@ class ObjectsApi {
 	/**
 	 * Objects service.
 	 * @module purecloud-platform-client-v2/api/ObjectsApi
-	 * @version 214.0.0
+	 * @version 215.0.0
 	 */
 
 	/**

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

@@ -5,7 +5,7 @@ class OperationalEventsApi {
 	/**
 	 * OperationalEvents service.
 	 * @module purecloud-platform-client-v2/api/OperationalEventsApi
-	 * @version 214.0.0
+	 * @version 215.0.0
 	 */
 
 	/**

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

@@ -5,7 +5,7 @@ class OrganizationApi {
 	/**
 	 * Organization service.
 	 * @module purecloud-platform-client-v2/api/OrganizationApi
-	 * @version 214.0.0
+	 * @version 215.0.0
 	 */
 
 	/**

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

@@ -5,7 +5,7 @@ class OrganizationAuthorizationApi {
 	/**
 	 * OrganizationAuthorization service.
 	 * @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
-	 * @version 214.0.0
+	 * @version 215.0.0
 	 */
 
 	/**

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

@@ -5,7 +5,7 @@ class OutboundApi {
 	/**
 	 * Outbound service.
 	 * @module purecloud-platform-client-v2/api/OutboundApi
-	 * @version 214.0.0
+	 * @version 215.0.0
 	 */
 
 	/**