@fiado/type-kit 3.388.0 → 3.390.0

package/bin/collection/dtos/CaptureCollectionHoldRequest.d.ts

@@ -0,0 +1,25 @@
+import { MechanismType } from '../enums/MechanismType';
+import { CollectionPricingDto } from './CollectionPricingDto';
+/**
+ * Captura de una retención: el dinero que estaba congelado en la cuenta del titular por fin sale.
+ *
+ * Una reserva no es un cobro. Hasta que se captura, el importe sigue siendo del cliente —sólo que
+ * inmovilizado— y no hay asiento contable que lo respalde. Esta petición cierra ese ciclo.
+ */
+export declare class CaptureCollectionHoldRequest {
+    /** Idempotencia: capturar dos veces con el mismo valor no mueve el dinero dos veces. */
+    executionId: string;
+    directoryId: string;
+    /** El identificador de la retención que devolvió el mecanismo al reservar. */
+    holdTxId: string;
+    /** Importe de la DEUDA que la retención cubre, sin la comisión encima. */
+    amount: number;
+    mechanism: MechanismType;
+    intentId?: string;
+    chargeId?: string;
+    /**
+     * Tarifa con la que se asienta el cobro. Presente, la captura deja transacción Fiado. Ausente, el
+     * dinero se libera igual pero sin asiento — mismo criterio que la autorización.
+     */
+    pricing?: CollectionPricingDto;
+}

package/bin/collection/dtos/CaptureCollectionHoldRequest.js

@@ -0,0 +1,61 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CaptureCollectionHoldRequest = void 0;
+const class_validator_1 = require("class-validator");
+const class_transformer_1 = require("class-transformer");
+const MechanismType_1 = require("../enums/MechanismType");
+const CollectionPricingDto_1 = require("./CollectionPricingDto");
+/**
+ * Captura de una retención: el dinero que estaba congelado en la cuenta del titular por fin sale.
+ *
+ * Una reserva no es un cobro. Hasta que se captura, el importe sigue siendo del cliente —sólo que
+ * inmovilizado— y no hay asiento contable que lo respalde. Esta petición cierra ese ciclo.
+ */
+class CaptureCollectionHoldRequest {
+}
+exports.CaptureCollectionHoldRequest = CaptureCollectionHoldRequest;
+__decorate([
+    (0, class_validator_1.IsString)(),
+    __metadata("design:type", String)
+], CaptureCollectionHoldRequest.prototype, "executionId", void 0);
+__decorate([
+    (0, class_validator_1.IsString)(),
+    __metadata("design:type", String)
+], CaptureCollectionHoldRequest.prototype, "directoryId", void 0);
+__decorate([
+    (0, class_validator_1.IsString)(),
+    __metadata("design:type", String)
+], CaptureCollectionHoldRequest.prototype, "holdTxId", void 0);
+__decorate([
+    (0, class_validator_1.IsNumber)(),
+    __metadata("design:type", Number)
+], CaptureCollectionHoldRequest.prototype, "amount", void 0);
+__decorate([
+    (0, class_validator_1.IsEnum)(MechanismType_1.MechanismType),
+    __metadata("design:type", String)
+], CaptureCollectionHoldRequest.prototype, "mechanism", void 0);
+__decorate([
+    (0, class_validator_1.IsOptional)(),
+    (0, class_validator_1.IsString)(),
+    __metadata("design:type", String)
+], CaptureCollectionHoldRequest.prototype, "intentId", void 0);
+__decorate([
+    (0, class_validator_1.IsOptional)(),
+    (0, class_validator_1.IsString)(),
+    __metadata("design:type", String)
+], CaptureCollectionHoldRequest.prototype, "chargeId", void 0);
+__decorate([
+    (0, class_validator_1.IsOptional)(),
+    (0, class_validator_1.ValidateNested)(),
+    (0, class_transformer_1.Type)(() => CollectionPricingDto_1.CollectionPricingDto),
+    __metadata("design:type", CollectionPricingDto_1.CollectionPricingDto)
+], CaptureCollectionHoldRequest.prototype, "pricing", void 0);

package/bin/collection/dtos/CaptureCollectionHoldResponse.d.ts

@@ -0,0 +1,16 @@
+import { CollectionResultStatus } from '../enums/CollectionResultStatus';
+/**
+ * Resultado de capturar una retención.
+ *
+ * `FULL` es que el dinero salió de la cuenta y quedó asentado. `NONE` es que el proveedor no
+ * confirmó la captura: la retención sigue en pie y el importe sigue siendo del titular.
+ */
+export declare class CaptureCollectionHoldResponse {
+    status: CollectionResultStatus;
+    /** Lo capturado, en importe de deuda. Cero si el proveedor no confirmó. */
+    amount: number;
+    /** Referencia de la captura en el proveedor, para cruzarla contra la retención original. */
+    captureTxId?: string;
+    /** Transacción Fiado del asiento, cuando la captura llevó tarifa. */
+    transactionId?: string;
+}

package/bin/collection/dtos/CaptureCollectionHoldResponse.js

@@ -0,0 +1,41 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CaptureCollectionHoldResponse = void 0;
+const class_validator_1 = require("class-validator");
+const CollectionResultStatus_1 = require("../enums/CollectionResultStatus");
+/**
+ * Resultado de capturar una retención.
+ *
+ * `FULL` es que el dinero salió de la cuenta y quedó asentado. `NONE` es que el proveedor no
+ * confirmó la captura: la retención sigue en pie y el importe sigue siendo del titular.
+ */
+class CaptureCollectionHoldResponse {
+}
+exports.CaptureCollectionHoldResponse = CaptureCollectionHoldResponse;
+__decorate([
+    (0, class_validator_1.IsEnum)(CollectionResultStatus_1.CollectionResultStatus),
+    __metadata("design:type", String)
+], CaptureCollectionHoldResponse.prototype, "status", void 0);
+__decorate([
+    (0, class_validator_1.IsNumber)(),
+    __metadata("design:type", Number)
+], CaptureCollectionHoldResponse.prototype, "amount", void 0);
+__decorate([
+    (0, class_validator_1.IsOptional)(),
+    (0, class_validator_1.IsString)(),
+    __metadata("design:type", String)
+], CaptureCollectionHoldResponse.prototype, "captureTxId", void 0);
+__decorate([
+    (0, class_validator_1.IsOptional)(),
+    (0, class_validator_1.IsString)(),
+    __metadata("design:type", String)
+], CaptureCollectionHoldResponse.prototype, "transactionId", void 0);

package/bin/collection/enums/AckIntentStatus.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Desenlace de dar por atendida la alerta de un intent. No tiene variante "terminal": reconocer una
+ * alerta es válido incluso sobre un intent que ya cerró después del problema que la disparó.
+ */
+export declare enum AckIntentStatus {
+    ACKED = "ACKED",
+    NOT_FOUND = "NOT_FOUND"
+}

package/bin/collection/enums/AckIntentStatus.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AckIntentStatus = void 0;
+/**
+ * Desenlace de dar por atendida la alerta de un intent. No tiene variante "terminal": reconocer una
+ * alerta es válido incluso sobre un intent que ya cerró después del problema que la disparó.
+ */
+var AckIntentStatus;
+(function (AckIntentStatus) {
+    AckIntentStatus["ACKED"] = "ACKED";
+    AckIntentStatus["NOT_FOUND"] = "NOT_FOUND";
+})(AckIntentStatus || (exports.AckIntentStatus = AckIntentStatus = {}));

package/bin/collection/enums/RedriveOutboxStatus.d.ts

@@ -0,0 +1,8 @@
+/** Desenlace de reinyectar un evento atascado en la cola muerta. */
+export declare enum RedriveOutboxStatus {
+    /** El evento volvió a la cola de entrega y se reintentará. */
+    REDRIVEN = "REDRIVEN",
+    /** El evento no estaba en la cola muerta: reinyectarlo duplicaría una entrega en curso. */
+    NOT_DLQ = "NOT_DLQ",
+    NOT_FOUND = "NOT_FOUND"
+}

package/bin/collection/enums/RedriveOutboxStatus.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RedriveOutboxStatus = void 0;
+/** Desenlace de reinyectar un evento atascado en la cola muerta. */
+var RedriveOutboxStatus;
+(function (RedriveOutboxStatus) {
+    /** El evento volvió a la cola de entrega y se reintentará. */
+    RedriveOutboxStatus["REDRIVEN"] = "REDRIVEN";
+    /** El evento no estaba en la cola muerta: reinyectarlo duplicaría una entrega en curso. */
+    RedriveOutboxStatus["NOT_DLQ"] = "NOT_DLQ";
+    RedriveOutboxStatus["NOT_FOUND"] = "NOT_FOUND";
+})(RedriveOutboxStatus || (exports.RedriveOutboxStatus = RedriveOutboxStatus = {}));

package/bin/collection/enums/RetryIntentStatus.d.ts

@@ -0,0 +1,8 @@
+/** Desenlace de un reintento forzado desde el panel de operación. */
+export declare enum RetryIntentStatus {
+    /** El intent estaba vivo y quedó reagendado para el próximo barrido. */
+    RETRIED = "RETRIED",
+    /** El intent ya había terminado (cobrado o cancelado). Forzar un reintento sería revivirlo. */
+    ALREADY_TERMINAL = "ALREADY_TERMINAL",
+    NOT_FOUND = "NOT_FOUND"
+}

package/bin/collection/enums/RetryIntentStatus.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RetryIntentStatus = void 0;
+/** Desenlace de un reintento forzado desde el panel de operación. */
+var RetryIntentStatus;
+(function (RetryIntentStatus) {
+    /** El intent estaba vivo y quedó reagendado para el próximo barrido. */
+    RetryIntentStatus["RETRIED"] = "RETRIED";
+    /** El intent ya había terminado (cobrado o cancelado). Forzar un reintento sería revivirlo. */
+    RetryIntentStatus["ALREADY_TERMINAL"] = "ALREADY_TERMINAL";
+    RetryIntentStatus["NOT_FOUND"] = "NOT_FOUND";
+})(RetryIntentStatus || (exports.RetryIntentStatus = RetryIntentStatus = {}));

package/bin/collection/index.d.ts

@@ -1,3 +1,5 @@
+export * from './dtos/CaptureCollectionHoldRequest';
+export * from './dtos/CaptureCollectionHoldResponse';
 export * from './enums/MechanismType';
 export * from './enums/CollectionState';
 export * from './enums/SagaStep';
@@ -5,6 +7,9 @@ export * from './enums/CollectionResultStatus';
 export * from './enums/DeregisterChargeStatus';
 export * from './enums/RegisterCollectibleStatus';
 export * from './enums/CollectionFeeMode';
+export * from './enums/RetryIntentStatus';
+export * from './enums/AckIntentStatus';
+export * from './enums/RedriveOutboxStatus';
 export * from './dtos/PendingChargeDto';
 export * from './dtos/CollectRequest';
 export * from './dtos/CollectResponse';

package/bin/collection/index.js

@@ -15,6 +15,8 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 // Enums
+__exportStar(require("./dtos/CaptureCollectionHoldRequest"), exports);
+__exportStar(require("./dtos/CaptureCollectionHoldResponse"), exports);
 __exportStar(require("./enums/MechanismType"), exports);
 __exportStar(require("./enums/CollectionState"), exports);
 __exportStar(require("./enums/SagaStep"), exports);
@@ -22,6 +24,9 @@ __exportStar(require("./enums/CollectionResultStatus"), exports);
 __exportStar(require("./enums/DeregisterChargeStatus"), exports);
 __exportStar(require("./enums/RegisterCollectibleStatus"), exports);
 __exportStar(require("./enums/CollectionFeeMode"), exports);
+__exportStar(require("./enums/RetryIntentStatus"), exports);
+__exportStar(require("./enums/AckIntentStatus"), exports);
+__exportStar(require("./enums/RedriveOutboxStatus"), exports);
 // DTOs
 __exportStar(require("./dtos/PendingChargeDto"), exports);
 __exportStar(require("./dtos/CollectRequest"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fiado/type-kit",
-  "version": "3.388.0",
+  "version": "3.390.0",
   "description": "",
   "main": "bin/index.js",
   "types": "bin/index.d.ts",

package/src/collection/dtos/CaptureCollectionHoldRequest.ts

@@ -0,0 +1,34 @@
+import { IsString, IsNumber, IsOptional, IsEnum, ValidateNested } from 'class-validator';
+import { Type } from 'class-transformer';
+import { MechanismType } from '../enums/MechanismType';
+import { CollectionPricingDto } from './CollectionPricingDto';
+
+/**
+ * Captura de una retención: el dinero que estaba congelado en la cuenta del titular por fin sale.
+ *
+ * Una reserva no es un cobro. Hasta que se captura, el importe sigue siendo del cliente —sólo que
+ * inmovilizado— y no hay asiento contable que lo respalde. Esta petición cierra ese ciclo.
+ */
+export class CaptureCollectionHoldRequest {
+  /** Idempotencia: capturar dos veces con el mismo valor no mueve el dinero dos veces. */
+  @IsString() executionId!: string;
+
+  @IsString() directoryId!: string;
+
+  /** El identificador de la retención que devolvió el mecanismo al reservar. */
+  @IsString() holdTxId!: string;
+
+  /** Importe de la DEUDA que la retención cubre, sin la comisión encima. */
+  @IsNumber() amount!: number;
+
+  @IsEnum(MechanismType) mechanism!: MechanismType;
+
+  @IsOptional() @IsString() intentId?: string;
+  @IsOptional() @IsString() chargeId?: string;
+
+  /**
+   * Tarifa con la que se asienta el cobro. Presente, la captura deja transacción Fiado. Ausente, el
+   * dinero se libera igual pero sin asiento — mismo criterio que la autorización.
+   */
+  @IsOptional() @ValidateNested() @Type(() => CollectionPricingDto) pricing?: CollectionPricingDto;
+}

package/src/collection/dtos/CaptureCollectionHoldResponse.ts

@@ -0,0 +1,21 @@
+import { IsString, IsNumber, IsOptional, IsEnum } from 'class-validator';
+import { CollectionResultStatus } from '../enums/CollectionResultStatus';
+
+/**
+ * Resultado de capturar una retención.
+ *
+ * `FULL` es que el dinero salió de la cuenta y quedó asentado. `NONE` es que el proveedor no
+ * confirmó la captura: la retención sigue en pie y el importe sigue siendo del titular.
+ */
+export class CaptureCollectionHoldResponse {
+  @IsEnum(CollectionResultStatus) status!: CollectionResultStatus;
+
+  /** Lo capturado, en importe de deuda. Cero si el proveedor no confirmó. */
+  @IsNumber() amount!: number;
+
+  /** Referencia de la captura en el proveedor, para cruzarla contra la retención original. */
+  @IsOptional() @IsString() captureTxId?: string;
+
+  /** Transacción Fiado del asiento, cuando la captura llevó tarifa. */
+  @IsOptional() @IsString() transactionId?: string;
+}

package/src/collection/enums/AckIntentStatus.ts

@@ -0,0 +1,8 @@
+/**
+ * Desenlace de dar por atendida la alerta de un intent. No tiene variante "terminal": reconocer una
+ * alerta es válido incluso sobre un intent que ya cerró después del problema que la disparó.
+ */
+export enum AckIntentStatus {
+  ACKED = 'ACKED',
+  NOT_FOUND = 'NOT_FOUND',
+}

package/src/collection/enums/RedriveOutboxStatus.ts

@@ -0,0 +1,8 @@
+/** Desenlace de reinyectar un evento atascado en la cola muerta. */
+export enum RedriveOutboxStatus {
+  /** El evento volvió a la cola de entrega y se reintentará. */
+  REDRIVEN = 'REDRIVEN',
+  /** El evento no estaba en la cola muerta: reinyectarlo duplicaría una entrega en curso. */
+  NOT_DLQ = 'NOT_DLQ',
+  NOT_FOUND = 'NOT_FOUND',
+}

package/src/collection/enums/RetryIntentStatus.ts

@@ -0,0 +1,8 @@
+/** Desenlace de un reintento forzado desde el panel de operación. */
+export enum RetryIntentStatus {
+  /** El intent estaba vivo y quedó reagendado para el próximo barrido. */
+  RETRIED = 'RETRIED',
+  /** El intent ya había terminado (cobrado o cancelado). Forzar un reintento sería revivirlo. */
+  ALREADY_TERMINAL = 'ALREADY_TERMINAL',
+  NOT_FOUND = 'NOT_FOUND',
+}

package/src/collection/index.ts

@@ -1,4 +1,6 @@
 // Enums
+export * from './dtos/CaptureCollectionHoldRequest';
+export * from './dtos/CaptureCollectionHoldResponse';
 export * from './enums/MechanismType';
 export * from './enums/CollectionState';
 export * from './enums/SagaStep';
@@ -6,6 +8,9 @@ export * from './enums/CollectionResultStatus';
 export * from './enums/DeregisterChargeStatus';
 export * from './enums/RegisterCollectibleStatus';
 export * from './enums/CollectionFeeMode';
+export * from './enums/RetryIntentStatus';
+export * from './enums/AckIntentStatus';
+export * from './enums/RedriveOutboxStatus';
 
 // DTOs
 export * from './dtos/PendingChargeDto';