@fiado/type-kit 3.518.0 → 3.520.0

package/src/rewards/dtos/backoffice/GrantListQuery.ts

@@ -0,0 +1,23 @@
+import { ItemErrorCategoryEnum } from '../../enums/ItemErrorCategoryEnum';
+
+/** Query params ya validados de `GET /grants` y `GET /grants/export` (el lambda los valida; ver `GrantListQueryHelper`). */
+export class GrantListQuery {
+    limit?: number;
+    cursor?: string;
+    /** Uno o varios `GrantStatusEnum` separados por coma. */
+    status?: string;
+    packageId?: string;
+    campaignId?: string;
+    service?: string;
+    partnerId?: string;
+    directoryId?: string;
+    /** Coincide con un `id` de entrega; si no, se trata como `directoryId`. Sin búsqueda por nombre. */
+    search?: string;
+    /** `AAAA-MM-DD` UTC, inclusivos. Default: `to` = hoy, `from` = `to − 6`. Máximo 92 días. */
+    from?: string;
+    to?: string;
+    /** Entregas que contienen esta recompensa del catálogo (D-F1). */
+    catalogItemId?: string;
+    /** Entregas con al menos un ítem FAILED cuyo último intento falló con esta categoría (D-F1). */
+    errorCategory?: ItemErrorCategoryEnum;
+}

package/src/rewards/dtos/backoffice/GrantListResponse.ts

@@ -0,0 +1,6 @@
+import { BackofficeGrantResponse } from './BackofficeGrantResponse';
+
+export class GrantListResponse {
+    items: BackofficeGrantResponse[];
+    nextCursor?: string;
+}

package/src/rewards/dtos/backoffice/PartnerListResponse.ts

@@ -0,0 +1,7 @@
+import { PartnerResponse } from './PartnerResponse';
+
+export class PartnerListResponse {
+    items: PartnerResponse[];
+    /** Cursor opaco de la página siguiente; ausente en la última página. */
+    nextCursor?: string;
+}

package/src/rewards/dtos/backoffice/PartnerRequest.ts

@@ -0,0 +1,22 @@
+import { Expose } from 'class-transformer';
+import { IsEnum, IsNotEmpty, IsString, Matches, MaxLength } from 'class-validator';
+import { REWARD_ID_PATTERN } from '../../constants/BackofficeLimits';
+import { RewardStatusEnum } from '../../enums/RewardStatusEnum';
+
+/** Crear (POST) o reemplazar (PUT) un aliado. `version` y `updatedBy` los pone el servidor. El `id` lo genera el front del nombre. */
+export class PartnerRequest {
+    @Expose()
+    @IsString()
+    @Matches(REWARD_ID_PATTERN)
+    id: string;
+
+    @Expose()
+    @IsString()
+    @IsNotEmpty()
+    @MaxLength(120)
+    name: string;
+
+    @Expose()
+    @IsEnum(RewardStatusEnum)
+    status: RewardStatusEnum;
+}

package/src/rewards/dtos/backoffice/PartnerResponse.ts

@@ -0,0 +1,12 @@
+import { RewardStatusEnum } from '../../enums/RewardStatusEnum';
+
+export class PartnerResponse {
+    id: string;
+    name: string;
+    status: RewardStatusEnum;
+    version: number;
+    /** Epoch en milisegundos. */
+    createdAt: number;
+    updatedAt: number;
+    updatedBy: string;
+}

package/src/rewards/dtos/backoffice/PartnerSummary.ts

@@ -0,0 +1,13 @@
+import { RewardCost } from '../RewardCost';
+import { RewardStatusEnum } from '../../enums/RewardStatusEnum';
+
+/** Un aliado con sus recompensas cobradas y el valor entregado en el rango (`GET /partners/summary`). */
+export class PartnerSummary {
+    partnerId: string;
+    partnerName: string;
+    status: RewardStatusEnum;
+    /** Recompensas del catálogo que se le cobran a este aliado. */
+    catalogItemIds: string[];
+    /** Valor entregado en el rango, POR MONEDA (nunca se mezclan). Vacío si no hubo entregas. */
+    delivered: RewardCost[];
+}

package/src/rewards/dtos/backoffice/PartnersSummaryQuery.ts

@@ -0,0 +1,5 @@
+/** Query params ya validados de `GET /partners/summary` (`AAAA-MM-DD`, UTC, inclusivos; default últimos 30 días). */
+export class PartnersSummaryQuery {
+    from?: string;
+    to?: string;
+}

package/src/rewards/dtos/backoffice/RewardChargeToInput.ts

@@ -1,16 +1,11 @@
 import { Expose } from 'class-transformer';
 import { IsNotEmpty, IsString, MaxLength } from 'class-validator';
 
+/** A quién se le cobra. `partnerName` ya no se escribe a mano: el servidor lo copia de `RewardPartner_GT` (D-A2). */
 export class RewardChargeToInput {
     @Expose()
     @IsString()
     @IsNotEmpty()
     @MaxLength(64)
     partnerId: string;
-
-    @Expose()
-    @IsString()
-    @IsNotEmpty()
-    @MaxLength(120)
-    partnerName: string;
 }

package/src/rewards/enums/DeliveryDimensionEnum.ts

@@ -0,0 +1,8 @@
+/** Dimensión de la serie diaria de métricas. Las etiquetas (`TAG#campaignId`, `TAG#evaluationId`) se validan con `METRICS_TAG_DIMENSION_PATTERN`. */
+export enum DeliveryDimensionEnum {
+    ALL = 'ALL',
+    PACKAGE = 'PACKAGE',
+    CATALOG_ITEM = 'CATALOG_ITEM',
+    PARTNER = 'PARTNER',
+    SOURCE = 'SOURCE',
+}

package/src/rewards/enums/DeliveryTopByEnum.ts

@@ -0,0 +1,5 @@
+/** Criterio de ordenamiento del top de métricas. */
+export enum DeliveryTopByEnum {
+    cost = 'cost',
+    count = 'count',
+}

package/src/rewards/enums/DeliveryTopDimensionEnum.ts

@@ -0,0 +1,7 @@
+/** Dimensiones sobre las que se calcula el top de métricas. */
+export enum DeliveryTopDimensionEnum {
+    PACKAGE = 'PACKAGE',
+    CATALOG_ITEM = 'CATALOG_ITEM',
+    PARTNER = 'PARTNER',
+    SOURCE = 'SOURCE',
+}

package/src/rewards/index.ts

@@ -8,6 +8,9 @@ export * from './enums/ItemErrorCategoryEnum';
 export * from './enums/RewardStatusEnum';
 export * from './enums/DependencyIfMissingEnum';
 export * from './enums/RewardsErrorCodeEnum';
+export * from './enums/DeliveryDimensionEnum';
+export * from './enums/DeliveryTopDimensionEnum';
+export * from './enums/DeliveryTopByEnum';
 
 //Types
 export * from './types/RewardInputs';
@@ -50,3 +53,21 @@ export * from './dtos/backoffice/PackageResponse';
 export * from './dtos/backoffice/RewardTypeResponse';
 export * from './dtos/backoffice/CatalogItemListResponse';
 export * from './dtos/backoffice/PackageListResponse';
+export * from './dtos/backoffice/PartnerRequest';
+export * from './dtos/backoffice/PartnerResponse';
+export * from './dtos/backoffice/PartnerListResponse';
+export * from './dtos/backoffice/PartnerSummary';
+export * from './dtos/backoffice/PartnersSummaryQuery';
+export * from './dtos/backoffice/GrantListQuery';
+export * from './dtos/backoffice/BackofficeGrantAttemptResponse';
+export * from './dtos/backoffice/BackofficeGrantItemResponse';
+export * from './dtos/backoffice/BackofficeGrantResponse';
+export * from './dtos/backoffice/GrantListResponse';
+export * from './dtos/backoffice/ChargeRecord';
+export * from './dtos/backoffice/ChargeListResponse';
+export * from './dtos/backoffice/ChargesQuery';
+export * from './dtos/backoffice/ChargesExportQuery';
+export * from './dtos/backoffice/DeliveryMetricsQuery';
+export * from './dtos/backoffice/DeliveryTopQuery';
+export * from './dtos/backoffice/DeliveryMetricsPoint';
+export * from './dtos/backoffice/DeliveryTopEntry';