@fiado/type-kit 3.325.0 → 3.326.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,11 @@
1
+ export declare enum BenefitFlowEnum {
2
+ TOPUPS = "TOPUPS",
3
+ BILL_PAYMENT = "BILL_PAYMENT",
4
+ CREDIT = "CREDIT",
5
+ INSURANCE = "INSURANCE",
6
+ DONATION = "DONATION",
7
+ PHARMACY = "PHARMACY",
8
+ REMITTANCE = "REMITTANCE",
9
+ /** Fondeo de wallet PCF con efectivo via provider externo (Equality/Passport, OpenPay, …) — spec 13. */
10
+ WALLET_FUNDING = "WALLET_FUNDING"
11
+ }
@@ -0,0 +1,15 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.BenefitFlowEnum = void 0;
4
+ var BenefitFlowEnum;
5
+ (function (BenefitFlowEnum) {
6
+ BenefitFlowEnum["TOPUPS"] = "TOPUPS";
7
+ BenefitFlowEnum["BILL_PAYMENT"] = "BILL_PAYMENT";
8
+ BenefitFlowEnum["CREDIT"] = "CREDIT";
9
+ BenefitFlowEnum["INSURANCE"] = "INSURANCE";
10
+ BenefitFlowEnum["DONATION"] = "DONATION";
11
+ BenefitFlowEnum["PHARMACY"] = "PHARMACY";
12
+ BenefitFlowEnum["REMITTANCE"] = "REMITTANCE";
13
+ /** Fondeo de wallet PCF con efectivo via provider externo (Equality/Passport, OpenPay, …) — spec 13. */
14
+ BenefitFlowEnum["WALLET_FUNDING"] = "WALLET_FUNDING";
15
+ })(BenefitFlowEnum || (exports.BenefitFlowEnum = BenefitFlowEnum = {}));
@@ -10,9 +10,22 @@
10
10
  * `PROOF_OF_ADDRESS` va sin prefijo por decisión de nombrado (la regla sigue siendo la del comprobante
11
11
  * de domicilio mexicano). `DATA_CONFIRMATION` es el paso de "revisá y confirmá tus datos"; se llama así
12
12
  * y no `INFO_SELF_VERIFY` para no confundirlo con la verificación de Metamap de `KYC_IDENTIFICATION`.
13
+ *
14
+ * Los DOS pasos de identificación son un solo trámite partido en dos, no dos trámites:
15
+ * `KYC_IDENTIFICATION` pide el primer documento —el que sea— y `KYC_IDENTIFICATION_MEX` aparece
16
+ * SOLO si ese primero no fue mexicano, porque entonces el lado rosa sigue sin documento propio.
13
17
  */
14
18
  export declare enum OnboardingStepIdEnum {
15
19
  KYC_IDENTIFICATION = "KYC_IDENTIFICATION",
20
+ /**
21
+ * Identificación mexicana, cuando el primer documento no lo fue. Oculto en el camino normal:
22
+ * el documento mexicano cubre los dos lados, así que quien empieza por ahí nunca lo ve.
23
+ *
24
+ * Existe porque la cobertura NO es simétrica. El documento mexicano llena el nombre latino y
25
+ * el US; el de USA (o el de cualquier otro país) deja el nombre latino sin respaldo de un
26
+ * documento mexicano, y la cuenta rosa exige los tres campos latinos para abrir.
27
+ */
28
+ KYC_IDENTIFICATION_MEX = "KYC_IDENTIFICATION_MEX",
16
29
  SSN_ITIN = "SSN_ITIN",
17
30
  INCOME_INFORMATION = "INCOME_INFORMATION",
18
31
  US_ADDRESS = "US_ADDRESS",
@@ -13,10 +13,23 @@ exports.OnboardingStepIdEnum = void 0;
13
13
  * `PROOF_OF_ADDRESS` va sin prefijo por decisión de nombrado (la regla sigue siendo la del comprobante
14
14
  * de domicilio mexicano). `DATA_CONFIRMATION` es el paso de "revisá y confirmá tus datos"; se llama así
15
15
  * y no `INFO_SELF_VERIFY` para no confundirlo con la verificación de Metamap de `KYC_IDENTIFICATION`.
16
+ *
17
+ * Los DOS pasos de identificación son un solo trámite partido en dos, no dos trámites:
18
+ * `KYC_IDENTIFICATION` pide el primer documento —el que sea— y `KYC_IDENTIFICATION_MEX` aparece
19
+ * SOLO si ese primero no fue mexicano, porque entonces el lado rosa sigue sin documento propio.
16
20
  */
17
21
  var OnboardingStepIdEnum;
18
22
  (function (OnboardingStepIdEnum) {
19
23
  OnboardingStepIdEnum["KYC_IDENTIFICATION"] = "KYC_IDENTIFICATION";
24
+ /**
25
+ * Identificación mexicana, cuando el primer documento no lo fue. Oculto en el camino normal:
26
+ * el documento mexicano cubre los dos lados, así que quien empieza por ahí nunca lo ve.
27
+ *
28
+ * Existe porque la cobertura NO es simétrica. El documento mexicano llena el nombre latino y
29
+ * el US; el de USA (o el de cualquier otro país) deja el nombre latino sin respaldo de un
30
+ * documento mexicano, y la cuenta rosa exige los tres campos latinos para abrir.
31
+ */
32
+ OnboardingStepIdEnum["KYC_IDENTIFICATION_MEX"] = "KYC_IDENTIFICATION_MEX";
20
33
  OnboardingStepIdEnum["SSN_ITIN"] = "SSN_ITIN";
21
34
  OnboardingStepIdEnum["INCOME_INFORMATION"] = "INCOME_INFORMATION";
22
35
  OnboardingStepIdEnum["US_ADDRESS"] = "US_ADDRESS";
@@ -0,0 +1,17 @@
1
+ import { CurrencyId } from '../../currency/enums/CurrencyId';
2
+ /**
3
+ * Comisión que cobra un punto de cash-in (lo que el lambda MUESTRA, no cobra).
4
+ * - GreenDot (US): representativo por cadena → `fixed` + `cap` (cada tienda cobra hasta el tope).
5
+ * - Passport (MX): por red → `fixed` + `percentage`.
6
+ * Response DTO — sin decoradores de validación.
7
+ */
8
+ export declare class CashInFeeDto {
9
+ /** Comisión fija, en la moneda del país. */
10
+ fixed?: number;
11
+ /** Porcentaje del monto depositado (0–100). */
12
+ percentage?: number;
13
+ /** Tope máximo de comisión (GreenDot: el asociado cobra hasta este cap). */
14
+ cap?: number;
15
+ /** Moneda del fee: USD (GreenDot) | MXN (Passport). */
16
+ currency: CurrencyId;
17
+ }
@@ -0,0 +1,12 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.CashInFeeDto = void 0;
4
+ /**
5
+ * Comisión que cobra un punto de cash-in (lo que el lambda MUESTRA, no cobra).
6
+ * - GreenDot (US): representativo por cadena → `fixed` + `cap` (cada tienda cobra hasta el tope).
7
+ * - Passport (MX): por red → `fixed` + `percentage`.
8
+ * Response DTO — sin decoradores de validación.
9
+ */
10
+ class CashInFeeDto {
11
+ }
12
+ exports.CashInFeeDto = CashInFeeDto;
@@ -0,0 +1,9 @@
1
+ /**
2
+ * Body del PUT /me/profile/complete (autenticado, gate post-MFA del autoregistro). DEC-RBAC-034.
3
+ * Opera sobre el propio usuario (cognitoSub del token). Valida nombre + los `userFieldDefs` requeridos
4
+ * del tenant (422 MISSING_REQUIRED_FIELDS si faltan) y flipea `profileComplete=true`.
5
+ */
6
+ export declare class CompleteMyProfileRequest {
7
+ displayName: string;
8
+ customFields?: Record<string, string>;
9
+ }
@@ -0,0 +1,34 @@
1
+ "use strict";
2
+ var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
3
+ var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
4
+ if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
5
+ 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;
6
+ return c > 3 && r && Object.defineProperty(target, key, r), r;
7
+ };
8
+ var __metadata = (this && this.__metadata) || function (k, v) {
9
+ if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
10
+ };
11
+ Object.defineProperty(exports, "__esModule", { value: true });
12
+ exports.CompleteMyProfileRequest = void 0;
13
+ const class_transformer_1 = require("class-transformer");
14
+ const class_validator_1 = require("class-validator");
15
+ /**
16
+ * Body del PUT /me/profile/complete (autenticado, gate post-MFA del autoregistro). DEC-RBAC-034.
17
+ * Opera sobre el propio usuario (cognitoSub del token). Valida nombre + los `userFieldDefs` requeridos
18
+ * del tenant (422 MISSING_REQUIRED_FIELDS si faltan) y flipea `profileComplete=true`.
19
+ */
20
+ class CompleteMyProfileRequest {
21
+ }
22
+ exports.CompleteMyProfileRequest = CompleteMyProfileRequest;
23
+ __decorate([
24
+ (0, class_transformer_1.Expose)(),
25
+ (0, class_validator_1.IsString)(),
26
+ (0, class_validator_1.IsNotEmpty)(),
27
+ __metadata("design:type", String)
28
+ ], CompleteMyProfileRequest.prototype, "displayName", void 0);
29
+ __decorate([
30
+ (0, class_transformer_1.Expose)(),
31
+ (0, class_validator_1.IsOptional)(),
32
+ (0, class_validator_1.IsObject)(),
33
+ __metadata("design:type", Object)
34
+ ], CompleteMyProfileRequest.prototype, "customFields", void 0);
@@ -0,0 +1,14 @@
1
+ /**
2
+ * Body para cancelar una referencia de funding ya creada. La referencia/fundingId
3
+ * viaja en la URL (`/funding/{moduleName}/{fundingId}/cancel`); este body aporta
4
+ * el contexto del solicitante + idempotencia.
5
+ *
6
+ * NOTA: shape inferido desde el uso en `@fiado/api-invoker`
7
+ * (benefits-marketplace / equality-connector) — confirmar con el dueño del
8
+ * módulo walletFunding / el lambda equality-connector que implementa el cancel.
9
+ */
10
+ export declare class CancelFundingReferenceRequest {
11
+ directoryId: string;
12
+ reason?: string;
13
+ idempotencyKey: string;
14
+ }
@@ -0,0 +1,41 @@
1
+ "use strict";
2
+ var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
3
+ var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
4
+ if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
5
+ 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;
6
+ return c > 3 && r && Object.defineProperty(target, key, r), r;
7
+ };
8
+ var __metadata = (this && this.__metadata) || function (k, v) {
9
+ if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
10
+ };
11
+ Object.defineProperty(exports, "__esModule", { value: true });
12
+ exports.CancelFundingReferenceRequest = void 0;
13
+ const class_validator_1 = require("class-validator");
14
+ /**
15
+ * Body para cancelar una referencia de funding ya creada. La referencia/fundingId
16
+ * viaja en la URL (`/funding/{moduleName}/{fundingId}/cancel`); este body aporta
17
+ * el contexto del solicitante + idempotencia.
18
+ *
19
+ * NOTA: shape inferido desde el uso en `@fiado/api-invoker`
20
+ * (benefits-marketplace / equality-connector) — confirmar con el dueño del
21
+ * módulo walletFunding / el lambda equality-connector que implementa el cancel.
22
+ */
23
+ class CancelFundingReferenceRequest {
24
+ }
25
+ exports.CancelFundingReferenceRequest = CancelFundingReferenceRequest;
26
+ __decorate([
27
+ (0, class_validator_1.IsString)(),
28
+ (0, class_validator_1.MaxLength)(64),
29
+ __metadata("design:type", String)
30
+ ], CancelFundingReferenceRequest.prototype, "directoryId", void 0);
31
+ __decorate([
32
+ (0, class_validator_1.IsOptional)(),
33
+ (0, class_validator_1.IsString)(),
34
+ (0, class_validator_1.MaxLength)(256),
35
+ __metadata("design:type", String)
36
+ ], CancelFundingReferenceRequest.prototype, "reason", void 0);
37
+ __decorate([
38
+ (0, class_validator_1.IsString)(),
39
+ (0, class_validator_1.MaxLength)(64),
40
+ __metadata("design:type", String)
41
+ ], CancelFundingReferenceRequest.prototype, "idempotencyKey", void 0);
@@ -0,0 +1,15 @@
1
+ import { BenefitPaymentStatusEnum } from "../../benefitCenter/enums/BenefitPaymentStatusEnum";
2
+ import { WalletFundingErrorCodeEnum } from "../enums/WalletFundingErrorCodeEnum";
3
+ /**
4
+ * Respuesta de la cancelación de una referencia de funding. Mismo estilo que
5
+ * CreateFundingReferenceResponse.
6
+ *
7
+ * NOTA: shape inferido desde el uso en `@fiado/api-invoker` — confirmar con el
8
+ * dueño del módulo walletFunding / el lambda equality-connector.
9
+ */
10
+ export declare class CancelFundingReferenceResponse {
11
+ /** Referencia cancelada (misma PK que se creó). */
12
+ reference: string;
13
+ status: BenefitPaymentStatusEnum;
14
+ errorCode?: WalletFundingErrorCodeEnum;
15
+ }
@@ -0,0 +1,13 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.CancelFundingReferenceResponse = void 0;
4
+ /**
5
+ * Respuesta de la cancelación de una referencia de funding. Mismo estilo que
6
+ * CreateFundingReferenceResponse.
7
+ *
8
+ * NOTA: shape inferido desde el uso en `@fiado/api-invoker` — confirmar con el
9
+ * dueño del módulo walletFunding / el lambda equality-connector.
10
+ */
11
+ class CancelFundingReferenceResponse {
12
+ }
13
+ exports.CancelFundingReferenceResponse = CancelFundingReferenceResponse;
@@ -0,0 +1,3 @@
1
+ export declare class CancelWalletFundingRequest {
2
+ idempotencyKey: string;
3
+ }
@@ -0,0 +1,21 @@
1
+ "use strict";
2
+ var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
3
+ var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
4
+ if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
5
+ 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;
6
+ return c > 3 && r && Object.defineProperty(target, key, r), r;
7
+ };
8
+ var __metadata = (this && this.__metadata) || function (k, v) {
9
+ if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
10
+ };
11
+ Object.defineProperty(exports, "__esModule", { value: true });
12
+ exports.CancelWalletFundingRequest = void 0;
13
+ const class_validator_1 = require("class-validator");
14
+ class CancelWalletFundingRequest {
15
+ }
16
+ exports.CancelWalletFundingRequest = CancelWalletFundingRequest;
17
+ __decorate([
18
+ (0, class_validator_1.IsString)(),
19
+ (0, class_validator_1.MaxLength)(64),
20
+ __metadata("design:type", String)
21
+ ], CancelWalletFundingRequest.prototype, "idempotencyKey", void 0);
@@ -0,0 +1,7 @@
1
+ import { BenefitPaymentStatusEnum } from "../../benefitCenter/enums/BenefitPaymentStatusEnum";
2
+ import { WalletFundingErrorCodeEnum } from "../enums/WalletFundingErrorCodeEnum";
3
+ export declare class CancelWalletFundingResponse {
4
+ status: BenefitPaymentStatusEnum;
5
+ errorCode?: WalletFundingErrorCodeEnum;
6
+ fundingId?: string;
7
+ }
@@ -0,0 +1,6 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.CancelWalletFundingResponse = void 0;
4
+ class CancelWalletFundingResponse {
5
+ }
6
+ exports.CancelWalletFundingResponse = CancelWalletFundingResponse;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@fiado/type-kit",
3
- "version": "3.325.0",
3
+ "version": "3.326.0",
4
4
  "description": "",
5
5
  "main": "bin/index.js",
6
6
  "types": "bin/index.d.ts",
@@ -10,9 +10,22 @@
10
10
  * `PROOF_OF_ADDRESS` va sin prefijo por decisión de nombrado (la regla sigue siendo la del comprobante
11
11
  * de domicilio mexicano). `DATA_CONFIRMATION` es el paso de "revisá y confirmá tus datos"; se llama así
12
12
  * y no `INFO_SELF_VERIFY` para no confundirlo con la verificación de Metamap de `KYC_IDENTIFICATION`.
13
+ *
14
+ * Los DOS pasos de identificación son un solo trámite partido en dos, no dos trámites:
15
+ * `KYC_IDENTIFICATION` pide el primer documento —el que sea— y `KYC_IDENTIFICATION_MEX` aparece
16
+ * SOLO si ese primero no fue mexicano, porque entonces el lado rosa sigue sin documento propio.
13
17
  */
14
18
  export enum OnboardingStepIdEnum {
15
19
  KYC_IDENTIFICATION = 'KYC_IDENTIFICATION',
20
+ /**
21
+ * Identificación mexicana, cuando el primer documento no lo fue. Oculto en el camino normal:
22
+ * el documento mexicano cubre los dos lados, así que quien empieza por ahí nunca lo ve.
23
+ *
24
+ * Existe porque la cobertura NO es simétrica. El documento mexicano llena el nombre latino y
25
+ * el US; el de USA (o el de cualquier otro país) deja el nombre latino sin respaldo de un
26
+ * documento mexicano, y la cuenta rosa exige los tres campos latinos para abrir.
27
+ */
28
+ KYC_IDENTIFICATION_MEX = 'KYC_IDENTIFICATION_MEX',
16
29
  SSN_ITIN = 'SSN_ITIN',
17
30
  INCOME_INFORMATION = 'INCOME_INFORMATION',
18
31
  US_ADDRESS = 'US_ADDRESS',