apacuana-sdk-core 1.24.0 → 1.26.0

package/.env.example

@@ -0,0 +1,10 @@
+# Apacuana SDK - Integration Test Environment Variables
+# Copy this file to .env and fill in your values
+
+APACUANA_API_URL=https://api.dev.apacuana.3dlinkweb.com
+APACUANA_SECRET_KEY=your-secret-key-here
+APACUANA_API_KEY=your-api-key-here
+APACUANA_VERIFICATION_ID=your-verification-id-here
+APACUANA_INTEGRATION_TYPE=ONBOARDING
+APACUANA_CUSTOMER_ID=your-customer-id-here
+APACUANA_DOCUMENT_ID=cc3ff044-966b-412d-af48-7ccc628b8cb8

package/README.md

@@ -72,14 +72,14 @@ El SDK puede inicializarse sin el parámetro `customerId`, lo que permite el acc
 - `generateCert(params)`
 - `getCertStatus(params)`
 - `addSigner(params)`
+- `addMember(params)`
 - `getDocs(params)`
 - `getDigest(params)`
 - `signDocument(params)`
 - `uploadSignatureVariant(params)`
 - `getSignatureVariant()`
 - `deleteSignatureVariant()`
-- `createFaceLivenessSession()`
-- `validateFaceLiveness({ sessionId })`
+-
 - `requestRevocation(params)`
 - `getRevocationReasons()`
 
@@ -376,6 +376,38 @@ try {
 }
 ```
 
+### `addMember(params)`
+
+Añade un signatario a un documento existente. Este método permite agregar un nuevo signatario a un documento que ya fue creado, asignándole un tipo y número de documento.
+
+#### Parámetros:
+
+- **`params`**: Objeto con los datos del signatario.
+  - `documentId` (String, **obligatorio**): ID del documento al que se agregará el signatario.
+  - `typedoc` (String, **obligatorio**): Tipo de documento de identidad del signatario. Valores permitidos: "V", "P", "E".
+  - `doc` (String, **obligatorio**): Número de documento de identidad del signatario.
+
+#### Comportamiento:
+
+- Solo disponible para `integrationType: ONBOARDING`. Si se usa con `ONPREMISE`, lanzará un error `NOT_IMPLEMENTED`.
+- Realiza una solicitud PUT al endpoint `services/api/documents/addmember`.
+
+#### Ejemplo:
+
+```javascript
+try {
+  const member = {
+    documentId: "cc3ff044-966b-412d-af48-7ccc628b8cb8",
+    typedoc: "V",
+    doc: "28152139",
+  };
+  const response = await apacuana.addMember(member);
+  console.log("Signatario añadido:", response.data);
+} catch (error) {
+  console.error("Error al añadir signatario:", error.message);
+}
+```
+
 ### `getDocs(data)`
 
 Obtiene una lista paginada de documentos asociados al usuario autenticado, permitiendo aplicar filtros avanzados.
@@ -501,7 +533,7 @@ const imageFile = new File(
     /* datos */
   ],
   "firma.png",
-  { type: "image/png" }
+  { type: "image/png" },
 );
 const result = await apacuana.uploadSignatureVariant({ file: imageFile });
 // result.data contendrá la información de la variante subida
@@ -518,48 +550,61 @@ const result = await apacuana.getSignatureVariant();
 // result.data contendrá la imagen en Base64
 ```
 
-### `deleteSignatureVariant()`
+### `sendFaceLiveness(params)`
 
-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.
+Envía la captura de biometría facial (Prueba de Vida) para ser procesada y vinculada a un trámite específico.
 
-**Ejemplo:**
+Ejemplo de estructura de parámetros:
 
-```javascript
-try {
-  const response = await apacuana.deleteSignatureVariant();
-  console.log(response.data);
-} catch (error) {
-  console.error("Error al eliminar la firma:", error.message);
+```js
+{
+  faceLiveness: base64,
+  documentprefid: 'id-pref-faceliveness'
 }
 ```
 
-### `createFaceLivenessSession()`
+#### Comportamiento:
 
-Crea una nueva sesión de prueba de vida (face liveness) para el usuario autenticado. Este método solo está disponible si el SDK fue inicializado con customerId. No requiere parámetros de entrada. El resultado vendrá en el objeto `data` del response, incluyendo el identificador único de la sesión creada.
+- Solo disponible para `integrationType: ONBOARDING`. Si se usa con `ONPREMISE`, lanzará un error `NOT_IMPLEMENTED`.
+- El SDK convierte automáticamente el Base64 en un archivo binario y lo sube al endpoint de validación de Apacuana. Devuelve una instancia de `ApacuanaSuccess` con un mensaje de confirmación.
 
-Ejemplo de uso:
+#### Respuesta:
 
-```js
-const result = await apacuana.createFaceLivenessSession();
-// result.data contendrá el ID de la sesión de prueba de vida
-```
+`````js
+{
+  success: true,
+  data: {
+    ...
+  }
+}
+
+#### Ejemplo:
+
+````javascript
+try {
+  const result = await apacuana.sendFaceLiveness({
+    faceLiveness: "data:image/png;base64,iVBOR...",
+    documentprefid: "DOC-12345",
+  });
+  console.log("Estado de envío:", result.data.status);
+} catch (error) {
+  console.error("Error:", error.message);
+}
 
-### `validateFaceLiveness({ sessionId })`
+`````
 
-Valida el resultado de una sesión de prueba de vida.
+### `deleteSignatureVariant()`
 
-- `sessionId` (String, **obligatorio**): El ID de la sesión de prueba de vida que se va a validar.
+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.
 
 **Ejemplo:**
 
 ```javascript
 try {
-  const response = await apacuana.validateFaceLiveness({
-    sessionId: "your-session-id",
-  });
-  console.log("Resultado de la validación:", response.data);
+  const response = await apacuana.deleteSignatureVariant();
+  console.log(response.data);
 } catch (error) {
-  console.error("Error al validar la sesión de prueba de vida:", error.message);
+  console.error("Error al eliminar la firma:", error.message);
 }
 ```