apacuana-sdk-core 0.8.0 → 0.10.0

package/README.md

@@ -140,6 +140,71 @@ Obtiene el estado actual del certificado del usuario.
   - `status` (String): El estado del certificado (ver sección de Estados de Certificado).
   - `success` (Boolean): Indicador de éxito de la operación.
 
+### getCertTypes()
+
+Obtiene los tipos de certificados disponibles.
+
+**Parámetros:** Ninguno
+
+**Retorna:**
+
+- `Promise<GetCertTypesResponse>`: Un objeto que contiene:
+  - `types` (Array<Object>): Una lista de los tipos de certificados disponibles.
+  - `success` (Boolean): Indicador de éxito de la operación.
+
+**Comportamiento por `integrationType`:**
+
+- **`ONBOARDING`**: Realiza una petición `GET` para obtener los tipos de certificados.
+- **`ONPREMISE`**: No soportado. Lanza una `ApacuanaAPIError` con el código `NOT_IMPLEMENTED`.
+
+**Ejemplo:**
+
+```javascript
+try {
+  const { types, success } = await apacuana.getCertTypes();
+  if (success) {
+    console.log("Tipos de certificados:", types);
+  }
+} catch (error) {
+  console.error("Error al obtener los tipos de certificados:", error.message);
+}
+```
+
+### getRequerimentsByTypeUser(params)
+
+Obtiene los requisitos para un tipo de usuario determinado.
+
+**Parámetros:**
+
+- `params` (Object): Objeto de parámetros.
+  - `type` (Number): El tipo de usuario para el que se obtienen los requisitos.
+
+**Retorna:**
+
+- `Promise<GetRequirementsResponse>`: Un objeto que contiene:
+  - `requirements` (Array<Object>): Una lista de los requisitos.
+  - `success` (Boolean): Indicador de éxito de la operación.
+
+**Comportamiento por `integrationType`:**
+
+- **`ONBOARDING`**: Realiza una petición `GET` para obtener los requisitos.
+- **`ONPREMISE`**: No soportado. Lanza una `ApacuanaAPIError` con el código `NOT_IMPLEMENTED`.
+
+**Ejemplo:**
+
+```javascript
+try {
+  const { requirements, success } = await apacuana.getRequerimentsByTypeUser({
+    type: 1,
+  });
+  if (success) {
+    console.log("Requisitos:", requirements);
+  }
+} catch (error) {
+  console.error("Error al obtener los requisitos:", error.message);
+}
+```
+
 ### addSigner(signerData)
 
 Agrega un firmante a un documento. El comportamiento y la estructura del objeto `signerData` varían según el `integrationType`.
@@ -261,6 +326,91 @@ Obtiene la lista de códigos de motivo de revocación disponibles que se pueden
 - **`ONBOARDING`**: Obtiene la lista de motivos desde la API.
 - **`ONPREMISE`**: No soportado. Lanza una `ApacuanaAPIError` con el código `NOT_IMPLEMENTED`.
 
+### uploadSignatureVariant(data)
+
+Sube una variante de firma (imagen) para un firmante específico. Esta imagen se utilizará como la representación gráfica de la firma en los documentos.
+
+**Parámetros:**
+
+- `data` (`UploadSignatureVariantData`): Objeto que contiene los datos para la subida.
+  - `file` (`File`): El archivo de imagen de la firma. Debe ser una instancia de `File` y de tipo `image/png`.
+  - `signerId` (`string`): El identificador del firmante al que se asociará la imagen.
+
+**Retorna:**
+
+- `Promise<UploadSignatureVariantResponse>`: Un objeto que contiene:
+  - `message` (String): Un mensaje de confirmación.
+  - `success` (Boolean): Indicador de éxito de la operación.
+
+**Comportamiento por `integrationType`:**
+
+- **`ONBOARDING`**: Sube el archivo a la API.
+- **`ONPREMISE`**: No soportado. Lanza una `ApacuanaAPIError` con el código `NOT_IMPLEMENTED`.
+
+### getSignatureVariant()
+
+Obtiene la variante de firma (imagen) de un firmante.
+
+**Parámetros:** Ninguno
+
+**Retorna:**
+
+- `Promise<GetSignatureVariantResponse>`: Un objeto que contiene:
+  - `file` (String): La imagen de la firma en formato base64.
+  - `success` (Boolean): Indicador de éxito de la operación.
+
+**Comportamiento por `integrationType`:**
+
+- **`ONBOARDING`**: Realiza una petición `GET` para obtener la imagen.
+- **`ONPREMISE`**: No soportado. Lanza una `ApacuanaAPIError` con el código `NOT_IMPLEMENTED`.
+
+**Ejemplo:**
+
+```javascript
+try {
+  const { file, success } = await apacuana.getSignatureVariant();
+  if (success) {
+    console.log("Imagen de la firma obtenida.");
+    // Puedes usar 'file' para mostrar la imagen, por ejemplo:
+    // const img = document.createElement('img');
+    // img.src = `data:image/png;base64,${file}`;
+    // document.body.appendChild(img);
+  }
+} catch (error) {
+  console.error("Error al obtener la variante de firma:", error.message);
+}
+```
+
+### deleteSignatureVariant()
+
+Elimina la variante de firma (imagen) de un firmante.
+
+**Parámetros:** Ninguno
+
+**Retorna:**
+
+- `Promise<DeleteSignatureVariantResponse>`: Un objeto que contiene:
+  - `message` (String): Un mensaje de confirmación.
+  - `success` (Boolean): Indicador de éxito de la operación.
+
+**Comportamiento por `integrationType`:**
+
+- **`ONBOARDING`**: Realiza una petición `DELETE` para eliminar la imagen.
+- **`ONPREMISE`**: No soportado. Lanza una `ApacuanaAPIError` con el código `NOT_IMPLEMENTED`.
+
+**Ejemplo:**
+
+```javascript
+try {
+  const { message, success } = await apacuana.deleteSignatureVariant();
+  if (success) {
+    console.log(message); // "Signature variant deleted successfully."
+  }
+} catch (error) {
+  console.error("Error al eliminar la variante de firma:", error.message);
+}
+```
+
 ### getDocs(data)
 
 Obtiene una lista de documentos paginada.