@fiado/type-kit 2.1.47 → 2.1.49

package/src/credit/dtos/EarlyPaymentRequest.ts

@@ -0,0 +1,21 @@
+import { IsEnum, IsNotEmpty, IsNumber, IsOptional, IsString } from "class-validator";
+import { PaymentTypeEnum } from "../enums/PaymentTypeEnum";
+
+export class EarlyPaymentRequest {
+
+    @IsString()
+    @IsNotEmpty()
+    creditId: string;
+
+    @IsEnum(PaymentTypeEnum)
+    @IsNotEmpty()
+    type: PaymentTypeEnum;
+
+    @IsNumber()
+    @IsOptional()
+    amount?: number;
+
+    @IsNumber()
+    @IsOptional()
+    numberOfCoupons?: number;
+}

package/src/credit/dtos/EarlyPaymentResponse.ts

@@ -0,0 +1,12 @@
+import { PaymentTypeEnum } from "../enums/PaymentTypeEnum";
+
+export class EarlyPaymentResponse {
+    creditId: string;
+    type: PaymentTypeEnum;
+    amountCharged: number;
+    principalPaid: number;
+    interestSaved: number;
+    newBalance: number;
+    newMaturityDate: string | null;
+    transactionId: string;
+}

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

@@ -0,0 +1,8 @@
+import { IsNotEmpty, IsString } from "class-validator";
+
+export class CreditBalanceRequest {
+
+    @IsString()
+    @IsNotEmpty()
+    creditId: string;
+}

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

@@ -0,0 +1,10 @@
+export class CreditBalanceResponse {
+    creditId: string;
+    currentBalance: number;
+    principalBalance: number;
+    accruedInterest: number;
+    overdueAmount: number;
+    nextPaymentAmount: number;
+    nextPaymentDate: string;
+    availableForEarlyPayment: number;
+}

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

@@ -0,0 +1,39 @@
+import { IsEnum, IsNotEmpty, IsNumber, IsOptional, IsString, Matches } from "class-validator";
+import { regexUuidV4 } from "../../../helpers/constans/regex";
+import { PaymentTypeEnum } from "../../enums/PaymentTypeEnum";
+
+export class CreditCollectionRequest {
+
+    @IsString()
+    @IsNotEmpty()
+    creditId: string;
+
+    @IsString()
+    @IsNotEmpty()
+    @Matches(regexUuidV4, { message: 'directoryId must be a valid UUID v4' })
+    directoryId: string;
+
+    @IsNumber()
+    @IsNotEmpty()
+    amount: number;
+
+    @IsNumber()
+    @IsNotEmpty()
+    couponNumber: number;
+
+    @IsEnum(PaymentTypeEnum)
+    @IsNotEmpty()
+    paymentType: PaymentTypeEnum;
+
+    @IsString()
+    @IsNotEmpty()
+    pagoConfiadoAccountId: string;
+
+    @IsString()
+    @IsNotEmpty()
+    fiadoIncAccountId: string;
+
+    @IsString()
+    @IsOptional()
+    idempotencyKey?: string;
+}

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

@@ -0,0 +1,12 @@
+export class CreditCollectionResponse {
+    creditId: string;
+    transactionId: string;
+    idempotencyKey: string;
+    amountCollected: number;
+    principal: number;
+    interest: number;
+    iva: number;
+    newBalance: number;
+    status: 'COMPLETED' | 'FAILED' | 'INSUFFICIENT_FUNDS';
+    timestamp: string;
+}

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

@@ -0,0 +1,26 @@
+import { IsNotEmpty, IsNumber, IsString, Matches } from "class-validator";
+import { regexUuidV4 } from "../../../helpers/constans/regex";
+
+export class CreditDisbursementRequest {
+
+    @IsString()
+    @IsNotEmpty()
+    creditId: string;
+
+    @IsString()
+    @IsNotEmpty()
+    @Matches(regexUuidV4, { message: 'directoryId must be a valid UUID v4' })
+    directoryId: string;
+
+    @IsNumber()
+    @IsNotEmpty()
+    amount: number;
+
+    @IsString()
+    @IsNotEmpty()
+    pagoConfiadoAccountId: string;
+
+    @IsString()
+    @IsNotEmpty()
+    fiadoIncAccountId: string;
+}

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

@@ -0,0 +1,8 @@
+export class CreditDisbursementResponse {
+    creditId: string;
+    transactionId: string;
+    idempotencyKey: string;
+    amount: number;
+    status: 'COMPLETED' | 'FAILED';
+    timestamp: string;
+}

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

@@ -0,0 +1,10 @@
+import { IsNotEmpty, IsString, Matches } from "class-validator";
+import { regexUuidV4 } from "../../../helpers/constans/regex";
+
+export class CreditProfileRequest {
+
+    @IsString()
+    @IsNotEmpty()
+    @Matches(regexUuidV4, { message: 'directoryId must be a valid UUID v4' })
+    directoryId: string;
+}

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

@@ -0,0 +1,14 @@
+import { CreditStatusEnum } from "../../enums/CreditStatusEnum";
+import { OfferStatusEnum } from "../../enums/OfferStatusEnum";
+
+export class CreditProfileResponse {
+    directoryId: string;
+    hasActiveCredit: boolean;
+    creditId: string | null;
+    creditStatus: CreditStatusEnum | null;
+    offerStatus: OfferStatusEnum | null;
+    currentBalance: number | null;
+    overdueAmount: number | null;
+    financialScore: number | null;
+    lastUpdated: string;
+}

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

@@ -0,0 +1,20 @@
+export type CreditQueueMessageType =
+    | 'INCOME_DETECTION'
+    | 'SCORING'
+    | 'OFFER_GENERATION'
+    | 'COLLECTION'
+    | 'DELINQUENCY'
+    | 'TRANSFER'
+    | 'NOTIFICATION'
+    | 'STATEMENT'
+    | 'RECONCILIATION'
+    | 'LIEN_COLLECTION';
+
+export class CreditQueueMessage {
+    type: CreditQueueMessageType;
+    directoryId: string;
+    creditId: string | null;
+    payload: Record<string, any>;
+    timestamp: string;
+    correlationId: string;
+}

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

@@ -0,0 +1,16 @@
+import { IsNotEmpty, IsString } from "class-validator";
+
+export class CreditReversalRequest {
+
+    @IsString()
+    @IsNotEmpty()
+    originalTransactionId: string;
+
+    @IsString()
+    @IsNotEmpty()
+    creditId: string;
+
+    @IsString()
+    @IsNotEmpty()
+    reason: string;
+}

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

@@ -0,0 +1,7 @@
+export class CreditReversalResponse {
+    reversalTransactionId: string;
+    originalTransactionId: string;
+    amount: number;
+    status: 'COMPLETED' | 'FAILED';
+    timestamp: string;
+}

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

@@ -0,0 +1,28 @@
+import { IsNotEmpty, IsNumber, IsString } from "class-validator";
+
+export class CreditTransferLoancoRequest {
+
+    @IsString()
+    @IsNotEmpty()
+    transferId: string;
+
+    @IsString()
+    @IsNotEmpty()
+    creditId: string;
+
+    @IsNumber()
+    @IsNotEmpty()
+    amount: number;
+
+    @IsString()
+    @IsNotEmpty()
+    fiadoIncAccountId: string;
+
+    @IsString()
+    @IsNotEmpty()
+    loancoAccountId: string;
+
+    @IsString()
+    @IsNotEmpty()
+    concept: string;
+}

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

@@ -0,0 +1,9 @@
+import { TransferStatusEnum } from "../../enums/TransferStatusEnum";
+
+export class CreditTransferLoancoResponse {
+    transferId: string;
+    transactionId: string;
+    amount: number;
+    status: TransferStatusEnum;
+    timestamp: string;
+}

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

@@ -0,0 +1,34 @@
+import { IsBoolean, IsEnum, IsNotEmpty, IsNumber, IsOptional, IsString, Matches } from "class-validator";
+import { regexUuidV4 } from "../../../helpers/constans/regex";
+import { DocumentTypeEnum } from "../../enums/DocumentTypeEnum";
+
+export class DocumentGenerateRequest {
+
+    @IsString()
+    @IsNotEmpty()
+    templateId: string;
+
+    @IsEnum(DocumentTypeEnum)
+    @IsNotEmpty()
+    referenceType: DocumentTypeEnum;
+
+    @IsString()
+    @IsNotEmpty()
+    referenceId: string;
+
+    @IsString()
+    @IsNotEmpty()
+    @Matches(regexUuidV4, { message: 'directoryId must be a valid UUID v4' })
+    directoryId: string;
+
+    @IsNotEmpty()
+    variables: Record<string, any>;
+
+    @IsBoolean()
+    @IsOptional()
+    sign?: boolean;
+
+    @IsNumber()
+    @IsOptional()
+    expiresInDays?: number | null;
+}

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

@@ -0,0 +1,12 @@
+export class DocumentGenerateResponse {
+    documentId: string;
+    referenceType: string;
+    referenceId: string;
+    directoryId: string;
+    s3Key: string;
+    signed: boolean;
+    signedAt: string | null;
+    createdAt: string;
+    expiresAt: string | null;
+    downloadUrl: string | null;
+}

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

@@ -0,0 +1,8 @@
+import { IsNotEmpty, IsString } from "class-validator";
+
+export class DocumentSignRequest {
+
+    @IsString()
+    @IsNotEmpty()
+    documentId: string;
+}

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

@@ -0,0 +1,28 @@
+import { IsBoolean, IsNotEmpty, IsNumber, IsOptional, IsString, Matches, Max, Min } from "class-validator";
+import { regexUuidV4 } from "../../../helpers/constans/regex";
+
+export class LienApplyRequest {
+
+    @IsString()
+    @IsNotEmpty()
+    @Matches(regexUuidV4, { message: 'directoryId must be a valid UUID v4' })
+    directoryId: string;
+
+    @IsString()
+    @IsNotEmpty()
+    creditId: string;
+
+    @IsBoolean()
+    @IsNotEmpty()
+    active: boolean;
+
+    @IsNumber()
+    @IsOptional()
+    @Min(1)
+    @Max(100)
+    percentage?: number;
+
+    @IsNumber()
+    @IsOptional()
+    maxAmount?: number;
+}

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

@@ -0,0 +1,9 @@
+export class LienStatusResponse {
+    directoryId: string;
+    creditId: string;
+    lienActive: boolean;
+    lienPercentage: number;
+    lienMaxAmount: number | null;
+    totalCollectedByLien: number;
+    lastLienDate: string | null;
+}

package/src/credit/enums/CollectionFrequencyEnum.ts

@@ -0,0 +1,5 @@
+export enum CollectionFrequencyEnum {
+    WEEKLY = 'WEEKLY',
+    BIWEEKLY = 'BIWEEKLY',
+    MONTHLY = 'MONTHLY'
+}

package/src/credit/enums/CreditOperationEnum.ts

@@ -0,0 +1,11 @@
+export enum CreditOperationEnum {
+    DISBURSEMENT = 'DISBURSEMENT',
+    COLLECTION = 'COLLECTION',
+    COLLECTION_PARTIAL = 'COLLECTION_PARTIAL',
+    COLLECTION_LIEN = 'COLLECTION_LIEN',
+    EARLY_PAYMENT = 'EARLY_PAYMENT',
+    TRANSFER_LOANCO = 'TRANSFER_LOANCO',
+    REVERSAL = 'REVERSAL',
+    INTEREST_ACCRUAL = 'INTEREST_ACCRUAL',
+    FEE_CHARGE = 'FEE_CHARGE'
+}

package/src/credit/enums/CreditStatusEnum.ts

@@ -0,0 +1,12 @@
+export enum CreditStatusEnum {
+    PENDING_APPROVAL = 'PENDING_APPROVAL',
+    APPROVED = 'APPROVED',
+    ACTIVE = 'ACTIVE',
+    CURRENT = 'CURRENT',
+    DELINQUENT = 'DELINQUENT',
+    DEFAULTED = 'DEFAULTED',
+    PAID_OFF = 'PAID_OFF',
+    CANCELLED = 'CANCELLED',
+    RETURNED_TO_LOANCO = 'RETURNED_TO_LOANCO',
+    WRITTEN_OFF = 'WRITTEN_OFF'
+}

package/src/credit/enums/DelinquencyLevelEnum.ts

@@ -0,0 +1,9 @@
+export enum DelinquencyLevelEnum {
+    CURRENT = 'CURRENT',
+    EARLY_1_7 = 'EARLY_1_7',
+    EARLY_8_14 = 'EARLY_8_14',
+    LATE_15_30 = 'LATE_15_30',
+    LATE_31_60 = 'LATE_31_60',
+    SEVERE_61_90 = 'SEVERE_61_90',
+    DEFAULT_90_PLUS = 'DEFAULT_90_PLUS'
+}

package/src/credit/enums/DocumentTypeEnum.ts

@@ -0,0 +1,8 @@
+export enum DocumentTypeEnum {
+    CREDIT_CONTRACT = 'CREDIT_CONTRACT',
+    CREDIT_STATEMENT = 'CREDIT_STATEMENT',
+    CREDIT_AMORTIZATION = 'CREDIT_AMORTIZATION',
+    CREDIT_COVER_SHEET = 'CREDIT_COVER_SHEET',
+    ONBOARDING_CONTRACT = 'ONBOARDING_CONTRACT',
+    ONBOARDING_IFPE = 'ONBOARDING_IFPE'
+}

package/src/credit/enums/OfferStatusEnum.ts

@@ -0,0 +1,8 @@
+export enum OfferStatusEnum {
+    NOT_ELIGIBLE = 'NOT_ELIGIBLE',
+    PRE_QUALIFIED = 'PRE_QUALIFIED',
+    OFFER_AVAILABLE = 'OFFER_AVAILABLE',
+    OFFER_CONFIGURED = 'OFFER_CONFIGURED',
+    OFFER_ACCEPTED = 'OFFER_ACCEPTED',
+    OFFER_EXPIRED = 'OFFER_EXPIRED'
+}

package/src/credit/enums/PaymentTypeEnum.ts

@@ -0,0 +1,9 @@
+export enum PaymentTypeEnum {
+    REGULAR = 'REGULAR',
+    PARTIAL = 'PARTIAL',
+    EARLY_ANTICIPATED = 'EARLY_ANTICIPATED',
+    EARLY_ADVANCED = 'EARLY_ADVANCED',
+    EARLY_SETTLEMENT = 'EARLY_SETTLEMENT',
+    LIEN = 'LIEN',
+    REVERSAL = 'REVERSAL'
+}

package/src/credit/enums/ReconciliationStatusEnum.ts

@@ -0,0 +1,6 @@
+export enum ReconciliationStatusEnum {
+    PENDING = 'PENDING',
+    MATCHED = 'MATCHED',
+    DISCREPANCY = 'DISCREPANCY',
+    RESOLVED = 'RESOLVED'
+}

package/src/credit/enums/TransferStatusEnum.ts

@@ -0,0 +1,8 @@
+export enum TransferStatusEnum {
+    PENDING = 'PENDING',
+    APPROVED = 'APPROVED',
+    IN_PROGRESS = 'IN_PROGRESS',
+    COMPLETED = 'COMPLETED',
+    FAILED = 'FAILED',
+    REJECTED = 'REJECTED'
+}

package/src/credit/index.ts

@@ -0,0 +1,44 @@
+//dtos
+export * from './dtos/CreditBannerStateResponse';
+export * from './dtos/CreditEligibilityResponse';
+export * from './dtos/CreditOfferConfigureRequest';
+export * from './dtos/CreditOfferConfigureResponse';
+export * from './dtos/CreditRequestCreate';
+export * from './dtos/CreditRequestResponse';
+export * from './dtos/CreditDetailResponse';
+export * from './dtos/CreditMovementResponse';
+export * from './dtos/CreditScheduleResponse';
+export * from './dtos/CreditStatementResponse';
+export * from './dtos/EarlyPaymentRequest';
+export * from './dtos/EarlyPaymentResponse';
+
+//dtos/internal
+export * from './dtos/internal/CreditProfileRequest';
+export * from './dtos/internal/CreditProfileResponse';
+export * from './dtos/internal/CreditDisbursementRequest';
+export * from './dtos/internal/CreditDisbursementResponse';
+export * from './dtos/internal/CreditCollectionRequest';
+export * from './dtos/internal/CreditCollectionResponse';
+export * from './dtos/internal/CreditTransferLoancoRequest';
+export * from './dtos/internal/CreditTransferLoancoResponse';
+export * from './dtos/internal/CreditReversalRequest';
+export * from './dtos/internal/CreditReversalResponse';
+export * from './dtos/internal/CreditBalanceRequest';
+export * from './dtos/internal/CreditBalanceResponse';
+export * from './dtos/internal/LienStatusResponse';
+export * from './dtos/internal/LienApplyRequest';
+export * from './dtos/internal/CreditQueueMessage';
+export * from './dtos/internal/DocumentGenerateRequest';
+export * from './dtos/internal/DocumentGenerateResponse';
+export * from './dtos/internal/DocumentSignRequest';
+
+//enums
+export * from './enums/CreditStatusEnum';
+export * from './enums/DelinquencyLevelEnum';
+export * from './enums/PaymentTypeEnum';
+export * from './enums/CollectionFrequencyEnum';
+export * from './enums/CreditOperationEnum';
+export * from './enums/OfferStatusEnum';
+export * from './enums/TransferStatusEnum';
+export * from './enums/ReconciliationStatusEnum';
+export * from './enums/DocumentTypeEnum';

package/src/index.ts

@@ -55,4 +55,6 @@ export * as PayrollBusiness from './payroll-business';
 export * as Event from './event';
 export * as NotificationWS from './notificationWS';
 export * as ZendeskMessaging from './zendeskMessaging';
+export * as Credit from './credit';
 export * as ReferralBusiness from './referral-business';
+export * as ComissionBusiness from './comission-business';