@fiado/type-kit 3.456.0 → 3.458.0

package/src/emailVerification/dtos/EmailSetTrustedResponse.ts

@@ -0,0 +1,16 @@
+import { Expose } from 'class-transformer';
+import { EmailTypeEnum } from '../enums/EmailTypeEnum';
+
+/**
+ * Respuesta al registrar un correo como confiable.
+ */
+export class EmailSetTrustedResponse {
+    @Expose()
+    email!: string;
+
+    @Expose()
+    type!: EmailTypeEnum;
+
+    @Expose()
+    isVerified!: boolean;
+}

package/src/emailVerification/enums/EmailTypeEnum.ts

@@ -0,0 +1,9 @@
+/**
+ * Origen del correo asociado a un directorio.
+ * PERSONAL: correo particular del titular.
+ * CORPORATE: correo institucional/empresarial del titular.
+ */
+export enum EmailTypeEnum {
+    PERSONAL = 'PERSONAL',
+    CORPORATE = 'CORPORATE',
+}

package/src/emailVerification/index.ts

@@ -1,5 +1,6 @@
 export * from './enums/EmailVerificationStatusEnum';
 export * from './enums/EmailLinkExpirationReasonEnum';
+export * from './enums/EmailTypeEnum';
 export * from './dtos/EmailVerificationStartRequest';
 export * from './dtos/EmailVerificationStartResponse';
 export * from './dtos/EmailVerificationResendRequest';
@@ -10,6 +11,8 @@ export * from './dtos/EmailItem';
 export * from './dtos/EmailListResponse';
 export * from './dtos/EmailSetPrincipalRequest';
 export * from './dtos/EmailSetPrincipalResponse';
+export * from './dtos/EmailSetTrustedRequest';
+export * from './dtos/EmailSetTrustedResponse';
 export * from './dtos/EmailDeleteRequest';
 export * from './dtos/EmailDeleteResponse';
 export * from './dtos/EmailConfirmRequest';

package/src/index.ts

@@ -178,3 +178,7 @@ export * as WebhookBusiness from './webhookBusiness';
 // (MembershipDirectoryUser_GT). Espeja al dominio `services`, que modela lo mismo para
 // servicios de terceros.
 export * as Membership from './membership';
+
+// RetailLoanConnector: contrato público de retail-loan-connector (I1), la puerta de la App Fiado
+// hacia las suites FiadoLend/FiadoRetail. Montos en pesos; el conector convierte desde centavos.
+export * as RetailLoanConnector from './retailLoanConnector';

package/src/loanCredit/dtos/responses/CreditSaleContext.ts

@@ -0,0 +1,44 @@
+import { WizardSessionLookupStatusEnum } from '../../../retailWizard/enums/WizardSessionLookupStatusEnum';
+
+/**
+ * Por qué una columna del contexto de venta salió sin dato. Catálogo CERRADO y propio: nunca
+ * repite el mensaje del lambda vecino, que puede traer datos que este silo no controla.
+ */
+export type SaleContextReason =
+    | 'CREDIT_WITHOUT_WIZARD_SESSION'
+    | 'WIZARD_LOOKUP_FAILED'
+    | 'BORROWER_LOOKUP_FAILED'
+    | 'BORROWER_NOT_FOUND'
+    | 'CUSTOMER_ANCHOR_MISSING'
+    | 'CUSTOMER_NAME_LOOKUP_FAILED'
+    | 'CUSTOMER_NOT_FOUND'
+    | 'CUSTOMER_WITHOUT_NAME'
+    | 'STORE_ROSTER_FAILED'
+    | 'STORE_NOT_IN_ROSTER'
+    | 'RETAILER_UNKNOWN';
+
+/**
+ * Cliente, equipo y tienda de la venta que originó el crédito (loan-credit-business). Son CUATRO
+ * lecturas y cada una lleva su estado: `status` es el del lote al wizard (gobierna las columnas del
+ * equipo), `retailCustomerStatus` el del ancla del cliente, `customerNameStatus` el de su nombre y
+ * `storeNameStatus` el del nombre de la tienda. `NOT_FOUND` y `UNAVAILABLE` NUNCA se colapsan.
+ */
+export interface CreditSaleContext {
+    status: WizardSessionLookupStatusEnum;
+    reason?: SaleContextReason;
+    retailCustomerId: string | null;
+    retailCustomerStatus: WizardSessionLookupStatusEnum;
+    retailCustomerReason?: SaleContextReason;
+    /** PII: nunca se loguea. */
+    customerName: string | null;
+    customerNameStatus: WizardSessionLookupStatusEnum;
+    customerNameReason?: SaleContextReason;
+    productBrand: string | null;
+    productModel: string | null;
+    productCapacity: string | null;
+    retailerId: string | null;
+    storeId: string | null;
+    storeName: string | null;
+    storeNameStatus: WizardSessionLookupStatusEnum;
+    storeNameReason?: SaleContextReason;
+}

package/src/loanCredit/dtos/responses/LoanBorrowerCreditItem.ts

@@ -0,0 +1,18 @@
+import { LoanCreditResponse } from './LoanCreditResponse';
+import { CreditSaleContext } from './CreditSaleContext';
+
+/**
+ * Un crédito de un acreditado (loan-credit-business): el `LoanCreditResponse` MÁS las cifras de su
+ * plan y el contexto de su venta. Montos en cents · instantes ISO-8601 · dueDates `YYYY-MM-DD`.
+ */
+export interface LoanBorrowerCreditItem extends LoanCreditResponse {
+    /** Cupones cubiertos: pagados y pagados por adelantado. La reestructurada no cuenta. */
+    paidInstallments: number;
+    /** `null` = no aplica (el crédito se canceló o caducó); `0` = ya no debe nada. */
+    outstandingBalanceCents: number | null;
+    /** Días desde el vencimiento impago más viejo; `0` al día; `null` si no hay atraso que medir. */
+    overdueDays: number | null;
+    /** Suma del TOTAL de las cuotas vencidas impagas. Sigue a `overdueDays` en `null`/`0`. */
+    overdueAmountCents: number | null;
+    saleContext: CreditSaleContext;
+}

package/src/loanCredit/dtos/responses/LoanContractDownloadUrl.ts

@@ -0,0 +1,10 @@
+import { ContractTypeEnum } from '../../enums/ContractTypeEnum';
+
+/** Enlace prefirmado y temporal del PDF de un contrato. `expiresAt` en ISO-8601. */
+export interface LoanContractDownloadUrl {
+    contractId: string;
+    creditId: string;
+    type: ContractTypeEnum;
+    url: string;
+    expiresAt: string;
+}

package/src/loanCredit/dtos/responses/LoanCreditDetail.ts

@@ -0,0 +1,22 @@
+import { SaleFinancierEnum } from '../../../retailWizard/enums/SaleFinancierEnum';
+import { LoanCreditResponse } from './LoanCreditResponse';
+import { CreditSaleContext } from './CreditSaleContext';
+
+/**
+ * Detalle de UN crédito (loan-credit-business): el `LoanCreditResponse` MÁS las cifras de su plan,
+ * el equipo y el contexto de su venta. Montos en cents · instantes ISO-8601.
+ */
+export interface LoanCreditDetail extends LoanCreditResponse {
+    /** SKU del equipo financiado, congelado al originar. Ausente en créditos anteriores a 2026-08. */
+    productSku?: string;
+    /** Tienda que originó la venta. Ausente en créditos anteriores a 2026-08. */
+    storeId?: string;
+    financier: SaleFinancierEnum;
+    paidInstallments: number;
+    outstandingBalanceCents: number | null;
+    overdueDays: number | null;
+    overdueAmountCents: number | null;
+    /** Cuotas vencidas impagas. `0` = nada vencido; `null` acompaña a `overdueDays` en null. */
+    overdueInstallments: number | null;
+    saleContext: CreditSaleContext;
+}

package/src/loanCredit/dtos/responses/LoanPaymentListItem.ts

@@ -0,0 +1,34 @@
+import { CollectionResultStatus } from '../../../collection/enums/CollectionResultStatus';
+import { MechanismType } from '../../../collection/enums/MechanismType';
+import { CurrencyId } from '../../../currency/enums/CurrencyId';
+
+/** Un pago del historial de un crédito, tal como lo asentó el motor de cobro en `LoanPayment_GT`. */
+export interface LoanPaymentListItem {
+    paymentId: string;
+    /** Folio del pago — la referencia de conciliación. */
+    receipt: string;
+    installmentNumber: number;
+    attemptId: string;
+    mechanism: MechanismType;
+    result: CollectionResultStatus;
+    currency: CurrencyId;
+    collectedCents: number;
+    /** Lo que de verdad se abonó a la cuota. */
+    appliedCents: number;
+    overpaidCents: number;
+    reservedCents: number;
+    needsReview: boolean;
+    appliedAt: string;
+    /** Capital que abonó este pago. Ausente en pagos anteriores al desglose (I1). */
+    appliedCapitalCents?: number;
+    /** Interés que abonó este pago. Ausente en pagos anteriores al desglose (I1). */
+    appliedInterestCents?: number;
+    /** IVA del interés que abonó este pago. Ausente en pagos anteriores al desglose (I1). */
+    appliedIvaCents?: number;
+}
+
+/** Página del historial. El fin lo marca la AUSENCIA de `nextToken`, nunca una página corta. */
+export interface LoanPaymentListResponse {
+    items: LoanPaymentListItem[];
+    nextToken?: string;
+}

package/src/loanCredit/index.ts

@@ -37,6 +37,12 @@ export * from './dtos/requests/ChangeLoanCreditStatusRequest';
 export * from './dtos/responses/LoanBorrowerResponse';
 export * from './dtos/responses/LoanCreditResponse';
 export * from './dtos/responses/LoanInstallmentResponse';
+// Lectura de cliente (I1 · retail-loan-connector): antes locales de loan-credit-business
+export * from './dtos/responses/CreditSaleContext';
+export * from './dtos/responses/LoanBorrowerCreditItem';
+export * from './dtos/responses/LoanCreditDetail';
+export * from './dtos/responses/LoanPaymentListItem';
+export * from './dtos/responses/LoanContractDownloadUrl';
 export * from './dtos/responses/LoanContractResponse';
 export * from './dtos/responses/OriginateLoanCreditResponse';
 export * from './dtos/responses/QuoteLoanCreditResponse';

package/src/retailLoanConnector/dtos/MyCreditDetail.ts

@@ -0,0 +1,22 @@
+import { MyCreditSummary } from './MyCreditSummary';
+
+/** La próxima cuota abierta. `isOverdue` si su estado en loan-credit es OVERDUE. */
+export interface MyNextInstallment {
+    number: number;
+    dueDate: string;
+    amount: number;
+    isOverdue: boolean;
+}
+
+/** Detalle de un crédito (`GET /benefits/{benefitId}/credits/{creditId}`). Montos en pesos. */
+export interface MyCreditDetail extends MyCreditSummary {
+    equipmentPrice: number;
+    downPayment: number;
+    financedAmount: number;
+    /** Tasa anual ordinaria tal como la guarda loan-credit (`tnaAnnual`). */
+    annualRate: number;
+    activatedAt?: string;
+    firstDueDate?: string;
+    lastDueDate?: string;
+    nextInstallment?: MyNextInstallment;
+}

package/src/retailLoanConnector/dtos/MyCreditSummary.ts

@@ -0,0 +1,32 @@
+import { LoanCreditStatusEnum } from '../../loanCredit/enums/LoanCreditStatusEnum';
+import { MyPaymentFrequencyEnum } from '../enums/MyPaymentFrequencyEnum';
+
+/** Equipo financiado. Cada campo puede faltar si el contexto de venta no se pudo leer. */
+export interface MyDevice {
+    brand: string | null;
+    model: string | null;
+    capacity: string | null;
+}
+
+/** Atraso del crédito. Montos en pesos. `installments` solo viene en el detalle. */
+export interface MyOverdue {
+    amount: number;
+    days: number;
+    installments?: number;
+}
+
+/**
+ * Un crédito del cliente en la lista (`GET /benefits/{benefitId}/credits`). Montos en pesos con
+ * 2 decimales (DEC-007). `remainingBalance` `null` = no aplica (crédito que nunca contrajo deuda).
+ */
+export interface MyCreditSummary {
+    creditId: string;
+    status: LoanCreditStatusEnum;
+    device: MyDevice;
+    paymentFrequency: MyPaymentFrequencyEnum;
+    installmentAmount: number;
+    totalInstallments: number;
+    paidInstallments: number;
+    remainingBalance: number | null;
+    overdue?: MyOverdue;
+}

package/src/retailLoanConnector/dtos/MyDocument.ts

@@ -0,0 +1,23 @@
+import { ContractTypeEnum } from '../../loanCredit/enums/ContractTypeEnum';
+import { MyDocumentGroupIdEnum } from '../enums/MyDocumentGroupIdEnum';
+import { MyDocumentKindEnum } from '../enums/MyDocumentKindEnum';
+import { MyDocumentStatusEnum } from '../enums/MyDocumentStatusEnum';
+
+/**
+ * Un documento del crédito. `documentRef` sigue la convención del módulo de la app:
+ * `doc-contract-<contractId>` para contratos y `doc-stmt-YYYY-MM` para estados de cuenta.
+ */
+export interface MyDocument {
+    documentRef: string;
+    kind: MyDocumentKindEnum;
+    type?: ContractTypeEnum;
+    /** `YYYY-MM`, solo en estados de cuenta. */
+    period?: string;
+    issuedAt?: string;
+    status: MyDocumentStatusEnum;
+}
+
+export interface MyDocumentGroup {
+    id: MyDocumentGroupIdEnum;
+    documents: MyDocument[];
+}

package/src/retailLoanConnector/dtos/MyDocumentUrl.ts

@@ -0,0 +1,5 @@
+/** URL prefirmada y temporal de un documento. Nunca se loguea. */
+export interface MyDocumentUrl {
+    url: string;
+    expiresAt: string;
+}

package/src/retailLoanConnector/dtos/MyInstallment.ts

@@ -0,0 +1,17 @@
+import { LoanInstallmentStatusEnum } from '../../loanCredit/enums/LoanInstallmentStatusEnum';
+import { MyInstallmentDisplayStatusEnum } from '../enums/MyInstallmentDisplayStatusEnum';
+
+/** Una cuota del calendario. Montos en pesos; `dueDate` en `YYYY-MM-DD` sin zona horaria. */
+export interface MyInstallment {
+    number: number;
+    dueDate?: string;
+    amount: number;
+    principal: number;
+    interest: number;
+    iva: number;
+    /** Lo que la cuota todavía debe. */
+    outstanding: number;
+    status: LoanInstallmentStatusEnum;
+    displayStatus: MyInstallmentDisplayStatusEnum;
+    paidAt?: string;
+}

package/src/retailLoanConnector/dtos/MyPayment.ts

@@ -0,0 +1,22 @@
+import { CollectionResultStatus } from '../../collection/enums/CollectionResultStatus';
+import { MyPaymentMethodEnum } from '../enums/MyPaymentMethodEnum';
+
+/** Un pago aplicado al crédito. Montos en pesos; el desglose falta en pagos anteriores a él. */
+export interface MyPayment {
+    paymentId: string;
+    folio: string;
+    installmentNumber: number;
+    appliedAt: string;
+    amount: number;
+    principal?: number;
+    interest?: number;
+    iva?: number;
+    method: MyPaymentMethodEnum;
+    result: CollectionResultStatus;
+}
+
+/** Página del historial de pagos. El fin lo marca la ausencia de `nextToken`. */
+export interface MyPaymentPage {
+    items: MyPayment[];
+    nextToken?: string;
+}

package/src/retailLoanConnector/enums/MyDocumentGroupIdEnum.ts

@@ -0,0 +1,5 @@
+/** Ids de grupo que exige el módulo de la app (`DocumentGroupList`): minúsculas a propósito. */
+export enum MyDocumentGroupIdEnum {
+    CONTRACT = 'contract',
+    MONTHLY = 'monthly',
+}

package/src/retailLoanConnector/enums/MyDocumentKindEnum.ts

@@ -0,0 +1,4 @@
+export enum MyDocumentKindEnum {
+    CONTRACT = 'CONTRACT',
+    MONTHLY_STATEMENT = 'MONTHLY_STATEMENT',
+}

package/src/retailLoanConnector/enums/MyDocumentStatusEnum.ts

@@ -0,0 +1,5 @@
+/** READY = el PDF existe y se puede pedir su URL; PENDING = aún no se genera. */
+export enum MyDocumentStatusEnum {
+    READY = 'READY',
+    PENDING = 'PENDING',
+}

package/src/retailLoanConnector/enums/MyInstallmentDisplayStatusEnum.ts

@@ -0,0 +1,7 @@
+/** Estado de una cuota tal como la pinta la app. NEXT = la primera abierta cuando no hay vencidas. */
+export enum MyInstallmentDisplayStatusEnum {
+    PAID = 'PAID',
+    NEXT = 'NEXT',
+    FUTURE = 'FUTURE',
+    OVERDUE = 'OVERDUE',
+}

package/src/retailLoanConnector/enums/MyPaymentFrequencyEnum.ts

@@ -0,0 +1,4 @@
+/** Frecuencia del plan. Hoy todo plan es semanal (loan-credit define el plan en `termWeeks`). */
+export enum MyPaymentFrequencyEnum {
+    WEEKLY = 'WEEKLY',
+}

package/src/retailLoanConnector/enums/MyPaymentMethodEnum.ts

@@ -0,0 +1,7 @@
+/** Con qué se cobró un pago, sin nombres de instituciones (M1_WIZARD: "cuenta Pago Confiado"). */
+export enum MyPaymentMethodEnum {
+    /** MXN_DIRECT: débito a la cuenta PagoConFiado en pesos. */
+    PCF_ACCOUNT = 'PCF_ACCOUNT',
+    /** USD_DIRECT / USD_PREAUTH: cuenta en dólares. */
+    USD_ACCOUNT = 'USD_ACCOUNT',
+}

package/src/retailLoanConnector/index.ts

@@ -0,0 +1,15 @@
+// Enums
+export * from './enums/MyInstallmentDisplayStatusEnum';
+export * from './enums/MyPaymentMethodEnum';
+export * from './enums/MyDocumentKindEnum';
+export * from './enums/MyDocumentStatusEnum';
+export * from './enums/MyDocumentGroupIdEnum';
+export * from './enums/MyPaymentFrequencyEnum';
+
+// Contrato app ↔ retail-loan-connector (I1 · fase 1: lectura)
+export * from './dtos/MyCreditSummary';
+export * from './dtos/MyCreditDetail';
+export * from './dtos/MyInstallment';
+export * from './dtos/MyPayment';
+export * from './dtos/MyDocument';
+export * from './dtos/MyDocumentUrl';