@fiado/type-kit 3.58.0 → 3.60.0

package/src/remittance/dtos/RemittanceBeneficiary.ts

@@ -1,40 +1,40 @@
-import { ReceptionMethod } from "../enums/ReceptionMethod";
-import { RemittanceCountryISO } from "../enums/RemittanceCountryISO";
-
-/**
- * Beneficiary shape cross-lambda. Estado: `ACTIVE` o `DEACTIVATED`.
- * `accNumberLastFour` se expone para display; el accNumber completo NUNCA
- * sale del connector (PII / regulación). UNIR mantiene la fuente de verdad.
- */
-
-export type RemittanceBeneficiaryStatus = "ACTIVE" | "DEACTIVATED";
-
-export interface RemittanceBeneficiaryAddress {
-    address1: string;
-    address2?: string;
-    city: string;
-    state: string;
-    stateName?: string;
-    zipCode?: string;
-}
-
-export class RemittanceBeneficiary {
-    beneficiaryId!: string;
-    firstName!: string;
-    middleName?: string;
-    lastName!: string;
-    secondLastName?: string;
-    phone!: string;
-    countryISO!: RemittanceCountryISO;
-    currencyISO!: string;
-    receptionMethod!: ReceptionMethod;
-    payerCode!: string;
-    payerName!: string;
-    payerBranchCode?: string;
-    accNumberLastFour?: string;
-    address?: RemittanceBeneficiaryAddress;
-    status!: RemittanceBeneficiaryStatus;
-    lastUsedAt?: string;
-    createdAt!: string;
-    updatedAt!: string;
-}
+import { ReceptionMethod } from "../enums/ReceptionMethod";
+import { RemittanceCountryISO } from "../enums/RemittanceCountryISO";
+
+/**
+ * Beneficiary shape cross-lambda. Estado: `ACTIVE` o `DEACTIVATED`.
+ * `accNumberLastFour` se expone para display; el accNumber completo NUNCA
+ * sale del connector (PII / regulación). UNIR mantiene la fuente de verdad.
+ */
+
+export type RemittanceBeneficiaryStatus = "ACTIVE" | "DEACTIVATED";
+
+export interface RemittanceBeneficiaryAddress {
+    address1: string;
+    address2?: string;
+    city: string;
+    state: string;
+    stateName?: string;
+    zipCode?: string;
+}
+
+export class RemittanceBeneficiary {
+    beneficiaryId!: string;
+    firstName!: string;
+    middleName?: string;
+    lastName!: string;
+    secondLastName?: string;
+    phone!: string;
+    countryISO!: RemittanceCountryISO;
+    currencyISO!: string;
+    receptionMethod!: ReceptionMethod;
+    payerCode!: string;
+    payerName!: string;
+    payerBranchCode?: string;
+    accNumberLastFour?: string;
+    address?: RemittanceBeneficiaryAddress;
+    status!: RemittanceBeneficiaryStatus;
+    lastUsedAt?: string;
+    createdAt!: string;
+    updatedAt!: string;
+}

package/src/remittance/dtos/RemittanceConfirmRequest.ts

@@ -1,42 +1,42 @@
-/**
- * Sobre pre-armado por el backend (benefits) que el front reenvía **verbatim** al
- * procesador `POST /benefitsMarketplace/authorize` para confirmar el envío (F6).
- *
- * Es un subconjunto de `AuthorizeBenefitsMarketplaceTransactionRequest`: el backend
- * llena todo lo que deriva del corredor del beneficiario (`leafId`, `productId`,
- * `amount`, ...) más la taxonomía del marketplace (`benefitId`, `productCatalogId`,
- * `moduleName`). El front **solo agrega `inputs.idempotencyKey`** (que genera él, 1:1
- * con el `previewRef`) antes de postear. El front NO debe construir ni decodificar
- * ninguno de estos campos — los trata como tokens opacos.
- */
-export interface RemittanceConfirmRequest {
-    /** Producto del catálogo del marketplace (ProductCatalog_GT). Constante para remesas: `INTERNATIONAL_REMITTANCE`. */
-    productCatalogId: string;
-    /** Benefit que aloja remesas en el árbol del marketplace (ej. `ben-7`). */
-    benefitId: string;
-    /** productId del corredor — monto libre (ej. `GT#GCA10#VAR`). */
-    productId: string;
-    /** Módulo conector que ejecuta el pago (`uniteller-connector`). */
-    moduleName: string;
-    /** leafId base64url del corredor: `base64url("<moduleName>::<countryISO>#<payerCode>#<receptionMethodName>")`. */
-    leafId: string;
-    /** Referencia del beneficiario destino (ej. `BENE#1884512`). */
-    reference: string;
-    /** Monto USD total **congelado** a debitar del wallet (== total del preview). */
-    amount: number;
-    /** Moneda de cobro en ISO numérico — siempre USD (`840`) para remesas. */
-    currencyId: string;
-    /** Datos específicos del módulo que el procesador reenvía al connector. */
-    inputs: RemittanceConfirmInputs;
-}
-
-export interface RemittanceConfirmInputs {
-    /** `transactionInternalReference` de UNIR (sale del preview). Requerido para el confirm. */
-    previewRef: string;
-    /**
-     * Idempotencia del tramo mobile→procesador. **Lo genera el front** en el tap de
-     * confirmar, 1:1 con el `previewRef`: si re-previewa, nuevo `previewRef` ⇒ nuevo
-     * `idempotencyKey`. El backend lo deja vacío en el sobre.
-     */
-    idempotencyKey?: string;
-}
+/**
+ * Sobre pre-armado por el backend (benefits) que el front reenvía **verbatim** al
+ * procesador `POST /benefitsMarketplace/authorize` para confirmar el envío (F6).
+ *
+ * Es un subconjunto de `AuthorizeBenefitsMarketplaceTransactionRequest`: el backend
+ * llena todo lo que deriva del corredor del beneficiario (`leafId`, `productId`,
+ * `amount`, ...) más la taxonomía del marketplace (`benefitId`, `productCatalogId`,
+ * `moduleName`). El front **solo agrega `inputs.idempotencyKey`** (que genera él, 1:1
+ * con el `previewRef`) antes de postear. El front NO debe construir ni decodificar
+ * ninguno de estos campos — los trata como tokens opacos.
+ */
+export interface RemittanceConfirmRequest {
+    /** Producto del catálogo del marketplace (ProductCatalog_GT). Constante para remesas: `INTERNATIONAL_REMITTANCE`. */
+    productCatalogId: string;
+    /** Benefit que aloja remesas en el árbol del marketplace (ej. `ben-7`). */
+    benefitId: string;
+    /** productId del corredor — monto libre (ej. `GT#GCA10#VAR`). */
+    productId: string;
+    /** Módulo conector que ejecuta el pago (`uniteller-connector`). */
+    moduleName: string;
+    /** leafId base64url del corredor: `base64url("<moduleName>::<countryISO>#<payerCode>#<receptionMethodName>")`. */
+    leafId: string;
+    /** Referencia del beneficiario destino (ej. `BENE#1884512`). */
+    reference: string;
+    /** Monto USD total **congelado** a debitar del wallet (== total del preview). */
+    amount: number;
+    /** Moneda de cobro en ISO numérico — siempre USD (`840`) para remesas. */
+    currencyId: string;
+    /** Datos específicos del módulo que el procesador reenvía al connector. */
+    inputs: RemittanceConfirmInputs;
+}
+
+export interface RemittanceConfirmInputs {
+    /** `transactionInternalReference` de UNIR (sale del preview). Requerido para el confirm. */
+    previewRef: string;
+    /**
+     * Idempotencia del tramo mobile→procesador. **Lo genera el front** en el tap de
+     * confirmar, 1:1 con el `previewRef`: si re-previewa, nuevo `previewRef` ⇒ nuevo
+     * `idempotencyKey`. El backend lo deja vacío en el sobre.
+     */
+    idempotencyKey?: string;
+}

package/src/remittance/dtos/RemittanceHomeResponse.ts

@@ -1,45 +1,45 @@
-import { RemittanceUserState } from "../enums/RemittanceUserState";
-import { RemittanceBeneficiary } from "./RemittanceBeneficiary";
-import { RemittanceTransaction } from "./RemittanceTransaction";
-import { RemittanceLimitsInfo } from "./RemittanceLimitsInfo";
-
-/**
- * Response del endpoint GET /remittance/home, discriminado por `state`.
- * Bajo D23-D26 (API Lite) no incluye funding methods — la fuente única de fondeo es
- * el wallet USD del usuario, expuesto en `walletBalance` cuando state=ACTIVE.
- */
-
-export interface WalletBalance {
-    amount: number;
-    currency: "USD";
-}
-
-export interface RemittanceHomeOnboardingRequired {
-    state: RemittanceUserState.ONBOARDING_REQUIRED;
-    needsEmailFromUser: boolean;
-}
-
-export interface RemittanceHomeActive {
-    state: RemittanceUserState.ACTIVE;
-    beneficiaries: RemittanceBeneficiary[];
-    recentTransactions: RemittanceTransaction[];
-    limits: RemittanceLimitsInfo;
-    walletBalance: WalletBalance;
-}
-
-export interface RemittanceHomeSuspended {
-    state: RemittanceUserState.SUSPENDED;
-    reason: string;
-    contactSupportInfo: string;
-}
-
-export interface RemittanceHomePendingVerification {
-    state: RemittanceUserState.PENDING_VERIFICATION;
-    pendingAction: "EMAIL_VERIFICATION";
-}
-
-export type RemittanceHomeResponse =
-    | RemittanceHomeOnboardingRequired
-    | RemittanceHomeActive
-    | RemittanceHomeSuspended
-    | RemittanceHomePendingVerification;
+import { RemittanceUserState } from "../enums/RemittanceUserState";
+import { RemittanceBeneficiary } from "./RemittanceBeneficiary";
+import { RemittanceTransaction } from "./RemittanceTransaction";
+import { RemittanceLimitsInfo } from "./RemittanceLimitsInfo";
+
+/**
+ * Response del endpoint GET /remittance/home, discriminado por `state`.
+ * Bajo D23-D26 (API Lite) no incluye funding methods — la fuente única de fondeo es
+ * el wallet USD del usuario, expuesto en `walletBalance` cuando state=ACTIVE.
+ */
+
+export interface WalletBalance {
+    amount: number;
+    currency: "USD";
+}
+
+export interface RemittanceHomeOnboardingRequired {
+    state: RemittanceUserState.ONBOARDING_REQUIRED;
+    needsEmailFromUser: boolean;
+}
+
+export interface RemittanceHomeActive {
+    state: RemittanceUserState.ACTIVE;
+    beneficiaries: RemittanceBeneficiary[];
+    recentTransactions: RemittanceTransaction[];
+    limits: RemittanceLimitsInfo;
+    walletBalance: WalletBalance;
+}
+
+export interface RemittanceHomeSuspended {
+    state: RemittanceUserState.SUSPENDED;
+    reason: string;
+    contactSupportInfo: string;
+}
+
+export interface RemittanceHomePendingVerification {
+    state: RemittanceUserState.PENDING_VERIFICATION;
+    pendingAction: "EMAIL_VERIFICATION";
+}
+
+export type RemittanceHomeResponse =
+    | RemittanceHomeOnboardingRequired
+    | RemittanceHomeActive
+    | RemittanceHomeSuspended
+    | RemittanceHomePendingVerification;

package/src/remittance/dtos/RemittanceLimitsInfo.ts

@@ -1,12 +1,12 @@
-/**
- * Límites del usuario para mostrar en Home/Send screens. Combina datos de
- * UNIR UserCreditLimit + UserComplianceLimit.
- */
-export class RemittanceLimitsInfo {
-    dailyLimitUSD!: number;
-    remainingTodayUSD!: number;
-    weeklyLimitUSD?: number;
-    remainingWeekUSD?: number;
-    monthlyLimitUSD?: number;
-    remainingMonthUSD?: number;
-}
+/**
+ * Límites del usuario para mostrar en Home/Send screens. Combina datos de
+ * UNIR UserCreditLimit + UserComplianceLimit.
+ */
+export class RemittanceLimitsInfo {
+    dailyLimitUSD!: number;
+    remainingTodayUSD!: number;
+    weeklyLimitUSD?: number;
+    remainingWeekUSD?: number;
+    monthlyLimitUSD?: number;
+    remainingMonthUSD?: number;
+}

package/src/remittance/dtos/RemittanceListBeneficiariesResponse.ts

@@ -1,7 +1,7 @@
-import { RemittanceBeneficiary } from "./RemittanceBeneficiary";
-
-export class RemittanceListBeneficiariesResponse {
-    beneficiaries!: RemittanceBeneficiary[];
-    totalActive!: number;
-    maxActive!: number;
-}
+import { RemittanceBeneficiary } from "./RemittanceBeneficiary";
+
+export class RemittanceListBeneficiariesResponse {
+    beneficiaries!: RemittanceBeneficiary[];
+    totalActive!: number;
+    maxActive!: number;
+}

package/src/remittance/dtos/RemittanceOnboardRequest.ts

@@ -1,64 +1,64 @@
-import { IsEmail, IsEnum, IsIn, IsNotEmpty, IsOptional, IsString, Matches, ValidateNested } from "class-validator";
-import { Type } from "class-transformer";
-import { RemittanceAddress } from "./RemittanceAddress";
-import { RemittanceCountryISO } from "../enums/RemittanceCountryISO";
-
-/**
- * Request que el composer en benefits-marketplace envía al connector vía
- * IUnitellerConnectorApi.onboard(). Bajo DP-05 NO incluye questionId/answer/answerHint
- * (el connector los autogenera internamente).
- */
-export class RemittanceOnboardRequest {
-    @IsString()
-    @IsNotEmpty()
-    directoryId!: string;
-
-    @IsEmail()
-    email!: string;
-
-    @IsString()
-    @IsNotEmpty()
-    firstName!: string;
-
-    @IsOptional()
-    @IsString()
-    middleName?: string;
-
-    @IsString()
-    @IsNotEmpty()
-    lastName!: string;
-
-    @IsOptional()
-    @IsString()
-    secondLastName?: string;
-
-    @IsOptional()
-    @IsString()
-    gender?: string;
-
-    @IsString()
-    @Matches(/^\d{8}$/, { message: "birthDate must be MMDDYYYY (8 digits)" })
-    birthDate!: string;
-
-    @IsString()
-    @IsNotEmpty()
-    cellPhone!: string;
-
-    @ValidateNested()
-    @Type(() => RemittanceAddress)
-    address!: RemittanceAddress;
-
-    @IsEnum(RemittanceCountryISO)
-    destinationCountryISOCode!: RemittanceCountryISO;
-
-    @IsOptional()
-    @IsIn(["EN", "ES"])
-    agreementLocale?: "EN" | "ES";
-
-    @IsIn(["YES"])
-    privacyPolicyAgreement!: "YES";
-
-    @IsOptional()
-    @IsString()
-    userIPAddress?: string;
-}
+import { IsEmail, IsEnum, IsIn, IsNotEmpty, IsOptional, IsString, Matches, ValidateNested } from "class-validator";
+import { Type } from "class-transformer";
+import { RemittanceAddress } from "./RemittanceAddress";
+import { RemittanceCountryISO } from "../enums/RemittanceCountryISO";
+
+/**
+ * Request que el composer en benefits-marketplace envía al connector vía
+ * IUnitellerConnectorApi.onboard(). Bajo DP-05 NO incluye questionId/answer/answerHint
+ * (el connector los autogenera internamente).
+ */
+export class RemittanceOnboardRequest {
+    @IsString()
+    @IsNotEmpty()
+    directoryId!: string;
+
+    @IsEmail()
+    email!: string;
+
+    @IsString()
+    @IsNotEmpty()
+    firstName!: string;
+
+    @IsOptional()
+    @IsString()
+    middleName?: string;
+
+    @IsString()
+    @IsNotEmpty()
+    lastName!: string;
+
+    @IsOptional()
+    @IsString()
+    secondLastName?: string;
+
+    @IsOptional()
+    @IsString()
+    gender?: string;
+
+    @IsString()
+    @Matches(/^\d{8}$/, { message: "birthDate must be MMDDYYYY (8 digits)" })
+    birthDate!: string;
+
+    @IsString()
+    @IsNotEmpty()
+    cellPhone!: string;
+
+    @ValidateNested()
+    @Type(() => RemittanceAddress)
+    address!: RemittanceAddress;
+
+    @IsEnum(RemittanceCountryISO)
+    destinationCountryISOCode!: RemittanceCountryISO;
+
+    @IsOptional()
+    @IsIn(["EN", "ES"])
+    agreementLocale?: "EN" | "ES";
+
+    @IsIn(["YES"])
+    privacyPolicyAgreement!: "YES";
+
+    @IsOptional()
+    @IsString()
+    userIPAddress?: string;
+}

package/src/remittance/dtos/RemittanceOnboardResponse.ts

@@ -1,7 +1,7 @@
-import { RemittanceUserState } from "../enums/RemittanceUserState";
-
-export class RemittanceOnboardResponse {
-    state!: RemittanceUserState;
-    unirUserId!: string;
-    activatedAt?: string;
-}
+import { RemittanceUserState } from "../enums/RemittanceUserState";
+
+export class RemittanceOnboardResponse {
+    state!: RemittanceUserState;
+    unirUserId!: string;
+    activatedAt?: string;
+}

package/src/remittance/dtos/RemittancePayRequest.ts

@@ -1,30 +1,30 @@
-import { IsNotEmpty, IsOptional, IsString } from "class-validator";
-
-/**
- * Body del POST /pay del uniteller-connector (lo invoca benefits-marketplace
- * vía api-invoker tras la orquestación del procesador). Confirma una remesa
- * previamente previsualizada (F6).
- *
- * Bajo API Lite (D22-D26) NO incluye fundingMethod/fundingMethodSourceId — el
- * wallet USD principal del usuario es la única fuente; el connector usa
- * unirWlpWalletId de RemittanceUsers_GT.
- *
- * `directoryId` viaja en el body de las llamadas privadas (D18) pero se valida
- * por separado en el controller, no en este DTO.
- */
-export class RemittancePayRequest {
-    /** transactionInternalReference que devolvió SendMoneyPreview (cacheado en RemittanceCache_GT). */
-    @IsString()
-    @IsNotEmpty()
-    previewRef!: string;
-
-    /** Idempotency key generado por mobile; end-to-end (D-F6.6). */
-    @IsString()
-    @IsNotEmpty()
-    idempotencyKey!: string;
-
-    /** transactionNumber del procesador, para el lookup de consult() (F6.C.1). */
-    @IsOptional()
-    @IsString()
-    marketplaceTransactionNumber?: string;
-}
+import { IsNotEmpty, IsOptional, IsString } from "class-validator";
+
+/**
+ * Body del POST /pay del uniteller-connector (lo invoca benefits-marketplace
+ * vía api-invoker tras la orquestación del procesador). Confirma una remesa
+ * previamente previsualizada (F6).
+ *
+ * Bajo API Lite (D22-D26) NO incluye fundingMethod/fundingMethodSourceId — el
+ * wallet USD principal del usuario es la única fuente; el connector usa
+ * unirWlpWalletId de RemittanceUsers_GT.
+ *
+ * `directoryId` viaja en el body de las llamadas privadas (D18) pero se valida
+ * por separado en el controller, no en este DTO.
+ */
+export class RemittancePayRequest {
+    /** transactionInternalReference que devolvió SendMoneyPreview (cacheado en RemittanceCache_GT). */
+    @IsString()
+    @IsNotEmpty()
+    previewRef!: string;
+
+    /** Idempotency key generado por mobile; end-to-end (D-F6.6). */
+    @IsString()
+    @IsNotEmpty()
+    idempotencyKey!: string;
+
+    /** transactionNumber del procesador, para el lookup de consult() (F6.C.1). */
+    @IsOptional()
+    @IsString()
+    marketplaceTransactionNumber?: string;
+}

package/src/remittance/dtos/RemittancePayResponse.ts

@@ -1,24 +1,24 @@
-import { RemittanceTxStatus } from "../enums/RemittanceTxStatus";
-
-/**
- * Respuesta del POST /pay del uniteller-connector. Refleja el resultado del
- * SendMoneyConfirm de UNIR + la row persistida en RemittanceTransactions_GT.
- *
- * exchangeRate y receivedAmount provienen del ExternalQuickQuotes cacheado en
- * el preview (D-F5.6: en sandbox las responses de Confirm los devuelven en 0
- * para Wlp Wallet).
- */
-export class RemittancePayResponse {
-    /** transactionNumber de UNIR, formato "XXXXXXXSF". */
-    txNumber!: string;
-    status!: RemittanceTxStatus;
-    amountUSD!: number;
-    receivedAmount!: number;
-    receivedCurrency!: string;
-    exchangeRate!: number;
-    serviceFee!: number;
-    /** Fecha en que la remesa queda disponible para retiro (si UNIR la provee). */
-    availableDate?: string;
-    /** ISO timestamp de creación de la row local. */
-    createdAt!: string;
-}
+import { RemittanceTxStatus } from "../enums/RemittanceTxStatus";
+
+/**
+ * Respuesta del POST /pay del uniteller-connector. Refleja el resultado del
+ * SendMoneyConfirm de UNIR + la row persistida en RemittanceTransactions_GT.
+ *
+ * exchangeRate y receivedAmount provienen del ExternalQuickQuotes cacheado en
+ * el preview (D-F5.6: en sandbox las responses de Confirm los devuelven en 0
+ * para Wlp Wallet).
+ */
+export class RemittancePayResponse {
+    /** transactionNumber de UNIR, formato "XXXXXXXSF". */
+    txNumber!: string;
+    status!: RemittanceTxStatus;
+    amountUSD!: number;
+    receivedAmount!: number;
+    receivedCurrency!: string;
+    exchangeRate!: number;
+    serviceFee!: number;
+    /** Fecha en que la remesa queda disponible para retiro (si UNIR la provee). */
+    availableDate?: string;
+    /** ISO timestamp de creación de la row local. */
+    createdAt!: string;
+}

package/src/remittance/dtos/RemittancePayerAdditionalFieldDto.ts

@@ -1,27 +1,27 @@
-/**
- * Campo adicional requerido por un payer/receptionMethod, devuelto por el
- * endpoint público `GET /remittance/payers/{code}/fields?...`.
- *
- * El frontend renderiza un control según `fieldType` y valida con `regex` /
- * `minLen`/`maxLen` antes de submit. El valor capturado se envía al backend
- * como `additionalFieldInfo: [{ name, value }, ...]` en la request de
- * AddBeneficiary o SendMoneyPreview.
- *
- * Ejemplo real (Banco Industrial GTQ Account Credit): 1 field `accountType`
- * dropdown con opciones { key:"01", value:"Checking" }, { key:"02", value:"Savings" }.
- */
-export interface RemittancePayerAdditionalFieldDto {
-    fieldName: string;
-    fieldLabel: string;
-    /** "dropdown" | "text" | "number" | etc. — UI elige control según este valor. */
-    fieldType: string;
-    required: boolean;
-    /** Solo si `fieldType === "dropdown"`. */
-    fieldOptions?: Array<{ key: string; value: string }>;
-    regex?: string;
-    minLen?: number;
-    maxLen?: number;
-    errorMsg?: string;
-    /** Mensaje informativo (no de error) que la UI puede mostrar como helper text. */
-    fieldMsg?: string;
-}
+/**
+ * Campo adicional requerido por un payer/receptionMethod, devuelto por el
+ * endpoint público `GET /remittance/payers/{code}/fields?...`.
+ *
+ * El frontend renderiza un control según `fieldType` y valida con `regex` /
+ * `minLen`/`maxLen` antes de submit. El valor capturado se envía al backend
+ * como `additionalFieldInfo: [{ name, value }, ...]` en la request de
+ * AddBeneficiary o SendMoneyPreview.
+ *
+ * Ejemplo real (Banco Industrial GTQ Account Credit): 1 field `accountType`
+ * dropdown con opciones { key:"01", value:"Checking" }, { key:"02", value:"Savings" }.
+ */
+export interface RemittancePayerAdditionalFieldDto {
+    fieldName: string;
+    fieldLabel: string;
+    /** "dropdown" | "text" | "number" | etc. — UI elige control según este valor. */
+    fieldType: string;
+    required: boolean;
+    /** Solo si `fieldType === "dropdown"`. */
+    fieldOptions?: Array<{ key: string; value: string }>;
+    regex?: string;
+    minLen?: number;
+    maxLen?: number;
+    errorMsg?: string;
+    /** Mensaje informativo (no de error) que la UI puede mostrar como helper text. */
+    fieldMsg?: string;
+}