@fiado/type-kit 3.455.0 → 3.457.0

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';