@fiado/type-kit 3.1.30 → 3.2.1

package/src/benefitCenter/dtos/BenefitCreateRequest.ts

@@ -0,0 +1,59 @@
+import {
+    IsEnum,
+    IsInt,
+    IsNotEmpty,
+    IsObject,
+    IsOptional,
+    IsString,
+    Min,
+    ValidateNested,
+} from "class-validator";
+import { Type } from "class-transformer";
+import { BenefitFlowEnum } from "../enums/BenefitFlowEnum";
+import { BenefitModuleConfigRequest } from "./BenefitModuleConfigRequest";
+
+/** Mirror enum-like de BenefitCatalogStatus en el type-kit (para validación). */
+export enum BenefitCatalogStatusEnum {
+    ACTIVE = "ACTIVE",
+    INACTIVE = "INACTIVE",
+    COMING_SOON = "COMING_SOON",
+}
+
+export class BenefitCreateRequest {
+    @IsOptional()
+    @IsString()
+    id?: string;
+
+    @IsNotEmpty()
+    @IsString()
+    name!: string;
+
+    @IsOptional()
+    @IsString()
+    description?: string;
+
+    @IsEnum(BenefitCatalogStatusEnum)
+    status!: BenefitCatalogStatusEnum;
+
+    @IsInt()
+    @Min(0)
+    sortOrder!: number;
+
+    @IsOptional()
+    @IsString()
+    icon?: string;
+
+    @IsEnum(BenefitFlowEnum)
+    flow!: BenefitFlowEnum;
+
+    @IsOptional()
+    @IsString()
+    translationKey?: string;
+
+    @ValidateNested()
+    @Type(() => BenefitModuleConfigRequest)
+    moduleConfig!: BenefitModuleConfigRequest;
+
+    @IsObject()
+    rulesVisibility!: Record<string, unknown>;
+}

package/src/benefitCenter/dtos/BenefitModuleConfigRequest.ts

@@ -0,0 +1,11 @@
+import { ArrayMinSize, IsArray, ValidateNested } from "class-validator";
+import { Type } from "class-transformer";
+import { BenefitModuleEntryRequest } from "./BenefitModuleEntryRequest";
+
+export class BenefitModuleConfigRequest {
+    @IsArray()
+    @ArrayMinSize(1)
+    @ValidateNested({ each: true })
+    @Type(() => BenefitModuleEntryRequest)
+    modules!: BenefitModuleEntryRequest[];
+}

package/src/benefitCenter/dtos/BenefitModuleEntryRequest.ts

@@ -0,0 +1,11 @@
+import { IsNotEmpty, IsString } from "class-validator";
+
+export class BenefitModuleEntryRequest {
+    @IsNotEmpty()
+    @IsString()
+    moduleEnvVar!: string;
+
+    @IsNotEmpty()
+    @IsString()
+    moduleName!: string;
+}

package/src/benefitCenter/dtos/BenefitUpdateRequest.ts

@@ -0,0 +1,34 @@
+import {
+    IsEnum,
+    IsInt,
+    IsObject,
+    IsOptional,
+    IsString,
+    Min,
+    ValidateNested,
+} from "class-validator";
+import { Type } from "class-transformer";
+import { BenefitFlowEnum } from "../enums/BenefitFlowEnum";
+import {
+    BenefitCatalogStatusEnum,
+} from "./BenefitCreateRequest";
+import { BenefitModuleConfigRequest } from "./BenefitModuleConfigRequest";
+
+export class BenefitUpdateRequest {
+    @IsOptional() @IsString() name?: string;
+    @IsOptional() @IsString() description?: string;
+    @IsOptional() @IsEnum(BenefitCatalogStatusEnum) status?: BenefitCatalogStatusEnum;
+    @IsOptional() @IsInt() @Min(0) sortOrder?: number;
+    @IsOptional() @IsString() icon?: string;
+    @IsOptional() @IsEnum(BenefitFlowEnum) flow?: BenefitFlowEnum;
+    @IsOptional() @IsString() translationKey?: string;
+
+    @IsOptional()
+    @ValidateNested()
+    @Type(() => BenefitModuleConfigRequest)
+    moduleConfig?: BenefitModuleConfigRequest;
+
+    @IsOptional()
+    @IsObject()
+    rulesVisibility?: Record<string, unknown>;
+}

package/src/benefitCenter/dtos/PublicVerifyReferenceRequest.ts

@@ -0,0 +1,33 @@
+import { IsNotEmpty, IsString, Length } from "class-validator";
+
+/**
+ * Request del endpoint público POST /benefits/{benefitId}/verificateReference del
+ * `benefits-marketplace-business`. Combina:
+ *  - Los campos de `BenefitReferenceVerificationRequest` (serviceId/productId/reference)
+ *  - Un `leafId` adicional para que el lambda del Centro sepa a qué módulo rutear
+ *    la verificación sin tener que buscar por anchor.
+ *
+ * Se expone separado de `BenefitReferenceVerificationRequest` porque éste último
+ * es el contrato DIRECTO al conector (no conoce de leafIds).
+ */
+export class PublicVerifyReferenceRequest {
+    @IsNotEmpty()
+    @IsString()
+    @Length(1, 100)
+    leafId!: string;
+
+    @IsNotEmpty()
+    @IsString()
+    @Length(1, 50)
+    serviceId!: string;
+
+    @IsNotEmpty()
+    @IsString()
+    @Length(1, 50)
+    productId!: string;
+
+    @IsNotEmpty()
+    @IsString()
+    @Length(1, 100)
+    reference!: string;
+}

package/src/benefitCenter/index.ts

@@ -25,3 +25,15 @@ export * from "./dtos/BannerItem";
 export * from "./dtos/BenefitReferenceVerificationRequest";
 export * from "./dtos/ConnectorCatalogItem";
 export * from "./dtos/ConnectorCatalogResponse";
+//Admin + public request DTOs (v3.2.1)
+export * from "./dtos/BenefitModuleEntryRequest";
+export * from "./dtos/BenefitModuleConfigRequest";
+export * from "./dtos/BenefitCreateRequest";
+export * from "./dtos/BenefitUpdateRequest";
+export * from "./dtos/BannerTranslationRequest";
+export * from "./dtos/BannerTranslationsRequest";
+export * from "./dtos/BannerContentRequest";
+export * from "./dtos/BannerActionRequest";
+export * from "./dtos/BannerCreateRequest";
+export * from "./dtos/BannerUpdateRequest";
+export * from "./dtos/PublicVerifyReferenceRequest";

package/src/credit/dtos/BannerStateResponse.ts

@@ -1,3 +1,11 @@
+/**
+ * CTA asociado al banner state (boton y accion a ejecutar).
+ */
+export class BannerCta {
+    text!: string;
+    action!: string;
+}
+
 /**
  * Respuesta del endpoint GET /credit/{partnerId}/banner-state/{directoryId}
  */
@@ -8,7 +16,18 @@ export class BannerStateResponse {
     title: string;
     subtitle: string;
     progress_pct: number | null;
-    cta: { text: string; action: string } | null;
+    cta: BannerCta | null;
     credit_level: string | null;
     max_credit_amount_mxn: number | null;
+    /** Presente cuando el banner refleja un credito activo/delinquent/defaulted. */
+    credit_id?: string | null;
+    /** Pago del proximo cupon pendiente. */
+    next_payment_amount_mxn?: number | null;
+    next_payment_date?: string | null;
+    next_coupon_number?: number | null;
+    /** Montos de cupones vencidos (solo DELINQUENT). */
+    overdue_amount_mxn?: number | null;
+    overdue_count?: number | null;
+    /** Saldo insoluto del credito activo. */
+    outstanding_balance_mxn?: number | null;
 }

package/src/credit/dtos/CreditOfferOptionItem.ts

@@ -9,4 +9,10 @@ export class CreditOfferOptionItem {
     total_interest_mxn: number;
     savings_vs_longest: number;
     is_recommended: boolean;
+    /** IVA (16%) sobre intereses del cupon. */
+    total_iva_mxn?: number;
+    /** Costo Anual Total (tasa efectiva anual de la operacion). */
+    cat?: number;
+    /** Fecha del primer pago (ISO, 7 dias desde la originacion). */
+    first_payment_date?: string;
 }

package/src/credit/dtos/EligibilityResponse.ts

@@ -2,8 +2,8 @@
  * Respuesta del endpoint GET /credit/{partnerId}/eligibility/{directoryId}
  */
 export class EligibilityResponse {
-    partner_id: string;
-    directory_id: string;
+    partner_id?: string;
+    directory_id?: string;
     is_eligible: boolean;
     credit_level: string | null;
     max_credit_amount_mxn: number | null;

package/src/creditBackoffice/dtos/BackofficeApplicationDetail.ts

@@ -0,0 +1,33 @@
+/**
+ * Row de aplicación de crédito (schema espejo de `CreditApplications_GT`).
+ * Inline aquí porque los DTOs son contratos públicos y no deben depender de
+ * tipos de infra en el repo de cada lambda.
+ */
+export class BackofficeCreditApplicationRow {
+    pk!: string;
+    sk!: string;
+    application_id?: string;
+    directory_id?: string;
+    partner_id?: string;
+    offer_id?: string;
+    status?: string;
+    amount_mxn?: number;
+    term_weeks?: number;
+    annual_rate?: number;
+    weekly_payment_mxn?: number;
+    cat?: number;
+    first_payment_date?: string;
+    contract_view_url?: string;
+    expires_at?: string;
+    signed_at?: string;
+    created_at?: string;
+    updated_at?: string;
+    /** Runtime fields set by managers but not declared in the Dynamoose schema. */
+    credit_level?: string;
+    config_version?: number;
+}
+
+export class BackofficeApplicationDetail {
+    application!: BackofficeCreditApplicationRow;
+    user!: { directory_id: string; phone_number: string; people_id: string };
+}

package/src/creditBackoffice/dtos/BackofficeApplicationsListItem.ts

@@ -0,0 +1,11 @@
+export class BackofficeApplicationsListItem {
+    application_id!: string;
+    directory_id!: string;
+    partner_id!: string;
+    phone_number!: string;
+    amount_mxn!: number;
+    term_weeks!: number;
+    status!: string;
+    signed_at!: string;
+    created_at!: string;
+}

package/src/creditBackoffice/dtos/BackofficeCreditDetail.ts

@@ -0,0 +1,78 @@
+/**
+ * Row de crédito (schema espejo de `Credits_GT`).
+ * Inline aquí porque los DTOs son contratos públicos y no deben depender de
+ * tipos de infra en el repo de cada lambda.
+ */
+export class BackofficeCreditRow {
+    pk!: string;
+    sk!: string;
+    credit_id!: string;
+    application_id?: string;
+    directory_id?: string;
+    partner_id?: string;
+    status?: string;
+    amount_mxn?: number;
+    term_weeks?: number;
+    annual_rate?: number;
+    weekly_payment_mxn?: number;
+    cat?: number;
+    total_interest_mxn?: number;
+    total_payable_mxn?: number;
+    total_iva_mxn?: number;
+    iva_rate?: number;
+    fiado_rate_points?: number;
+    loanco_rate_points?: number;
+    fiado_interest_mxn?: number;
+    loanco_interest_mxn?: number;
+    credit_level?: string;
+    disbursed_at?: string;
+    first_payment_date?: string;
+    total_collected_mxn?: number;
+    outstanding_balance_mxn?: number;
+    last_payment_date?: string;
+    created_at?: string;
+    updated_at?: string;
+    /** Runtime fields set by managers but not declared in the Dynamoose schema. */
+    config_version?: number;
+    signed_at?: string;
+}
+
+/**
+ * Row del calendario de pagos (schema espejo de `CreditPaymentSchedule_GT`).
+ * Inline aquí porque los DTOs son contratos públicos.
+ */
+export class BackofficeCreditPaymentScheduleRow {
+    pk!: string;
+    sk!: string;
+    credit_id?: string;
+    coupon_number!: number;
+    due_date?: string;
+    principal_mxn?: number;
+    interest_mxn?: number;
+    iva_mxn?: number;
+    total_mxn?: number;
+    fiado_interest_mxn?: number;
+    loanco_interest_mxn?: number;
+    remaining_balance_mxn?: number;
+    status?: string;
+    paid_amount_mxn?: number;
+    principal_collected_mxn?: number;
+    interest_collected_mxn?: number;
+    iva_collected_mxn?: number;
+    fiado_interest_collected_mxn?: number;
+    loanco_interest_collected_mxn?: number;
+    anticipated_reduction_mxn?: number;
+    collection_attempts?: number;
+    last_collection_date?: string;
+    paid_at?: string;
+    created_at?: string;
+    updated_at?: string;
+    /** Runtime field used during settlement. */
+    settlement_adjustment_mxn?: number;
+}
+
+export class BackofficeCreditDetail {
+    credit!: BackofficeCreditRow;
+    user!: { directory_id: string; phone_number: string; people_id: string };
+    schedule!: BackofficeCreditPaymentScheduleRow[];
+}

package/src/creditBackoffice/dtos/BackofficeCreditsListItem.ts

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

package/src/creditBackoffice/dtos/BackofficeIncomeSourceItem.ts

@@ -0,0 +1,13 @@
+export class BackofficeIncomeSourceItem {
+    normalized_memo!: string;
+    classification!: string;
+    detected_frequency!: string;
+    total_deposits_90d!: number;
+    total_amount_90d_usd!: number;
+    average_amount_usd!: number;
+    reliable_amount_usd!: number;
+    income_share_pct!: number;
+    avg_days_between_deposits!: number;
+    first_detection!: string;
+    last_detection!: string;
+}

package/src/creditBackoffice/dtos/BackofficeOfferDetail.ts

@@ -0,0 +1,29 @@
+/**
+ * Row de oferta de crédito (schema espejo de `CreditOffers_GT`).
+ * Inline aquí porque los DTOs son contratos públicos y no deben depender de
+ * tipos de infra en el repo de cada lambda.
+ */
+export class BackofficeCreditOfferRow {
+    pk!: string;
+    sk!: string;
+    offer_id?: string;
+    directory_id?: string;
+    partner_id?: string;
+    status?: string;
+    credit_level?: string;
+    max_amount_mxn?: number;
+    selected_amount_mxn?: number;
+    offer_expires_at?: string;
+    options?: Record<string, unknown>[];
+    created_at?: string;
+    updated_at?: string;
+    /** Runtime fields set by managers but not declared in the Dynamoose schema. */
+    min_amount_mxn?: number;
+    available_rates?: { term_weeks: number; annual_rate: number }[];
+    config_version?: number;
+}
+
+export class BackofficeOfferDetail {
+    offer!: BackofficeCreditOfferRow;
+    user!: { directory_id: string; phone_number: string; people_id: string };
+}

package/src/creditBackoffice/dtos/BackofficeOffersListItem.ts

@@ -0,0 +1,13 @@
+export class BackofficeOffersListItem {
+    offer_id!: string;
+    directory_id!: string;
+    partner_id!: string;
+    phone_number!: string;
+    credit_level!: string;
+    max_amount_mxn!: number;
+    min_amount_mxn!: number;
+    available_rates!: { term_weeks: number; annual_rate: number }[];
+    status!: string;
+    offer_expires_at!: string;
+    created_at!: string;
+}

package/src/creditBackoffice/dtos/BackofficePagination.ts

@@ -0,0 +1,6 @@
+export class BackofficePagination {
+    page!: number;
+    page_size!: number;
+    total_items!: number;
+    total_pages!: number;
+}

package/src/creditBackoffice/dtos/BackofficePipeline.ts

@@ -0,0 +1,9 @@
+import { BackofficePipelineByLevel } from "./BackofficePipelineByLevel";
+
+export class BackofficePipeline {
+    eligible_count!: number;
+    total_potential_mxn!: number;
+    avg_potential_mxn!: number;
+    by_level!: BackofficePipelineByLevel[];
+    by_banner_state!: { state: string; count: number }[];
+}

package/src/creditBackoffice/dtos/BackofficePipelineByLevel.ts

@@ -0,0 +1,6 @@
+export class BackofficePipelineByLevel {
+    level!: string;
+    count!: number;
+    total_potential_mxn!: number;
+    avg_potential_mxn!: number;
+}

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[];
+}