@fiado/type-kit 3.28.0 → 3.30.0

package/src/remittance/dtos/RemittanceAddBeneficiaryRequest.ts

@@ -1,81 +1,81 @@
-import { IsEnum, IsNotEmpty, IsOptional, IsString, Matches, ValidateNested } from "class-validator";
-import { Type } from "class-transformer";
-import { ReceptionMethod } from "../enums/ReceptionMethod";
-import { RemittanceCountryISO } from "../enums/RemittanceCountryISO";
-
-export class RemittanceBeneficiaryAddressDTO {
-    @IsString()
-    @IsNotEmpty()
-    address1!: string;
-
-    @IsOptional()
-    @IsString()
-    address2?: string;
-
-    @IsString()
-    @IsNotEmpty()
-    city!: string;
-
-    @IsString()
-    @IsNotEmpty()
-    state!: string;
-
-    @IsOptional()
-    @IsString()
-    stateName?: string;
-
-    @IsOptional()
-    @IsString()
-    zipCode?: string;
-}
-
-export class RemittanceAddBeneficiaryRequest {
-    @IsString()
-    @IsNotEmpty()
-    firstName!: string;
-
-    @IsOptional()
-    @IsString()
-    middleName?: string;
-
-    @IsString()
-    @IsNotEmpty()
-    lastName!: string;
-
-    @IsOptional()
-    @IsString()
-    secondLastName?: string;
-
-    /** Sin código país (UNIR lo agrega). 7-15 dígitos numéricos. */
-    @IsString()
-    @Matches(/^\d{7,15}$/, { message: "phone must be 7-15 digits, no country code" })
-    phone!: string;
-
-    @IsEnum(RemittanceCountryISO)
-    countryISO!: RemittanceCountryISO;
-
-    @IsString()
-    @IsNotEmpty()
-    currencyISO!: string;
-
-    @IsEnum(ReceptionMethod)
-    receptionMethod!: ReceptionMethod;
-
-    @IsString()
-    @IsNotEmpty()
-    payerCode!: string;
-
-    /** Requerido si receptionMethod=ACCOUNT_CREDIT. Validado por regex del payer en el connector. */
-    @IsOptional()
-    @IsString()
-    accNumber?: string;
-
-    /** Requerido si payer.isPayerBranchRequired=YES. */
-    @IsOptional()
-    @IsString()
-    payerBranchCode?: string;
-
-    @ValidateNested()
-    @Type(() => RemittanceBeneficiaryAddressDTO)
-    address!: RemittanceBeneficiaryAddressDTO;
-}
+import { IsEnum, IsNotEmpty, IsOptional, IsString, Matches, ValidateNested } from "class-validator";
+import { Type } from "class-transformer";
+import { ReceptionMethod } from "../enums/ReceptionMethod";
+import { RemittanceCountryISO } from "../enums/RemittanceCountryISO";
+
+export class RemittanceBeneficiaryAddressDTO {
+    @IsString()
+    @IsNotEmpty()
+    address1!: string;
+
+    @IsOptional()
+    @IsString()
+    address2?: string;
+
+    @IsString()
+    @IsNotEmpty()
+    city!: string;
+
+    @IsString()
+    @IsNotEmpty()
+    state!: string;
+
+    @IsOptional()
+    @IsString()
+    stateName?: string;
+
+    @IsOptional()
+    @IsString()
+    zipCode?: string;
+}
+
+export class RemittanceAddBeneficiaryRequest {
+    @IsString()
+    @IsNotEmpty()
+    firstName!: string;
+
+    @IsOptional()
+    @IsString()
+    middleName?: string;
+
+    @IsString()
+    @IsNotEmpty()
+    lastName!: string;
+
+    @IsOptional()
+    @IsString()
+    secondLastName?: string;
+
+    /** Sin código país (UNIR lo agrega). 7-15 dígitos numéricos. */
+    @IsString()
+    @Matches(/^\d{7,15}$/, { message: "phone must be 7-15 digits, no country code" })
+    phone!: string;
+
+    @IsEnum(RemittanceCountryISO)
+    countryISO!: RemittanceCountryISO;
+
+    @IsString()
+    @IsNotEmpty()
+    currencyISO!: string;
+
+    @IsEnum(ReceptionMethod)
+    receptionMethod!: ReceptionMethod;
+
+    @IsString()
+    @IsNotEmpty()
+    payerCode!: string;
+
+    /** Requerido si receptionMethod=ACCOUNT_CREDIT. Validado por regex del payer en el connector. */
+    @IsOptional()
+    @IsString()
+    accNumber?: string;
+
+    /** Requerido si payer.isPayerBranchRequired=YES. */
+    @IsOptional()
+    @IsString()
+    payerBranchCode?: string;
+
+    @ValidateNested()
+    @Type(() => RemittanceBeneficiaryAddressDTO)
+    address!: RemittanceBeneficiaryAddressDTO;
+}

package/src/remittance/dtos/RemittanceAddress.ts

@@ -1,40 +1,40 @@
-import { IsNotEmpty, IsOptional, IsString, Length } from "class-validator";
-
-/**
- * Address del remitente para SignUp en UNIR. Bajo modelo Fiado el remitente siempre
- * opera desde USA (country="USA", countryISOCode="US"), pero los campos se mantienen
- * required para que UNIR los valide explícitamente.
- */
-export class RemittanceAddress {
-    @IsString()
-    @IsNotEmpty()
-    address1!: string;
-
-    @IsOptional()
-    @IsString()
-    address2?: string;
-
-    @IsString()
-    @IsNotEmpty()
-    city!: string;
-
-    @IsString()
-    @Length(2, 2)
-    state!: string;
-
-    @IsOptional()
-    @IsString()
-    stateName?: string;
-
-    @IsString()
-    @IsNotEmpty()
-    country!: string;
-
-    @IsString()
-    @Length(2, 2)
-    countryISOCode!: string;
-
-    @IsString()
-    @Length(5, 10)
-    zipCode!: string;
-}
+import { IsNotEmpty, IsOptional, IsString, Length } from "class-validator";
+
+/**
+ * Address del remitente para SignUp en UNIR. Bajo modelo Fiado el remitente siempre
+ * opera desde USA (country="USA", countryISOCode="US"), pero los campos se mantienen
+ * required para que UNIR los valide explícitamente.
+ */
+export class RemittanceAddress {
+    @IsString()
+    @IsNotEmpty()
+    address1!: string;
+
+    @IsOptional()
+    @IsString()
+    address2?: string;
+
+    @IsString()
+    @IsNotEmpty()
+    city!: string;
+
+    @IsString()
+    @Length(2, 2)
+    state!: string;
+
+    @IsOptional()
+    @IsString()
+    stateName?: string;
+
+    @IsString()
+    @IsNotEmpty()
+    country!: string;
+
+    @IsString()
+    @Length(2, 2)
+    countryISOCode!: string;
+
+    @IsString()
+    @Length(5, 10)
+    zipCode!: string;
+}

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/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/RemittancePayerAdditionalFieldDto.ts

@@ -0,0 +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;
+}

package/src/remittance/dtos/RemittancePayerBranchDto.ts

@@ -0,0 +1,29 @@
+/**
+ * Sucursal de un payer (para método Cash Pickup), devuelta por el endpoint
+ * público `GET /remittance/payers/{code}/branches?...`.
+ *
+ * El frontend la consume en el flow de "Enviar dinero" cuando el beneficiario
+ * tiene `receptionMethod === "CASH_PICKUP"` y el payer marca `requiresBranch = true`.
+ *
+ * Nota de tamaño: un payer puede tener cientos de sucursales (ej. Gyt Continental
+ * GT ~300). Diseñar el UI con un buscador local sobre `name`/`address.city`.
+ */
+export interface RemittancePayerBranchDto {
+    branchCode: string;
+    name: string;
+    /** Horario de atención en formato libre (ej. "0900AM-0500PM"). */
+    branchHours?: string;
+    phoneNumber?: string;
+    address?: RemittancePayerBranchAddressDto;
+}
+
+export interface RemittancePayerBranchAddressDto {
+    address1?: string;
+    city?: string;
+    /** Código ISO 3166-2 (ej. "GT-GU"). */
+    state?: string;
+    stateName?: string;
+    country?: string;
+    countryISOCode?: string;
+    zipCode?: string;
+}