@fiado/type-kit 3.564.0 → 3.566.0

package/src/retailWizard/dtos/responses/BackofficeCustomerReferralsResponse.ts

@@ -0,0 +1,63 @@
+import { ReferralRoleEnum } from '../../../retailCustomer/enums/ReferralRoleEnum';
+import { ReferralSourceEnum } from '../../../retailCustomer/enums/ReferralSourceEnum';
+import { ReferralStatusEnum } from '../../../retailCustomer/enums/ReferralStatusEnum';
+import { ReferralRewardStatusEnum } from '../../../retailPromotions/enums/ReferralRewardStatusEnum';
+import { ReferralRewardTypeEnum } from '../../../retailPromotions/enums/ReferralRewardTypeEnum';
+
+/** Premio de referido que muestra el cajón. */
+export interface BackofficeReferralReward {
+    promotionId: string;
+    promotionName: string;
+    role: ReferralRoleEnum;
+    rewardType: ReferralRewardTypeEnum;
+    amountCents: number | null;
+    status: ReferralRewardStatusEnum;
+    /** Fecha del estado: pago, reserva o anulación. */
+    statusAt: string;
+}
+
+/** Dónde, cuándo y quién capturó el referido. */
+export interface BackofficeReferralCapture {
+    source: ReferralSourceEnum;
+    /** `null` si se agregó en el cajón. */
+    storeId: string | null;
+    storeName: string | null;
+    /** Solo en `SALE`. */
+    saleId: string | null;
+    saleFolio: string | null;
+    /** Solo en `OPENING`. */
+    accountOpeningSessionId: string | null;
+    capturedBy: string;
+    capturedAt: string;
+}
+
+/** Referido del cliente en el cajón. */
+export interface BackofficeCustomerReferral {
+    referralId: string;
+    name: string;
+    phone: string;
+    email: string | null;
+    status: ReferralStatusEnum;
+    capture: BackofficeReferralCapture;
+    updatedBy: string;
+    updatedAt: string;
+    /** Premios de quien recomienda por este referido; ausente si la ruta aún no los consulta. */
+    rewards?: BackofficeReferralReward[];
+}
+
+/** Quién recomendó al cliente y, opcional, lo que ganó él. */
+export interface BackofficeReferredBy {
+    referralId: string;
+    referrerCustomerId: string;
+    referrerName: string;
+    referredAt: string;
+    /** Premios del cliente como recomendado, con su promo. */
+    rewards?: BackofficeReferralReward[];
+}
+
+/** GET /backoffice/customers/{retailCustomerId}/referrals — pestaña Referidos del cajón. */
+export interface BackofficeCustomerReferralsResponse {
+    referrals: BackofficeCustomerReferral[];
+    /** `null` si el cliente no llegó recomendado. */
+    referredBy: BackofficeReferredBy | null;
+}

package/src/retailWizard/enums/RetailPromotionInboundMessageTypeEnum.ts

@@ -1,5 +1,7 @@
-/** Tipo de mensaje que el wizard publica en la cola de Promociones. */
+/** Tipo de mensaje en la cola de Promociones: venta y apertura los publica el wizard; la cuota, loan-credit. */
 export enum RetailPromotionInboundMessageTypeEnum {
     SALE_CONFIRMED = 'SALE_CONFIRMED',
     SALE_CANCELLED = 'SALE_CANCELLED',
+    ACCOUNT_OPENED = 'ACCOUNT_OPENED',
+    CREDIT_INSTALLMENT_PAID = 'CREDIT_INSTALLMENT_PAID',
 }

package/src/retailWizard/enums/WizardStepEnum.ts

@@ -10,4 +10,6 @@ export enum WizardStepEnum {
     S08 = 'S08',
     S09 = 'S09',
     S10 = 'S10',
+    /** Referidos: tras firma o cobro en la venta, tras cuenta abierta en la apertura; el orden lo da el camino. */
+    S11 = 'S11',
 }

package/src/retailWizard/events/RetailCommissionInboundMessage.ts

@@ -70,6 +70,17 @@ export class RetailCommissionInboundLine {
     phoneCount?: number;
 }
 
+/** Referido capturado en la venta, con quien lo capturó para su comisión. */
+export class RetailCommissionInboundReferral {
+    @IsString()
+    @IsNotEmpty()
+    referralId!: string;
+
+    @IsString()
+    @IsNotEmpty()
+    capturedBy!: string;
+}
+
 /** Venta cerrada o cancelada que el wizard publica en RetailCommissionInboundQueue. */
 export class RetailCommissionInboundMessage {
     @IsEnum(RetailCommissionInboundMessageTypeEnum)
@@ -130,4 +141,11 @@ export class RetailCommissionInboundMessage {
     @ValidateNested({ each: true })
     @Type(() => RetailCommissionInboundLine)
     lines!: RetailCommissionInboundLine[];
+
+    /** Referidos capturados en la venta; ausente en mensajes viejos. */
+    @IsOptional()
+    @IsArray()
+    @ValidateNested({ each: true })
+    @Type(() => RetailCommissionInboundReferral)
+    referrals?: RetailCommissionInboundReferral[];
 }

package/src/retailWizard/events/RetailPromotionAccountOpenedMessage.ts

@@ -0,0 +1,38 @@
+import { Equals, IsISO8601, IsNotEmpty, IsString } from 'class-validator';
+import { RetailPromotionInboundMessageTypeEnum } from '../enums/RetailPromotionInboundMessageTypeEnum';
+
+/** Cuenta PCF que quedó OPEN (LINKED no cuenta); el wizard la publica en RetailPromotionInboundQueue. */
+export class RetailPromotionAccountOpenedMessage {
+    @Equals(RetailPromotionInboundMessageTypeEnum.ACCOUNT_OPENED)
+    type!: RetailPromotionInboundMessageTypeEnum.ACCOUNT_OPENED;
+
+    @IsString()
+    @IsNotEmpty()
+    tenantId!: string;
+
+    @IsString()
+    @IsNotEmpty()
+    retailerId!: string;
+
+    @IsString()
+    @IsNotEmpty()
+    storeId!: string;
+
+    /** El retailCustomerId de quien abrió la cuenta. */
+    @IsString()
+    @IsNotEmpty()
+    customerId!: string;
+
+    /** Teléfono a 10 dígitos: con él se busca al referidor. */
+    @IsString()
+    @IsNotEmpty()
+    phone!: string;
+
+    /** Sesión del wizard donde se abrió la cuenta. */
+    @IsString()
+    @IsNotEmpty()
+    sessionId!: string;
+
+    @IsISO8601()
+    openedAt!: string;
+}

package/src/retailWizard/events/RetailPromotionInboundMessage.ts

@@ -4,6 +4,7 @@ import {
     IsArray,
     IsBoolean,
     IsEnum,
+    IsIn,
     IsISO8601,
     IsInt,
     IsNotEmpty,
@@ -14,7 +15,10 @@ import {
 } from 'class-validator';
 import { LinePromotionAmount } from '../../retailPromotions/dtos/LinePromotionAmount';
 import { SalePromotionRef } from '../../retailPromotions/dtos/SalePromotionRef';
+import { ExternalProviderEnum } from '../enums/ExternalProviderEnum';
 import { RetailPromotionInboundMessageTypeEnum } from '../enums/RetailPromotionInboundMessageTypeEnum';
+import { SalePaymentMethodEnum } from '../enums/SalePaymentMethodEnum';
+import { SaleTypeEnum } from '../enums/SaleTypeEnum';
 import { WizardLineRoleEnum } from '../enums/WizardLineRoleEnum';
 
 /** Línea de la venta en el mensaje de Promociones. */
@@ -90,9 +94,14 @@ export class RetailPromotionInboundLine {
     returned?: boolean;
 }
 
+const SALE_MESSAGE_TYPES = [
+    RetailPromotionInboundMessageTypeEnum.SALE_CONFIRMED,
+    RetailPromotionInboundMessageTypeEnum.SALE_CANCELLED,
+];
+
 /** Venta confirmada o cancelada que el wizard publica en RetailPromotionInboundQueue; crédito = trae creditId. */
 export class RetailPromotionInboundMessage {
-    @IsEnum(RetailPromotionInboundMessageTypeEnum)
+    @IsIn(SALE_MESSAGE_TYPES)
     type!: RetailPromotionInboundMessageTypeEnum;
 
     @IsString()
@@ -159,4 +168,37 @@ export class RetailPromotionInboundMessage {
     @ValidateNested({ each: true })
     @Type(() => RetailPromotionInboundLine)
     lines!: RetailPromotionInboundLine[];
+
+    /** Forma de pago; ausente en mensajes viejos. */
+    @IsOptional()
+    @IsEnum(SaleTypeEnum)
+    saleType?: SaleTypeEnum;
+
+    /** Medio de cobro, solo en contado. */
+    @IsOptional()
+    @IsEnum(SalePaymentMethodEnum)
+    paymentMethod?: SalePaymentMethodEnum | null;
+
+    /** Financiera externa, solo en `EXTERNAL_REFERRAL`. */
+    @IsOptional()
+    @IsEnum(ExternalProviderEnum)
+    externalProvider?: ExternalProviderEnum | null;
+
+    /** Precio del equipo en centavos; en crédito no es el enganche. */
+    @IsOptional()
+    @IsInt()
+    @Min(0)
+    amountCents?: number;
+
+    /** 1 + ventas no canceladas del cliente en la cadena. */
+    @IsOptional()
+    @IsInt()
+    @Min(1)
+    purchaseNumber?: number;
+
+    /** Teléfono del cliente a 10 dígitos. */
+    @IsOptional()
+    @IsString()
+    @IsNotEmpty()
+    phone?: string;
 }

package/src/retailWizard/events/RetailPromotionInstallmentPaidMessage.ts

@@ -0,0 +1,53 @@
+import { Equals, IsBoolean, IsEnum, IsISO8601, IsInt, IsNotEmpty, IsString, Min } from 'class-validator';
+import { LoanInstallmentStatusEnum } from '../../loanCredit/enums/LoanInstallmentStatusEnum';
+import { RetailPromotionInboundMessageTypeEnum } from '../enums/RetailPromotionInboundMessageTypeEnum';
+
+/** Cuota pagada que loan-credit publica en RetailPromotionInboundQueue: `InstallmentPaidV1` + contexto. Sin PII. */
+export class RetailPromotionInstallmentPaidMessage {
+    @Equals(RetailPromotionInboundMessageTypeEnum.CREDIT_INSTALLMENT_PAID)
+    type!: RetailPromotionInboundMessageTypeEnum.CREDIT_INSTALLMENT_PAID;
+
+    @IsString()
+    @IsNotEmpty()
+    tenantId!: string;
+
+    @IsString()
+    @IsNotEmpty()
+    creditId!: string;
+
+    @IsInt()
+    @Min(1)
+    installmentNumber!: number;
+
+    /** Lo pagado de la cuota en total, en centavos. */
+    @IsInt()
+    @Min(0)
+    paidCents!: number;
+
+    @IsISO8601()
+    paidAt!: string;
+
+    @IsEnum(LoanInstallmentStatusEnum)
+    installmentStatus!: LoanInstallmentStatusEnum;
+
+    @IsString()
+    @IsNotEmpty()
+    paymentId!: string;
+
+    @IsString()
+    @IsNotEmpty()
+    wizardSessionId!: string;
+
+    @IsString()
+    @IsNotEmpty()
+    storeId!: string;
+
+    /** Pagada a más tardar en su vencimiento. */
+    @IsBoolean()
+    onTime!: boolean;
+
+    /** Cuotas seguidas a tiempo hasta esta, incluida; 0 si esta fue tarde. */
+    @IsInt()
+    @Min(0)
+    onTimeStreak!: number;
+}

package/src/retailWizard/events/RetailPromotionQueueMessage.ts

@@ -0,0 +1,9 @@
+import { RetailPromotionAccountOpenedMessage } from './RetailPromotionAccountOpenedMessage';
+import { RetailPromotionInboundMessage } from './RetailPromotionInboundMessage';
+import { RetailPromotionInstallmentPaidMessage } from './RetailPromotionInstallmentPaidMessage';
+
+/** Cualquier mensaje de RetailPromotionInboundQueue; el `type` dice cuál clase validar. */
+export type RetailPromotionQueueMessage =
+    | RetailPromotionInboundMessage
+    | RetailPromotionAccountOpenedMessage
+    | RetailPromotionInstallmentPaidMessage;

package/src/retailWizard/index.ts

@@ -182,6 +182,7 @@ export * from './enums/SellerTableSourceStatusEnum';
 export * from './dtos/responses/BackofficeSellerTableResponse';
 export * from './dtos/responses/BackofficeCustomerTableResponse';
 export * from './dtos/responses/BackofficeAccountOpeningsResponse';
+export * from './dtos/responses/BackofficeCustomerReferralsResponse';
 export * from './enums/StoreKindEnum';
 export * from './dtos/responses/BackofficeStoreTableResponse';
 export * from './enums/StoreMixCategoryEnum';
@@ -196,6 +197,9 @@ export * from './events/SessionExpiredV1';
 export * from './enums/RetailPromotionInboundMessageTypeEnum';
 export * from './enums/RetailCommissionInboundMessageTypeEnum';
 export * from './events/RetailPromotionInboundMessage';
+export * from './events/RetailPromotionAccountOpenedMessage';
+export * from './events/RetailPromotionInstallmentPaidMessage';
+export * from './events/RetailPromotionQueueMessage';
 export * from './events/RetailCommissionInboundMessage';
 
 // Lookup privado por lote (GET /private/wizard-sessions/batch)