golscontrol-frontend-v1/src/pages/ComercialClassifications/interfaces/comercial-classifications.interfaces.js

63 lines
2.4 KiB
JavaScript

/**
* Interfaces para Comercial Classifications
*
* @author Sistema
* @version 1.0.0
*/
/**
* @typedef {Object} ComercialClassification
* @property {number} id - ID de la clasificación
* @property {string} code - Código de la clasificación
* @property {string} name - Nombre de la clasificación
* @property {string|null} description - Descripción de la clasificación
* @property {boolean} is_active - Estado activo/inactivo
* @property {number|null} parent_id - ID del padre
* @property {string} created_at - Fecha de creación
* @property {string} updated_at - Fecha de actualización
* @property {string|null} deleted_at - Fecha de eliminación
* @property {ComercialClassification|null} parent - Clasificación padre
* @property {ComercialClassification[]} children - Clasificaciones hijas
*/
/**
* @typedef {Object} ComercialClassificationResponse
* @property {string} status - Estado de la respuesta
* @property {Object} data - Datos de la respuesta
* @property {string} data.message - Mensaje de la respuesta
* @property {ComercialClassification} data.comercial_classification - Clasificación comercial
*/
/**
* @typedef {Object} ComercialClassificationsListResponse
* @property {string} status - Estado de la respuesta
* @property {Object} data - Datos de la respuesta
* @property {ComercialClassification[]} data.comercial_classifications - Lista de clasificaciones
*/
/**
* @typedef {Object} CreateComercialClassificationData
* @property {string} code - Código de la clasificación
* @property {string} name - Nombre de la clasificación
* @property {string|null} description - Descripción de la clasificación
* @property {boolean} is_active - Estado activo/inactivo
* @property {number|null} parent_id - ID del padre
*/
/**
* @typedef {Object} UpdateComercialClassificationData
* @property {string} [code] - Código de la clasificación
* @property {string} [name] - Nombre de la clasificación
* @property {string|null} [description] - Descripción de la clasificación
* @property {boolean} [is_active] - Estado activo/inactivo
* @property {number|null} [parent_id] - ID del padre
*/
export {
ComercialClassification,
ComercialClassificationResponse,
ComercialClassificationsListResponse,
CreateComercialClassificationData,
UpdateComercialClassificationData
};