@fiado/type-kit 3.495.0 → 3.497.0

package/src/loanCredit/dtos/responses/SellerPaymentResult.ts

@@ -0,0 +1,43 @@
+import type { InStorePaymentMethodEnum } from '../../enums/InStorePaymentMethodEnum';
+import type { LoanCustomerPaymentTypeEnum } from '../../enums/LoanCustomerPaymentTypeEnum';
+import type { LoanInstallmentStatusEnum } from '../../enums/LoanInstallmentStatusEnum';
+
+/** Algo con id y el nombre congelado al cobrar. */
+export interface NamedRef {
+    id: string;
+    name: string | null;
+}
+
+/** La cuota que sigue después del pago; null si ya no queda ninguna abierta. */
+export interface SellerNextInstallment {
+    installmentNumber: number;
+    dueDate: string | null;
+    amountCents: number;
+    status: LoanInstallmentStatusEnum;
+}
+
+/** El crédito con su equipo, para que el comprobante diga qué se pagó. */
+export interface SellerPaymentCredit {
+    creditId: string;
+    imei: string | null;
+    productBrand: string | null;
+    productModel: string | null;
+}
+
+/** Respuesta 200 de `POST /seller/credits/{creditId}/payments`: el comprobante en pantalla. */
+export interface SellerPaymentResult {
+    creditId: string;
+    /** Folio `SK-TD-…`. */
+    receipt: string;
+    amountCents: number;
+    type: LoanCustomerPaymentTypeEnum;
+    method: InStorePaymentMethodEnum;
+    appliedAt: string;
+    outstandingBalanceAfterCents: number;
+    /** Solo si el pago emitió documento (comprobante de adelanto o constancia de liquidación). */
+    documentId?: string;
+    collectedAtStore: NamedRef;
+    collectedBySeller: NamedRef;
+    nextInstallment: SellerNextInstallment | null;
+    credit: SellerPaymentCredit;
+}

package/src/loanCredit/enums/CreditCustomerStateEnum.ts

@@ -0,0 +1,6 @@
+/** Estado del bloque de crédito de la fila de Clientes: leído, sin acreditado o sin leer. */
+export enum CreditCustomerStateEnum {
+    READ = 'READ',
+    NO_BORROWER = 'NO_BORROWER',
+    UNAVAILABLE = 'UNAVAILABLE',
+}

package/src/loanCredit/enums/InStorePaymentMethodEnum.ts

@@ -0,0 +1,6 @@
+/** Forma en que el cliente pagó en tienda. Solo se anota: no se verifica contra banco ni terminal. */
+export enum InStorePaymentMethodEnum {
+    CASH = 'CASH',
+    CARD = 'CARD',
+    WIRE = 'WIRE',
+}

package/src/loanCredit/enums/LoanPaymentOriginEnum.ts

@@ -0,0 +1,5 @@
+/** Por dónde entró el pago al crédito. Ausente en filas viejas = COLLECTION_ENGINE. */
+export enum LoanPaymentOriginEnum {
+    COLLECTION_ENGINE = 'COLLECTION_ENGINE',
+    IN_STORE = 'IN_STORE',
+}

package/src/loanCredit/index.ts

@@ -167,3 +167,15 @@ export * from './enums/LoanPaymentOptionUnavailableReasonEnum';
 export * from './dtos/requests/CreateCustomerPaymentRequest';
 export * from './dtos/responses/LoanCustomerPaymentOptions';
 export * from './dtos/responses/LoanCustomerPaymentResult';
+
+// Cobro en tienda del Portal del Vendedor
+export * from './enums/InStorePaymentMethodEnum';
+export * from './enums/LoanPaymentOriginEnum';
+export * from './enums/CreditCustomerStateEnum';
+export * from './dtos/requests/InStorePaymentDetail';
+export * from './dtos/requests/CreateSellerPaymentRequest';
+export * from './dtos/responses/SellerPaymentResult';
+export * from './dtos/responses/SellerPaymentOptions';
+export * from './dtos/responses/SellerCreditLookupResult';
+export * from './dtos/responses/InStorePaymentListItem';
+export * from './dtos/responses/CreditCustomerListItem';

package/src/retailIntegration/constants/retailIntegrationLimits.ts

@@ -0,0 +1,9 @@
+/** Tope de `eventId`: el límite seguro de una llave de DynamoDB. */
+export const RETAIL_EVENT_ID_MAX_LENGTH = 1024;
+
+/** Rango de `limit` en las listas paginadas del retailer. */
+export const RETAIL_LIST_LIMIT_MIN = 1;
+export const RETAIL_LIST_LIMIT_MAX = 200;
+
+/** Forma válida de un `tenantId`; también arma el nombre del secreto del retailer. */
+export const RETAIL_TENANT_ID_PATTERN = /^[A-Za-z0-9_-]{1,64}$/;

package/src/retailIntegration/dtos/ApplyRetailEventRequest.ts

@@ -0,0 +1,49 @@
+import { IsString, Matches } from 'class-validator';
+import { RETAIL_TENANT_ID_PATTERN } from '../constants/retailIntegrationLimits';
+import { ReceiveInventoryEventRequest } from './ReceiveInventoryEventRequest';
+import { ReceiveProductEventRequest } from './ReceiveProductEventRequest';
+import { ReceiveRetailUserEventRequest } from './ReceiveRetailUserEventRequest';
+import { ReceiveStoreEventRequest } from './ReceiveStoreEventRequest';
+import { RetailEventResult } from './RetailEventResult';
+
+/** Evento de tienda que el connector manda a retail-org-business, con el tenant de la credencial. */
+export class ApplyStoreEventRequest extends ReceiveStoreEventRequest {
+    @IsString()
+    @Matches(RETAIL_TENANT_ID_PATTERN)
+    tenantId!: string;
+}
+
+/** Evento de usuario que el connector manda a retail-org-business, con el tenant de la credencial. */
+export class ApplyRetailUserEventRequest extends ReceiveRetailUserEventRequest {
+    @IsString()
+    @Matches(RETAIL_TENANT_ID_PATTERN)
+    tenantId!: string;
+}
+
+/** Evento de producto que el connector manda a retail-catalog-business, con el tenant de la credencial. */
+export class ApplyProductEventRequest extends ReceiveProductEventRequest {
+    @IsString()
+    @Matches(RETAIL_TENANT_ID_PATTERN)
+    tenantId!: string;
+}
+
+/** Evento de inventario que el connector manda a retail-catalog-business, con el tenant de la credencial. */
+export class ApplyInventoryEventRequest extends ReceiveInventoryEventRequest {
+    @IsString()
+    @Matches(RETAIL_TENANT_ID_PATTERN)
+    tenantId!: string;
+}
+
+/** Cualquiera de los cuatro eventos que el connector manda a un destino. */
+export type ApplyRetailEventRequest =
+    | ApplyStoreEventRequest
+    | ApplyRetailUserEventRequest
+    | ApplyProductEventRequest
+    | ApplyInventoryEventRequest;
+
+/** El destino contesta `200` con `result`; un rechazo de negocio es `REJECTED`, nunca 4xx. */
+export type ApplyRetailEventResponse = RetailEventResult;
+export type ApplyStoreEventResponse = RetailEventResult;
+export type ApplyRetailUserEventResponse = RetailEventResult;
+export type ApplyProductEventResponse = RetailEventResult;
+export type ApplyInventoryEventResponse = RetailEventResult;

package/src/retailIntegration/dtos/GetRetailInventoryRequest.ts

@@ -0,0 +1,9 @@
+import { IsString, Matches } from 'class-validator';
+import { RetailTenantQuery } from './RetailTenantQuery';
+
+/** Query de `GET /private/retail/inventory`; el inventario es por tienda y no pagina. */
+export class GetRetailInventoryRequest extends RetailTenantQuery {
+    @IsString()
+    @Matches(/\S/)
+    storeId!: string;
+}

package/src/retailIntegration/dtos/ListRetailCatalogRequest.ts

@@ -0,0 +1,4 @@
+import { RetailPagedQuery } from './RetailPagedQuery';
+
+/** Query de `GET /private/retail/catalog`. */
+export class ListRetailCatalogRequest extends RetailPagedQuery {}

package/src/retailIntegration/dtos/ListRetailStoresRequest.ts

@@ -0,0 +1,4 @@
+import { RetailPagedQuery } from './RetailPagedQuery';
+
+/** Query de `GET /private/retail/stores`. */
+export class ListRetailStoresRequest extends RetailPagedQuery {}

package/src/retailIntegration/dtos/ListRetailUsersRequest.ts

@@ -0,0 +1,10 @@
+import { IsOptional, IsString, Matches } from 'class-validator';
+import { RetailPagedQuery } from './RetailPagedQuery';
+
+/** Query de `GET /private/retail/users`; sin `storeId` trae todos los usuarios. */
+export class ListRetailUsersRequest extends RetailPagedQuery {
+    @IsOptional()
+    @IsString()
+    @Matches(/\S/)
+    storeId?: string;
+}

package/src/retailIntegration/dtos/ReceiveInventoryEventRequest.ts

@@ -0,0 +1,9 @@
+import { IsIn } from 'class-validator';
+import { InventoryEventTypeEnum } from '../enums/InventoryEventTypeEnum';
+import { RetailEventEnvelope } from './RetailEventEnvelope';
+
+/** Sobre de `POST /webhooks/inventory`. */
+export class ReceiveInventoryEventRequest extends RetailEventEnvelope {
+    @IsIn(Object.values(InventoryEventTypeEnum))
+    eventType!: InventoryEventTypeEnum;
+}

package/src/retailIntegration/dtos/ReceiveProductEventRequest.ts

@@ -0,0 +1,9 @@
+import { IsIn } from 'class-validator';
+import { ProductEventTypeEnum } from '../enums/ProductEventTypeEnum';
+import { RetailEventEnvelope } from './RetailEventEnvelope';
+
+/** Sobre de `POST /webhooks/catalog`. */
+export class ReceiveProductEventRequest extends RetailEventEnvelope {
+    @IsIn(Object.values(ProductEventTypeEnum))
+    eventType!: ProductEventTypeEnum;
+}

package/src/retailIntegration/dtos/ReceiveRetailEventRequest.ts

@@ -0,0 +1,18 @@
+import { InventoryEventTypeEnum } from '../enums/InventoryEventTypeEnum';
+import { ProductEventTypeEnum } from '../enums/ProductEventTypeEnum';
+import { RetailUserEventTypeEnum } from '../enums/RetailUserEventTypeEnum';
+import { StoreEventTypeEnum } from '../enums/StoreEventTypeEnum';
+import { ReceiveInventoryEventRequest } from './ReceiveInventoryEventRequest';
+import { ReceiveProductEventRequest } from './ReceiveProductEventRequest';
+import { ReceiveRetailUserEventRequest } from './ReceiveRetailUserEventRequest';
+import { ReceiveStoreEventRequest } from './ReceiveStoreEventRequest';
+
+/** Cualquier `eventType` aceptado por alguno de los cuatro webhooks. */
+export type RetailEventType = StoreEventTypeEnum | RetailUserEventTypeEnum | ProductEventTypeEnum | InventoryEventTypeEnum;
+
+/** Sobre ya validado de cualquiera de los cuatro webhooks. */
+export type ReceiveRetailEventRequest =
+    | ReceiveStoreEventRequest
+    | ReceiveRetailUserEventRequest
+    | ReceiveProductEventRequest
+    | ReceiveInventoryEventRequest;

package/src/retailIntegration/dtos/ReceiveRetailUserEventRequest.ts

@@ -0,0 +1,9 @@
+import { IsIn } from 'class-validator';
+import { RetailUserEventTypeEnum } from '../enums/RetailUserEventTypeEnum';
+import { RetailEventEnvelope } from './RetailEventEnvelope';
+
+/** Sobre de `POST /webhooks/users`. */
+export class ReceiveRetailUserEventRequest extends RetailEventEnvelope {
+    @IsIn(Object.values(RetailUserEventTypeEnum))
+    eventType!: RetailUserEventTypeEnum;
+}

package/src/retailIntegration/dtos/ReceiveStoreEventRequest.ts

@@ -0,0 +1,9 @@
+import { IsIn } from 'class-validator';
+import { StoreEventTypeEnum } from '../enums/StoreEventTypeEnum';
+import { RetailEventEnvelope } from './RetailEventEnvelope';
+
+/** Sobre de `POST /webhooks/stores`. */
+export class ReceiveStoreEventRequest extends RetailEventEnvelope {
+    @IsIn(Object.values(StoreEventTypeEnum))
+    eventType!: StoreEventTypeEnum;
+}

package/src/retailIntegration/dtos/RegisterRetailSaleRequest.ts

@@ -0,0 +1,4 @@
+import { RetailTenantQuery } from './RetailTenantQuery';
+
+/** Query de `POST /private/retail/sales`; el cuerpo es la venta y no se valida aquí. */
+export class RegisterRetailSaleRequest extends RetailTenantQuery {}

package/src/retailIntegration/dtos/RetailEventEnvelope.ts

@@ -0,0 +1,20 @@
+import { IsObject, IsString, Matches, MaxLength, Validate } from 'class-validator';
+import { RETAIL_EVENT_ID_MAX_LENGTH } from '../constants/retailIntegrationLimits';
+import { IsIsoDateTimeWithZone } from '../validators/IsIsoDateTimeWithZone';
+
+/** Payload del evento: el connector no lo valida, lo valida el lambda destino. */
+export type RetailEventPayload = Record<string, unknown>;
+
+/** Campos comunes del sobre de un webhook; cada ruta agrega su `eventType`. */
+export abstract class RetailEventEnvelope {
+    @IsString()
+    @Matches(/\S/)
+    @MaxLength(RETAIL_EVENT_ID_MAX_LENGTH)
+    eventId!: string;
+
+    @Validate(IsIsoDateTimeWithZone)
+    occurredAt!: string;
+
+    @IsObject()
+    payload!: RetailEventPayload;
+}

package/src/retailIntegration/dtos/RetailEventResult.ts

@@ -0,0 +1,14 @@
+import { RetailEventResultEnum } from '../enums/RetailEventResultEnum';
+
+/** Resultado de un evento; `code` explica un `REJECTED` y es `null` en los demás. */
+export interface RetailEventResult {
+    eventId: string;
+    result: RetailEventResultEnum;
+    code: string | null;
+}
+
+export type ReceiveStoreEventResponse = RetailEventResult;
+export type ReceiveRetailUserEventResponse = RetailEventResult;
+export type ReceiveProductEventResponse = RetailEventResult;
+export type ReceiveInventoryEventResponse = RetailEventResult;
+export type ReceiveRetailEventResponse = RetailEventResult;

package/src/retailIntegration/dtos/RetailOutboundResponses.ts

@@ -0,0 +1,35 @@
+import { RetailInventoryMeta, RetailPageMeta } from '../models/RetailPageMeta';
+import { RetailSystemPiece, RetailSystemStock } from '../models/RetailSystemInventory';
+import { RetailSystemProduct } from '../models/RetailSystemProduct';
+import { RetailSystemStore } from '../models/RetailSystemStore';
+import { RetailSystemUser } from '../models/RetailSystemUser';
+
+/** `data` de `GET /private/retail/stores`. */
+export interface ListRetailStoresResponse {
+    items: RetailSystemStore[];
+    meta: RetailPageMeta;
+}
+
+/** `data` de `GET /private/retail/catalog`. */
+export interface ListRetailCatalogResponse {
+    items: RetailSystemProduct[];
+    meta: RetailPageMeta;
+}
+
+/** `data` de `GET /private/retail/inventory`. */
+export interface GetRetailInventoryResponse {
+    pieces: RetailSystemPiece[];
+    stock: RetailSystemStock[];
+    meta: RetailInventoryMeta;
+}
+
+/** `data` de `GET /private/retail/users`. */
+export interface ListRetailUsersResponse {
+    items: RetailSystemUser[];
+    meta: RetailPageMeta;
+}
+
+/** `data` de `POST /private/retail/sales`: el id de la venta en el sistema del retailer. */
+export interface RegisterRetailSaleResponse {
+    externalSaleId: string;
+}

package/src/retailIntegration/dtos/RetailPagedQuery.ts

@@ -0,0 +1,19 @@
+import { Type } from 'class-transformer';
+import { IsInt, IsOptional, IsString, Matches, Max, Min } from 'class-validator';
+import { RETAIL_LIST_LIMIT_MAX, RETAIL_LIST_LIMIT_MIN } from '../constants/retailIntegrationLimits';
+import { RetailTenantQuery } from './RetailTenantQuery';
+
+/** Base de las listas paginadas; `nextToken` es opaco y viaja tal cual. */
+export class RetailPagedQuery extends RetailTenantQuery {
+    @IsOptional()
+    @Type(() => Number)
+    @IsInt()
+    @Min(RETAIL_LIST_LIMIT_MIN)
+    @Max(RETAIL_LIST_LIMIT_MAX)
+    limit?: number;
+
+    @IsOptional()
+    @IsString()
+    @Matches(/\S/)
+    nextToken?: string;
+}

package/src/retailIntegration/dtos/RetailTenantQuery.ts

@@ -0,0 +1,9 @@
+import { IsString, Matches } from 'class-validator';
+import { RETAIL_TENANT_ID_PATTERN } from '../constants/retailIntegrationLimits';
+
+/** Base de toda llamada de salida: el tenant cuyo retailer se consulta. */
+export class RetailTenantQuery {
+    @IsString()
+    @Matches(RETAIL_TENANT_ID_PATTERN)
+    tenantId!: string;
+}

package/src/retailIntegration/enums/InventoryEventTypeEnum.ts

@@ -0,0 +1,4 @@
+/** `eventType` válidos en `POST /webhooks/inventory`. */
+export enum InventoryEventTypeEnum {
+    INVENTORY_MOVEMENT_V1 = 'InventoryMovementV1',
+}

package/src/retailIntegration/enums/ProductEventTypeEnum.ts

@@ -0,0 +1,6 @@
+/** `eventType` válidos en `POST /webhooks/catalog`. */
+export enum ProductEventTypeEnum {
+    PRODUCT_CREATED_V1 = 'ProductCreatedV1',
+    PRODUCT_UPDATED_V1 = 'ProductUpdatedV1',
+    PRODUCT_STATUS_CHANGED_V1 = 'ProductStatusChangedV1',
+}

package/src/retailIntegration/enums/RetailCurrencyEnum.ts

@@ -0,0 +1,5 @@
+/** Moneda de precios y ventas. */
+export enum RetailCurrencyEnum {
+    MXN = 'MXN',
+    USD = 'USD',
+}

package/src/retailIntegration/enums/RetailEventResultEnum.ts

@@ -0,0 +1,6 @@
+/** Resultado de aplicar un evento del retailer en el lambda destino. */
+export enum RetailEventResultEnum {
+    APPLIED = 'APPLIED',
+    NOOP = 'NOOP',
+    REJECTED = 'REJECTED',
+}

package/src/retailIntegration/enums/RetailFinancierEnum.ts

@@ -0,0 +1,8 @@
+/** Financieras que pueden financiar un producto. */
+export enum RetailFinancierEnum {
+    SUREKEEP = 'SUREKEEP',
+    PAYJOY = 'PAYJOY',
+    CREDIYA = 'CREDIYA',
+    LESPAGO = 'LESPAGO',
+    INNOVA = 'INNOVA',
+}

package/src/retailIntegration/enums/RetailLinePaymentTypeEnum.ts

@@ -0,0 +1,5 @@
+/** Forma de pago de una línea de la venta. */
+export enum RetailLinePaymentTypeEnum {
+    CASH = 'CASH',
+    CREDIT = 'CREDIT',
+}

package/src/retailIntegration/enums/RetailMdmProviderEnum.ts

@@ -0,0 +1,5 @@
+/** Proveedor de MDM del equipo. */
+export enum RetailMdmProviderEnum {
+    TRUSTONIC = 'TRUSTONIC',
+    DATACULTR = 'DATACULTR',
+}

package/src/retailIntegration/enums/RetailPaymentMethodEnum.ts

@@ -0,0 +1,6 @@
+/** Método de pago de la venta. */
+export enum RetailPaymentMethodEnum {
+    CASH = 'CASH',
+    CARD = 'CARD',
+    SPEI = 'SPEI',
+}

package/src/retailIntegration/enums/RetailPieceReasonEnum.ts

@@ -0,0 +1,6 @@
+/** Motivo de una pieza fuera de venta. */
+export enum RetailPieceReasonEnum {
+    WARRANTY = 'WARRANTY',
+    DAMAGED_RETURN = 'DAMAGED_RETURN',
+    SHRINKAGE = 'SHRINKAGE',
+}

package/src/retailIntegration/enums/RetailPieceStatusEnum.ts

@@ -0,0 +1,7 @@
+/** Estatus de una pieza con IMEI o serie. */
+export enum RetailPieceStatusEnum {
+    AVAILABLE = 'AVAILABLE',
+    IN_TRANSIT = 'IN_TRANSIT',
+    SOLD = 'SOLD',
+    DAMAGED = 'DAMAGED',
+}

package/src/retailIntegration/enums/RetailProductCategoryEnum.ts

@@ -0,0 +1,7 @@
+/** Categoría de un producto del retailer. */
+export enum RetailProductCategoryEnum {
+    PHONE = 'PHONE',
+    MODEM = 'MODEM',
+    ACCESSORY = 'ACCESSORY',
+    SIM = 'SIM',
+}

package/src/retailIntegration/enums/RetailProductStatusEnum.ts

@@ -0,0 +1,6 @@
+/** Estatus de un producto del catálogo. */
+export enum RetailProductStatusEnum {
+    ACTIVE = 'ACTIVE',
+    INACTIVE = 'INACTIVE',
+    DISCONTINUED = 'DISCONTINUED',
+}

package/src/retailIntegration/enums/RetailProductTierEnum.ts

@@ -0,0 +1,7 @@
+/** Gama de un producto. */
+export enum RetailProductTierEnum {
+    LOW = 'LOW',
+    MID = 'MID',
+    HIGH = 'HIGH',
+    PREMIUM = 'PREMIUM',
+}

package/src/retailIntegration/enums/RetailSaleFinancierEnum.ts

@@ -0,0 +1,9 @@
+/** Financiera de la venta; `NONE` en una venta de contado. */
+export enum RetailSaleFinancierEnum {
+    NONE = 'NONE',
+    SUREKEEP = 'SUREKEEP',
+    PAYJOY = 'PAYJOY',
+    CREDIYA = 'CREDIYA',
+    LESPAGO = 'LESPAGO',
+    INNOVA = 'INNOVA',
+}

package/src/retailIntegration/enums/RetailSaleTypeEnum.ts

@@ -0,0 +1,6 @@
+/** Tipo de venta. */
+export enum RetailSaleTypeEnum {
+    CASH = 'CASH',
+    CREDIT = 'CREDIT',
+    EXTERNAL_REFERRAL = 'EXTERNAL_REFERRAL',
+}

package/src/retailIntegration/enums/RetailStoreStatusEnum.ts

@@ -0,0 +1,6 @@
+/** Estatus de una tienda del retailer. */
+export enum RetailStoreStatusEnum {
+    ACTIVE = 'ACTIVE',
+    SUSPENDED = 'SUSPENDED',
+    INACTIVE = 'INACTIVE',
+}

package/src/retailIntegration/enums/RetailTrackingModeEnum.ts

@@ -0,0 +1,6 @@
+/** Cómo se rastrea un producto: por IMEI, por serie o por cantidad. */
+export enum RetailTrackingModeEnum {
+    IMEI = 'IMEI',
+    SERIAL = 'SERIAL',
+    QUANTITY = 'QUANTITY',
+}

package/src/retailIntegration/enums/RetailUserAccessStatusEnum.ts

@@ -0,0 +1,6 @@
+/** Estatus de acceso de un usuario del retailer. */
+export enum RetailUserAccessStatusEnum {
+    ACTIVE = 'ACTIVE',
+    SUSPENDED = 'SUSPENDED',
+    INACTIVE = 'INACTIVE',
+}

package/src/retailIntegration/enums/RetailUserEventTypeEnum.ts

@@ -0,0 +1,7 @@
+/** `eventType` válidos en `POST /webhooks/users`. */
+export enum RetailUserEventTypeEnum {
+    RETAIL_USER_CREATED_V1 = 'RetailUserCreatedV1',
+    RETAIL_USER_UPDATED_V1 = 'RetailUserUpdatedV1',
+    RETAIL_USER_TRANSFERRED_V1 = 'RetailUserTransferredV1',
+    RETAIL_USER_STATUS_CHANGED_V1 = 'RetailUserStatusChangedV1',
+}

package/src/retailIntegration/enums/RetailUserRoleEnum.ts

@@ -0,0 +1,7 @@
+/** Rol de un usuario de la operación del retailer. */
+export enum RetailUserRoleEnum {
+    SELLER = 'SELLER',
+    STORE_MANAGER = 'STORE_MANAGER',
+    RETAILER_ADMIN = 'RETAILER_ADMIN',
+    COLLECTION_AGENT = 'COLLECTION_AGENT',
+}

package/src/retailIntegration/enums/StoreEventTypeEnum.ts

@@ -0,0 +1,6 @@
+/** `eventType` válidos en `POST /webhooks/stores`. */
+export enum StoreEventTypeEnum {
+    STORE_CREATED_V1 = 'StoreCreatedV1',
+    STORE_UPDATED_V1 = 'StoreUpdatedV1',
+    STORE_STATUS_CHANGED_V1 = 'StoreStatusChangedV1',
+}

package/src/retailIntegration/enums/index.ts

@@ -0,0 +1,21 @@
+export * from './RetailEventResultEnum';
+export * from './StoreEventTypeEnum';
+export * from './RetailUserEventTypeEnum';
+export * from './ProductEventTypeEnum';
+export * from './InventoryEventTypeEnum';
+export * from './RetailStoreStatusEnum';
+export * from './RetailProductCategoryEnum';
+export * from './RetailTrackingModeEnum';
+export * from './RetailProductTierEnum';
+export * from './RetailCurrencyEnum';
+export * from './RetailFinancierEnum';
+export * from './RetailMdmProviderEnum';
+export * from './RetailProductStatusEnum';
+export * from './RetailPieceStatusEnum';
+export * from './RetailPieceReasonEnum';
+export * from './RetailUserRoleEnum';
+export * from './RetailUserAccessStatusEnum';
+export * from './RetailSaleTypeEnum';
+export * from './RetailSaleFinancierEnum';
+export * from './RetailPaymentMethodEnum';
+export * from './RetailLinePaymentTypeEnum';

package/src/retailIntegration/index.ts

@@ -0,0 +1,25 @@
+export * from './constants/retailIntegrationLimits';
+export * from './enums';
+export * from './validators/IsIsoDateTimeWithZone';
+export * from './dtos/RetailEventEnvelope';
+export * from './dtos/ReceiveStoreEventRequest';
+export * from './dtos/ReceiveRetailUserEventRequest';
+export * from './dtos/ReceiveProductEventRequest';
+export * from './dtos/ReceiveInventoryEventRequest';
+export * from './dtos/ReceiveRetailEventRequest';
+export * from './dtos/RetailEventResult';
+export * from './dtos/ApplyRetailEventRequest';
+export * from './dtos/RetailTenantQuery';
+export * from './dtos/RetailPagedQuery';
+export * from './dtos/ListRetailStoresRequest';
+export * from './dtos/ListRetailCatalogRequest';
+export * from './dtos/GetRetailInventoryRequest';
+export * from './dtos/ListRetailUsersRequest';
+export * from './dtos/RegisterRetailSaleRequest';
+export * from './dtos/RetailOutboundResponses';
+export * from './models/RetailPageMeta';
+export * from './models/RetailSystemStore';
+export * from './models/RetailSystemProduct';
+export * from './models/RetailSystemInventory';
+export * from './models/RetailSystemUser';
+export * from './models/RetailSystemSale';

package/src/retailIntegration/models/RetailPageMeta.ts

@@ -0,0 +1,11 @@
+/** `meta` de una lista paginada del retailer; `nextToken` en `null` cierra la lectura. */
+export interface RetailPageMeta {
+    count: number;
+    nextToken: string | null;
+}
+
+/** `meta` del inventario de una tienda. */
+export interface RetailInventoryMeta {
+    storeId: string;
+    generatedAt: string;
+}

package/src/retailIntegration/models/RetailSystemInventory.ts

@@ -0,0 +1,20 @@
+import { RetailPieceReasonEnum, RetailPieceStatusEnum } from '../enums';
+
+export type RetailPieceStatus = `${RetailPieceStatusEnum}`;
+export type RetailPieceReason = `${RetailPieceReasonEnum}`;
+
+/** Pieza con IMEI o número de serie. */
+export interface RetailSystemPiece {
+    sku: string;
+    identifier: string;
+    storeId: string;
+    status: RetailPieceStatus;
+    reason: RetailPieceReason | null;
+}
+
+/** Existencia de un producto sin identificador por unidad. */
+export interface RetailSystemStock {
+    sku: string;
+    storeId: string;
+    qty: number;
+}