apacuana-sdk-core 1.26.4 → 1.26.6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (38) hide show
  1. package/.env +3 -2
  2. package/README.md +34 -1
  3. package/coverage/clover.xml +295 -267
  4. package/coverage/coverage-final.json +5 -5
  5. package/coverage/lcov-report/index.html +33 -33
  6. package/coverage/lcov-report/src/api/certs.js.html +1 -1
  7. package/coverage/lcov-report/src/api/faceLiveness.js.html +1 -1
  8. package/coverage/lcov-report/src/api/index.html +18 -18
  9. package/coverage/lcov-report/src/api/revocations.js.html +1 -1
  10. package/coverage/lcov-report/src/api/signatures.js.html +275 -20
  11. package/coverage/lcov-report/src/api/users.js.html +1 -1
  12. package/coverage/lcov-report/src/config/index.html +1 -1
  13. package/coverage/lcov-report/src/config/index.js.html +1 -1
  14. package/coverage/lcov-report/src/errors/index.html +1 -1
  15. package/coverage/lcov-report/src/errors/index.js.html +8 -8
  16. package/coverage/lcov-report/src/index.html +15 -15
  17. package/coverage/lcov-report/src/index.js.html +23 -8
  18. package/coverage/lcov-report/src/success/index.html +1 -1
  19. package/coverage/lcov-report/src/success/index.js.html +5 -5
  20. package/coverage/lcov-report/src/utils/constant.js.html +1 -1
  21. package/coverage/lcov-report/src/utils/helpers.js.html +40 -7
  22. package/coverage/lcov-report/src/utils/httpClient.js.html +1 -1
  23. package/coverage/lcov-report/src/utils/index.html +12 -12
  24. package/coverage/lcov.info +564 -501
  25. package/dist/api/signatures.d.ts +2 -0
  26. package/dist/index.d.ts +1 -0
  27. package/dist/index.js +234 -115
  28. package/dist/index.js.map +1 -1
  29. package/dist/index.mjs +234 -115
  30. package/dist/index.mjs.map +1 -1
  31. package/dist/types/signatures.d.ts +17 -0
  32. package/package.json +1 -1
  33. package/src/api/signatures.js +85 -0
  34. package/src/index.js +5 -0
  35. package/src/types/signatures.js +8 -0
  36. package/src/utils/helpers.js +11 -0
  37. package/tests/api/signatures.test.js +148 -0
  38. package/tests/integration/deleteSignature.test.js +96 -0
package/.env CHANGED
@@ -4,5 +4,6 @@ APACUANA_API_KEY=07NTZW6cCgSCKjhzSe1UJ2uJ6fTXHaAFKcfDtJqV5Vnhg0h2BitNr6iYCeM7ZZ7
4
4
  APACUANA_VERIFICATION_ID=53d1daa5-cc7a-4a70-ae46-1a3e8a405f7a
5
5
  APACUANA_INTEGRATION_TYPE=ONBOARDING
6
6
  APACUANA_CUSTOMER_ID=0f313054-f923-4905-98bb-0158c2f59a91
7
- APACUANA_DOCUMENT_ID=cc3ff044-966b-412d-af48-7ccc628b8cb8
8
- APACUANA_DOCUMENT_REFERENCE=reunion-bdt-2
7
+ APACUANA_DOCUMENT_ID="cec8223c-8082-4fc5-9f5d-d92fe54273b5"
8
+ APACUANA_DOCUMENT_REFERENCE=reunion-bdt-2
9
+ APACUANA_SIGNATURE_ID="ac858b65-da56-4a4f-9401-fcccfca67b79"
package/README.md CHANGED
@@ -67,6 +67,7 @@ El SDK puede inicializarse sin el parámetro `customerId`, lo que permite el acc
67
67
  - `createApacuanaUser(params)`
68
68
  - `createDocument(params)`
69
69
  - `lockDocument(documentId)`
70
+ - `deleteSignature(params)`
70
71
 
71
72
  **Funciones privadas (requieren `customerId`):**
72
73
 
@@ -414,9 +415,10 @@ try {
414
415
 
415
416
  Obtiene una lista paginada de documentos asociados al usuario autenticado, permitiendo aplicar filtros avanzados.
416
417
 
417
- - `data`: Objeto con parámetros de paginación (`page`, `size`) y filtros opcionales (`status`). Puedes combinar estos filtros para obtener solo los documentos que cumplan con los criterios deseados.
418
+ - `data`: Objeto con parámetros de paginación (`page`, `size`) y filtros opcionales (`status`, `blocked`). Puedes combinar estos filtros para obtener solo los documentos que cumplan con los criterios deseados.
418
419
 
419
420
  - `filtros` : (`status`) 0 pendiente, 1 = completado/firmado, -1 rechazado
421
+ - `filtros` : (`blocked`) 0 = no bloqueados, 1 = bloqueados. Si se omite, retorna todos independientemente de su estado de bloqueo.
420
422
 
421
423
  **Ejemplo:**
422
424
 
@@ -426,6 +428,7 @@ try {
426
428
  page: 1,
427
429
  size: 10,
428
430
  status: 0, // Estado del documento
431
+ blocked: 0, // Solo documentos no bloqueados
429
432
  };
430
433
  const response = await apacuana.getDocs(params);
431
434
  console.log("Documentos filtrados:", response.data);
@@ -595,6 +598,36 @@ try {
595
598
 
596
599
  `````
597
600
 
601
+ ### `deleteSignature(params)`
602
+
603
+ Elimina la firma de un firmante de un documento existente. Este método **no requiere `customerId`** para ser invocado y se autentica únicamente con las API keys (`apiKey` y `secretKey`).
604
+
605
+ #### Parámetros:
606
+
607
+ - **`params`**: Objeto con los identificadores requeridos.
608
+ - `documentId` (String, **obligatorio**): ID (UUID) del documento del que se eliminará la firma.
609
+ - `signatureId` (String, **obligatorio**): ID (UUID) de la firma que se desea eliminar.
610
+
611
+ #### Comportamiento:
612
+
613
+ - Solo disponible para `integrationType: ONBOARDING`. Si se usa con `ONPREMISE`, lanzará un error `NOT_IMPLEMENTED`.
614
+ - Realiza una solicitud DELETE al endpoint `services/api/documents/signature` enviando `{ documentid, signatureid }` en el cuerpo, sin enviar el header `Authorization`.
615
+ - Si la firma ya fue eliminada, la API responde con `"Firma no encontrada"`. Si la operación es exitosa, responde con `"Firma eliminada"`.
616
+
617
+ #### Ejemplo:
618
+
619
+ ```javascript
620
+ try {
621
+ const response = await apacuana.deleteSignature({
622
+ documentId: "cc3ff044-966b-412d-af48-7ccc628b8cb8",
623
+ signatureId: "cc3ff044-966b-412d-af48-7ccc628b8cb8",
624
+ });
625
+ console.log("Firma eliminada:", response.data);
626
+ } catch (error) {
627
+ console.error("Error al eliminar la firma:", error.message);
628
+ }
629
+ ```
630
+
598
631
  ### `deleteSignatureVariant()`
599
632
 
600
633
  Elimina la variante de firma almacenada para el usuario autenticado. Este método solo está disponible si el SDK fue inicializado con un customerId. No requiere parámetros de entrada. Si la operación es exitosa, el resultado vendrá en el objeto `data` del response. Si no existe una variante de firma registrada, la operación no tendrá efecto y el resultado indicará el estado actual.