@fiado/type-kit 3.1.30 → 3.2.0

package/src/creditBackoffice/dtos/BackofficeProfileDetail.ts

@@ -0,0 +1,79 @@
+/**
+ * Detalle de perfil enriquecido con información de directorio.
+ *
+ * Nota: en el lambda este tipo es una intersección de `CreditFinancialProfileRow` con
+ * `{ people_id, phone_number }`. Aquí se inlinea todo el shape del profile para no
+ * depender de tipos de infra.
+ */
+export class BackofficeProfileDetail {
+    pk?: string;
+    sk?: string;
+    directory_id?: string;
+    partner_id?: string;
+    calculation_date?: string;
+    // Income
+    total_income_sources?: number;
+    primary_sources?: number;
+    secondary_sources?: number;
+    has_regular_income?: string;
+    total_income_90d_usd?: number;
+    monthly_income_usd?: number;
+    primary_income_usd?: number;
+    secondary_income_usd?: number;
+    dominant_frequency?: string;
+    days_since_last_deposit?: number;
+    primary_amount_variation_pct?: number;
+    // Expenses
+    total_expenses_90d_usd?: number;
+    monthly_expenses_usd?: number;
+    expense_income_ratio?: number;
+    // Wallet loads
+    sends_to_mexico_wallet?: string;
+    total_wallet_loads_90d_usd?: number;
+    monthly_wallet_loads_usd?: number;
+    wallet_load_count_90d?: number;
+    avg_wallet_load_usd?: number;
+    wallet_load_income_ratio?: number;
+    days_since_last_wallet_load?: number;
+    wallet_load_frequency?: string;
+    // Balance
+    current_balance_usd?: number;
+    average_balance_90d_usd?: number;
+    balance_income_ratio?: number;
+    // Seniority
+    registration_date?: string;
+    months_in_platform?: number;
+    // Exchange rate
+    exchange_rate_usd_mxn?: number;
+    monthly_income_mxn?: number;
+    // Scores
+    score_income_stability?: number;
+    score_payment_capacity?: number;
+    score_mexico_transfers?: number;
+    score_seniority?: number;
+    score_income_level?: number;
+    score_total?: number;
+    // Level & Credit
+    credit_level?: string;
+    max_credit_amount_mxn?: number;
+    has_active_credit?: string;
+    is_eligible?: string;
+    ineligibility_reason?: string;
+    // Gamification
+    score_to_next_level?: number;
+    next_level?: string;
+    next_level_max_credit_mxn?: number;
+    progress_pct?: number;
+    recommendation_1?: string;
+    recommendation_1_points?: number;
+    recommendation_2?: string;
+    recommendation_2_points?: number;
+    last_level_change_date?: string;
+    level_change_direction?: string;
+    // Audit
+    created_at?: string;
+    updated_at?: string;
+    // Directory enrichment
+    people_id!: string | null;
+    phone_number!: string | null;
+}

package/src/creditBackoffice/dtos/BackofficeProfilesListItem.ts

@@ -0,0 +1,17 @@
+export class BackofficeProfilesListItem {
+    directory_id!: string;
+    partner_id!: string;
+    phone_number!: string;
+    credit_level!: string;
+    score_total!: number;
+    is_eligible!: string;
+    ineligibility_reason!: string | null;
+    max_credit_amount_mxn!: number;
+    monthly_income_mxn!: number;
+    has_regular_income!: string;
+    dominant_frequency!: string;
+    total_income_sources!: number;
+    days_since_last_deposit!: number;
+    calculation_date!: string;
+    banner_state!: string;
+}

package/src/creditBackoffice/dtos/BackofficeProfilesListResponse.ts

@@ -0,0 +1,7 @@
+import { BackofficeProfilesListItem } from "./BackofficeProfilesListItem";
+import { BackofficePagination } from "./BackofficePagination";
+
+export class BackofficeProfilesListResponse {
+    items!: BackofficeProfilesListItem[];
+    pagination!: BackofficePagination;
+}

package/src/creditBackoffice/dtos/BackofficeProfilesSummary.ts

@@ -0,0 +1,12 @@
+import { BackofficePipeline } from "./BackofficePipeline";
+
+export class BackofficeProfilesSummary {
+    total_profiles!: number;
+    eligible_count!: number;
+    ineligible_count!: number;
+    by_level!: { level: string; count: number; eligible: number; ineligible: number }[];
+    score_distribution!: { range: string; count: number }[];
+    avg_score!: number;
+    avg_max_credit_mxn!: number;
+    pipeline!: BackofficePipeline;
+}

package/src/creditBackoffice/dtos/ConfigSnapshotListItem.ts

@@ -0,0 +1,10 @@
+/**
+ * Item de lista de snapshots de configuración.
+ */
+export class ConfigSnapshotListItem {
+    version?: number;
+    created_at?: string;
+    created_by?: string;
+    description?: string;
+    config_type_changed?: string;
+}

package/src/creditBackoffice/dtos/SimulateImpactRequest.ts

@@ -0,0 +1,18 @@
+import { IsArray, IsNotEmpty, IsString } from "class-validator";
+
+/**
+ * Request para simular el impacto de un cambio de configuración contra el universo de clientes.
+ * Endpoint: POST /backoffice/config/simulate-impact
+ */
+export class SimulateImpactRequest {
+    @IsString()
+    @IsNotEmpty()
+    partnerId!: string;
+
+    @IsString()
+    @IsNotEmpty()
+    configType!: string;
+
+    @IsArray()
+    proposedConfig!: Array<Record<string, unknown>>;
+}

package/src/creditBackoffice/dtos/SimulateImpactResult.ts

@@ -0,0 +1,41 @@
+/**
+ * Resultado de simulación de impacto de un cambio de configuración.
+ */
+export class SimulateImpactStateSnapshot {
+    total_profiles!: number;
+    eligible_count!: number;
+    eligible_pct!: number;
+    by_level!: Record<string, number>;
+    potential_portfolio_mxn!: number;
+    avg_score!: number;
+    avg_ticket_mxn!: number;
+}
+
+export class SimulateImpactMigration {
+    directory_id?: string;
+    score_before!: number;
+    score_after!: number;
+    level_before!: string;
+    level_after!: string;
+    eligible_before!: boolean;
+    eligible_after!: boolean;
+}
+
+export class SimulateImpactResult {
+    before!: SimulateImpactStateSnapshot;
+    after!: SimulateImpactStateSnapshot;
+    delta!: {
+        eligible_count: number;
+        eligible_pct: number;
+        potential_portfolio_mxn: number;
+        avg_score: number;
+        level_migrations: { upgrades: number; downgrades: number; unchanged: number };
+        eligibility_changes: { became_eligible: number; lost_eligibility: number; unchanged: number };
+    };
+    migrations!: SimulateImpactMigration[];
+}
+
+export class SimulateImpactError {
+    error!: string;
+    total_profiles!: number;
+}

package/src/creditBackoffice/dtos/SimulateInterestRequest.ts

@@ -0,0 +1,15 @@
+import { IsNotEmpty, IsNumber, IsString, Min } from "class-validator";
+
+/**
+ * Request para simular el cálculo de intereses con la configuración actual.
+ * Endpoint: POST /backoffice/config/simulate
+ */
+export class SimulateInterestRequest {
+    @IsString()
+    @IsNotEmpty()
+    partnerId!: string;
+
+    @IsNumber()
+    @Min(1)
+    amount_mxn!: number;
+}

package/src/creditBackoffice/dtos/SimulateInterestResult.ts

@@ -0,0 +1,11 @@
+import { CreditOfferOptionItem } from "../../credit/dtos/CreditOfferOptionItem";
+
+/**
+ * Resultado de simulación de interés para un monto dado.
+ */
+export class SimulateInterestResult {
+    amount_mxn!: number;
+    partner_id!: string;
+    simulated_at!: string;
+    options!: CreditOfferOptionItem[];
+}

package/src/creditBackoffice/dtos/UpdateConfigRequest.ts

@@ -0,0 +1,23 @@
+import { ArrayNotEmpty, IsArray, IsNotEmpty, IsOptional, IsString } from "class-validator";
+
+/**
+ * Request para actualizar una configuración de política de crédito.
+ * Endpoint: PUT /backoffice/config/{configType}
+ */
+export class UpdateConfigRequest {
+    @IsString()
+    @IsNotEmpty()
+    partnerId!: string;
+
+    @IsArray()
+    @ArrayNotEmpty()
+    items!: Array<Record<string, unknown>>;
+
+    @IsOptional()
+    @IsString()
+    updatedBy?: string;
+
+    @IsOptional()
+    @IsString()
+    description?: string;
+}

package/src/creditBackoffice/enums/ConfigType.ts

@@ -0,0 +1,17 @@
+/**
+ * Tipos de configuración de política de crédito que expone el backoffice.
+ * Los valores son los `sk` (sin el prefijo) de las tablas de config en DynamoDB.
+ *
+ * Se ubica en domain porque es contrato del API (path parameter público) y concepto
+ * de negocio — no un detalle de persistencia.
+ */
+export enum ConfigType {
+    ELIGIBILITY_RULES = "eligibility-rules",
+    CREDIT_LEVELS = "credit-levels",
+    INTEREST_RATES = "interest-rates",
+    SPLIT = "split",
+    EXPOSURE_LIMITS = "exposure-limits",
+    SCORES = "scores",
+    BANK_ACCOUNTS = "bank-accounts",
+    OPERATIONAL_PARAMS = "operational-params",
+}

package/src/creditBackoffice/index.ts

@@ -0,0 +1,24 @@
+// Enums
+export * from './enums/ConfigType';
+
+// DTOs
+export * from './dtos/BackofficeApplicationDetail';
+export * from './dtos/BackofficeApplicationsListItem';
+export * from './dtos/BackofficeCreditDetail';
+export * from './dtos/BackofficeCreditsListItem';
+export * from './dtos/BackofficeIncomeSourceItem';
+export * from './dtos/BackofficeOfferDetail';
+export * from './dtos/BackofficeOffersListItem';
+export * from './dtos/BackofficePagination';
+export * from './dtos/BackofficePipeline';
+export * from './dtos/BackofficePipelineByLevel';
+export * from './dtos/BackofficeProfileDetail';
+export * from './dtos/BackofficeProfilesListItem';
+export * from './dtos/BackofficeProfilesListResponse';
+export * from './dtos/BackofficeProfilesSummary';
+export * from './dtos/ConfigSnapshotListItem';
+export * from './dtos/SimulateImpactRequest';
+export * from './dtos/SimulateImpactResult';
+export * from './dtos/SimulateInterestRequest';
+export * from './dtos/SimulateInterestResult';
+export * from './dtos/UpdateConfigRequest';

package/src/creditDashboard/dtos/CohortQualityItem.ts

@@ -0,0 +1,8 @@
+export class CohortQualityItem {
+    cohort_month!: string;
+    total_credits!: number;
+    active_pct!: number;
+    delinquent_pct!: number;
+    paid_off_pct!: number;
+    default_pct!: number;
+}

package/src/creditDashboard/dtos/DashboardSummary.ts

@@ -0,0 +1,8 @@
+export class DashboardSummary {
+    total_active_credits!: number;
+    total_disbursed_mxn!: number;
+    total_applications_pending!: number;
+    total_active_offers!: number;
+    avg_credit_amount_mxn!: number;
+    avg_term_weeks!: number;
+}

package/src/creditDashboard/dtos/NurturingFunnelItem.ts

@@ -0,0 +1,5 @@
+export class NurturingFunnelItem {
+    stage!: string;
+    count!: number;
+    conversion_rate_pct!: number;
+}

package/src/creditDashboard/dtos/OriginationCompositionResult.ts

@@ -0,0 +1,5 @@
+export class OriginationCompositionResult {
+    by_level!: { level: string; count: number; pct: number }[];
+    by_term!: { term_weeks: number; count: number; pct: number }[];
+    avg_annual_rate!: number;
+}

package/src/creditDashboard/dtos/OriginationEfficiencyResult.ts

@@ -0,0 +1,8 @@
+export class OriginationEfficiencyResult {
+    avg_days_to_disburse!: number;
+    offers_expired_pct!: number;
+    offers_abandoned_pct!: number;
+    total_offers!: number;
+    total_expired!: number;
+    total_abandoned!: number;
+}

package/src/creditDashboard/dtos/OriginationMonthlyItem.ts

@@ -0,0 +1,6 @@
+export class OriginationMonthlyItem {
+    month!: string;
+    credits_originated!: number;
+    total_amount_mxn!: number;
+    avg_amount_mxn!: number;
+}

package/src/creditDashboard/dtos/OriginationSummaryResult.ts

@@ -0,0 +1,6 @@
+export class OriginationSummaryResult {
+    credits_originated!: number;
+    total_amount_mxn!: number;
+    avg_amount_mxn!: number;
+    month!: string;
+}

package/src/creditDashboard/dtos/OriginationWeeklyItem.ts

@@ -0,0 +1,7 @@
+export class OriginationWeeklyItem {
+    week!: string;
+    credits_originated!: number;
+    total_amount_mxn!: number;
+    avg_amount_mxn!: number;
+    avg_term_weeks!: number;
+}

package/src/creditDashboard/dtos/PipelineLevelRow.ts

@@ -0,0 +1,10 @@
+export class PipelineLevelRow {
+    level!: string;
+    offers!: { count: number; amount_mxn: number; avg_mxn: number };
+    applications!: { count: number; amount_mxn: number; avg_mxn: number };
+    credits!: { count: number; amount_mxn: number; avg_mxn: number };
+    conversion_pct!: number;
+    credit_status!: { active_pct: number; paid_off_pct: number; delinquent_pct: number };
+    avg_term_weeks!: number;
+    avg_annual_rate!: number;
+}

package/src/creditDashboard/dtos/PipelineWeek.ts

@@ -0,0 +1,7 @@
+import { PipelineLevelRow } from "./PipelineLevelRow";
+
+export class PipelineWeek {
+    week!: string;
+    total!: PipelineLevelRow;
+    levels!: PipelineLevelRow[];
+}

package/src/creditDashboard/dtos/PortfolioActiveItem.ts

@@ -0,0 +1,12 @@
+export class PortfolioActiveItem {
+    credit_id!: string;
+    directory_id!: string;
+    partner_id!: string;
+    amount_mxn!: number;
+    term_weeks!: number;
+    annual_rate!: number;
+    weekly_payment_mxn!: number;
+    status!: string;
+    disbursed_at!: string;
+    credit_level!: string;
+}

package/src/creditDashboard/dtos/PortfolioBalance.ts

@@ -0,0 +1,5 @@
+export class PortfolioBalance {
+    alive_credits!: number;
+    total_outstanding_mxn!: number;
+    delinquency_rate_pct!: number;
+}

package/src/creditDashboard/dtos/PortfolioBalanceMonthlyItem.ts

@@ -0,0 +1,5 @@
+export class PortfolioBalanceMonthlyItem {
+    month!: string;
+    alive_credits!: number;
+    total_outstanding_mxn!: number;
+}

package/src/creditDashboard/dtos/PortfolioByLevelItem.ts

@@ -0,0 +1,7 @@
+export class PortfolioByLevelItem {
+    level!: string;
+    credits!: number;
+    balance_mxn!: number;
+    pct_of_portfolio!: number;
+    delinquency_rate_pct!: number;
+}

package/src/creditDashboard/dtos/PortfolioResolutionItem.ts

@@ -0,0 +1,8 @@
+export class PortfolioResolutionItem {
+    month!: string;
+    paid_off!: number;
+    defaulted!: number;
+    cancelled!: number;
+    total_resolved!: number;
+    recovery_rate_pct!: number;
+}

package/src/creditDashboard/dtos/PortfolioUpcomingWeek.ts

@@ -0,0 +1,7 @@
+export class PortfolioUpcomingWeek {
+    week!: string;
+    current_amount_mxn!: number;
+    current_count!: number;
+    delinquent_amount_mxn!: number;
+    delinquent_count!: number;
+}

package/src/creditDashboard/index.ts

@@ -0,0 +1,16 @@
+export * from './dtos/CohortQualityItem';
+export * from './dtos/DashboardSummary';
+export * from './dtos/NurturingFunnelItem';
+export * from './dtos/OriginationCompositionResult';
+export * from './dtos/OriginationEfficiencyResult';
+export * from './dtos/OriginationMonthlyItem';
+export * from './dtos/OriginationSummaryResult';
+export * from './dtos/OriginationWeeklyItem';
+export * from './dtos/PipelineLevelRow';
+export * from './dtos/PipelineWeek';
+export * from './dtos/PortfolioActiveItem';
+export * from './dtos/PortfolioBalance';
+export * from './dtos/PortfolioBalanceMonthlyItem';
+export * from './dtos/PortfolioByLevelItem';
+export * from './dtos/PortfolioResolutionItem';
+export * from './dtos/PortfolioUpcomingWeek';

package/src/creditEngine/dtos/AdvancedPaymentRequest.ts

@@ -0,0 +1,15 @@
+import { IsNotEmpty, IsNumber, IsString, Min } from "class-validator";
+
+/**
+ * Request para pago adelantado: paga cupones futuros por adelantado en cascada.
+ * Endpoint: POST /{partnerId}/early-payment/advanced
+ */
+export class AdvancedPaymentRequest {
+    @IsString()
+    @IsNotEmpty()
+    credit_id!: string;
+
+    @IsNumber()
+    @Min(1)
+    amount_mxn!: number;
+}

package/src/creditEngine/dtos/AnticipatedPaymentRequest.ts

@@ -0,0 +1,15 @@
+import { IsNotEmpty, IsNumber, IsString, Min } from "class-validator";
+
+/**
+ * Request para pago anticipado: abono a capital en cascada sobre cupones pendientes.
+ * Endpoint: POST /{partnerId}/early-payment/anticipated
+ */
+export class AnticipatedPaymentRequest {
+    @IsString()
+    @IsNotEmpty()
+    credit_id!: string;
+
+    @IsNumber()
+    @Min(1)
+    amount_mxn!: number;
+}

package/src/creditEngine/dtos/CreditDetailResponse.ts

@@ -4,15 +4,29 @@
  */
 export class CreditDetailResponse {
     creditId!: string;
-    applicationId!: string;
-    directoryId!: string;
-    amountMxn!: number;
-    termWeeks!: number;
-    annualRate!: number;
-    weeklyPaymentMxn!: number;
-    status!: string;
-    nextPaymentDate!: string;
-    paidCoupons!: number;
-    totalCoupons!: number;
-    remainingBalanceMxn!: number;
+    applicationId?: string;
+    directoryId?: string;
+    amountMxn?: number;
+    termWeeks?: number;
+    annualRate?: number;
+    weeklyPaymentMxn?: number;
+    status?: string;
+    nextPaymentDate?: string;
+    paidCoupons?: number;
+    totalCoupons?: number;
+    remainingBalanceMxn?: number;
+    cat?: number | null;
+    totalInterestMxn?: number;
+    totalIvaMxn?: number;
+    totalPayableMxn?: number;
+    creditLevel?: string | null;
+    partnerId?: string;
+    disbursedAt?: string | null;
+    firstPaymentDate?: string | null;
+    lastPaymentDate?: string | null;
+    nextPaymentAmountMxn?: number | null;
+    nextCouponNumber?: number | null;
+    totalPaidMxn?: number;
+    overdueCount?: number;
+    overdueAmountMxn?: number;
 }

package/src/creditEngine/dtos/CreditOriginationRequest.ts

@@ -1,4 +1,4 @@
-import { IsNotEmpty, IsNumber, IsString, Min } from "class-validator";
+import { IsInt, IsNotEmpty, IsNumber, IsOptional, IsString, Min } from "class-validator";
 
 /**
  * Request para solicitar la originacion de un credito LOAN.
@@ -15,5 +15,15 @@ export class CreditOriginationRequest {
 
     @IsNumber()
     @Min(1)
-    selectedTermWeeks!: number;
+    amountMxn!: number;
+
+    @IsInt()
+    @Min(1)
+    termWeeks!: number;
+
+    /** @deprecated Use `termWeeks` instead. Kept for backward compatibility. */
+    @IsOptional()
+    @IsNumber()
+    @Min(1)
+    selectedTermWeeks?: number;
 }

package/src/creditEngine/dtos/CreditRequestResult.ts

@@ -0,0 +1,9 @@
+/**
+ * Resultado de requestCredit: solicitud de crédito creada con contrato pendiente de firma.
+ */
+export class CreditRequestResult {
+    applicationId!: string;
+    status!: string;
+    contractViewUrl!: string;
+    expiresAt?: string;
+}

package/src/creditEngine/dtos/CreditSignatureResult.ts

@@ -0,0 +1,8 @@
+/**
+ * Resultado de signContract: contrato firmado (DISBURSED) o rechazado (CANCELLED).
+ */
+export class CreditSignatureResult {
+    applicationId!: string;
+    status!: string;
+    creditId?: string;
+}

package/src/creditEngine/dtos/EarlyPaymentResult.ts

@@ -0,0 +1,9 @@
+/**
+ * Resultado de una operación de pago anticipado / adelantado / liquidación.
+ */
+export class EarlyPaymentResult {
+    success!: boolean;
+    amount_applied_mxn!: number;
+    new_balance_mxn!: number;
+    message!: string;
+}

package/src/creditEngine/dtos/OfferResult.ts

@@ -0,0 +1,16 @@
+/**
+ * Respuesta del endpoint de generación de oferta: lista de tasas disponibles para el usuario.
+ */
+export class OfferRate {
+    term_weeks!: number;
+    annual_rate!: number;
+}
+
+export class OfferResult {
+    offer_id!: string;
+    credit_level!: string;
+    max_amount_mxn!: number;
+    min_amount_mxn!: number;
+    available_rates!: OfferRate[];
+    expires_at!: string;
+}

package/src/creditEngine/dtos/PaymentScheduleItemResponse.ts

@@ -4,11 +4,12 @@
  */
 export class PaymentScheduleItemResponse {
     couponNumber!: number;
-    dueDate!: string;
-    principalMxn!: number;
-    interestMxn!: number;
-    totalMxn!: number;
-    status!: string;
+    dueDate?: string;
+    principalMxn?: number;
+    interestMxn?: number;
+    ivaMxn?: number;
+    totalMxn?: number;
+    status?: string;
     paidAmountMxn!: number;
-    remainingBalanceMxn!: number;
+    remainingBalanceMxn?: number;
 }

package/src/creditEngine/dtos/SettlementPaymentRequest.ts

@@ -0,0 +1,11 @@
+import { IsNotEmpty, IsString } from "class-validator";
+
+/**
+ * Request para liquidación total del crédito.
+ * Endpoint: POST /{partnerId}/early-payment/settlement
+ */
+export class SettlementPaymentRequest {
+    @IsString()
+    @IsNotEmpty()
+    credit_id!: string;
+}

package/src/creditEngine/dtos/SettlementQuote.ts

@@ -0,0 +1,14 @@
+/**
+ * Cotización para liquidación anticipada de un crédito.
+ */
+export class SettlementQuote {
+    credit_id!: string;
+    outstanding_principal_mxn!: number;
+    accrued_interest_mxn!: number;
+    accrued_iva_mxn!: number;
+    total_settlement_mxn!: number;
+    interest_saved_mxn!: number;
+    available_balance_mxn!: number;
+    has_sufficient_funds!: boolean;
+    quote_date!: string;
+}

package/src/creditEngine/index.ts

@@ -10,3 +10,11 @@ export * from './dtos/CreditSignatureRequest';
 export * from './dtos/CreditDetailResponse';
 export * from './dtos/PaymentScheduleItemResponse';
 export * from './dtos/DisbursementRequest';
+export * from './dtos/AdvancedPaymentRequest';
+export * from './dtos/AnticipatedPaymentRequest';
+export * from './dtos/SettlementPaymentRequest';
+export * from './dtos/CreditRequestResult';
+export * from './dtos/CreditSignatureResult';
+export * from './dtos/EarlyPaymentResult';
+export * from './dtos/OfferResult';
+export * from './dtos/SettlementQuote';