apacuana-sdk-core 0.9.0 → 0.11.0

package/dist/success/index.d.ts

@@ -0,0 +1,7 @@
+export default class ApacuanaSuccess {
+    constructor(data: any, statusCode?: number);
+    success: boolean;
+    statusCode: number;
+    name: string;
+    data: any;
+}

package/dist/types/certs.d.ts

@@ -0,0 +1,97 @@
+export type GenerateCertResponse = {
+    /**
+     * - El certificado generado en formato string.
+     */
+    cert: string;
+    /**
+     * - El ID del certificado generado.
+     */
+    certifiedid: string;
+    /**
+     * - Indica si la operación fue exitosa.
+     */
+    success: boolean;
+};
+export type GetCertStatusResponse = {
+    /**
+     * - El estado actual del certificado del usuario.
+     */
+    status: string;
+    /**
+     * - Indica si la operación fue exitosa.
+     */
+    success: boolean;
+};
+export type EncryptedCSRObject = {
+    /**
+     * - The encrypted Certificate Signing Request.
+     */
+    csr: string;
+};
+export type CertType = {
+    /**
+     * - The ID of the certificate type.
+     */
+    id: string;
+    /**
+     * - The name of the certificate type.
+     */
+    name: string;
+};
+export type GetCertTypesResponse = {
+    /**
+     * - A list of available certificate types.
+     */
+    types: Array<CertType>;
+    /**
+     * - Indicates if the operation was successful.
+     */
+    success: boolean;
+};
+export type Requirement = {
+    /**
+     * - The ID of the requirement.
+     */
+    id: string;
+    /**
+     * - The description of the requirement.
+     */
+    description: string;
+};
+export type GetRequirementsResponse = {
+    /**
+     * - A list of requirements for the user type.
+     */
+    requirements: Array<Requirement>;
+    /**
+     * - Indicates if the operation was successful.
+     */
+    success: boolean;
+};
+export type CertificateRequestParams = {
+    /**
+     * - The user type to get requirements for.
+     */
+    type: number;
+    /**
+     * - An optional observation for the certificate request.
+     */
+    observation?: string | undefined;
+    /**
+     * - The documents required for the certificate.
+     */
+    documents: Array<{
+        id: string;
+        file: string;
+    }>;
+};
+export type RequestCertificateResponse = {
+    /**
+     * - A message confirming the request.
+     */
+    message: string;
+    /**
+     * - Indicates if the operation was successful.
+     */
+    success: boolean;
+};

package/dist/types/faceLiveness.d.ts

@@ -0,0 +1,10 @@
+export type CreateFaceLivenessSessionResponse = {
+    /**
+     * - The session ID for the face liveness check.
+     */
+    sessionId: string;
+    /**
+     * - Indicates if the operation was successful.
+     */
+    success: boolean;
+};

package/dist/types/revocations.d.ts

@@ -0,0 +1,40 @@
+export type RequestRevocationResponse = {
+    /**
+     * - El estado de la solicitud de revocación (e.g., "pending").
+     */
+    revocationStatus: string;
+    /**
+     * - El ID de la solicitud de revocación.
+     */
+    requestId: string | number;
+};
+export type RevocationResponse = {
+    /**
+     * - Indicates if the revocation request was successful.
+     */
+    success: boolean;
+    /**
+     * - A message providing details about the outcome.
+     */
+    message?: string | undefined;
+};
+export type RevocationReason = {
+    /**
+     * - The code for the revocation reason.
+     */
+    code: string;
+    /**
+     * - The description of the revocation reason.
+     */
+    description: string;
+};
+export type RevocationReasonsResponse = {
+    /**
+     * - Indicates if the request was successful.
+     */
+    success: boolean;
+    /**
+     * - A list of revocation reasons.
+     */
+    reasons: RevocationReason[];
+};

package/dist/types/signatures.d.ts

@@ -0,0 +1,152 @@
+/**
+ * Define la estructura de un objeto Firmante.
+ */
+export type Signer = {
+    /**
+     * - Nombre completo del firmante.
+     */
+    name: string;
+    /**
+     * - Correo electrónico del firmante.
+     */
+    email: string;
+    /**
+     * - Documento de identidad del firmante.
+     */
+    document: string;
+};
+/**
+ * Define la estructura de datos para añadir un firmante.
+ */
+export type SignerData = {
+    /**
+     * - Identificador único del documento.
+     */
+    docId: string;
+};
+/**
+ * Define la estructura de la respuesta al añadir un firmante.
+ */
+export type AddSignerResponse = {
+    /**
+     * - Identificador de confirmación del firmante añadido.
+     */
+    signer: string;
+    /**
+     * - Indica si la operación fue exitosa.
+     */
+    success: boolean;
+};
+/**
+ * Define la estructura de datos para obtener el digest de un documento.
+ */
+export type GetDigestData = {
+    /**
+     * - Certificado del firmante en formato base64.
+     */
+    cert: string;
+    /**
+     * - Identificador único del proceso de firma.
+     */
+    signatureId: string;
+};
+/**
+ * Define la estructura de la respuesta al obtener el digest.
+ */
+export type GetDigestResponse = {
+    /**
+     * - El digest del documento que se va a firmar.
+     */
+    digest: string;
+    /**
+     * - Indica si la operación fue exitosa.
+     */
+    success: boolean;
+};
+/**
+ * Define la estructura de los parámetros para obtener documentos.
+ */
+export type GetDocsParams = {
+    /**
+     * - Número de página para la paginación.
+     */
+    page: number;
+    /**
+     * - Cantidad de registros por página.
+     */
+    size: number;
+    /**
+     * - (Opcional) Estado para filtrar los documentos.
+     */
+    status?: string | undefined;
+};
+/**
+ * Define la estructura de la respuesta al obtener documentos.
+ */
+export type GetDocsResponse = {
+    /**
+     * - El número total de registros encontrados.
+     */
+    totalRecords: number;
+    /**
+     * - Un arreglo con los registros de los documentos.
+     */
+    records: Array<object>;
+    /**
+     * - Indica si la operación fue exitosa.
+     */
+    success: boolean;
+};
+export type SignDocumentData = {
+    /**
+     * - Objeto con información de la firma.
+     */
+    signature: {
+        id: string;
+        positions: Array<object>;
+    };
+    /**
+     * - Certificado en base64.
+     */
+    cert: string;
+    /**
+     * - Digest firmado.
+     */
+    signedDigest: string;
+};
+export type SignaturePosition = {
+    /**
+     * - The page number for the signature.
+     */
+    page: number;
+    /**
+     * - The x-coordinate for the signature's position (from 0 to 1).
+     */
+    x: number;
+    /**
+     * - The y-coordinate for the signature's position (from 0 to 1).
+     */
+    y: number;
+};
+export type OnboardingSignerData = {
+    /**
+     * - The name of the document.
+     */
+    name: string;
+    /**
+     * - An external reference for the document.
+     */
+    reference: string;
+    /**
+     * - The type of document of the signer (e.g., "V", "E", "J").
+     */
+    typedoc: string;
+    /**
+     * - The document number of the signer.
+     */
+    doc: string;
+    /**
+     * - An array of signature positions.
+     */
+    signature: SignaturePosition[];
+};

package/dist/types/users.d.ts

@@ -0,0 +1,260 @@
+export type UserData = {
+    /**
+     * - Correo electrónico. No puede contener espacios y tiene un máximo de 128 caracteres.
+     */
+    email: string;
+    /**
+     * - Tipo de usuario. Debe ser un ID valido.
+     */
+    typeuser: number;
+    /**
+     * - Nombre de la persona.
+     */
+    name: string;
+    /**
+     * - Apellido de la persona.
+     */
+    lastname: string;
+    /**
+     * - Tipo de documento de identidad. Puede ser 'V' (Venezolano), 'P' (Pasaporte) o 'E' (Extranjero).
+     */
+    kinddoc: "V" | "P" | "E";
+    /**
+     * - Número de documento de identidad. Debe ser un número entero.
+     */
+    doc: number;
+    /**
+     * - Fecha de nacimiento. Debe ser una fecha válida en formato ISO y no puede ser una fecha futura.
+     */
+    birthdate: string;
+    /**
+     * - Tipo de RIF (Registro de Información Fiscal). Puede ser 'J', 'G', 'V', 'P' o 'E'.
+     */
+    kindrif: "J" | "G" | "V" | "P" | "E";
+    /**
+     * - Género. Puede ser 'M' (Masculino), 'F' (Femenino) o 'Sin especificar'.
+     */
+    gender: "M" | "F" | "Sin especificar";
+    /**
+     * - Número de RIF. Debe ser un número entero.
+     */
+    rif: number;
+    /**
+     * - Número de teléfono. Debe ser un número entero.
+     */
+    phone: number;
+    /**
+     * - Código de área del teléfono. Ej. 0424.
+     */
+    kindphone: string;
+    /**
+     * - Nombre del estado.
+     */
+    state: string;
+    /**
+     * - Nombre del municipio.
+     */
+    municipality: string;
+    /**
+     * - Nombre de la parroquia.
+     */
+    parish: string;
+    /**
+     * - Código postal.
+     */
+    postalcode: string;
+    /**
+     * - Dirección.
+     */
+    address: string;
+    /**
+     * - Dirección fiscal.
+     */
+    fiscaladdress: string;
+    /**
+     * - Código de área del teléfono fiscal. Ej. 0424.
+     */
+    fiscalkindphone: string;
+    /**
+     * - Número de teléfono fiscal. Debe ser un número entero.
+     */
+    fiscalphone: number;
+    /**
+     * - Ocupacion de la persona.
+     */
+    occupation: string;
+    /**
+     * - Título universitario.
+     */
+    degree: string;
+    /**
+     * - Universidad.
+     */
+    university: string;
+    /**
+     * - Año de graduación.
+     */
+    graduationyear: string;
+    /**
+     * - Número de colegiado.
+     */
+    collegiatenumber: string;
+    /**
+     * - Año de colegiatura.
+     */
+    collegiateyear: string;
+    /**
+     * - Nombre de la empresa.
+     */
+    companyname: string;
+    /**
+     * - Tipo de RIF de la empresa. Puede ser 'J', 'G', 'V', 'P' o 'E'.
+     */
+    companykindrif: "J" | "G" | "V" | "P" | "E";
+    /**
+     * - Número de RIF de la empresa.
+     */
+    companyrif: string;
+    /**
+     * - Estado de la empresa.
+     */
+    companystate: string;
+    /**
+     * - Municipio de la empresa.
+     */
+    companymunicipality: string;
+    /**
+     * - Parroquia de la empresa.
+     */
+    companyparish: string;
+    /**
+     * - Dirección de la empresa.
+     */
+    companyaddress: string;
+    /**
+     * - Código de área del teléfono de la empresa. Ej. 0212.
+     */
+    companykindphone: string;
+    /**
+     * - Número de teléfono de la empresa.
+     */
+    companyphone: string;
+    /**
+     * - Código postal de la empresa.
+     */
+    companypostalcode: string;
+    /**
+     * - Página web de la empresa.
+     */
+    companywebpage: string;
+    /**
+     * - Registro comercial de la empresa.
+     */
+    companycommercialregister: string;
+    /**
+     * - Fecha de registro de la empresa en formato ISO.
+     */
+    companyregisterdate: string;
+    /**
+     * - Número de registro de la empresa.
+     */
+    companyregisternumber: string;
+    /**
+     * - Fecha de constitución de la empresa en formato ISO.
+     */
+    companyconstitutiondate: string;
+    /**
+     * - Fecha de publicación del decreto de constitución. Debe ser una fecha válida en formato ISO y no puede ser una fecha futura.
+     */
+    companypublishdate: string;
+    /**
+     * - Decreto de constitución de la empresa. Máximo 32 caracteres.
+     */
+    companyconstitutiondecree: string;
+    /**
+     * - Número de decreto de la empresa. Máximo 16 caracteres.
+     */
+    companynumberdecree: string;
+    /**
+     * - Cargo empleado empresa privada.
+     */
+    positionprivate: string;
+    /**
+     * - Departamento empleado empresa privada.
+     */
+    departmentprivate: string;
+    /**
+     * - Autorizado de por empleado empresa privada.
+     */
+    authorizedprivate: string;
+    /**
+     * - Funciones empleado empresa privada.
+     */
+    functionsprivate: string;
+    /**
+     * - Fecha de publicación de la gaceta de la empresa privada.
+     */
+    publishprivate: string;
+    /**
+     * - Fecha de registro de la empresa privada. Debe ser una fecha válida en formato ISO.
+     */
+    issuedateprivate: string;
+    /**
+     * - Código de área del teléfono de la empresa privada. ej. 0424.
+     */
+    kindphoneprivate: string;
+    /**
+     * - Número de teléfono privado. Debe ser un número entero.
+     */
+    phoneprivate: number;
+    /**
+     * - Cargo empleado empresa publica.
+     */
+    positionpublic: string;
+    /**
+     * - Departamento empleado empresa publica.
+     */
+    departmentpublic: string;
+    /**
+     * - Autorizado empleado empresa publica.
+     */
+    authorizedpublic: string;
+    /**
+     * - Funciones de empleado empresa publica.
+     */
+    functionspublic: string;
+    /**
+     * - Fecha de publicación de la gaceta de la empresa pública.
+     */
+    publishpublic: string;
+    /**
+     * - Fecha de registro de la empresa pública. Debe ser una fecha válida en formato ISO.
+     */
+    issuedatepublic: string;
+    /**
+     * - Código de área del teléfono de la empresa publica. ej 0424.
+     */
+    kindphonepublic: string;
+    /**
+     * - Número de teléfono público. Debe ser un número entero.
+     */
+    phonepublic: number;
+    /**
+     * - ID de la empresa. Debe ser un UUID para la creacion de empleados.
+     */
+    companyid: string;
+};
+export type GetCustomerResponse = {
+    /**
+     * - El token de sesión del usuario.
+     */
+    token: string;
+    /**
+     * - Los datos del usuario obtenidos.
+     */
+    userData: UserData;
+    /**
+     * - Indica si la operación fue exitosa.
+     */
+    success: boolean;
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "apacuana-sdk-core",
-  "version": "0.9.0",
+  "version": "0.11.0",
   "description": "Core SDK para interacciones con las APIs de Apacuana.",
   "main": "dist/index.js",
   "module": "dist/index.mjs",