call-control-sdk 6.2.0 → 6.2.1

package/dist/index.d.mts

@@ -155,6 +155,10 @@ declare function isSDKInitialized(): boolean;
  * @example
  * ```tsx
  * <CallControlPanel onDataChange={handleDataChange} />
+ *
+ * <CallControlPanel onDataChange={(data) => {
+ *   console.log('Call Data:', data);
+ * }} />
  * ```
  *
  * @since 1.0.0
@@ -174,15 +178,10 @@ declare const CallControlPanel: React.ComponentType<CallControlPanelProps>;
  * Contains all necessary information about active calls, including metadata, status, and references.
  *
  * @properties
- * - `mobileNumber?: string` - Mobile number of the caller or callee
  * - `callReferenceId?: string` - Unique reference identifier for the call
- * - `convoxId?: string` - Convox system identifier for the call
- * - `type?: string` - Type of call (inbound, outbound, internal, etc.)
  * - `status?: string` - Current status of the call (ONCALL, RINGING, WRAPUP, etc.)
  * - `agent_id?: string` - Agent identifier associated with the call
  * - `phone_number?: string` - Phone number involved in the call
- * - `event_time?: string` - Timestamp when the call event occurred
- * - `convox_id?: string` - Convox system call ID
  * - `process_id?: string` - Process identifier for the call
  * - `process_name?: string` - Name of the process handling the call
  *
@@ -190,15 +189,10 @@ declare const CallControlPanel: React.ComponentType<CallControlPanelProps>;
  * @author CTI SDK Team
  */
 interface CallData {
-	mobileNumber?: string;
 	callReferenceId?: string;
-	convoxId?: string;
-	type?: string;
 	status?: string;
 	agent_id?: string;
 	phone_number?: string;
-	event_time?: string;
-	convox_id?: string;
 	process_id?: string;
 	process_name?: string;
 }
@@ -258,7 +252,6 @@ interface CallControlPanelProps {
 // =============================================================================
 
 /**
- * @fileoverview 📞 TypeScript Declaration File for useEndCall Hook
  *
  * This file contains TypeScript type definitions for the useEndCall custom hook
  * and its related interfaces. It provides comprehensive type safety and IntelliSense
@@ -399,6 +392,78 @@ interface EndCallPayload {
 	refno?: string;
 }
 
+/**
+ * 📅 End Call Data Interface
+ *
+ * @interface EndCallData
+ * @description 📊 Defines the structure for call termination input data
+ *              Contains disposition and callback information for ending calls
+ *
+ * @properties
+ * - `disposition?: string` - 📝 Call outcome classification (default: "RES")
+ * - `followUp?: string` - 📅 Follow-up requirement (default: "N")
+ * - `callbackDate?: string` - 📅 Scheduled callback date (default: "")
+ * - `callbackHrs?: string` - 🕐 Scheduled callback hour (default: "")
+ * - `callbackMins?: string` - 🕐 Scheduled callback minute (default: "")
+ *
+ * @example
+ * ```typescript
+ * // Basic end call data
+ * const endCallData: EndCallData = {
+ *   disposition: "RES",
+ *   followUp: "N"
+ * };
+ *
+ * // With callback scheduling
+ * const endCallWithCallback: EndCallData = {
+ *   disposition: "RES",
+ *   followUp: "Y",
+ *   callbackDate: "2024-01-15",
+ *   callbackHrs: "14",
+ *   callbackMins: "30"
+ * };
+ * ```
+ *
+ * @since 1.0.0
+ * @author CTI SDK Team
+ */
+interface EndCallData {
+	/**
+	 * 📝 Call outcome classification
+	 * @description How the call ended (default: "RES" for Resolved)
+	 * @type {string | undefined}
+	 */
+	disposition?: string;
+
+	/**
+	 * 📅 Follow-up requirement
+	 * @description Whether follow-up is required (default: "N" for No)
+	 * @type {string | undefined}
+	 */
+	followUp?: string;
+
+	/**
+	 * 📅 Scheduled callback date
+	 * @description Date for callback scheduling (YYYY-MM-DD format)
+	 * @type {string | undefined}
+	 */
+	callbackDate?: string;
+
+	/**
+	 * 🕐 Scheduled callback hour
+	 * @description Hour for callback scheduling (0-23)
+	 * @type {string | undefined}
+	 */
+	callbackHrs?: string;
+
+	/**
+	 * 🕐 Scheduled callback minute
+	 * @description Minute for callback scheduling (0-59)
+	 * @type {string | undefined}
+	 */
+	callbackMins?: string;
+}
+
 /**
  * 📞 Call Termination Function Type
  *
@@ -587,7 +652,7 @@ declare const useEndCall: () => UseEndCallReturn;
  * @since 1.0.0
  * @author CTI SDK Team
  */
-type DispositionType = "RES" | "NI" | "CB" | "NA" | "BUSY" | "NO_ANSWER";
+type DispositionType = string;
 
 /**
  * 📅 Follow-up Types
@@ -599,7 +664,7 @@ type DispositionType = "RES" | "NI" | "CB" | "NA" | "BUSY" | "NO_ANSWER";
  * @since 1.0.0
  * @author CTI SDK Team
  */
-type FollowUpType = "Y" | "N";
+type FollowUpType = string;
 
 /**
  * ⚙️ Process Data Interface
@@ -631,82 +696,10 @@ interface ProcessData {
 	process_name: string;
 }
 
-/**
- * 📅 End Call Data Interface
- *
- * @interface EndCallData
- * @description 📊 Defines the structure for call termination input data
- *              Contains disposition and callback information for ending calls
- *
- * @properties
- * - `disposition?: string` - 📝 Call outcome classification (default: "RES")
- * - `followUp?: string` - 📅 Follow-up requirement (default: "N")
- * - `callbackDate?: string` - 📅 Scheduled callback date (default: "")
- * - `callbackHrs?: string` - 🕐 Scheduled callback hour (default: "")
- * - `callbackMins?: string` - 🕐 Scheduled callback minute (default: "")
- *
- * @example
- * ```typescript
- * // Basic end call data
- * const endCallData: EndCallData = {
- *   disposition: "RES",
- *   followUp: "N"
- * };
- *
- * // With callback scheduling
- * const endCallWithCallback: EndCallData = {
- *   disposition: "RES",
- *   followUp: "Y",
- *   callbackDate: "2024-01-15",
- *   callbackHrs: "14",
- *   callbackMins: "30"
- * };
- * ```
- *
- * @since 1.0.0
- * @author CTI SDK Team
- */
-interface EndCallData {
-	/**
-	 * 📝 Call outcome classification
-	 * @description How the call ended (default: "RES" for Resolved)
-	 * @type {string | undefined}
-	 */
-	disposition?: string;
-
-	/**
-	 * 📅 Follow-up requirement
-	 * @description Whether follow-up is required (default: "N" for No)
-	 * @type {string | undefined}
-	 */
-	followUp?: string;
-
-	/**
-	 * 📅 Scheduled callback date
-	 * @description Date for callback scheduling (YYYY-MM-DD format)
-	 * @type {string | undefined}
-	 */
-	callbackDate?: string;
-
-	/**
-	 * 🕐 Scheduled callback hour
-	 * @description Hour for callback scheduling (0-23)
-	 * @type {string | undefined}
-	 */
-	callbackHrs?: string;
-
-	/**
-	 * 🕐 Scheduled callback minute
-	 * @description Minute for callback scheduling (0-59)
-	 * @type {string | undefined}
-	 */
-	callbackMins?: string;
-}
-
 /**
  * 📞 Call Data Interface
  *
- * @interface EndCallData
+ * @interface EndCallPayLoadData
  * @description 📊 Type definition for call data structure
  *              Contains information about the current call
  *
@@ -717,7 +710,7 @@ interface EndCallData {
  * @since 1.0.0
  * @author CTI SDK Team
  */
-interface EndCallData {
+interface EndCallPayLoadData {
 	/**
 	 * 🔗 Call reference identifier
 	 * @description Unique identifier for the call
@@ -754,7 +747,6 @@ interface EndCallData {
  */
 
 /**
- * @fileoverview 🚪 TypeScript Declaration File for useLogout Hook
  *
  * This file contains TypeScript type definitions for the useLogout custom hook
  * and its related interfaces. It provides comprehensive type safety and IntelliSense
@@ -826,10 +818,7 @@ interface LogoutPayload {
  *
  * @example
  * ```typescript
- * const logout: LogoutFunction = async () => {
- *   // Logout logic
- *   return await apiCall();
- * };
+ * const logout();
  * ```
  *
  * @since 1.0.0
@@ -1158,10 +1147,9 @@ interface StartCallPayload {
  *
  * @example
  * ```typescript
- * const handleStartCall: CallInitiationFunction = async (data) => {
- *   // Call initiation logic
- *   return await apiCall(data);
- * };
+ * const handleStartCall({
+ * mobileNumber: "1234567890"
+ * })
  * ```
  *
  * @since 1.0.0
@@ -1333,7 +1321,7 @@ declare const useClickToCall: () => UseClickToCallReturn;
  * @since 1.0.0
  * @author CTI SDK Team
  */
-type AgentStatus = "IDLE" | "ONCALL" | "BUSY" | "AWAY" | "BREAK";
+type AgentStatus = string;
 
 /**
  * 📞 Conference Line Interface
@@ -1647,4 +1635,4 @@ interface ErrorResponse {
 	details?: any;
 }
 
-export { type APIResponse, type AgentStatus, CallControlPanel, type CallControlPanelProps, type CallData, type CallInitiationFunction, type CallTerminationFunction, type CleanupOperation, type ConferenceLine, type DispositionType, type EndCallData, type EndCallPayload, type ErrorResponse, type FollowUpType, type HookStateTypes, type InitSDKParams, type LogoutFunction, type LogoutHookStateTypes, type LogoutPayload, type ProcessData, type SDKConfig, type SDKState, type StartCallPayload, type StartCalltData, type StartCalltHookStateTypes, type StorageType, type UseClickToCallReturn, type UseEndCallReturn, type UseLogoutReturn, getSDKVersion, initSDK, isSDKInitialized, useClickToCall, useEndCall, useLogout };
+export { type APIResponse, type AgentStatus, CallControlPanel, type CallControlPanelProps, type CallData, type CallInitiationFunction, type CallTerminationFunction, type CleanupOperation, type ConferenceLine, type DispositionType, type EndCallData, type EndCallPayLoadData, type EndCallPayload, type ErrorResponse, type FollowUpType, type HookStateTypes, type InitSDKParams, type LogoutFunction, type LogoutHookStateTypes, type LogoutPayload, type ProcessData, type SDKConfig, type SDKState, type StartCallPayload, type StartCalltData, type StartCalltHookStateTypes, type StorageType, type UseClickToCallReturn, type UseEndCallReturn, type UseLogoutReturn, getSDKVersion, initSDK, isSDKInitialized, useClickToCall, useEndCall, useLogout };

package/dist/index.d.ts

@@ -155,6 +155,10 @@ declare function isSDKInitialized(): boolean;
  * @example
  * ```tsx
  * <CallControlPanel onDataChange={handleDataChange} />
+ *
+ * <CallControlPanel onDataChange={(data) => {
+ *   console.log('Call Data:', data);
+ * }} />
  * ```
  *
  * @since 1.0.0
@@ -174,15 +178,10 @@ declare const CallControlPanel: React.ComponentType<CallControlPanelProps>;
  * Contains all necessary information about active calls, including metadata, status, and references.
  *
  * @properties
- * - `mobileNumber?: string` - Mobile number of the caller or callee
  * - `callReferenceId?: string` - Unique reference identifier for the call
- * - `convoxId?: string` - Convox system identifier for the call
- * - `type?: string` - Type of call (inbound, outbound, internal, etc.)
  * - `status?: string` - Current status of the call (ONCALL, RINGING, WRAPUP, etc.)
  * - `agent_id?: string` - Agent identifier associated with the call
  * - `phone_number?: string` - Phone number involved in the call
- * - `event_time?: string` - Timestamp when the call event occurred
- * - `convox_id?: string` - Convox system call ID
  * - `process_id?: string` - Process identifier for the call
  * - `process_name?: string` - Name of the process handling the call
  *
@@ -190,15 +189,10 @@ declare const CallControlPanel: React.ComponentType<CallControlPanelProps>;
  * @author CTI SDK Team
  */
 interface CallData {
-	mobileNumber?: string;
 	callReferenceId?: string;
-	convoxId?: string;
-	type?: string;
 	status?: string;
 	agent_id?: string;
 	phone_number?: string;
-	event_time?: string;
-	convox_id?: string;
 	process_id?: string;
 	process_name?: string;
 }
@@ -258,7 +252,6 @@ interface CallControlPanelProps {
 // =============================================================================
 
 /**
- * @fileoverview 📞 TypeScript Declaration File for useEndCall Hook
  *
  * This file contains TypeScript type definitions for the useEndCall custom hook
  * and its related interfaces. It provides comprehensive type safety and IntelliSense
@@ -399,6 +392,78 @@ interface EndCallPayload {
 	refno?: string;
 }
 
+/**
+ * 📅 End Call Data Interface
+ *
+ * @interface EndCallData
+ * @description 📊 Defines the structure for call termination input data
+ *              Contains disposition and callback information for ending calls
+ *
+ * @properties
+ * - `disposition?: string` - 📝 Call outcome classification (default: "RES")
+ * - `followUp?: string` - 📅 Follow-up requirement (default: "N")
+ * - `callbackDate?: string` - 📅 Scheduled callback date (default: "")
+ * - `callbackHrs?: string` - 🕐 Scheduled callback hour (default: "")
+ * - `callbackMins?: string` - 🕐 Scheduled callback minute (default: "")
+ *
+ * @example
+ * ```typescript
+ * // Basic end call data
+ * const endCallData: EndCallData = {
+ *   disposition: "RES",
+ *   followUp: "N"
+ * };
+ *
+ * // With callback scheduling
+ * const endCallWithCallback: EndCallData = {
+ *   disposition: "RES",
+ *   followUp: "Y",
+ *   callbackDate: "2024-01-15",
+ *   callbackHrs: "14",
+ *   callbackMins: "30"
+ * };
+ * ```
+ *
+ * @since 1.0.0
+ * @author CTI SDK Team
+ */
+interface EndCallData {
+	/**
+	 * 📝 Call outcome classification
+	 * @description How the call ended (default: "RES" for Resolved)
+	 * @type {string | undefined}
+	 */
+	disposition?: string;
+
+	/**
+	 * 📅 Follow-up requirement
+	 * @description Whether follow-up is required (default: "N" for No)
+	 * @type {string | undefined}
+	 */
+	followUp?: string;
+
+	/**
+	 * 📅 Scheduled callback date
+	 * @description Date for callback scheduling (YYYY-MM-DD format)
+	 * @type {string | undefined}
+	 */
+	callbackDate?: string;
+
+	/**
+	 * 🕐 Scheduled callback hour
+	 * @description Hour for callback scheduling (0-23)
+	 * @type {string | undefined}
+	 */
+	callbackHrs?: string;
+
+	/**
+	 * 🕐 Scheduled callback minute
+	 * @description Minute for callback scheduling (0-59)
+	 * @type {string | undefined}
+	 */
+	callbackMins?: string;
+}
+
 /**
  * 📞 Call Termination Function Type
  *
@@ -587,7 +652,7 @@ declare const useEndCall: () => UseEndCallReturn;
  * @since 1.0.0
  * @author CTI SDK Team
  */
-type DispositionType = "RES" | "NI" | "CB" | "NA" | "BUSY" | "NO_ANSWER";
+type DispositionType = string;
 
 /**
  * 📅 Follow-up Types
@@ -599,7 +664,7 @@ type DispositionType = "RES" | "NI" | "CB" | "NA" | "BUSY" | "NO_ANSWER";
  * @since 1.0.0
  * @author CTI SDK Team
  */
-type FollowUpType = "Y" | "N";
+type FollowUpType = string;
 
 /**
  * ⚙️ Process Data Interface
@@ -631,82 +696,10 @@ interface ProcessData {
 	process_name: string;
 }
 
-/**
- * 📅 End Call Data Interface
- *
- * @interface EndCallData
- * @description 📊 Defines the structure for call termination input data
- *              Contains disposition and callback information for ending calls
- *
- * @properties
- * - `disposition?: string` - 📝 Call outcome classification (default: "RES")
- * - `followUp?: string` - 📅 Follow-up requirement (default: "N")
- * - `callbackDate?: string` - 📅 Scheduled callback date (default: "")
- * - `callbackHrs?: string` - 🕐 Scheduled callback hour (default: "")
- * - `callbackMins?: string` - 🕐 Scheduled callback minute (default: "")
- *
- * @example
- * ```typescript
- * // Basic end call data
- * const endCallData: EndCallData = {
- *   disposition: "RES",
- *   followUp: "N"
- * };
- *
- * // With callback scheduling
- * const endCallWithCallback: EndCallData = {
- *   disposition: "RES",
- *   followUp: "Y",
- *   callbackDate: "2024-01-15",
- *   callbackHrs: "14",
- *   callbackMins: "30"
- * };
- * ```
- *
- * @since 1.0.0
- * @author CTI SDK Team
- */
-interface EndCallData {
-	/**
-	 * 📝 Call outcome classification
-	 * @description How the call ended (default: "RES" for Resolved)
-	 * @type {string | undefined}
-	 */
-	disposition?: string;
-
-	/**
-	 * 📅 Follow-up requirement
-	 * @description Whether follow-up is required (default: "N" for No)
-	 * @type {string | undefined}
-	 */
-	followUp?: string;
-
-	/**
-	 * 📅 Scheduled callback date
-	 * @description Date for callback scheduling (YYYY-MM-DD format)
-	 * @type {string | undefined}
-	 */
-	callbackDate?: string;
-
-	/**
-	 * 🕐 Scheduled callback hour
-	 * @description Hour for callback scheduling (0-23)
-	 * @type {string | undefined}
-	 */
-	callbackHrs?: string;
-
-	/**
-	 * 🕐 Scheduled callback minute
-	 * @description Minute for callback scheduling (0-59)
-	 * @type {string | undefined}
-	 */
-	callbackMins?: string;
-}
-
 /**
  * 📞 Call Data Interface
  *
- * @interface EndCallData
+ * @interface EndCallPayLoadData
  * @description 📊 Type definition for call data structure
  *              Contains information about the current call
  *
@@ -717,7 +710,7 @@ interface EndCallData {
  * @since 1.0.0
  * @author CTI SDK Team
  */
-interface EndCallData {
+interface EndCallPayLoadData {
 	/**
 	 * 🔗 Call reference identifier
 	 * @description Unique identifier for the call
@@ -754,7 +747,6 @@ interface EndCallData {
  */
 
 /**
- * @fileoverview 🚪 TypeScript Declaration File for useLogout Hook
  *
  * This file contains TypeScript type definitions for the useLogout custom hook
  * and its related interfaces. It provides comprehensive type safety and IntelliSense
@@ -826,10 +818,7 @@ interface LogoutPayload {
  *
  * @example
  * ```typescript
- * const logout: LogoutFunction = async () => {
- *   // Logout logic
- *   return await apiCall();
- * };
+ * const logout();
  * ```
  *
  * @since 1.0.0
@@ -1158,10 +1147,9 @@ interface StartCallPayload {
  *
  * @example
  * ```typescript
- * const handleStartCall: CallInitiationFunction = async (data) => {
- *   // Call initiation logic
- *   return await apiCall(data);
- * };
+ * const handleStartCall({
+ * mobileNumber: "1234567890"
+ * })
  * ```
  *
  * @since 1.0.0
@@ -1333,7 +1321,7 @@ declare const useClickToCall: () => UseClickToCallReturn;
  * @since 1.0.0
  * @author CTI SDK Team
  */
-type AgentStatus = "IDLE" | "ONCALL" | "BUSY" | "AWAY" | "BREAK";
+type AgentStatus = string;
 
 /**
  * 📞 Conference Line Interface
@@ -1647,4 +1635,4 @@ interface ErrorResponse {
 	details?: any;
 }
 
-export { type APIResponse, type AgentStatus, CallControlPanel, type CallControlPanelProps, type CallData, type CallInitiationFunction, type CallTerminationFunction, type CleanupOperation, type ConferenceLine, type DispositionType, type EndCallData, type EndCallPayload, type ErrorResponse, type FollowUpType, type HookStateTypes, type InitSDKParams, type LogoutFunction, type LogoutHookStateTypes, type LogoutPayload, type ProcessData, type SDKConfig, type SDKState, type StartCallPayload, type StartCalltData, type StartCalltHookStateTypes, type StorageType, type UseClickToCallReturn, type UseEndCallReturn, type UseLogoutReturn, getSDKVersion, initSDK, isSDKInitialized, useClickToCall, useEndCall, useLogout };
+export { type APIResponse, type AgentStatus, CallControlPanel, type CallControlPanelProps, type CallData, type CallInitiationFunction, type CallTerminationFunction, type CleanupOperation, type ConferenceLine, type DispositionType, type EndCallData, type EndCallPayLoadData, type EndCallPayload, type ErrorResponse, type FollowUpType, type HookStateTypes, type InitSDKParams, type LogoutFunction, type LogoutHookStateTypes, type LogoutPayload, type ProcessData, type SDKConfig, type SDKState, type StartCallPayload, type StartCalltData, type StartCalltHookStateTypes, type StorageType, type UseClickToCallReturn, type UseEndCallReturn, type UseLogoutReturn, getSDKVersion, initSDK, isSDKInitialized, useClickToCall, useEndCall, useLogout };