@fiado/api-invoker 4.68.0 → 4.71.0

package/src/retailCustomer/api/interfaces/IRetailCustomerBusinessApi.ts

@@ -0,0 +1,97 @@
+import { StandardResponse } from "@fiado/gateway-adapter";
+import {
+    UpsertCustomerFromKycRequest,
+    AccountResultRequest,
+    CustomerResponse,
+} from "@fiado/type-kit/bin/retailCustomer/index.js";
+
+/**
+ * Contrato del publisher HTTP del lambda `retail-customer-business` (SureKeep Fase 2, pista Retail)
+ * para sus 4 endpoints privados de cliente (service-to-service, VPC-only).
+ *
+ * Consumidor previsto:
+ *   - `retail-wizard-business` → upsert del cliente post-KYC, aterrizaje del resultado de apertura
+ *     de cuenta (D35), y lecturas del cliente por teléfono / id durante la saga de venta.
+ *
+ * ─────────────────────────────────────────────────────────────────────────────
+ * `tenantId` es OBLIGATORIO en los 4 métodos — no es un detalle de firma.
+ * ─────────────────────────────────────────────────────────────────────────────
+ * Los privados NO llevan token de usuario (`Feature.ANONIMUS`; la protección es la red VPC), así que
+ * el lambda destino no tiene `AuthContext.issuer` y NO puede inferir el silo. El caller declara el
+ * tenant explícito por query (`?tenantId=`) y `@fiado/tenant-context` (`withContextByTenantId`) asume
+ * el rol de ESE silo. Sin `tenantId` → `400 UNKNOWN_TENANT` (fail-closed). Nunca hay default: caer a un
+ * tenant por default sería fail-OPEN y podría devolver datos de otra SOFOM.
+ *
+ * ⚠️ `tenantId` = el tenant CANÓNICO (p.ej. `'surekeep'`), NO el issuer Cognito ni la URL del pool.
+ * Es el mismo valor que consume `retail-org-business` en sus privados (`withContextByTenantId`).
+ *
+ * ─────────────────────────────────────────────────────────────────────────────
+ * ⚠️ Patrón de retorno: `StandardResponse<T>` — el consumer accede `result.data`, NO `result.body`.
+ * ─────────────────────────────────────────────────────────────────────────────
+ * `@fiado/http-client` entrega el BODY PELADO (hace `return response.data` en `AxiosHttpRequest`), así
+ * que `.statusCode`/`.body` no existen en runtime. El envelope real del lambda destino es
+ * `{ code, date, data, msg, description }` = `StandardResponse<T>` (ya exportado por
+ * `@fiado/gateway-adapter`). El consumer lee el shape del cliente en `result.data`.
+ *
+ * Errores: el lambda destino lanza `DomainError` tipado → el publisher RECHAZA (no devuelve null).
+ * Cada consumer mapea a su propio error de dominio (ver `fiado-api-invoker § 6`):
+ *   `404 CUSTOMER_NOT_FOUND` (por id / por teléfono inexistente)
+ *   `400 UNKNOWN_TENANT` (tenantId ausente o desconocido)
+ *
+ * Env var requerida en el consumer: `RETAIL_CUSTOMER_BUSINESS_URL`.
+ * El template.yml del consumer la setea con:
+ *
+ *   RETAIL_CUSTOMER_BUSINESS_URL: '{{resolve:ssm:retail-customer-business}}'
+ *
+ * Convención CLAUDE.md global: SSM key = nombre del lambda owner de la URL.
+ */
+export interface IRetailCustomerBusinessApi {
+    /**
+     * POST /private/customers/upsert-from-kyc?tenantId= — upsert idempotente del cliente tras el KYC
+     * (paso 02f). El lambda resuelve UNIQ#PHONE + UNIQ#CURP en la misma TX y setea
+     * `accountStatus=OPENING` server-side (la apertura corre en background, D35). Responde `201`.
+     *
+     * NOTA (TD-014 del customer): el `address` del type-kit tipa el `AddressBase` canónico (pesado);
+     * el lambda valida con un DTO local ligero. El domicilio OCR-parcial se salda con `RetailAddress`
+     * aditivo al type-kit (backlog) — no acá.
+     */
+    upsertCustomerFromKyc(
+        payload: UpsertCustomerFromKycRequest,
+        tenantId: string,
+    ): Promise<StandardResponse<CustomerResponse>>;
+
+    /**
+     * PUT /private/customers/{customerId}/account-result?tenantId= — aterriza el resultado terminal de
+     * la apertura de cuenta async (D35). Solo acepta OPEN/FAILED (nunca el intermedio OPENING). OPEN
+     * llega con `pcfClabe`/`pcfAccountLevel`; FAILED con `failReason`.
+     *
+     * @throws si el cliente no existe (`404 CUSTOMER_NOT_FOUND`).
+     */
+    setAccountResult(
+        customerId: string,
+        payload: AccountResultRequest,
+        tenantId: string,
+    ): Promise<StandardResponse<CustomerResponse>>;
+
+    /**
+     * GET /private/customers/by-phone/{phone}?tenantId= — resuelve el cliente por su teléfono MX (10
+     * dígitos, ya normalizado sin separadores). Usado por el wizard para saber si el teléfono ya es
+     * cliente del silo.
+     *
+     * @throws si no hay cliente con ese teléfono (`404 CUSTOMER_NOT_FOUND`).
+     */
+    getCustomerByPhone(
+        phone: string,
+        tenantId: string,
+    ): Promise<StandardResponse<CustomerResponse>>;
+
+    /**
+     * GET /private/customers/{customerId}?tenantId= — resuelve el cliente por su id.
+     *
+     * @throws si el cliente no existe (`404 CUSTOMER_NOT_FOUND`).
+     */
+    getCustomer(
+        customerId: string,
+        tenantId: string,
+    ): Promise<StandardResponse<CustomerResponse>>;
+}

package/src/retailCustomer/index.ts

@@ -0,0 +1,2 @@
+export * from "./api/interfaces/IRetailCustomerBusinessApi.js";
+export { default as RetailCustomerBusinessApi } from "./api/RetailCustomerBusinessApi.js";

package/src/riskProfile/api/RiskProfileApi.ts

@@ -5,6 +5,7 @@ import {CreatePrivateAlarm, CreateRiskProfileRequest} from "@fiado/type-kit/bin/
 type UpdateRiskProfileRequest = import("@fiado/type-kit/bin/riskProfile/dtos/UpdateRiskProfileRequest.js").default;
 type UpdateAlarmProfileRequest = import("@fiado/type-kit/bin/riskProfile/dtos/UpdateAlarmProfileRequest.js").default;
 import { ResponseOptions } from "@fiado/gateway-adapter";
+type FiadoApiResponse<T> = import("@fiado/type-kit/bin/apiResponse/dtos/FiadoApiResponse.js").default<T>;
 import {
     SetCustomAlarmRequest,
     SetCustomAlarmResponse,
@@ -86,4 +87,9 @@ export default class RiskProfileApi implements IRiskProfileApi {
         return await this.httpRequest.get(url);
     }
 
+    async deleteByDirectoryId(directoryId: string): Promise<FiadoApiResponse<{ deletedCount: number }>> {
+        const url = `${this.baseUrl}/private/directory/${directoryId}`;
+        return await this.httpRequest.delete<FiadoApiResponse<{ deletedCount: number }>>(url);
+    }
+
 }

package/src/riskProfile/api/interfaces/IRiskProfileApi.ts

@@ -2,6 +2,7 @@ import {CreatePrivateAlarm, CreateRiskProfileRequest} from "@fiado/type-kit/bin/
 type UpdateAlarmProfileRequest = import("@fiado/type-kit/bin/riskProfile/dtos/UpdateAlarmProfileRequest.js").default;
 type UpdateRiskProfileRequest = import("@fiado/type-kit/bin/riskProfile/dtos/UpdateRiskProfileRequest.js").default;
 import { ResponseOptions } from "@fiado/gateway-adapter";
+type FiadoApiResponse<T> = import("@fiado/type-kit/bin/apiResponse/dtos/FiadoApiResponse.js").default<T>;
 import {
     SetCustomAlarmRequest,
     SetCustomAlarmResponse,
@@ -67,4 +68,12 @@ export interface IRiskProfileApi {
      * Paginación: pasar `continuationToken` de la respuesta previa; `null` = fin.
      */
     listClientFinancialHistory(directoryId: string, params?: { limit?: number; continuationToken?: string }): Promise<ResponseOptions<ListClientFinancialHistoryResponse>>;
+
+    /**
+     * Borra en cascada el perfil de riesgo asociado a un directoryId.
+     * @param directoryId ID del directorio.
+     * @throws {Error} Lanza un error si los parámetros de entrada son inválidos.
+     */
+    // TODO(type-kit): swap a Directory.DeleteByDirectoryResponse cuando se publique
+    deleteByDirectoryId(directoryId: string): Promise<FiadoApiResponse<{ deletedCount: number }>>;
 }

package/src/zendesk/ZendeskApi.ts

@@ -21,4 +21,9 @@ export class ZendeskApi implements IZendeskApi {
         const url: string = `${this.baseUrl}tickets/create`;
         return await this.httpRequest.post(url,data);
     }
+
+    async deleteByDirectoryId(directoryId: string): Promise<FiadoApiResponse<{ deletedCount: number }>> {
+        const url = `${this.baseUrl}private/directory/${directoryId}`;
+        return await this.httpRequest.delete<FiadoApiResponse<{ deletedCount: number }>>(url);
+    }
 }

package/src/zendesk/interfaces/IZendeskApi.ts

@@ -7,4 +7,12 @@ import { HelpdeskCreateTicketRequest, HelpdeskCreateUserRequest } from '@fiado/t
 export interface IZendeskApi {
     createUser(data: HelpdeskCreateUserRequest): Promise<FiadoApiResponse<any>>;
     createTicket(data: HelpdeskCreateTicketRequest): Promise<FiadoApiResponse<any>>;
+
+    /**
+     * Borra en cascada los registros de Zendesk asociados a un directoryId.
+     * @param directoryId ID del directorio.
+     * @throws {Error} Lanza un error si los parámetros de entrada son inválidos.
+     */
+    // TODO(type-kit): swap a Directory.DeleteByDirectoryResponse cuando se publique
+    deleteByDirectoryId(directoryId: string): Promise<FiadoApiResponse<{ deletedCount: number }>>;
 }