Actualizar README.md

2026-06-15 17:41:30 +00:00
parent 7501b6567c
commit 0eda7448c1
1 changed files with 64 additions and 0 deletions
@@ -148,6 +148,69 @@ python main.py
 | Mensaje entrante en canal de chat | On demand | Usuario envia instruccion o consulta en lenguaje natural |

 ---
+## TASK 2 — Mapeo de endpoints BambooHR API
+
+**Estado:** Completada
+**Documento de entrega:** TASK 2 — Mapeo de endpoints BambooHR API
+
+Se revisó la documentación de BambooHR API y se mapearon los endpoints relevantes para construir el BambooHR Agent como producto final. El mapeo cubre los tres modos principales del agente: **acción, consulta y reporte**.
+
+### Categorías de endpoints identificadas
+
+| Categoría          | Uso dentro del agente                                                                   |
+| ------------------ | --------------------------------------------------------------------------------------- |
+| Metadata           | Validar conexión, campos, tablas y listas disponibles                                   |
+| Empleados          | Buscar, listar y consultar empleados                                                    |
+| Tablas históricas  | Consultar o modificar `jobInfo`, `compensation`, `employmentStatus`, bonos y comisiones |
+| Acciones           | Crear empleados, actualizar datos básicos y agregar filas históricas                    |
+| Archivos           | Listar, subir, descargar o eliminar documentos de empleados                             |
+| Reportes           | Ejecutar reportes guardados y reportes personalizados                                   |
+| Datasets           | Consultas avanzadas para reportería dinámica                                            |
+| Webhooks / cambios | Monitorear cambios en empleados y tablas                                                |
+| Time Off           | Consultar tipos y balances de vacaciones/licencias                                      |
+
+### Endpoints principales documentados
+
+```text
+GET  /api/v1/company_information
+GET  /api/v1/meta/fields
+GET  /api/v1/meta/tables
+GET  /api/v1/meta/lists
+
+GET  /api/v1/employees
+GET  /api/v1/employees/directory
+GET  /api/v1/employees/{id}
+GET  /api/v1/employees/{id}/tables/{table}
+
+POST /api/v1/employees
+POST /api/v1/employees/{id}
+POST /api/v1/employees/{id}/tables/{table}
+POST /api/v1/employees/{id}/tables/{table}/{rowId}
+
+GET  /api/v1/employees/{id}/files/view
+POST /api/v1/employees/{id}/files
+GET  /api/v1/employees/{id}/files/{fileId}
+DELETE /api/v1/employees/{id}/files/{fileId}
+
+GET  /api/v1/reports/{reportId}
+POST /api/v1/reports/custom
+
+GET  /api/v1_2/datasets
+GET  /api/v1_2/datasets/{datasetName}/fields
+POST /api/v1_2/datasets/{datasetName}/field-options
+POST /api/v1_2/datasets/{datasetName}/data
+
+GET  /api/v1/employees/changed
+GET  /api/v1/employees/changed/tables/{table}
+GET  /api/v1/webhooks
+GET  /api/v1/meta/time_off/types
+```
+
+### Validaciones pendientes para TASK 3
+
+La TASK 2 deja listo el mapa técnico. La TASK 3 debe validar estos endpoints con la API Key real de GLM, confirmar permisos reales del plan contratado y probar lectura/escritura sobre un empleado dummy autorizado por RRHH/IT.
+
+No se deben ejecutar acciones de escritura sobre empleados reales.

 ## Testing

@@ -233,6 +296,7 @@ python tests/integration_test.py

 ```
 [Junio 8, 2026] v0.1 — Inicio del ciclo. Repo creado.
+[Junio 15, 2026] TASK 2 — Endpoints BambooHR API mapeados y documentados para acciones, consultas y reportes del producto final.
 ```

 ---