@fiado/type-kit 3.471.0 → 3.473.0

package/src/retailPromotions/dtos/SalePromotionLevers.ts

@@ -0,0 +1,67 @@
+import { ProductCategoryEnum } from '../../retailCatalog/enums/ProductCategoryEnum';
+import { ProductTierEnum } from '../../retailCatalog/enums/ProductTierEnum';
+import { CouponScopeEnum } from '../enums/CouponScopeEnum';
+import { GiftModeEnum } from '../enums/GiftModeEnum';
+import { DiscountValue } from './DiscountValue';
+
+/** Descuento en accesorios: % sobre los accesorios de la venta, con tope opcional en centavos. */
+export interface AccessoryDiscountLever {
+    percentBps: number;
+    maxAmountCents: number | null;
+}
+
+/** Regalo por lista (`skus`) o por gama (`category` + `maxPriceCents`); el cliente elige `chooseCount`. */
+export interface GiftLever {
+    mode: GiftModeEnum;
+    skus: string[] | null;
+    category: string | null;
+    maxPriceCents: number | null;
+    chooseCount: number;
+}
+
+/** Cupón que emite la venta: su descuento, días de vida y dónde vale. */
+export interface CouponLever extends DiscountValue {
+    validityDays: number;
+    scope: CouponScopeEnum;
+}
+
+/** Tiempo aire: `rechargeCount` recargas de `rechargeAmountCents`. */
+export interface AirtimeLever {
+    rechargeCount: number;
+    rechargeAmountCents: number;
+}
+
+/** Garantía extendida: meses extra sobre la de fábrica y su costo para el presupuesto. */
+export interface ExtendedWarrantyLever {
+    extraMonths: number;
+    costCents: number;
+}
+
+export interface WalletBonusLever {
+    amountCents: number;
+}
+
+/** Las 7 palancas; una palanca ausente o `null` no se usa. */
+export interface SalePromotionLevers {
+    deviceDiscount: DiscountValue | null;
+    accessoryDiscount: AccessoryDiscountLever | null;
+    gift: GiftLever | null;
+    coupon: CouponLever | null;
+    airtime: AirtimeLever | null;
+    extendedWarranty: ExtendedWarrantyLever | null;
+    walletBonus: WalletBonusLever | null;
+}
+
+/** Qué compra dispara la promo; cada lista `null` = sin restricción en esa dimensión. */
+export interface SalePromotionScope {
+    productCategories: ProductCategoryEnum[] | null;
+    tiers: ProductTierEnum[] | null;
+    skus: string[] | null;
+    storeIds: string[] | null;
+}
+
+/** A quién va la promo: segmentos de loan-offerings y, aparte, si exige crédito SK activo. */
+export interface SalePromotionSegmentation {
+    segmentIds: string[] | null;
+    requiresActiveSurekeepCredit: boolean;
+}

package/src/retailPromotions/dtos/SalePromotionLogEntry.ts

@@ -0,0 +1,19 @@
+import { SalePromotionLogEventEnum } from '../enums/SalePromotionLogEventEnum';
+import { SalePromotionStatusEnum } from '../enums/SalePromotionStatusEnum';
+
+/** Evento del historial de una promo. */
+export interface SalePromotionLogEntry {
+    logId: string;
+    promotionId: string;
+    promotionName: string;
+    version: number;
+    event: SalePromotionLogEventEnum;
+    fromStatus: SalePromotionStatusEnum | null;
+    toStatus: SalePromotionStatusEnum | null;
+    /** `null` = evento automático del sistema. */
+    performedByUserId: string | null;
+    /** Nombre visible del actor; «Sistema» en los automáticos. */
+    performedByName: string;
+    occurredAt: string;
+    reason: string | null;
+}

package/src/retailPromotions/dtos/requests/ChangeDiscountCodeStatusRequest.ts

@@ -0,0 +1,15 @@
+import { Expose } from 'class-transformer';
+import { IsEnum, IsOptional, IsString } from 'class-validator';
+import { DiscountCodeTransitionEnum } from '../../enums/DiscountCodeTransitionEnum';
+
+/** Body de publicChangeDiscountCodeStatus (anular un código o cupón). */
+export class ChangeDiscountCodeStatusRequest {
+    @Expose()
+    @IsEnum(DiscountCodeTransitionEnum)
+    transition!: DiscountCodeTransitionEnum;
+
+    @Expose()
+    @IsOptional()
+    @IsString()
+    reason?: string | null;
+}

package/src/retailPromotions/dtos/requests/ChangeSalePromotionStatusRequest.ts

@@ -0,0 +1,15 @@
+import { Expose } from 'class-transformer';
+import { IsEnum, IsOptional, IsString } from 'class-validator';
+import { SalePromotionTransitionEnum } from '../../enums/SalePromotionTransitionEnum';
+
+/** Body de publicChangeSalePromotionStatus; `reason` queda en el historial. */
+export class ChangeSalePromotionStatusRequest {
+    @Expose()
+    @IsEnum(SalePromotionTransitionEnum)
+    transition!: SalePromotionTransitionEnum;
+
+    @Expose()
+    @IsOptional()
+    @IsString()
+    reason?: string | null;
+}

package/src/retailPromotions/dtos/requests/CreateDiscountCodeRequest.ts

@@ -0,0 +1,71 @@
+import { Expose, Type } from 'class-transformer';
+import {
+    IsArray,
+    IsBoolean,
+    IsDefined,
+    IsEnum,
+    IsInt,
+    IsISO8601,
+    IsNotEmpty,
+    IsOptional,
+    IsString,
+    MaxLength,
+    ValidateNested,
+} from 'class-validator';
+import { PromotionAppliesToEnum } from '../../enums/PromotionAppliesToEnum';
+import { DiscountValueInput } from './DiscountValueInput';
+
+/** Body de publicCreateDiscountCode. Que el texto sea único entre los vigentes es `CODE_TEXT_TAKEN`. */
+export class CreateDiscountCodeRequest {
+    @Expose()
+    @IsString()
+    @IsNotEmpty()
+    @MaxLength(32)
+    codeText!: string;
+
+    @Expose()
+    @IsDefined()
+    @ValidateNested()
+    @Type(() => DiscountValueInput)
+    discount!: DiscountValueInput;
+
+    @Expose()
+    @IsOptional()
+    @IsISO8601()
+    validFrom?: string | null;
+
+    @Expose()
+    @IsOptional()
+    @IsISO8601()
+    validUntil?: string | null;
+
+    /** `null` = sin tope de usos. */
+    @Expose()
+    @IsOptional()
+    @IsInt()
+    maxUses?: number | null;
+
+    /** Equipos donde vale; `null` = todos. */
+    @Expose()
+    @IsOptional()
+    @IsArray()
+    @IsString({ each: true })
+    skus?: string[] | null;
+
+    @Expose()
+    @IsOptional()
+    @IsArray()
+    @IsString({ each: true })
+    storeIds?: string[] | null;
+
+    @Expose()
+    @IsOptional()
+    @IsBoolean()
+    announceInStore?: boolean;
+
+    /** Ausente = `SUREKEEP_ONLY`. */
+    @Expose()
+    @IsOptional()
+    @IsEnum(PromotionAppliesToEnum)
+    appliesTo?: PromotionAppliesToEnum;
+}

package/src/retailPromotions/dtos/requests/CreateSalePromotionRequest.ts

@@ -0,0 +1,73 @@
+import { Expose, Type } from 'class-transformer';
+import {
+    IsBoolean,
+    IsDefined,
+    IsEnum,
+    IsInt,
+    IsISO8601,
+    IsNotEmpty,
+    IsOptional,
+    IsString,
+    ValidateNested,
+} from 'class-validator';
+import { PromotionAppliesToEnum } from '../../enums/PromotionAppliesToEnum';
+import { SalePromotionLeversInput } from './SalePromotionLeversInput';
+import { SalePromotionScopeInput, SalePromotionSegmentationInput } from './SalePromotionScopeInput';
+
+/** Body de publicCreateSalePromotion. Nace en `DRAFT`; el retailer sale del token. */
+export class CreateSalePromotionRequest {
+    @Expose()
+    @IsString()
+    @IsNotEmpty()
+    name!: string;
+
+    @Expose()
+    @IsString()
+    customerText!: string;
+
+    @Expose()
+    @IsDefined()
+    @ValidateNested()
+    @Type(() => SalePromotionLeversInput)
+    levers!: SalePromotionLeversInput;
+
+    @Expose()
+    @IsOptional()
+    @ValidateNested()
+    @Type(() => SalePromotionScopeInput)
+    scope?: SalePromotionScopeInput | null;
+
+    @Expose()
+    @IsOptional()
+    @ValidateNested()
+    @Type(() => SalePromotionSegmentationInput)
+    segmentation?: SalePromotionSegmentationInput | null;
+
+    /** Ausente = `SUREKEEP_ONLY`. */
+    @Expose()
+    @IsOptional()
+    @IsEnum(PromotionAppliesToEnum)
+    appliesTo?: PromotionAppliesToEnum;
+
+    /** `null` = sin tope. */
+    @Expose()
+    @IsOptional()
+    @IsInt()
+    budgetMaxCents?: number | null;
+
+    @Expose()
+    @IsOptional()
+    @IsISO8601()
+    validFrom?: string | null;
+
+    /** `null` = permanente. */
+    @Expose()
+    @IsOptional()
+    @IsISO8601()
+    validUntil?: string | null;
+
+    @Expose()
+    @IsOptional()
+    @IsBoolean()
+    oncePerCustomer?: boolean;
+}

package/src/retailPromotions/dtos/requests/DiscountValueInput.ts

@@ -0,0 +1,21 @@
+import { Expose } from 'class-transformer';
+import { IsEnum, IsInt, ValidateIf } from 'class-validator';
+import { DiscountTypeEnum } from '../../enums/DiscountTypeEnum';
+
+/** Descuento en el body: exige el campo que corresponde al tipo. Rangos y signo los valida el lambda (422). */
+export class DiscountValueInput {
+    @Expose()
+    @IsEnum(DiscountTypeEnum)
+    type!: DiscountTypeEnum;
+
+    @Expose()
+    @ValidateIf((o: DiscountValueInput) => o.type === DiscountTypeEnum.AMOUNT)
+    @IsInt()
+    amountCents?: number | null;
+
+    /** Puntos base: 1000 = 10%. */
+    @Expose()
+    @ValidateIf((o: DiscountValueInput) => o.type === DiscountTypeEnum.PERCENTAGE)
+    @IsInt()
+    percentBps?: number | null;
+}

package/src/retailPromotions/dtos/requests/EvaluateSalePromotionsRequest.ts

@@ -0,0 +1,16 @@
+import { Expose } from 'class-transformer';
+import { IsNotEmpty, IsOptional, IsString } from 'class-validator';
+
+/** Body de publicEvaluateSalePromotions; precios, líneas y cliente salen de la sesión. */
+export class EvaluateSalePromotionsRequest {
+    @Expose()
+    @IsString()
+    @IsNotEmpty()
+    sessionId!: string;
+
+    @Expose()
+    @IsOptional()
+    @IsString()
+    @IsNotEmpty()
+    discountCode?: string | null;
+}

package/src/retailPromotions/dtos/requests/HoldSalePromotionRequest.ts

@@ -0,0 +1,32 @@
+import { Expose } from 'class-transformer';
+import { IsArray, IsInt, IsNotEmpty, IsOptional, IsString, ValidateIf } from 'class-validator';
+
+/**
+ * Body de publicHoldSalePromotion (PUT, `sessionId` en el path). `promotionId: null` = «Ninguna»;
+ * un PUT distinto reemplaza el apartado anterior.
+ */
+export class HoldSalePromotionRequest {
+    @Expose()
+    @IsOptional()
+    @IsString()
+    @IsNotEmpty()
+    promotionId?: string | null;
+
+    @Expose()
+    @ValidateIf((o: HoldSalePromotionRequest) => o.promotionId !== undefined && o.promotionId !== null)
+    @IsInt()
+    promotionVersion?: number | null;
+
+    /** Regalos elegidos por el cliente, si la promo trae regalo. */
+    @Expose()
+    @IsOptional()
+    @IsArray()
+    @IsString({ each: true })
+    giftSkus?: string[] | null;
+
+    @Expose()
+    @IsOptional()
+    @IsString()
+    @IsNotEmpty()
+    discountCode?: string | null;
+}

package/src/retailPromotions/dtos/requests/ListDiscountCodesQuery.ts

@@ -0,0 +1,33 @@
+import { Expose, Type } from 'class-transformer';
+import { IsEnum, IsIn, IsInt, IsOptional, IsString, Max, Min } from 'class-validator';
+import { CouponStatusEnum } from '../../enums/CouponStatusEnum';
+import { DiscountCodeOriginEnum } from '../../enums/DiscountCodeOriginEnum';
+import { DiscountCodeStatusEnum } from '../../enums/DiscountCodeStatusEnum';
+
+const LISTABLE_STATUSES = [...new Set<string>([...Object.values(DiscountCodeStatusEnum), ...Object.values(CouponStatusEnum)])];
+
+/** Query de publicListDiscountCodes: códigos y cupones, filtrables por origen y estado. */
+export class ListDiscountCodesQuery {
+    @Expose()
+    @IsOptional()
+    @IsEnum(DiscountCodeOriginEnum)
+    origin?: DiscountCodeOriginEnum;
+
+    @Expose()
+    @IsOptional()
+    @IsIn(LISTABLE_STATUSES)
+    status?: DiscountCodeStatusEnum | CouponStatusEnum;
+
+    @Expose()
+    @IsOptional()
+    @Type(() => Number)
+    @IsInt()
+    @Min(1)
+    @Max(100)
+    limit?: number;
+
+    @Expose()
+    @IsOptional()
+    @IsString()
+    nextToken?: string;
+}

package/src/retailPromotions/dtos/requests/ListSalePromotionLogQuery.ts

@@ -0,0 +1,29 @@
+import { Expose, Type } from 'class-transformer';
+import { IsEnum, IsInt, IsOptional, IsString, Max, Min } from 'class-validator';
+import { SalePromotionLogFormatEnum } from '../../enums/SalePromotionLogFormatEnum';
+
+/** Query de publicListSalePromotionLog: global o de una promo; `CSV` exporta en vez de paginar. */
+export class ListSalePromotionLogQuery {
+    @Expose()
+    @IsOptional()
+    @IsString()
+    promotionId?: string;
+
+    @Expose()
+    @IsOptional()
+    @IsEnum(SalePromotionLogFormatEnum)
+    format?: SalePromotionLogFormatEnum;
+
+    @Expose()
+    @IsOptional()
+    @Type(() => Number)
+    @IsInt()
+    @Min(1)
+    @Max(100)
+    limit?: number;
+
+    @Expose()
+    @IsOptional()
+    @IsString()
+    nextToken?: string;
+}

package/src/retailPromotions/dtos/requests/ListSalePromotionsQuery.ts

@@ -0,0 +1,24 @@
+import { Expose, Type } from 'class-transformer';
+import { IsEnum, IsInt, IsOptional, IsString, Max, Min } from 'class-validator';
+import { SalePromotionStatusEnum } from '../../enums/SalePromotionStatusEnum';
+
+/** Query de publicListSalePromotions; sin `status` excluye las archivadas. */
+export class ListSalePromotionsQuery {
+    @Expose()
+    @IsOptional()
+    @IsEnum(SalePromotionStatusEnum)
+    status?: SalePromotionStatusEnum;
+
+    @Expose()
+    @IsOptional()
+    @Type(() => Number)
+    @IsInt()
+    @Min(1)
+    @Max(100)
+    limit?: number;
+
+    @Expose()
+    @IsOptional()
+    @IsString()
+    nextToken?: string;
+}

package/src/retailPromotions/dtos/requests/ListStoreSalePromotionsQuery.ts

@@ -0,0 +1,10 @@
+import { Expose } from 'class-transformer';
+import { IsNotEmpty, IsString } from 'class-validator';
+
+/** Query de publicListStoreSalePromotions; la tienda sale de la sesión, no del request. */
+export class ListStoreSalePromotionsQuery {
+    @Expose()
+    @IsString()
+    @IsNotEmpty()
+    sessionId!: string;
+}

package/src/retailPromotions/dtos/requests/SalePromotionLeversInput.ts

@@ -0,0 +1,136 @@
+import { Expose, Type } from 'class-transformer';
+import {
+    ArrayNotEmpty,
+    IsArray,
+    IsEnum,
+    IsInt,
+    IsNotEmpty,
+    IsOptional,
+    IsString,
+    ValidateIf,
+    ValidateNested,
+} from 'class-validator';
+import { CouponScopeEnum } from '../../enums/CouponScopeEnum';
+import { GiftModeEnum } from '../../enums/GiftModeEnum';
+import { DiscountValueInput } from './DiscountValueInput';
+
+export class AccessoryDiscountLeverInput {
+    @Expose()
+    @IsInt()
+    percentBps!: number;
+
+    @Expose()
+    @IsOptional()
+    @IsInt()
+    maxAmountCents?: number | null;
+}
+
+/** Regalo por lista exige `skus`; por gama exige `category` y `maxPriceCents`. */
+export class GiftLeverInput {
+    @Expose()
+    @IsEnum(GiftModeEnum)
+    mode!: GiftModeEnum;
+
+    @Expose()
+    @ValidateIf((o: GiftLeverInput) => o.mode === GiftModeEnum.LIST)
+    @IsArray()
+    @ArrayNotEmpty()
+    @IsString({ each: true })
+    skus?: string[] | null;
+
+    @Expose()
+    @ValidateIf((o: GiftLeverInput) => o.mode === GiftModeEnum.RANGE)
+    @IsString()
+    @IsNotEmpty()
+    category?: string | null;
+
+    @Expose()
+    @ValidateIf((o: GiftLeverInput) => o.mode === GiftModeEnum.RANGE)
+    @IsInt()
+    maxPriceCents?: number | null;
+
+    @Expose()
+    @IsInt()
+    chooseCount!: number;
+}
+
+export class CouponLeverInput extends DiscountValueInput {
+    @Expose()
+    @IsInt()
+    validityDays!: number;
+
+    @Expose()
+    @IsEnum(CouponScopeEnum)
+    scope!: CouponScopeEnum;
+}
+
+export class AirtimeLeverInput {
+    @Expose()
+    @IsInt()
+    rechargeCount!: number;
+
+    @Expose()
+    @IsInt()
+    rechargeAmountCents!: number;
+}
+
+export class ExtendedWarrantyLeverInput {
+    @Expose()
+    @IsInt()
+    extraMonths!: number;
+
+    @Expose()
+    @IsInt()
+    costCents!: number;
+}
+
+export class WalletBonusLeverInput {
+    @Expose()
+    @IsInt()
+    amountCents!: number;
+}
+
+/** Las 7 palancas en el body; que venga al menos una lo valida el lambda (422). */
+export class SalePromotionLeversInput {
+    @Expose()
+    @IsOptional()
+    @ValidateNested()
+    @Type(() => DiscountValueInput)
+    deviceDiscount?: DiscountValueInput | null;
+
+    @Expose()
+    @IsOptional()
+    @ValidateNested()
+    @Type(() => AccessoryDiscountLeverInput)
+    accessoryDiscount?: AccessoryDiscountLeverInput | null;
+
+    @Expose()
+    @IsOptional()
+    @ValidateNested()
+    @Type(() => GiftLeverInput)
+    gift?: GiftLeverInput | null;
+
+    @Expose()
+    @IsOptional()
+    @ValidateNested()
+    @Type(() => CouponLeverInput)
+    coupon?: CouponLeverInput | null;
+
+    @Expose()
+    @IsOptional()
+    @ValidateNested()
+    @Type(() => AirtimeLeverInput)
+    airtime?: AirtimeLeverInput | null;
+
+    @Expose()
+    @IsOptional()
+    @ValidateNested()
+    @Type(() => ExtendedWarrantyLeverInput)
+    extendedWarranty?: ExtendedWarrantyLeverInput | null;
+
+    @Expose()
+    @IsOptional()
+    @ValidateNested()
+    @Type(() => WalletBonusLeverInput)
+    walletBonus?: WalletBonusLeverInput | null;
+}

package/src/retailPromotions/dtos/requests/SalePromotionScopeInput.ts

@@ -0,0 +1,45 @@
+import { Expose } from 'class-transformer';
+import { IsArray, IsBoolean, IsEnum, IsOptional, IsString } from 'class-validator';
+import { ProductCategoryEnum } from '../../../retailCatalog/enums/ProductCategoryEnum';
+import { ProductTierEnum } from '../../../retailCatalog/enums/ProductTierEnum';
+
+/** Alcance en el body; cada lista ausente o `null` = sin restricción. */
+export class SalePromotionScopeInput {
+    @Expose()
+    @IsOptional()
+    @IsArray()
+    @IsEnum(ProductCategoryEnum, { each: true })
+    productCategories?: ProductCategoryEnum[] | null;
+
+    @Expose()
+    @IsOptional()
+    @IsArray()
+    @IsEnum(ProductTierEnum, { each: true })
+    tiers?: ProductTierEnum[] | null;
+
+    @Expose()
+    @IsOptional()
+    @IsArray()
+    @IsString({ each: true })
+    skus?: string[] | null;
+
+    @Expose()
+    @IsOptional()
+    @IsArray()
+    @IsString({ each: true })
+    storeIds?: string[] | null;
+}
+
+/** Segmentación en el body: segmentos de loan-offerings y si exige crédito SK activo. */
+export class SalePromotionSegmentationInput {
+    @Expose()
+    @IsOptional()
+    @IsArray()
+    @IsString({ each: true })
+    segmentIds?: string[] | null;
+
+    @Expose()
+    @IsOptional()
+    @IsBoolean()
+    requiresActiveSurekeepCredit?: boolean;
+}

package/src/retailPromotions/dtos/requests/UpdateSalePromotionRequest.ts

@@ -0,0 +1,74 @@
+import { Expose, Type } from 'class-transformer';
+import {
+    IsBoolean,
+    IsEnum,
+    IsInt,
+    IsISO8601,
+    IsNotEmpty,
+    IsOptional,
+    IsString,
+    ValidateNested,
+} from 'class-validator';
+import { PromotionAppliesToEnum } from '../../enums/PromotionAppliesToEnum';
+import { SalePromotionLeversInput } from './SalePromotionLeversInput';
+import { SalePromotionScopeInput, SalePromotionSegmentationInput } from './SalePromotionScopeInput';
+
+/** Body de publicUpdateSalePromotion: parche; el lambda crea una versión nueva para ventas futuras. */
+export class UpdateSalePromotionRequest {
+    @Expose()
+    @IsOptional()
+    @IsString()
+    @IsNotEmpty()
+    name?: string;
+
+    @Expose()
+    @IsOptional()
+    @IsString()
+    customerText?: string;
+
+    @Expose()
+    @IsOptional()
+    @ValidateNested()
+    @Type(() => SalePromotionLeversInput)
+    levers?: SalePromotionLeversInput;
+
+    @Expose()
+    @IsOptional()
+    @ValidateNested()
+    @Type(() => SalePromotionScopeInput)
+    scope?: SalePromotionScopeInput | null;
+
+    @Expose()
+    @IsOptional()
+    @ValidateNested()
+    @Type(() => SalePromotionSegmentationInput)
+    segmentation?: SalePromotionSegmentationInput | null;
+
+    /** Ausente = conserva el valor actual. */
+    @Expose()
+    @IsOptional()
+    @IsEnum(PromotionAppliesToEnum)
+    appliesTo?: PromotionAppliesToEnum;
+
+    /** `null` = sin tope. */
+    @Expose()
+    @IsOptional()
+    @IsInt()
+    budgetMaxCents?: number | null;
+
+    @Expose()
+    @IsOptional()
+    @IsISO8601()
+    validFrom?: string | null;
+
+    /** `null` = permanente. */
+    @Expose()
+    @IsOptional()
+    @IsISO8601()
+    validUntil?: string | null;
+
+    @Expose()
+    @IsOptional()
+    @IsBoolean()
+    oncePerCustomer?: boolean;
+}