@fiado/type-kit 3.613.0 → 3.615.0

package/src/loanOfferings/dtos/responses/TestCohortResponse.ts

@@ -0,0 +1,19 @@
+import { CohortConditionOutcomeEnum } from '../../enums/CohortConditionOutcomeEnum';
+import { CohortFactKeyEnum } from '../../enums/CohortFactKeyEnum';
+import { CohortConditionResponse } from './CohortResponse';
+
+/** Una condición probada con un cliente: el valor real que tiene y si la cumple. */
+export interface CohortConditionTrace extends CohortConditionResponse {
+    /** Valor del cliente. `null` = no tiene el dato. */
+    actual: number | boolean | string | null;
+    outcome: CohortConditionOutcomeEnum;
+}
+
+/** Respuesta de POST /cohorts/test. `matched` es `true` si el cliente cumple todas las condiciones. */
+export interface TestCohortResponse {
+    retailCustomerId: string;
+    matched: boolean;
+    /** Datos del cliente que se evaluaron. Un dato ausente no viene. */
+    facts: Partial<Record<CohortFactKeyEnum, number | boolean | string>>;
+    conditions: CohortConditionTrace[];
+}

package/src/loanOfferings/dtos/responses/TestCustomerSegmentsResponse.ts

@@ -0,0 +1,25 @@
+import { CohortFactKeyEnum } from '../../enums/CohortFactKeyEnum';
+import { SegmentMembershipReasonEnum } from '../../enums/SegmentMembershipReasonEnum';
+
+/** Un segmento evaluado para un cliente: si entra, por qué, y qué cohorts cumplió. */
+export interface CustomerSegmentTrace {
+    segmentId: string;
+    name: string;
+    matched: boolean;
+    /** `null` cuando no entra. */
+    reason: SegmentMembershipReasonEnum | null;
+    matchedCohortIds: string[];
+}
+
+/** Respuesta de POST /segments/test. */
+export interface TestCustomerSegmentsResponse {
+    retailCustomerId: string;
+    /** Datos del cliente que se evaluaron. Un dato ausente no viene. */
+    facts: Partial<Record<CohortFactKeyEnum, number | boolean | string>>;
+    /** Todos los segmentos ACTIVE que no son el catch-all. */
+    segments: CustomerSegmentTrace[];
+    /** `true` si no cayó en ningún segmento: le aplica el catch-all. */
+    defaultApplies: boolean;
+    /** `false` si el evaluador de cohorts falló: solo cuenta la lista manual. */
+    evaluatorAvailable: boolean;
+}

package/src/loanOfferings/enums/CohortConditionOutcomeEnum.ts

@@ -0,0 +1,10 @@
+/**
+ * Resultado de una condición al probar un cohort con un cliente. `MISSING` = el cliente no tiene
+ * ese dato, así que la condición no se cumple.
+ * @enum {string}
+ */
+export enum CohortConditionOutcomeEnum {
+    MATCH = 'MATCH',
+    NO_MATCH = 'NO_MATCH',
+    MISSING = 'MISSING',
+}

package/src/loanOfferings/enums/CohortFactKeyEnum.ts

@@ -0,0 +1,17 @@
+/**
+ * Datos del cliente sobre los que se arma una condición de cohort. Catálogo cerrado: un dato
+ * nuevo es un cambio de código en quien lo calcula y en quien lo evalúa.
+ * @enum {string}
+ */
+export enum CohortFactKeyEnum {
+    SCI_LEVEL = 'sciLevel',
+    TOTAL_CREDITS = 'totalCredits',
+    ACTIVE_CREDITS = 'activeCredits',
+    COMPLETED_CREDITS = 'completedCredits',
+    LIFETIME_WRITE_OFFS = 'lifetimeWriteOffs',
+    CURRENT_ARREARS_DAYS = 'currentArrearsDays',
+    DELINQUENCY_DAYS_LAST_6M = 'delinquencyDaysLast6M',
+    LIFETIME_RESTRUCTURES = 'lifetimeRestructures',
+    IS_EMPLOYEE = 'isEmployee',
+    HAS_PCF_ACCOUNT = 'hasPcfAccount',
+}

package/src/loanOfferings/enums/CohortFactTypeEnum.ts

@@ -0,0 +1,9 @@
+/**
+ * Tipo de un dato del catálogo de cohorts. Define qué operadores admite y cómo se pinta el valor.
+ * @enum {string}
+ */
+export enum CohortFactTypeEnum {
+    NUMBER = 'NUMBER',
+    SELECT = 'SELECT',
+    BOOLEAN = 'BOOLEAN',
+}

package/src/loanOfferings/enums/CohortLogEventEnum.ts

@@ -0,0 +1,10 @@
+/**
+ * Evento de la bitácora de un cohort.
+ * @enum {string}
+ */
+export enum CohortLogEventEnum {
+    CREATED = 'CREATED',
+    UPDATED = 'UPDATED',
+    ARCHIVED = 'ARCHIVED',
+    REACTIVATED = 'REACTIVATED',
+}

package/src/loanOfferings/enums/CohortOperatorEnum.ts

@@ -0,0 +1,15 @@
+/**
+ * Operador de una condición de cohort. `IN` y `NOT_IN` comparan contra una lista (`values`); el
+ * resto, contra un solo valor (`value`).
+ * @enum {string}
+ */
+export enum CohortOperatorEnum {
+    EQUALS = 'EQUALS',
+    NOT_EQUALS = 'NOT_EQUALS',
+    GT = 'GT',
+    GTE = 'GTE',
+    LT = 'LT',
+    LTE = 'LTE',
+    IN = 'IN',
+    NOT_IN = 'NOT_IN',
+}

package/src/loanOfferings/enums/CohortStatusEnum.ts

@@ -0,0 +1,9 @@
+/**
+ * Estado persistido de un cohort. No hay borrado: `ARCHIVED` lo saca de la evaluación y de los
+ * selectores, y los segmentos que lo usaban siguen resolviendo su nombre.
+ * @enum {string}
+ */
+export enum CohortStatusEnum {
+    ACTIVE = 'ACTIVE',
+    ARCHIVED = 'ARCHIVED',
+}

package/src/loanOfferings/enums/SegmentFilterIdEnum.ts

@@ -4,6 +4,8 @@
  *
  * El nombre y la descripción que ve el operador NO viven acá: los sirve
  * `GET /segments/filters`, junto con la marca de si el filtro tiene fuente de datos hoy.
+ * @deprecated El segmento se arma con cohorts (`cohortIds`). Se conserva para migrar los filtros
+ * viejos y para los consumidores que todavía lo importan.
  * @enum {string}
  */
 export enum SegmentFilterIdEnum {

package/src/loanOfferings/enums/SegmentLogEventEnum.ts

@@ -0,0 +1,10 @@
+/**
+ * Evento de la bitácora de un segmento.
+ * @enum {string}
+ */
+export enum SegmentLogEventEnum {
+    CREATED = 'CREATED',
+    UPDATED = 'UPDATED',
+    ARCHIVED = 'ARCHIVED',
+    REACTIVATED = 'REACTIVATED',
+}

package/src/loanOfferings/enums/SegmentMembershipReasonEnum.ts

@@ -0,0 +1,9 @@
+/**
+ * Por qué un cliente entra a un segmento: está en la lista manual (`MEMBER`) o cumple al menos
+ * uno de sus cohorts (`COHORT`). Si cumple las dos, gana la lista manual.
+ * @enum {string}
+ */
+export enum SegmentMembershipReasonEnum {
+    MEMBER = 'MEMBER',
+    COHORT = 'COHORT',
+}

package/src/loanOfferings/enums/SegmentationRecountStatusEnum.ts

@@ -0,0 +1,9 @@
+/**
+ * Estado de una corrida de recálculo de conteos de cohorts y segmentos.
+ * @enum {string}
+ */
+export enum SegmentationRecountStatusEnum {
+    RUNNING = 'RUNNING',
+    FINISHED = 'FINISHED',
+    FAILED = 'FAILED',
+}

package/src/loanOfferings/enums/SegmentationRecountTriggerEnum.ts

@@ -0,0 +1,8 @@
+/**
+ * Qué disparó un recálculo de conteos: la corrida nocturna o el botón del backoffice.
+ * @enum {string}
+ */
+export enum SegmentationRecountTriggerEnum {
+    NIGHTLY = 'NIGHTLY',
+    MANUAL = 'MANUAL',
+}

package/src/loanOfferings/index.ts

@@ -17,9 +17,20 @@ export * from './enums/SegmentStatusEnum';
 export * from './enums/SegmentColorSlotEnum';
 export * from './enums/SegmentFilterIdEnum';
 export * from './enums/PrepaymentMinimumModeEnum';
+export * from './enums/CohortStatusEnum';
+export * from './enums/CohortFactKeyEnum';
+export * from './enums/CohortFactTypeEnum';
+export * from './enums/CohortOperatorEnum';
+export * from './enums/CohortConditionOutcomeEnum';
+export * from './enums/CohortLogEventEnum';
+export * from './enums/SegmentLogEventEnum';
+export * from './enums/SegmentMembershipReasonEnum';
+export * from './enums/SegmentationRecountTriggerEnum';
+export * from './enums/SegmentationRecountStatusEnum';
 
 // Constantes
 export * from './constants/promotionSkuBatch';
+export * from './constants/promotionRetailerScope';
 
 // Entity DTOs
 export * from './dtos/CreditPlan';
@@ -50,7 +61,16 @@ export * from './dtos/requests/ChangeStorePolicyStatusRequest';
 export * from './dtos/requests/CreateSegmentRequest';
 export * from './dtos/requests/UpdateSegmentRequest';
 export * from './dtos/requests/ChangeSegmentStatusRequest';
+export * from './dtos/requests/CustomerSegmentFacts';
 export * from './dtos/requests/ResolveCustomerSegmentsRequest';
+export * from './dtos/requests/ResolveSegmentMembersRequest';
+export * from './dtos/requests/TestCustomerSegmentsRequest';
+export * from './dtos/requests/CohortCondition';
+export * from './dtos/requests/CreateCohortRequest';
+export * from './dtos/requests/UpdateCohortRequest';
+export * from './dtos/requests/ChangeCohortStatusRequest';
+export * from './dtos/requests/TestCohortRequest';
+export * from './dtos/requests/ListCohortsQuery';
 export * from './dtos/requests/ComputeAmortizationScheduleRequest';
 export * from './dtos/requests/ListSegmentCatalogQuery';
 export * from './dtos/requests/PromotionSkuInput';
@@ -75,5 +95,15 @@ export * from './dtos/responses/SegmentResponse';
 export * from './dtos/responses/SegmentFilterResponse';
 export * from './dtos/responses/SegmentCatalogResponse';
 export * from './dtos/responses/ResolveCustomerSegmentsResponse';
+export * from './dtos/responses/SegmentMembersResponse';
+export * from './dtos/responses/SegmentUsageResponse';
+export * from './dtos/responses/TestCustomerSegmentsResponse';
+export * from './dtos/responses/SegmentLogEntryResponse';
+export * from './dtos/responses/SegmentationRecountStartResponse';
+export * from './dtos/responses/SegmentationRecountRunResponse';
+export * from './dtos/responses/CohortResponse';
+export * from './dtos/responses/CohortCatalogResponse';
+export * from './dtos/responses/TestCohortResponse';
+export * from './dtos/responses/CohortLogEntryResponse';
 export * from './dtos/responses/AmortizationScheduleRow';
 export * from './dtos/responses/AmortizationScheduleResponse';