@fiado/type-kit 3.48.0 → 3.49.0

package/src/credit/dtos/ExpedienteIdentityResponse.ts

@@ -1,92 +1,92 @@
-/**
- * Respuesta del endpoint GET /credit/backoffice/expedientes/{directoryId}/identity (P10 §4.2).
- * Compone datos del identity-lambda (people + OCR + signed URLs),
- * address-lambda (dirección mexicana principal) y risk-profile-business (score).
- */
-
-export class ExpedienteIdentityPersonalData {
-    full_name: string;
-    phone: string | null;
-    email: string | null;
-    directory_id: string;
-    client_since: string | null;
-    wallet_source: string | null;
-    // Identificación
-    curp: string | null;
-    rfc: string | null;
-    date_of_birth: string | null;
-    sex: string | null;
-    nationality: string | null;
-    pep_level: string | null;
-}
-
-/**
- * Verificación KYC extraída del primer documento vigente.
- */
-export class ExpedienteIdentityKyc {
-    status: string | null;
-    verified_at: string | null;
-    verification_id: string | null;
-    primary_document_type: string | null;
-    document_number: string | null;
-    document_expires_at: string | null;
-    document_issue_date: string | null;
-    document_country_id: string | null;
-    document_issue_state: string | null;
-}
-
-/**
- * Dirección registrada del cliente (típicamente la principal mexicana).
- */
-export class ExpedienteIdentityAddress {
-    id: string | null;
-    street: string | null;
-    address_number: string | null;
-    internal_number: string | null;
-    neighborhood: string | null;
-    municipality: string | null;
-    region: string | null;
-    postal_code: string | null;
-    country_id: string | null;
-    additional_information: string | null;
-    is_principal: boolean;
-    status: string | null;
-    valid_from: string | null;
-}
-
-/**
- * Listas de cumplimiento regulatorio.
- */
-export class ExpedienteIdentityComplianceLists {
-    fiado_list_approved: boolean | null;
-    cnbv_list_approved: boolean | null;
-    black_list_approved: boolean | null;
-}
-
-export class ExpedienteIdentityDocument {
-    key: string;
-    signed_url: string;
-    signed_url_expires_at: string | null;
-    type_of_document: string | null;
-    document_number: string | null;
-    verification_date: string | null;
-    country_id: string | null;
-    ocr_full_name: string | null;
-    ocr_date_of_birth: string | null;
-    ocr_sex: string | null;
-}
-
-export class ExpedienteIdentityRiskProfile {
-    score: number | null;
-    level: string | null;
-    manual_risk_level: number | null;
-}
-
-export class ExpedienteIdentityResponse {
-    personal_data: ExpedienteIdentityPersonalData;
-    kyc: ExpedienteIdentityKyc | null;
-    address: ExpedienteIdentityAddress | null;
-    compliance_lists: ExpedienteIdentityComplianceLists | null;
-    risk_profile: ExpedienteIdentityRiskProfile | null;
-    documents: ExpedienteIdentityDocument[];
-}
+/**
+ * Respuesta del endpoint GET /credit/backoffice/expedientes/{directoryId}/identity (P10 §4.2).
+ * Compone datos del identity-lambda (people + OCR + signed URLs),
+ * address-lambda (dirección mexicana principal) y risk-profile-business (score).
+ */
+
+export class ExpedienteIdentityPersonalData {
+    full_name: string;
+    phone: string | null;
+    email: string | null;
+    directory_id: string;
+    client_since: string | null;
+    wallet_source: string | null;
+    // Identificación
+    curp: string | null;
+    rfc: string | null;
+    date_of_birth: string | null;
+    sex: string | null;
+    nationality: string | null;
+    pep_level: string | null;
+}
+
+/**
+ * Verificación KYC extraída del primer documento vigente.
+ */
+export class ExpedienteIdentityKyc {
+    status: string | null;
+    verified_at: string | null;
+    verification_id: string | null;
+    primary_document_type: string | null;
+    document_number: string | null;
+    document_expires_at: string | null;
+    document_issue_date: string | null;
+    document_country_id: string | null;
+    document_issue_state: string | null;
+}
+
+/**
+ * Dirección registrada del cliente (típicamente la principal mexicana).
+ */
+export class ExpedienteIdentityAddress {
+    id: string | null;
+    street: string | null;
+    address_number: string | null;
+    internal_number: string | null;
+    neighborhood: string | null;
+    municipality: string | null;
+    region: string | null;
+    postal_code: string | null;
+    country_id: string | null;
+    additional_information: string | null;
+    is_principal: boolean;
+    status: string | null;
+    valid_from: string | null;
+}
+
+/**
+ * Listas de cumplimiento regulatorio.
+ */
+export class ExpedienteIdentityComplianceLists {
+    fiado_list_approved: boolean | null;
+    cnbv_list_approved: boolean | null;
+    black_list_approved: boolean | null;
+}
+
+export class ExpedienteIdentityDocument {
+    key: string;
+    signed_url: string;
+    signed_url_expires_at: string | null;
+    type_of_document: string | null;
+    document_number: string | null;
+    verification_date: string | null;
+    country_id: string | null;
+    ocr_full_name: string | null;
+    ocr_date_of_birth: string | null;
+    ocr_sex: string | null;
+}
+
+export class ExpedienteIdentityRiskProfile {
+    score: number | null;
+    level: string | null;
+    manual_risk_level: number | null;
+}
+
+export class ExpedienteIdentityResponse {
+    personal_data: ExpedienteIdentityPersonalData;
+    kyc: ExpedienteIdentityKyc | null;
+    address: ExpedienteIdentityAddress | null;
+    compliance_lists: ExpedienteIdentityComplianceLists | null;
+    risk_profile: ExpedienteIdentityRiskProfile | null;
+    documents: ExpedienteIdentityDocument[];
+}

package/src/credit/dtos/ExpedienteResumenResponse.ts

@@ -1,34 +1,34 @@
-import { CreditLevelEnum } from '../enums/CreditLevelEnum';
-
-export class ExpedienteIdentityStatus {
-    verified: boolean;
-    verified_at: string | null;
-}
-
-export class ExpedienteFinancialProfileSummary {
-    score_total: number;
-    credit_level: CreditLevelEnum;
-}
-
-export class ExpedienteContractsCount {
-    total: number;
-    active: number;
-    paid_off: number;
-}
-
-/**
- * Respuesta de la pantalla principal del expediente (§4.1).
- * Endpoint: GET /credit/backoffice/expedientes/{directoryId}/resumen
- */
-export class ExpedienteResumenResponse {
-    directory_id: string;
-    full_name: string;
-    phone: string;
-    email: string | null;
-    client_since: string;
-    wallet_source: string;
-    identity_verified: ExpedienteIdentityStatus;
-    financial_profile: ExpedienteFinancialProfileSummary | null;
-    contracts_count: ExpedienteContractsCount;
-    payments_count: number;
-}
+import { CreditLevelEnum } from '../enums/CreditLevelEnum';
+
+export class ExpedienteIdentityStatus {
+    verified: boolean;
+    verified_at: string | null;
+}
+
+export class ExpedienteFinancialProfileSummary {
+    score_total: number;
+    credit_level: CreditLevelEnum;
+}
+
+export class ExpedienteContractsCount {
+    total: number;
+    active: number;
+    paid_off: number;
+}
+
+/**
+ * Respuesta de la pantalla principal del expediente (§4.1).
+ * Endpoint: GET /credit/backoffice/expedientes/{directoryId}/resumen
+ */
+export class ExpedienteResumenResponse {
+    directory_id: string;
+    full_name: string;
+    phone: string;
+    email: string | null;
+    client_since: string;
+    wallet_source: string;
+    identity_verified: ExpedienteIdentityStatus;
+    financial_profile: ExpedienteFinancialProfileSummary | null;
+    contracts_count: ExpedienteContractsCount;
+    payments_count: number;
+}

package/src/credit/dtos/ExpedienteSearchItem.ts

@@ -1,13 +1,13 @@
-import { CreditLevelEnum } from '../enums/CreditLevelEnum';
-
-/**
- * Item de resultado de busqueda de expedientes.
- * Endpoint: GET /credit/backoffice/expedientes/search
- */
-export class ExpedienteSearchItem {
-    directory_id: string;
-    full_name: string;
-    phone: string;
-    credit_level: CreditLevelEnum | null;
-    has_active_credit: boolean;
-}
+import { CreditLevelEnum } from '../enums/CreditLevelEnum';
+
+/**
+ * Item de resultado de busqueda de expedientes.
+ * Endpoint: GET /credit/backoffice/expedientes/search
+ */
+export class ExpedienteSearchItem {
+    directory_id: string;
+    full_name: string;
+    phone: string;
+    credit_level: CreditLevelEnum | null;
+    has_active_credit: boolean;
+}

package/src/credit/dtos/FinancialProfileResponse.ts

@@ -1,39 +1,39 @@
-/**
- * Respuesta del endpoint GET /credit/profile/{directoryId} (private/inter-service)
- */
-export class FinancialProfileResponse {
-    directory_id: string;
-    partner_id: string;
-    // Ingresos
-    total_income_sources: number;
-    primary_sources: number;
-    secondary_sources: number;
-    has_regular_income: string;
-    total_income_90d_usd: number;
-    monthly_income_usd: number;
-    monthly_income_mxn: number;
-    dominant_frequency: string;
-    // Gastos
-    total_expenses_90d_usd: number;
-    monthly_expenses_usd: number;
-    expense_income_ratio: number;
-    // Scores
-    score_income_stability: number;
-    score_payment_capacity: number;
-    score_mexico_transfers: number;
-    score_seniority: number;
-    score_income_level: number;
-    score_total: number;
-    // Nivel
-    credit_level: string | null;
-    max_credit_amount_mxn: number | null;
-    is_eligible: string;
-    ineligibility_reason: string | null;
-    // Gamification
-    next_level: string | null;
-    score_to_next_level: number | null;
-    progress_pct: number | null;
-    recommendations: any[];
-    // Metadata
-    last_updated: string;
-}
+/**
+ * Respuesta del endpoint GET /credit/profile/{directoryId} (private/inter-service)
+ */
+export class FinancialProfileResponse {
+    directory_id: string;
+    partner_id: string;
+    // Ingresos
+    total_income_sources: number;
+    primary_sources: number;
+    secondary_sources: number;
+    has_regular_income: string;
+    total_income_90d_usd: number;
+    monthly_income_usd: number;
+    monthly_income_mxn: number;
+    dominant_frequency: string;
+    // Gastos
+    total_expenses_90d_usd: number;
+    monthly_expenses_usd: number;
+    expense_income_ratio: number;
+    // Scores
+    score_income_stability: number;
+    score_payment_capacity: number;
+    score_mexico_transfers: number;
+    score_seniority: number;
+    score_income_level: number;
+    score_total: number;
+    // Nivel
+    credit_level: string | null;
+    max_credit_amount_mxn: number | null;
+    is_eligible: string;
+    ineligibility_reason: string | null;
+    // Gamification
+    next_level: string | null;
+    score_to_next_level: number | null;
+    progress_pct: number | null;
+    recommendations: any[];
+    // Metadata
+    last_updated: string;
+}

package/src/credit/dtos/internal/CreditBalanceResponse.ts

@@ -1,17 +1,17 @@
-/**
- * Respuesta del endpoint GET /credit/balance/{directoryId} (inter-service)
- * Balance y estado de un crédito activo.
- */
-export class CreditBalanceResponse {
-    directory_id: string;
-    credit_id: string;
-    partner_id: string;
-    total_amount_mxn: number;
-    disbursed_amount_mxn: number;
-    paid_amount_mxn: number;
-    outstanding_balance_mxn: number;
-    next_payment_date: string | null;
-    next_payment_amount_mxn: number | null;
-    status: string;
-    last_updated: string;
-}
+/**
+ * Respuesta del endpoint GET /credit/balance/{directoryId} (inter-service)
+ * Balance y estado de un crédito activo.
+ */
+export class CreditBalanceResponse {
+    directory_id: string;
+    credit_id: string;
+    partner_id: string;
+    total_amount_mxn: number;
+    disbursed_amount_mxn: number;
+    paid_amount_mxn: number;
+    outstanding_balance_mxn: number;
+    next_payment_date: string | null;
+    next_payment_amount_mxn: number | null;
+    status: string;
+    last_updated: string;
+}

package/src/credit/dtos/internal/CreditProfileResponse.ts

@@ -1,15 +1,15 @@
-/**
- * Respuesta del endpoint GET /credit/profile/{directoryId} (inter-service)
- * Perfil crediticio resumido para consumo interno entre lambdas.
- */
-export class CreditProfileResponse {
-    directory_id: string;
-    partner_id: string;
-    credit_level: string | null;
-    max_credit_amount_mxn: number | null;
-    score_total: number | null;
-    is_eligible: boolean;
-    ineligibility_reason: string | null;
-    has_active_credit: boolean;
-    last_updated: string;
-}
+/**
+ * Respuesta del endpoint GET /credit/profile/{directoryId} (inter-service)
+ * Perfil crediticio resumido para consumo interno entre lambdas.
+ */
+export class CreditProfileResponse {
+    directory_id: string;
+    partner_id: string;
+    credit_level: string | null;
+    max_credit_amount_mxn: number | null;
+    score_total: number | null;
+    is_eligible: boolean;
+    ineligibility_reason: string | null;
+    has_active_credit: boolean;
+    last_updated: string;
+}

package/src/credit/dtos/internal/CreditQueueMessage.ts

@@ -1,18 +1,18 @@
-/**
- * Mensaje SQS genérico para colas de crédito (P4-P10).
- * Usado por: Collection, Delinquency, LienCollection, Notification,
- * Reconciliation, Statement, Transfer, Scoring, OfferGeneration, IncomeDetection.
- *
- * `directoryId` es lo unico requerido. Los demas son opcionales porque hay
- * emisores externos (ej: wallet/account/STP notificando un deposit en tiempo
- * real para IncomeDetectionQueue) que NO conocen el contexto de credito del
- * usuario — el consumer del worker los resuelve internamente cuando los necesita.
- */
-export interface CreditQueueMessage {
-    directoryId: string;
-    creditId?: string;
-    executionId?: string;
-    partnerId?: string;
-    eventType?: string;
-    payload?: Record<string, any>;
-}
+/**
+ * Mensaje SQS genérico para colas de crédito (P4-P10).
+ * Usado por: Collection, Delinquency, LienCollection, Notification,
+ * Reconciliation, Statement, Transfer, Scoring, OfferGeneration, IncomeDetection.
+ *
+ * `directoryId` es lo unico requerido. Los demas son opcionales porque hay
+ * emisores externos (ej: wallet/account/STP notificando un deposit en tiempo
+ * real para IncomeDetectionQueue) que NO conocen el contexto de credito del
+ * usuario — el consumer del worker los resuelve internamente cuando los necesita.
+ */
+export interface CreditQueueMessage {
+    directoryId: string;
+    creditId?: string;
+    executionId?: string;
+    partnerId?: string;
+    eventType?: string;
+    payload?: Record<string, any>;
+}

package/src/credit/dtos/internal/DocumentGenerateRequest.ts

@@ -1,19 +1,19 @@
-import { IsOptional, IsString } from "class-validator";
-
-/**
- * Request del endpoint POST /document/generate y POST /document/generate-and-sign
- */
-export class DocumentGenerateRequest {
-
-    @IsString()
-    templateId!: string;
-
-    @IsString()
-    referenceType!: string;
-
-    @IsString()
-    referenceId!: string;
-
-    @IsOptional()
-    data?: Record<string, any>;
-}
+import { IsOptional, IsString } from "class-validator";
+
+/**
+ * Request del endpoint POST /document/generate y POST /document/generate-and-sign
+ */
+export class DocumentGenerateRequest {
+
+    @IsString()
+    templateId!: string;
+
+    @IsString()
+    referenceType!: string;
+
+    @IsString()
+    referenceId!: string;
+
+    @IsOptional()
+    data?: Record<string, any>;
+}

package/src/credit/dtos/internal/DocumentGenerateResponse.ts

@@ -1,16 +1,16 @@
-/**
- * Respuesta de los endpoints de generación y consulta de documentos.
- * Usado por: generate, sign, generateAndSign, getDocument, getDocumentByReference.
- */
-export class DocumentGenerateResponse {
-    document_id: string;
-    template_id: string;
-    reference_type: string;
-    reference_id: string;
-    status: string;
-    is_signed: boolean;
-    signed_at: string | null;
-    file_url: string | null;
-    created_at: string;
-    updated_at: string;
-}
+/**
+ * Respuesta de los endpoints de generación y consulta de documentos.
+ * Usado por: generate, sign, generateAndSign, getDocument, getDocumentByReference.
+ */
+export class DocumentGenerateResponse {
+    document_id: string;
+    template_id: string;
+    reference_type: string;
+    reference_id: string;
+    status: string;
+    is_signed: boolean;
+    signed_at: string | null;
+    file_url: string | null;
+    created_at: string;
+    updated_at: string;
+}

package/src/credit/dtos/internal/LienStatusResponse.ts

@@ -1,13 +1,13 @@
-/**
- * Respuesta del endpoint GET /credit/lien/{directoryId} (inter-service)
- * Estado del lien (cobro latente) sobre depositos de un usuario.
- */
-export class LienStatusResponse {
-    directory_id: string;
-    credit_id: string;
-    active: boolean;
-    percentage: number | null;
-    max_amount: number | null;
-    total_retained_mxn: number;
-    last_retention_date: string | null;
-}
+/**
+ * Respuesta del endpoint GET /credit/lien/{directoryId} (inter-service)
+ * Estado del lien (cobro latente) sobre depositos de un usuario.
+ */
+export class LienStatusResponse {
+    directory_id: string;
+    credit_id: string;
+    active: boolean;
+    percentage: number | null;
+    max_amount: number | null;
+    total_retained_mxn: number;
+    last_retention_date: string | null;
+}

package/src/credit/enums/BannerStateEnum.ts

@@ -1,15 +1,15 @@
-/**
- * Estados del banner de nurturing de credito
- * @enum {string}
- *
- * @property {string} NO_PAYROLL - Sin deposito directo
- * @property {string} IN_PROGRESS - Perfil en analisis
- * @property {string} ELIGIBLE - Elegible para credito
- * @property {string} HAS_ACTIVE_CREDIT - Ya tiene credito activo
- */
-export enum BannerStateEnum {
-    NO_PAYROLL = 'NO_PAYROLL',
-    IN_PROGRESS = 'IN_PROGRESS',
-    ELIGIBLE = 'ELIGIBLE',
-    HAS_ACTIVE_CREDIT = 'HAS_ACTIVE_CREDIT',
-}
+/**
+ * Estados del banner de nurturing de credito
+ * @enum {string}
+ *
+ * @property {string} NO_PAYROLL - Sin deposito directo
+ * @property {string} IN_PROGRESS - Perfil en analisis
+ * @property {string} ELIGIBLE - Elegible para credito
+ * @property {string} HAS_ACTIVE_CREDIT - Ya tiene credito activo
+ */
+export enum BannerStateEnum {
+    NO_PAYROLL = 'NO_PAYROLL',
+    IN_PROGRESS = 'IN_PROGRESS',
+    ELIGIBLE = 'ELIGIBLE',
+    HAS_ACTIVE_CREDIT = 'HAS_ACTIVE_CREDIT',
+}

package/src/credit/enums/CreditLevelEnum.ts

@@ -1,15 +1,15 @@
-/**
- * Niveles crediticios del modulo de credito
- * @enum {string}
- *
- * @property {string} BRONZE - Nivel inicial
- * @property {string} SILVER - Nivel intermedio bajo
- * @property {string} GOLD - Nivel intermedio alto
- * @property {string} PLATINUM - Nivel maximo
- */
-export enum CreditLevelEnum {
-    BRONZE = 'BRONZE',
-    SILVER = 'SILVER',
-    GOLD = 'GOLD',
-    PLATINUM = 'PLATINUM',
-}
+/**
+ * Niveles crediticios del modulo de credito
+ * @enum {string}
+ *
+ * @property {string} BRONZE - Nivel inicial
+ * @property {string} SILVER - Nivel intermedio bajo
+ * @property {string} GOLD - Nivel intermedio alto
+ * @property {string} PLATINUM - Nivel maximo
+ */
+export enum CreditLevelEnum {
+    BRONZE = 'BRONZE',
+    SILVER = 'SILVER',
+    GOLD = 'GOLD',
+    PLATINUM = 'PLATINUM',
+}

package/src/credit/enums/CreditOfferStatusEnum.ts

@@ -1,17 +1,17 @@
-/**
- * Estados de una oferta de credito
- * @enum {string}
- *
- * @property {string} VIEWING - Oferta activa siendo visualizada
- * @property {string} ACCEPTED - Oferta aceptada por el cliente
- * @property {string} ABANDONED - Oferta abandonada
- * @property {string} EXPIRED - Oferta expirada
- * @property {string} CONVERTED - Oferta convertida en credito activo
- */
-export enum CreditOfferStatusEnum {
-    VIEWING = 'VIEWING',
-    ACCEPTED = 'ACCEPTED',
-    ABANDONED = 'ABANDONED',
-    EXPIRED = 'EXPIRED',
-    CONVERTED = 'CONVERTED',
-}
+/**
+ * Estados de una oferta de credito
+ * @enum {string}
+ *
+ * @property {string} VIEWING - Oferta activa siendo visualizada
+ * @property {string} ACCEPTED - Oferta aceptada por el cliente
+ * @property {string} ABANDONED - Oferta abandonada
+ * @property {string} EXPIRED - Oferta expirada
+ * @property {string} CONVERTED - Oferta convertida en credito activo
+ */
+export enum CreditOfferStatusEnum {
+    VIEWING = 'VIEWING',
+    ACCEPTED = 'ACCEPTED',
+    ABANDONED = 'ABANDONED',
+    EXPIRED = 'EXPIRED',
+    CONVERTED = 'CONVERTED',
+}