@fiado/api-invoker 4.5.0 → 4.7.0

package/src/directory/interfaces/IDirectoryApi.ts

@@ -1,73 +1,73 @@
-import { Profile } from "@fiado/type-kit/bin/directory/enums/Profile";
-import { Status } from "@fiado/type-kit/bin/directory/enums/Status";
-import { Provider } from "@fiado/type-kit/bin/provider";
-
-/**
- * Interfaz para el servicio Directory que permite operaciones sobre directorios.
- */
-export interface IDirectoryApi {
-    /**
-     * Obtiene una lista de directorios por sus IDs.
-     * @param ids Array de IDs de directorios (UUIDs) a buscar.
-     * @returns Una promesa que resuelve a un arreglo de objetos de directorio.
-     * Puede devolver un arreglo vacío si no se encuentran coincidencias.
-     * @throws {Error} Lanza un error si los parámetros de entrada son inválidos.
-     */
-    getByIds(ids: string[]): Promise<any>;
-
-    /**
-     * Actualiza el ID de usuario externo en un directorio.
-     * @param directoryId ID del directorio (UUID) a actualizar.
-     * @param provider Proveedor de autenticación del usuario.
-     * @param externalUserId ID de usuario externo.
-     * @returns Una promesa que resuelve a un objeto vacío.
-     * @throws {Error} Lanza un error si los parámetros de entrada son inválidos.
-     */
-
-    updateExternalUserId(directoryId: string, provider: Provider, externalUserId: string): Promise<void>;
-
-    /**
-     * Actualiza el alcance de un directorio.
-     * @param directoryId ID del directorio (UUID) a actualizar.
-     * @param scope Alcance a actualizar.
-     * @returns Una promesa que resuelve a un objeto vacío.
-     * @throws {Error} Lanza un error si los parámetros de entrada son inválidos.
-     */
-    updateScope(directoryId: string, scope: string[]): Promise<void>;
-
-    /**
-     * Obtiene un directorio por su ID de directorio propietario.
-     * @param ownerDirectoryId ID de directorio propietario (UUID) a buscar.
-     * @returns Una promesa que resuelve a un objeto de directorio.
-     * Puede devolver un objeto vacío si no se encuentra coincidencia.
-     * @throws {Error} Lanza un error si los parámetros de entrada son inválidos.
-     */
-    getByOwnerDirectoryId(ownerDirectoryId: string): Promise<any>
-
-    /**
-     * Obtiene un directorio por su número de teléfono.
-     * @param phoneNumber Número de teléfono a buscar.
-     * @returns Una promesa que resuelve a un objeto de directorio.
-     * Puede devolver un objeto vacío si no se encuentra coincidencia.
-     * @throws {Error} Lanza un error si los parámetros de entrada son inválidos.
-     */
-    getByPhoneNumber(phoneNumber: string): Promise<any>
-
-    addOwnerDirectoryId(directoryId: string, newOwnerDirectoryId: string): Promise<any>
-
-    updateUserProfile(directoryId: string, profile: Profile): Promise<void>
-
-    updateOwnerDirectoryId(directoryId: string, newOwnerDirectoryId: string): Promise<any>
-
-    updateStatus(directoryId: string, status: Status): Promise<void>
-
-    getByPeopleId(peopleId: string): Promise<any>;
-
-    validateSecretNumber(directoryId: string, secretNumber: string): Promise<void>;
-
-    deleteDirectory(directoryId: string): Promise<void>;
-
-    getDirectoriesByPeopleId(peopleIds: string[]): Promise<any>;
-
-
-}
+import { Profile } from "@fiado/type-kit/bin/directory/enums/Profile";
+import { Status } from "@fiado/type-kit/bin/directory/enums/Status";
+import { Provider } from "@fiado/type-kit/bin/provider";
+
+/**
+ * Interfaz para el servicio Directory que permite operaciones sobre directorios.
+ */
+export interface IDirectoryApi {
+    /**
+     * Obtiene una lista de directorios por sus IDs.
+     * @param ids Array de IDs de directorios (UUIDs) a buscar.
+     * @returns Una promesa que resuelve a un arreglo de objetos de directorio.
+     * Puede devolver un arreglo vacío si no se encuentran coincidencias.
+     * @throws {Error} Lanza un error si los parámetros de entrada son inválidos.
+     */
+    getByIds(ids: string[]): Promise<any>;
+
+    /**
+     * Actualiza el ID de usuario externo en un directorio.
+     * @param directoryId ID del directorio (UUID) a actualizar.
+     * @param provider Proveedor de autenticación del usuario.
+     * @param externalUserId ID de usuario externo.
+     * @returns Una promesa que resuelve a un objeto vacío.
+     * @throws {Error} Lanza un error si los parámetros de entrada son inválidos.
+     */
+
+    updateExternalUserId(directoryId: string, provider: Provider, externalUserId: string): Promise<void>;
+
+    /**
+     * Actualiza el alcance de un directorio.
+     * @param directoryId ID del directorio (UUID) a actualizar.
+     * @param scope Alcance a actualizar.
+     * @returns Una promesa que resuelve a un objeto vacío.
+     * @throws {Error} Lanza un error si los parámetros de entrada son inválidos.
+     */
+    updateScope(directoryId: string, scope: string[]): Promise<void>;
+
+    /**
+     * Obtiene un directorio por su ID de directorio propietario.
+     * @param ownerDirectoryId ID de directorio propietario (UUID) a buscar.
+     * @returns Una promesa que resuelve a un objeto de directorio.
+     * Puede devolver un objeto vacío si no se encuentra coincidencia.
+     * @throws {Error} Lanza un error si los parámetros de entrada son inválidos.
+     */
+    getByOwnerDirectoryId(ownerDirectoryId: string): Promise<any>
+
+    /**
+     * Obtiene un directorio por su número de teléfono.
+     * @param phoneNumber Número de teléfono a buscar.
+     * @returns Una promesa que resuelve a un objeto de directorio.
+     * Puede devolver un objeto vacío si no se encuentra coincidencia.
+     * @throws {Error} Lanza un error si los parámetros de entrada son inválidos.
+     */
+    getByPhoneNumber(phoneNumber: string): Promise<any>
+
+    addOwnerDirectoryId(directoryId: string, newOwnerDirectoryId: string): Promise<any>
+
+    updateUserProfile(directoryId: string, profile: Profile): Promise<void>
+
+    updateOwnerDirectoryId(directoryId: string, newOwnerDirectoryId: string): Promise<any>
+
+    updateStatus(directoryId: string, status: Status): Promise<void>
+
+    getByPeopleId(peopleId: string): Promise<any>;
+
+    validateSecretNumber(directoryId: string, secretNumber: string): Promise<void>;
+
+    deleteDirectory(directoryId: string): Promise<void>;
+
+    getDirectoriesByPeopleId(peopleIds: string[]): Promise<any>;
+
+
+}

package/src/directorySetting/DirectorySettingApi.ts

@@ -1,42 +1,42 @@
-import dotenv from 'dotenv';
-import { inject, injectable } from "inversify";
-import { IHttpRequest } from "@fiado/http-client";
-import { IDirectorySettingApi } from "./interfaces/IDirectorySettingApi";
-import FiadoApiResponse from '@fiado/type-kit/bin/apiResponse/dtos/FiadoApiResponse';
-import { DirectorySettingCreateRequest } from '@fiado/type-kit/bin/directorySetting';
-dotenv.config();
-
-@injectable()
-export class DirectorySettingApi implements IDirectorySettingApi {
-
-    private readonly baseUrl = process.env.DIRECTORY_SETTING_URL || "";
-
-    constructor(@inject("IHttpRequest") private httpRequest: IHttpRequest) {}
-    
-    async createBatchDirectorySetting(params: DirectorySettingCreateRequest): Promise<FiadoApiResponse<{ key: string; value: string; directoryId: string; metadata?: any; }[]>> {
-        const url = `${this.baseUrl}create/batch`;
-        return await this.httpRequest.post(url, document);
-    }
-    
-    async getByIds(ids: string[]): Promise<FiadoApiResponse<{ key: string; value: string; directoryId: string; metadata?: any; }[]>> {
-
-        if (ids.length === 0) {
-            throw new Error("At least one people ID is required.")
-        }
-
-        const url = `${this.baseUrl}get/ids?${ids.map(id => `id=${encodeURIComponent(id)}`).join('&')}`;
-        return await this.httpRequest.get(`${url}`);
-    }
-    
-    async getDirectorySettingsByDirectoryId(params: { pageSize?: number; index?: string; directoryId: string; }): Promise<FiadoApiResponse<{ key: string; value: string; directoryId: string; metadata?: any; }>> {
-        const url = `${this.baseUrl}get/directory/${params.directoryId}`;
-        const queryParameters = [];
-        if (params.pageSize) queryParameters.push(`pageSize=${params.pageSize}`);
-        if (params.index) queryParameters.push(`index=${params.index}`);
-
-        if (queryParameters.length > 0) {
-            url.concat(`?${queryParameters.join('&')}`);
-        }
-        return await this.httpRequest.get(url);
-    }
-}
+import dotenv from 'dotenv';
+import { inject, injectable } from "inversify";
+import { IHttpRequest } from "@fiado/http-client";
+import { IDirectorySettingApi } from "./interfaces/IDirectorySettingApi";
+import FiadoApiResponse from '@fiado/type-kit/bin/apiResponse/dtos/FiadoApiResponse';
+import { DirectorySettingCreateRequest } from '@fiado/type-kit/bin/directorySetting';
+dotenv.config();
+
+@injectable()
+export class DirectorySettingApi implements IDirectorySettingApi {
+
+    private readonly baseUrl = process.env.DIRECTORY_SETTING_URL || "";
+
+    constructor(@inject("IHttpRequest") private httpRequest: IHttpRequest) {}
+    
+    async createBatchDirectorySetting(params: DirectorySettingCreateRequest): Promise<FiadoApiResponse<{ key: string; value: string; directoryId: string; metadata?: any; }[]>> {
+        const url = `${this.baseUrl}create/batch`;
+        return await this.httpRequest.post(url, document);
+    }
+    
+    async getByIds(ids: string[]): Promise<FiadoApiResponse<{ key: string; value: string; directoryId: string; metadata?: any; }[]>> {
+
+        if (ids.length === 0) {
+            throw new Error("At least one people ID is required.")
+        }
+
+        const url = `${this.baseUrl}get/ids?${ids.map(id => `id=${encodeURIComponent(id)}`).join('&')}`;
+        return await this.httpRequest.get(`${url}`);
+    }
+    
+    async getDirectorySettingsByDirectoryId(params: { pageSize?: number; index?: string; directoryId: string; }): Promise<FiadoApiResponse<{ key: string; value: string; directoryId: string; metadata?: any; }>> {
+        const url = `${this.baseUrl}get/directory/${params.directoryId}`;
+        const queryParameters = [];
+        if (params.pageSize) queryParameters.push(`pageSize=${params.pageSize}`);
+        if (params.index) queryParameters.push(`index=${params.index}`);
+
+        if (queryParameters.length > 0) {
+            url.concat(`?${queryParameters.join('&')}`);
+        }
+        return await this.httpRequest.get(url);
+    }
+}

package/src/directorySetting/index.ts

@@ -1,3 +1,3 @@
-
-export * from './interfaces/IDirectorySettingApi';
-export * from './DirectorySettingApi';
+
+export * from './interfaces/IDirectorySettingApi';
+export * from './DirectorySettingApi';

package/src/directorySetting/interfaces/IDirectorySettingApi.ts

@@ -1,56 +1,56 @@
-
-import FiadoApiResponse from "@fiado/type-kit/bin/apiResponse/dtos/FiadoApiResponse";
-import { DirectorySettingCreateRequest } from "@fiado/type-kit/bin/directorySetting/dtos/DirectorySettingCreateRequest";
-
-/**
- * Interfaz para el servicio Directory que permite operaciones sobre directorios.
- */
-export interface IDirectorySettingApi {
-
-
-    /**
-     * Crea en batch settings de directorio.
-     * @param params Parámetros para crear el setting de directorio.
-     * @returns Una promesa que resuelve a la respuesta del API.
-     * @throws {Error} Lanza un error si los parámetros de entrada son inválidos.
-     */
-    createBatchDirectorySetting(params: DirectorySettingCreateRequest): Promise<FiadoApiResponse<{
-        key: string;
-        value: string;
-        directoryId:string
-        metadata?: any;
-    }[]>>;
-
-
-    /**
-     * Obtiene una lista de settings por sus IDs.
-     * @param ids Array de IDs de directorios (UUIDs) a buscar.
-     * @returns Una promesa que resuelve a un arreglo de objetos de directorio.
-     * Puede devolver un arreglo vacío si no se encuentran coincidencias.
-     * @throws {Error} Lanza un error si los parámetros de entrada son inválidos.
-     */
-    getByIds(ids: string[]): Promise<FiadoApiResponse<{
-        key: string;
-        value: string;
-        directoryId:string
-        metadata?: any;
-    }[]>>;
-
-
-    
-    
-    getDirectorySettingsByDirectoryId(params:{
-        pageSize?: number;
-        index?: string;
-        directoryId: string;
-    }): Promise<FiadoApiResponse<
-    {
-    key: string;
-    value: string;
-    directoryId:string
-    metadata?: any;
-}
-    >>;
-
-    
-}
+
+import FiadoApiResponse from "@fiado/type-kit/bin/apiResponse/dtos/FiadoApiResponse";
+import { DirectorySettingCreateRequest } from "@fiado/type-kit/bin/directorySetting/dtos/DirectorySettingCreateRequest";
+
+/**
+ * Interfaz para el servicio Directory que permite operaciones sobre directorios.
+ */
+export interface IDirectorySettingApi {
+
+
+    /**
+     * Crea en batch settings de directorio.
+     * @param params Parámetros para crear el setting de directorio.
+     * @returns Una promesa que resuelve a la respuesta del API.
+     * @throws {Error} Lanza un error si los parámetros de entrada son inválidos.
+     */
+    createBatchDirectorySetting(params: DirectorySettingCreateRequest): Promise<FiadoApiResponse<{
+        key: string;
+        value: string;
+        directoryId:string
+        metadata?: any;
+    }[]>>;
+
+
+    /**
+     * Obtiene una lista de settings por sus IDs.
+     * @param ids Array de IDs de directorios (UUIDs) a buscar.
+     * @returns Una promesa que resuelve a un arreglo de objetos de directorio.
+     * Puede devolver un arreglo vacío si no se encuentran coincidencias.
+     * @throws {Error} Lanza un error si los parámetros de entrada son inválidos.
+     */
+    getByIds(ids: string[]): Promise<FiadoApiResponse<{
+        key: string;
+        value: string;
+        directoryId:string
+        metadata?: any;
+    }[]>>;
+
+
+    
+    
+    getDirectorySettingsByDirectoryId(params:{
+        pageSize?: number;
+        index?: string;
+        directoryId: string;
+    }): Promise<FiadoApiResponse<
+    {
+    key: string;
+    value: string;
+    directoryId:string
+    metadata?: any;
+}
+    >>;
+
+    
+}

package/src/disputes/DisputesApi.ts

@@ -1,51 +1,51 @@
-import { inject, injectable } from "inversify";
-import { IHttpRequest } from "@fiado/http-client";
-import dotenv from 'dotenv';
-import { PeopleUpdateRequest } from "@fiado/type-kit/bin/identity";
-import { IDisputesApi } from "./interfaces/IDisputesApi";
-dotenv.config();
-
-@injectable()
-export class DisputesApi implements IDisputesApi {
-
-    private readonly baseUrl = process.env.DISPUTES_LAMBDA_URL || "";
-
-    constructor(@inject("IHttpRequest") private httpRequest: IHttpRequest) { }
-    async getListBetweenDates(params: { index?: string; pageSize?: number; startDate: string; endDate: string; }): Promise<void> {
-        let queryParams = [];
-
-        if (!params.index) {
-            queryParams.push(`index=${params.index}`);
-        }
-
-        if (!params.pageSize) {
-            queryParams.push(`pageSize=${params.pageSize}`);
-        }
-
-        queryParams.push(`startDate=${params.startDate}`);
-        queryParams.push(`endDate=${params.endDate}`);
-
-        const url = `${this.baseUrl}disputes/bdates?${queryParams.join('&')}`;
-        return await this.httpRequest.get(url);
-    }
-    async addProvisional(params: { disputeId: string; amount: number; date: string; type: "PROV" | "REV_PROV"; }): Promise<void> {
-        const url = `${this.baseUrl}disputes/provisional/add/${params.disputeId}`;
-        return await this.httpRequest.put(url, {amount: params.amount, date: params.date, type: params.type});
-    }
-
-    async getByDirectoryId(params: { directoryId: string; pageSize?: number; index?: string; }): Promise<void> {
-            
-            let queryParams = [];
-            if (!params.index) {
-                queryParams.push(`index=${params.index}`);
-            }
-    
-            if (!params.pageSize) {
-                queryParams.push(`pageSize=${params.pageSize}`);
-            }
-    
-            const url = `${this.baseUrl}disputes/${params.directoryId}?${queryParams.join('&')}`;
-            return await this.httpRequest.get(url);
-    }
-    
+import { inject, injectable } from "inversify";
+import { IHttpRequest } from "@fiado/http-client";
+import dotenv from 'dotenv';
+import { PeopleUpdateRequest } from "@fiado/type-kit/bin/identity";
+import { IDisputesApi } from "./interfaces/IDisputesApi";
+dotenv.config();
+
+@injectable()
+export class DisputesApi implements IDisputesApi {
+
+    private readonly baseUrl = process.env.DISPUTES_LAMBDA_URL || "";
+
+    constructor(@inject("IHttpRequest") private httpRequest: IHttpRequest) { }
+    async getListBetweenDates(params: { index?: string; pageSize?: number; startDate: string; endDate: string; }): Promise<void> {
+        let queryParams = [];
+
+        if (!params.index) {
+            queryParams.push(`index=${params.index}`);
+        }
+
+        if (!params.pageSize) {
+            queryParams.push(`pageSize=${params.pageSize}`);
+        }
+
+        queryParams.push(`startDate=${params.startDate}`);
+        queryParams.push(`endDate=${params.endDate}`);
+
+        const url = `${this.baseUrl}disputes/bdates?${queryParams.join('&')}`;
+        return await this.httpRequest.get(url);
+    }
+    async addProvisional(params: { disputeId: string; amount: number; date: string; type: "PROV" | "REV_PROV"; }): Promise<void> {
+        const url = `${this.baseUrl}disputes/provisional/add/${params.disputeId}`;
+        return await this.httpRequest.put(url, {amount: params.amount, date: params.date, type: params.type});
+    }
+
+    async getByDirectoryId(params: { directoryId: string; pageSize?: number; index?: string; }): Promise<void> {
+            
+            let queryParams = [];
+            if (!params.index) {
+                queryParams.push(`index=${params.index}`);
+            }
+    
+            if (!params.pageSize) {
+                queryParams.push(`pageSize=${params.pageSize}`);
+            }
+    
+            const url = `${this.baseUrl}disputes/${params.directoryId}?${queryParams.join('&')}`;
+            return await this.httpRequest.get(url);
+    }
+    
 }

package/src/disputes/index.ts

@@ -1,3 +1,3 @@
-
-export * from './interfaces/IDisputesApi';
+
+export * from './interfaces/IDisputesApi';
 export * from './DisputesApi';

package/src/disputes/interfaces/IDisputesApi.ts

@@ -1,54 +1,54 @@
-
-/**
- * Interfaz que define las operaciones que se pueden realizar en el servicio de disputas.
- */
-export interface IDisputesApi {
-
-    /**
-     * Obtener disputas por directoryId.
-     * @param directoryId DirectoryId del usuario a consultar.
-     * @param pageSize Tamaño de la página.
-     * @param index Índice de la página.
-     * @returns Una promesa que resuelve a void.
-     * @throws {Error} Lanza un error si los parámetros de entrada son inválidos.
-     */
-    getByDirectoryId(params:{
-        directoryId:string,
-        pageSize?:number,
-        index?:string
-    }): Promise<void>;
-
-
-        /**
-     * Agregar PROV Y REV_PROV a una disputa.
-     * @param disputeId Id de la disputa.
-     * @param amount Monto de la transacción.
-     * @param date Fecha de la transacción.
-     * @param type REV ó PROV.
-     * @returns Una promesa que resuelve a void.
-     * @throws {Error} Lanza un error si los parámetros de entrada son inválidos.
-     */
-        addProvisional(params:{
-            disputeId:string,
-            amount:number,
-            date:string,
-            type:"PROV"|"REV_PROV"
-        }): Promise<void>;
-
-
-        /**
-     * Consultar disputas entre fechas.
-     * @param index indice de consulta.
-     * @param pageSize tamaño de paginación.
-     * @param startDate Fecha inicial de consulta.
-     * @param endDate Fecha final de consulta
-     * @returns Una promesa que resuelve a void.
-     * @throws {Error} Lanza un error si los parámetros de entrada son inválidos.
-     */
-        getListBetweenDates(params:{
-            index?:string,
-            pageSize?:number,
-            startDate:string,
-            endDate:string
-        }): Promise<void>;
-}
+
+/**
+ * Interfaz que define las operaciones que se pueden realizar en el servicio de disputas.
+ */
+export interface IDisputesApi {
+
+    /**
+     * Obtener disputas por directoryId.
+     * @param directoryId DirectoryId del usuario a consultar.
+     * @param pageSize Tamaño de la página.
+     * @param index Índice de la página.
+     * @returns Una promesa que resuelve a void.
+     * @throws {Error} Lanza un error si los parámetros de entrada son inválidos.
+     */
+    getByDirectoryId(params:{
+        directoryId:string,
+        pageSize?:number,
+        index?:string
+    }): Promise<void>;
+
+
+        /**
+     * Agregar PROV Y REV_PROV a una disputa.
+     * @param disputeId Id de la disputa.
+     * @param amount Monto de la transacción.
+     * @param date Fecha de la transacción.
+     * @param type REV ó PROV.
+     * @returns Una promesa que resuelve a void.
+     * @throws {Error} Lanza un error si los parámetros de entrada son inválidos.
+     */
+        addProvisional(params:{
+            disputeId:string,
+            amount:number,
+            date:string,
+            type:"PROV"|"REV_PROV"
+        }): Promise<void>;
+
+
+        /**
+     * Consultar disputas entre fechas.
+     * @param index indice de consulta.
+     * @param pageSize tamaño de paginación.
+     * @param startDate Fecha inicial de consulta.
+     * @param endDate Fecha final de consulta
+     * @returns Una promesa que resuelve a void.
+     * @throws {Error} Lanza un error si los parámetros de entrada son inválidos.
+     */
+        getListBetweenDates(params:{
+            index?:string,
+            pageSize?:number,
+            startDate:string,
+            endDate:string
+        }): Promise<void>;
+}