@fiado/api-invoker 5.41.0 → 5.42.0

package/bin/loanCredit/api/LoanCreditBusinessApi.d.ts

@@ -1,6 +1,7 @@
 import type { IHttpRequest } from "@fiado/http-client";
 import { StandardResponse } from "@fiado/gateway-adapter";
 import { ActivationCheckRequest, ActivationCheckResponse, LoanBorrowerResponse, LoanCreditResponse, OriginateLoanCreditRequest, OriginateLoanCreditResponse, QuoteLoanCreditRequest, QuoteLoanCreditResponse, SignLoanCreditRequest, SignLoanCreditResponse, UpsertLoanBorrowerRequest } from "@fiado/type-kit/bin/loanCredit/index.js";
+import { LoanCreditAnalyticsBatchRequest, LoanCreditAnalyticsBatchResponse } from "./dtos/LoanCreditAnalyticsBatch.js";
 import { ILoanCreditBusinessApi } from "./interfaces/ILoanCreditBusinessApi.js";
 /**
  * Publisher HTTP del lambda `loan-credit-business` (componente 09 SureKeep F2 — motor de crédito).
@@ -25,5 +26,6 @@ export default class LoanCreditBusinessApi implements ILoanCreditBusinessApi {
     discard(creditId: string, tenantId: string): Promise<StandardResponse<LoanCreditResponse>>;
     getCredit(creditId: string, tenantId: string): Promise<StandardResponse<LoanCreditResponse>>;
     getBorrowerByRetailCustomer(retailCustomerId: string, tenantId: string): Promise<StandardResponse<LoanBorrowerResponse>>;
+    batchGetCreditAnalytics(input: LoanCreditAnalyticsBatchRequest, tenantId: string): Promise<StandardResponse<LoanCreditAnalyticsBatchResponse>>;
     upsertBorrower(input: UpsertLoanBorrowerRequest, tenantId: string): Promise<StandardResponse<LoanBorrowerResponse>>;
 }

package/bin/loanCredit/api/LoanCreditBusinessApi.js

@@ -58,6 +58,10 @@ let LoanCreditBusinessApi = class LoanCreditBusinessApi {
         const url = `${this.baseUrl}/private/borrowers/by-retail-customer/${encodeURIComponent(retailCustomerId)}?tenantId=${encodeURIComponent(tenantId)}`;
         return await this.httpRequest.get(url);
     }
+    async batchGetCreditAnalytics(input, tenantId) {
+        const url = `${this.baseUrl}/private/credits/analytics?tenantId=${encodeURIComponent(tenantId)}`;
+        return await this.httpRequest.post(url, input);
+    }
     async upsertBorrower(input, tenantId) {
         const url = `${this.baseUrl}/private/borrowers?tenantId=${encodeURIComponent(tenantId)}`;
         return await this.httpRequest.post(url, input);

package/bin/loanCredit/api/dtos/LoanCreditAnalyticsBatch.d.ts

@@ -0,0 +1,31 @@
+import { LoanCreditStatusEnum } from "@fiado/type-kit/bin/loanCredit/index.js";
+import { ClientLevelEnum } from "@fiado/type-kit/bin/loanScoring/index.js";
+/** Body de `POST /private/credits/analytics`. Hasta 500 ids por request; el caller pagina. */
+export interface LoanCreditAnalyticsBatchRequest {
+    creditIds: string[];
+}
+/**
+ * Lo mínimo de un crédito para contar: eje de riesgo, plan, cifras del enganche, estado y fecha.
+ * CERO PII — ni acreditado, ni nombre, ni teléfono.
+ */
+export interface LoanCreditAnalyticsItem {
+    creditId: string;
+    /** Nivel CONGELADO al originar; ausente en los créditos que se originaron sin SCI. */
+    clientLevelAtOrigination?: ClientLevelEnum;
+    /** Score CONGELADO al originar; ausente en los créditos que se originaron sin SCI. */
+    sciAtOrigination?: number;
+    /** Plan comercial con el que se originó. Es lo que distingue una venta a empleado. */
+    planId: string;
+    equipmentPriceCents: number;
+    downPaymentCents: number;
+    status: LoanCreditStatusEnum;
+    createdAt: string;
+}
+/**
+ * Los ids que no existen simplemente no vuelven; los que DynamoDB no alcanzó a leer salen
+ * NOMBRADOS para que el caller no los cuente como cero.
+ */
+export interface LoanCreditAnalyticsBatchResponse {
+    items: LoanCreditAnalyticsItem[];
+    unresolvedCreditIds: string[];
+}

package/bin/loanCredit/api/dtos/LoanCreditAnalyticsBatch.js

@@ -0,0 +1 @@
+export {};

package/bin/loanCredit/api/interfaces/ILoanCreditBusinessApi.d.ts

@@ -1,5 +1,6 @@
 import { StandardResponse } from "@fiado/gateway-adapter";
 import { ActivationCheckRequest, ActivationCheckResponse, LoanBorrowerResponse, LoanCreditResponse, OriginateLoanCreditRequest, OriginateLoanCreditResponse, QuoteLoanCreditRequest, QuoteLoanCreditResponse, SignLoanCreditRequest, SignLoanCreditResponse, UpsertLoanBorrowerRequest } from "@fiado/type-kit/bin/loanCredit/index.js";
+import { LoanCreditAnalyticsBatchRequest, LoanCreditAnalyticsBatchResponse } from "../dtos/LoanCreditAnalyticsBatch.js";
 /**
  * Contrato del publisher de `loan-credit-business` (componente 09 SureKeep F2 — motor de crédito
  * SOFOM, pista Loan). Endpoints PRIVADOS (VPC) consumidos por `retail-wizard-business` (pasos
@@ -56,6 +57,16 @@ export interface ILoanCreditBusinessApi {
      * `404 BORROWER_NOT_FOUND` si el evento KYC aún no lo hidrató.
      */
     getBorrowerByRetailCustomer(retailCustomerId: string, tenantId: string): Promise<StandardResponse<LoanBorrowerResponse>>;
+    /**
+     * Lee créditos EN LOTE por su id y devuelve solo lo que se cuenta: el eje de riesgo congelado
+     * al originar, el plan, las cifras del enganche, el estado y la fecha. **Cero PII.**
+     *
+     * Se resuelve por BatchGetItem sobre la clave primaria, así que el orden de salida NO es el de
+     * entrada. Un id que no existe no vuelve; uno que DynamoDB no alcanzó a leer vuelve nombrado en
+     * `unresolvedCreditIds` — nunca se confunde «no pude leerlo» con «no existe».
+     * `400 VALIDATION_ERROR` si el lote pasa de 500 ids o trae uno que no es ULID.
+     */
+    batchGetCreditAnalytics(input: LoanCreditAnalyticsBatchRequest, tenantId: string): Promise<StandardResponse<LoanCreditAnalyticsBatchResponse>>;
     /**
      * Upsert idempotente del acreditado por `retailCustomerId` (mismo contrato que el consumidor
      * del evento `CustomerKycVerifiedV1` — fallback operativo mientras la cola no exista).

package/bin/loanCredit/index.d.ts

@@ -1,3 +1,4 @@
+export * from "./api/dtos/LoanCreditAnalyticsBatch.js";
 export * from "./api/interfaces/ILoanCreditBusinessApi.js";
 export { default as LoanCreditBusinessApi } from "./api/LoanCreditBusinessApi.js";
 export * from "./api/interfaces/ILoanCreditDeviceApi.js";

package/bin/loanCredit/index.js

@@ -1,3 +1,4 @@
+export * from "./api/dtos/LoanCreditAnalyticsBatch.js";
 export * from "./api/interfaces/ILoanCreditBusinessApi.js";
 export { default as LoanCreditBusinessApi } from "./api/LoanCreditBusinessApi.js";
 export * from "./api/interfaces/ILoanCreditDeviceApi.js";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fiado/api-invoker",
-  "version": "5.41.0",
+  "version": "5.42.0",
   "description": "Sirve como un puente entre diferentes funciones lambda, facilitando la comunicación entre ellas a través de invocaciones http",
   "type": "module",
   "main": "bin/index.js",

package/src/loanCredit/api/LoanCreditBusinessApi.ts

@@ -14,6 +14,10 @@ import {
     SignLoanCreditResponse,
     UpsertLoanBorrowerRequest,
 } from "@fiado/type-kit/bin/loanCredit/index.js";
+import {
+    LoanCreditAnalyticsBatchRequest,
+    LoanCreditAnalyticsBatchResponse,
+} from "./dtos/LoanCreditAnalyticsBatch.js";
 import { ILoanCreditBusinessApi } from "./interfaces/ILoanCreditBusinessApi.js";
 
 /**
@@ -94,6 +98,14 @@ export default class LoanCreditBusinessApi implements ILoanCreditBusinessApi {
         return await this.httpRequest.get(url);
     }
 
+    async batchGetCreditAnalytics(
+        input: LoanCreditAnalyticsBatchRequest,
+        tenantId: string,
+    ): Promise<StandardResponse<LoanCreditAnalyticsBatchResponse>> {
+        const url = `${this.baseUrl}/private/credits/analytics?tenantId=${encodeURIComponent(tenantId)}`;
+        return await this.httpRequest.post(url, input);
+    }
+
     async upsertBorrower(
         input: UpsertLoanBorrowerRequest,
         tenantId: string,

package/src/loanCredit/api/dtos/LoanCreditAnalyticsBatch.ts

@@ -0,0 +1,34 @@
+import { LoanCreditStatusEnum } from "@fiado/type-kit/bin/loanCredit/index.js";
+import { ClientLevelEnum } from "@fiado/type-kit/bin/loanScoring/index.js";
+
+/** Body de `POST /private/credits/analytics`. Hasta 500 ids por request; el caller pagina. */
+export interface LoanCreditAnalyticsBatchRequest {
+    creditIds: string[];
+}
+
+/**
+ * Lo mínimo de un crédito para contar: eje de riesgo, plan, cifras del enganche, estado y fecha.
+ * CERO PII — ni acreditado, ni nombre, ni teléfono.
+ */
+export interface LoanCreditAnalyticsItem {
+    creditId: string;
+    /** Nivel CONGELADO al originar; ausente en los créditos que se originaron sin SCI. */
+    clientLevelAtOrigination?: ClientLevelEnum;
+    /** Score CONGELADO al originar; ausente en los créditos que se originaron sin SCI. */
+    sciAtOrigination?: number;
+    /** Plan comercial con el que se originó. Es lo que distingue una venta a empleado. */
+    planId: string;
+    equipmentPriceCents: number;
+    downPaymentCents: number;
+    status: LoanCreditStatusEnum;
+    createdAt: string;
+}
+
+/**
+ * Los ids que no existen simplemente no vuelven; los que DynamoDB no alcanzó a leer salen
+ * NOMBRADOS para que el caller no los cuente como cero.
+ */
+export interface LoanCreditAnalyticsBatchResponse {
+    items: LoanCreditAnalyticsItem[];
+    unresolvedCreditIds: string[];
+}

package/src/loanCredit/api/interfaces/ILoanCreditBusinessApi.ts

@@ -12,6 +12,10 @@ import {
     SignLoanCreditResponse,
     UpsertLoanBorrowerRequest,
 } from "@fiado/type-kit/bin/loanCredit/index.js";
+import {
+    LoanCreditAnalyticsBatchRequest,
+    LoanCreditAnalyticsBatchResponse,
+} from "../dtos/LoanCreditAnalyticsBatch.js";
 
 /**
  * Contrato del publisher de `loan-credit-business` (componente 09 SureKeep F2 — motor de crédito
@@ -100,6 +104,20 @@ export interface ILoanCreditBusinessApi {
         tenantId: string,
     ): Promise<StandardResponse<LoanBorrowerResponse>>;
 
+    /**
+     * Lee créditos EN LOTE por su id y devuelve solo lo que se cuenta: el eje de riesgo congelado
+     * al originar, el plan, las cifras del enganche, el estado y la fecha. **Cero PII.**
+     *
+     * Se resuelve por BatchGetItem sobre la clave primaria, así que el orden de salida NO es el de
+     * entrada. Un id que no existe no vuelve; uno que DynamoDB no alcanzó a leer vuelve nombrado en
+     * `unresolvedCreditIds` — nunca se confunde «no pude leerlo» con «no existe».
+     * `400 VALIDATION_ERROR` si el lote pasa de 500 ids o trae uno que no es ULID.
+     */
+    batchGetCreditAnalytics(
+        input: LoanCreditAnalyticsBatchRequest,
+        tenantId: string,
+    ): Promise<StandardResponse<LoanCreditAnalyticsBatchResponse>>;
+
     /**
      * Upsert idempotente del acreditado por `retailCustomerId` (mismo contrato que el consumidor
      * del evento `CustomerKycVerifiedV1` — fallback operativo mientras la cola no exista).

package/src/loanCredit/index.ts

@@ -1,3 +1,4 @@
+export * from "./api/dtos/LoanCreditAnalyticsBatch.js";
 export * from "./api/interfaces/ILoanCreditBusinessApi.js";
 export { default as LoanCreditBusinessApi } from "./api/LoanCreditBusinessApi.js";