@fiado/type-kit 3.490.0 → 3.492.0

package/src/retailCommission/enums/CommissionSimulationSkipEnum.ts

@@ -0,0 +1,14 @@
+/**
+ * Por qué una regla no paga en la simulación.
+ *
+ * NOT_IN_EFFECT - Fuera de su vigencia en la fecha simulada.
+ * OUT_OF_SCOPE - El producto o la tienda no caen en su alcance.
+ * CONDITION_NOT_MET - Su condición no se cumple en esa posición.
+ * NO_DATA - Su condición usa un dato que todavía no existe (NPI M30).
+ */
+export enum CommissionSimulationSkipEnum {
+    NOT_IN_EFFECT = 'NOT_IN_EFFECT',
+    OUT_OF_SCOPE = 'OUT_OF_SCOPE',
+    CONDITION_NOT_MET = 'CONDITION_NOT_MET',
+    NO_DATA = 'NO_DATA',
+}

package/src/retailCommission/enums/CommissionWindowEnum.ts

@@ -0,0 +1,12 @@
+/**
+ * Ventana del corte de comisiones.
+ *
+ * SEMANA_OPERATIVA - Semana operativa de la cadena.
+ * ROLLING_7D - Últimos 7 días.
+ * MES - Mes calendario.
+ */
+export enum CommissionWindowEnum {
+    SEMANA_OPERATIVA = 'SEMANA_OPERATIVA',
+    ROLLING_7D = 'ROLLING_7D',
+    MES = 'MES',
+}

package/src/retailCommission/index.ts

@@ -12,9 +12,19 @@ export * from './enums/CommissionPayoutStatusEnum';
 export * from './enums/CommissionPayeeTypeEnum';
 export * from './enums/CommissionExceptionTypeEnum';
 export * from './enums/CommissionCalcStepEnum';
+export * from './enums/CommissionRuleStatusEnum';
+export * from './enums/CommissionBonusModeEnum';
+export * from './enums/CommissionMetricEnum';
+export * from './enums/CommissionOperatorEnum';
+export * from './enums/CommissionWindowEnum';
+export * from './enums/CommissionAggregateByEnum';
+export * from './enums/CommissionSeriesByEnum';
+export * from './enums/CommissionSimulationSkipEnum';
 
 // Entidades del dominio
 export * from './dtos/CommissionPlan';
+export * from './dtos/CommissionRule';
+export * from './dtos/CommissionCouponAccrual';
 export * from './dtos/CommissionCalcTrace';
 export * from './dtos/CommissionAccrual';
 export * from './dtos/CommissionPayout';

package/src/retailLoan/dtos/CreateMyPaymentRequest.ts

@@ -1,5 +1,5 @@
 import { Expose } from 'class-transformer';
-import { IsEnum, IsNumber, IsPositive } from 'class-validator';
+import { IsEnum, IsInt, IsNumber, IsOptional, IsPositive, Min } from 'class-validator';
 import { MyPaymentTypeEnum } from '../enums/MyPaymentTypeEnum';
 
 /** Body de `POST /benefits/{benefitId}/credits/{creditId}/payments`. La llave va en el header `Idempotency-Key`. */
@@ -8,9 +8,16 @@ export class CreateMyPaymentRequest {
     @IsEnum(MyPaymentTypeEnum)
     type!: MyPaymentTypeEnum;
 
-    /** Monto en pesos que vio el cliente; si ya no coincide, responde PAYMENT_AMOUNT_CHANGED. */
+    /** Monto en pesos que vio el cliente (en PREPAYMENT, el que eligió); si ya no coincide, responde PAYMENT_AMOUNT_CHANGED. */
     @Expose()
     @IsNumber({ maxDecimalPlaces: 2 })
     @IsPositive()
     expectedAmount!: number;
+
+    /** Solo ADVANCE: cuántas cuotas adelanta. */
+    @Expose()
+    @IsOptional()
+    @IsInt()
+    @Min(2)
+    installmentCount?: number;
 }

package/src/retailLoan/dtos/CreateMyPaymentResponse.ts

@@ -7,4 +7,6 @@ export interface CreateMyPaymentResponse {
     type: MyPaymentTypeEnum;
     amount: number;
     collection: MyCollectionOutcomeEnum;
+    /** Solo ADVANCE: cuántas cuotas cubre. */
+    installmentCount?: number;
 }

package/src/retailLoan/dtos/MyPaymentOptions.ts

@@ -9,17 +9,41 @@ export interface MyPaymentOption {
     amount?: number;
 }
 
+/** Una cuota que se puede adelantar. `amount` en pesos. */
+export interface MyAdvanceInstallment {
+    installmentNumber: number;
+    /** `YYYY-MM-DD`. */
+    dueDate: string;
+    amount: number;
+}
+
 /** Opciones de pago de un crédito (`GET /benefits/{benefitId}/credits/{creditId}/payment-options`). Montos en pesos. */
 export interface MyPaymentOptions {
     /** Pago en curso; mientras exista, ninguna opción está disponible. */
-    pendingPayment?: { type: MyPaymentTypeEnum; amount: number };
+    pendingPayment?: {
+        type: MyPaymentTypeEnum;
+        amount: number;
+        /** Solo en varias cuotas: las cuotas que cubre. */
+        installmentNumbers?: number[];
+    };
     nextInstallment: MyPaymentOption & {
         mode?: MyNextInstallmentModeEnum;
         installmentNumber?: number;
         /** `YYYY-MM-DD`. */
         dueDate?: string;
     };
-    advance: MyPaymentOption;
+    /** Varias cuotas. `installments` trae las `maxInstallments` que se pueden adelantar, en orden. */
+    advance: MyPaymentOption & {
+        minInstallments?: number;
+        maxInstallments?: number;
+        installments?: MyAdvanceInstallment[];
+    };
+    /** Abono a capital: monto libre entre `minAmount` y `maxAmount`. */
+    prepayment: MyPaymentOption & {
+        minAmount?: number;
+        maxAmount?: number;
+        outstandingCapital?: number;
+    };
     settlement: MyPaymentOption & {
         breakdown?: { overdue: number; capital: number; interest: number; iva: number };
         savings?: number;

package/src/retailLoan/enums/MyPaymentTypeEnum.ts

@@ -1,6 +1,7 @@
-/** Pago que el cliente pide desde la app. `ADVANCE` = varias cuotas. */
+/** Pago que el cliente pide desde la app. `ADVANCE` = varias cuotas; `PREPAYMENT` = abono a capital. */
 export enum MyPaymentTypeEnum {
     NEXT_INSTALLMENT = 'NEXT_INSTALLMENT',
     ADVANCE = 'ADVANCE',
     SETTLEMENT = 'SETTLEMENT',
+    PREPAYMENT = 'PREPAYMENT',
 }

package/src/retailWizard/enums/RetailCommissionInboundMessageTypeEnum.ts

@@ -0,0 +1,5 @@
+/** Tipo de mensaje que el wizard publica en la cola de Comisiones. */
+export enum RetailCommissionInboundMessageTypeEnum {
+    SALE_COMPLETED = 'SALE_COMPLETED',
+    SALE_CANCELLED = 'SALE_CANCELLED',
+}

package/src/retailWizard/events/RetailCommissionInboundMessage.ts

@@ -1,9 +1,31 @@
 import { Type } from 'class-transformer';
-import { ArrayMinSize, IsArray, IsEnum, IsISO8601, IsInt, IsNotEmpty, IsString, Min, ValidateNested } from 'class-validator';
+import {
+    ArrayMinSize,
+    IsArray,
+    IsEnum,
+    IsISO8601,
+    IsInt,
+    IsNotEmpty,
+    IsOptional,
+    IsString,
+    Min,
+    ValidateNested,
+} from 'class-validator';
 import { ItemTypeEnum } from '../../retailCatalog/enums/ItemTypeEnum';
+import { ProductCategoryEnum } from '../../retailCatalog/enums/ProductCategoryEnum';
+import { ProductTierEnum } from '../../retailCatalog/enums/ProductTierEnum';
+import { ExternalProviderEnum } from '../enums/ExternalProviderEnum';
+import { LinePaymentTypeEnum } from '../enums/LinePaymentTypeEnum';
+import { RetailCommissionInboundMessageTypeEnum } from '../enums/RetailCommissionInboundMessageTypeEnum';
+import { SaleTypeEnum } from '../enums/SaleTypeEnum';
+import { WizardLineRoleEnum } from '../enums/WizardLineRoleEnum';
 
 /** Línea vendida en el mensaje de comisiones. */
 export class RetailCommissionInboundLine {
+    @IsString()
+    @IsNotEmpty()
+    lineId!: string;
+
     @IsString()
     @IsNotEmpty()
     sku!: string;
@@ -19,10 +41,34 @@ export class RetailCommissionInboundLine {
 
     @IsEnum(ItemTypeEnum)
     itemType!: ItemTypeEnum;
+
+    /** `null` si la línea no trae la ficha del producto. */
+    @IsOptional()
+    @IsEnum(ProductCategoryEnum)
+    category!: ProductCategoryEnum | null;
+
+    /** `null` = sin gama. */
+    @IsOptional()
+    @IsEnum(ProductTierEnum)
+    tier!: ProductTierEnum | null;
+
+    @IsOptional()
+    @IsString()
+    brand!: string | null;
+
+    @IsEnum(LinePaymentTypeEnum)
+    paymentType!: LinePaymentTypeEnum;
+
+    @IsOptional()
+    @IsEnum(WizardLineRoleEnum)
+    role?: WizardLineRoleEnum;
 }
 
-/** Venta de la saga que el wizard publica en la cola de comisiones, con sus líneas. */
+/** Venta cerrada o cancelada que el wizard publica en RetailCommissionInboundQueue. */
 export class RetailCommissionInboundMessage {
+    @IsEnum(RetailCommissionInboundMessageTypeEnum)
+    type!: RetailCommissionInboundMessageTypeEnum;
+
     @IsString()
     @IsNotEmpty()
     tenantId!: string;
@@ -43,9 +89,36 @@ export class RetailCommissionInboundMessage {
     @IsNotEmpty()
     sessionId!: string;
 
+    /** Quién vendió. */
+    @IsString()
+    @IsNotEmpty()
+    sellerRetailUserId!: string;
+
+    @IsEnum(SaleTypeEnum)
+    saleType!: SaleTypeEnum;
+
+    /** Solo en EXTERNAL_REFERRAL. */
+    @IsOptional()
+    @IsEnum(ExternalProviderEnum)
+    externalProvider!: ExternalProviderEnum | null;
+
+    @IsOptional()
+    @IsString()
+    @IsNotEmpty()
+    creditId!: string | null;
+
     @IsISO8601()
     soldAt!: string;
 
+    /** soldAt en la venta; cancelledAt en la cancelación. */
+    @IsISO8601()
+    occurredAt!: string;
+
+    /** Motivo de la cancelación; puede venir vacío. */
+    @IsOptional()
+    @IsString()
+    cancelReason?: string;
+
     @IsArray()
     @ArrayMinSize(1)
     @ValidateNested({ each: true })

package/src/retailWizard/index.ts

@@ -166,6 +166,7 @@ export * from './events/SaleCompletedV2';
 export * from './events/SaleCancelledV2';
 export * from './events/SessionExpiredV1';
 export * from './enums/RetailPromotionInboundMessageTypeEnum';
+export * from './enums/RetailCommissionInboundMessageTypeEnum';
 export * from './events/RetailPromotionInboundMessage';
 export * from './events/RetailCommissionInboundMessage';