@fiado/type-kit 3.367.0 → 3.368.0

package/bin/account/dtos/CollectDebitRequest.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Débito atómico condicional sobre el saldo disponible de una cuenta, para cobrar una deuda.
+ *
+ * `executionId` identifica el intento de cobro y es lo que hace la operación idempotente: repetirlo
+ * con el mismo valor devuelve el resultado del primer intento en lugar de debitar de nuevo.
+ */
+export declare class CollectDebitRequest {
+    executionId: string;
+    amount: number;
+}

package/bin/account/dtos/CollectDebitRequest.js

@@ -0,0 +1,31 @@
+"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.CollectDebitRequest = void 0;
+const class_validator_1 = require("class-validator");
+/**
+ * Débito atómico condicional sobre el saldo disponible de una cuenta, para cobrar una deuda.
+ *
+ * `executionId` identifica el intento de cobro y es lo que hace la operación idempotente: repetirlo
+ * con el mismo valor devuelve el resultado del primer intento en lugar de debitar de nuevo.
+ */
+class CollectDebitRequest {
+}
+exports.CollectDebitRequest = CollectDebitRequest;
+__decorate([
+    (0, class_validator_1.IsString)(),
+    __metadata("design:type", String)
+], CollectDebitRequest.prototype, "executionId", void 0);
+__decorate([
+    (0, class_validator_1.IsNumber)(),
+    (0, class_validator_1.IsPositive)(),
+    __metadata("design:type", Number)
+], CollectDebitRequest.prototype, "amount", void 0);

package/bin/account/dtos/CollectDebitResponse.d.ts

@@ -0,0 +1,9 @@
+import { CollectDebitResultEnum } from '../enums/CollectDebitResultEnum';
+/**
+ * Resultado del débito. `NONE` significa saldo insuficiente, que es un desenlace normal del cobro y
+ * no un error: el motor pasa a la siguiente fuente de su cascada.
+ */
+export declare class CollectDebitResponse {
+    result: CollectDebitResultEnum;
+    collected: number;
+}

package/bin/account/dtos/CollectDebitResponse.js

@@ -0,0 +1,29 @@
+"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.CollectDebitResponse = void 0;
+const class_validator_1 = require("class-validator");
+const CollectDebitResultEnum_1 = require("../enums/CollectDebitResultEnum");
+/**
+ * Resultado del débito. `NONE` significa saldo insuficiente, que es un desenlace normal del cobro y
+ * no un error: el motor pasa a la siguiente fuente de su cascada.
+ */
+class CollectDebitResponse {
+}
+exports.CollectDebitResponse = CollectDebitResponse;
+__decorate([
+    (0, class_validator_1.IsEnum)(CollectDebitResultEnum_1.CollectDebitResultEnum),
+    __metadata("design:type", String)
+], CollectDebitResponse.prototype, "result", void 0);
+__decorate([
+    (0, class_validator_1.IsNumber)(),
+    __metadata("design:type", Number)
+], CollectDebitResponse.prototype, "collected", void 0);

package/bin/account/enums/CollectDebitResultEnum.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Resultado de un débito atómico condicional de cobro. No hay variante parcial: la condición del
+ * débito es "alcanza o no alcanza", así que la cuenta se debita entera o no se toca.
+ */
+export declare enum CollectDebitResultEnum {
+    FULL = "FULL",
+    NONE = "NONE"
+}

package/bin/account/enums/CollectDebitResultEnum.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CollectDebitResultEnum = void 0;
+/**
+ * Resultado de un débito atómico condicional de cobro. No hay variante parcial: la condición del
+ * débito es "alcanza o no alcanza", así que la cuenta se debita entera o no se toca.
+ */
+var CollectDebitResultEnum;
+(function (CollectDebitResultEnum) {
+    CollectDebitResultEnum["FULL"] = "FULL";
+    CollectDebitResultEnum["NONE"] = "NONE";
+})(CollectDebitResultEnum || (exports.CollectDebitResultEnum = CollectDebitResultEnum = {}));

package/bin/account/index.d.ts

@@ -43,6 +43,8 @@ export * from './dtos/BankAccountMCSendTransferRequest';
 export * from './dtos/BankAccountMCSendTransferResponse';
 export * from './dtos/CreateAccountEventRequest';
 export * from './dtos/CreateAccountEventResponse';
+export * from './dtos/CollectDebitRequest';
+export * from './dtos/CollectDebitResponse';
 export * from './entities/AccountEntityBase';
 export * from './entities/BankInfo';
 export * from './enums/AccountEntityStatusEnum';
@@ -57,3 +59,4 @@ export * from './enums/PocketOperationTypeEnum';
 export * from './enums/AchTransferStatusEnum';
 export * from './enums/AchTransferTypeEnum';
 export * from './enums/AccountLifecycleEventTypeEnum';
+export * from './enums/CollectDebitResultEnum';

package/bin/account/index.js

@@ -60,6 +60,8 @@ __exportStar(require("./dtos/BankAccountMCSendTransferRequest"), exports);
 __exportStar(require("./dtos/BankAccountMCSendTransferResponse"), exports);
 __exportStar(require("./dtos/CreateAccountEventRequest"), exports);
 __exportStar(require("./dtos/CreateAccountEventResponse"), exports);
+__exportStar(require("./dtos/CollectDebitRequest"), exports);
+__exportStar(require("./dtos/CollectDebitResponse"), exports);
 //Entities
 __exportStar(require("./entities/AccountEntityBase"), exports);
 __exportStar(require("./entities/BankInfo"), exports);
@@ -76,3 +78,4 @@ __exportStar(require("./enums/PocketOperationTypeEnum"), exports);
 __exportStar(require("./enums/AchTransferStatusEnum"), exports);
 __exportStar(require("./enums/AchTransferTypeEnum"), exports);
 __exportStar(require("./enums/AccountLifecycleEventTypeEnum"), exports);
+__exportStar(require("./enums/CollectDebitResultEnum"), exports);

package/package.json

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

package/src/account/dtos/CollectDebitRequest.ts

@@ -0,0 +1,15 @@
+import { IsNumber, IsPositive, IsString } from 'class-validator';
+
+/**
+ * Débito atómico condicional sobre el saldo disponible de una cuenta, para cobrar una deuda.
+ *
+ * `executionId` identifica el intento de cobro y es lo que hace la operación idempotente: repetirlo
+ * con el mismo valor devuelve el resultado del primer intento en lugar de debitar de nuevo.
+ */
+export class CollectDebitRequest {
+    @IsString() executionId!: string;
+
+    @IsNumber()
+    @IsPositive()
+    amount!: number;
+}

package/src/account/dtos/CollectDebitResponse.ts

@@ -0,0 +1,11 @@
+import { IsEnum, IsNumber } from 'class-validator';
+import { CollectDebitResultEnum } from '../enums/CollectDebitResultEnum';
+
+/**
+ * Resultado del débito. `NONE` significa saldo insuficiente, que es un desenlace normal del cobro y
+ * no un error: el motor pasa a la siguiente fuente de su cascada.
+ */
+export class CollectDebitResponse {
+    @IsEnum(CollectDebitResultEnum) result!: CollectDebitResultEnum;
+    @IsNumber() collected!: number;
+}

package/src/account/enums/CollectDebitResultEnum.ts

@@ -0,0 +1,8 @@
+/**
+ * Resultado de un débito atómico condicional de cobro. No hay variante parcial: la condición del
+ * débito es "alcanza o no alcanza", así que la cuenta se debita entera o no se toca.
+ */
+export enum CollectDebitResultEnum {
+    FULL = 'FULL',
+    NONE = 'NONE',
+}

package/src/account/index.ts

@@ -45,6 +45,8 @@ export * from './dtos/BankAccountMCSendTransferRequest';
 export * from './dtos/BankAccountMCSendTransferResponse';
 export * from './dtos/CreateAccountEventRequest';
 export * from './dtos/CreateAccountEventResponse';
+export * from './dtos/CollectDebitRequest';
+export * from './dtos/CollectDebitResponse';
 
 //Entities
 export * from './entities/AccountEntityBase';
@@ -63,3 +65,4 @@ export * from './enums/PocketOperationTypeEnum';
 export * from './enums/AchTransferStatusEnum';
 export * from './enums/AchTransferTypeEnum';
 export * from './enums/AccountLifecycleEventTypeEnum';
+export * from './enums/CollectDebitResultEnum';