@fiado/type-kit 3.0.6 → 3.0.8

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.
Files changed (104) hide show
  1. package/bin/card/validations/CardUpdateKeyConstraint.js +2 -2
  2. package/bin/card/validations/IsPhoneNumberConstraint.js +2 -2
  3. package/bin/credit/dtos/BannerStateResponse.d.ts +17 -0
  4. package/bin/credit/dtos/BannerStateResponse.js +9 -0
  5. package/bin/credit/dtos/CreditOfferConfigureRequest.d.ts +5 -4
  6. package/bin/credit/dtos/CreditOfferConfigureRequest.js +8 -16
  7. package/bin/credit/dtos/CreditOfferConfigureResponse.d.ts +11 -22
  8. package/bin/credit/dtos/CreditOfferConfigureResponse.js +4 -4
  9. package/bin/credit/dtos/CreditOfferOptionItem.d.ts +12 -0
  10. package/bin/credit/dtos/CreditOfferOptionItem.js +9 -0
  11. package/bin/credit/dtos/EligibilityResponse.d.ts +13 -0
  12. package/bin/credit/dtos/EligibilityResponse.js +9 -0
  13. package/bin/credit/dtos/FinancialProfileResponse.d.ts +33 -0
  14. package/bin/credit/dtos/FinancialProfileResponse.js +9 -0
  15. package/bin/credit/enums/BannerStateEnum.d.ts +15 -0
  16. package/bin/credit/enums/BannerStateEnum.js +19 -0
  17. package/bin/credit/enums/CreditLevelEnum.d.ts +15 -0
  18. package/bin/credit/enums/CreditLevelEnum.js +19 -0
  19. package/bin/credit/enums/CreditOfferStatusEnum.d.ts +17 -0
  20. package/bin/credit/enums/CreditOfferStatusEnum.js +21 -0
  21. package/bin/credit/enums/IncomeClassificationEnum.d.ts +15 -0
  22. package/bin/credit/enums/IncomeClassificationEnum.js +19 -0
  23. package/bin/credit/enums/IncomeFrequencyEnum.d.ts +17 -0
  24. package/bin/credit/enums/IncomeFrequencyEnum.js +21 -0
  25. package/bin/credit/index.d.ts +12 -37
  26. package/bin/credit/index.js +15 -40
  27. package/bin/credit/interfaces/IIncomeDetectionMessage.d.ts +9 -0
  28. package/bin/credit/interfaces/IIncomeDetectionMessage.js +2 -0
  29. package/bin/credit/interfaces/IOfferGenerationMessage.d.ts +8 -0
  30. package/bin/credit/interfaces/IOfferGenerationMessage.js +2 -0
  31. package/bin/credit/interfaces/IScoringMessage.d.ts +8 -0
  32. package/bin/credit/interfaces/IScoringMessage.js +2 -0
  33. package/bin/index.d.ts +1 -1
  34. package/bin/index.js +19 -9
  35. package/package.json +1 -1
  36. package/src/credit/dtos/BannerStateResponse.ts +14 -0
  37. package/src/credit/dtos/CreditOfferConfigureRequest.ts +8 -15
  38. package/src/credit/dtos/CreditOfferConfigureResponse.ts +11 -23
  39. package/src/credit/dtos/CreditOfferOptionItem.ts +12 -0
  40. package/src/credit/dtos/EligibilityResponse.ts +13 -0
  41. package/src/credit/dtos/FinancialProfileResponse.ts +39 -0
  42. package/src/credit/enums/BannerStateEnum.ts +15 -0
  43. package/src/credit/enums/CreditLevelEnum.ts +15 -0
  44. package/src/credit/enums/CreditOfferStatusEnum.ts +17 -0
  45. package/src/credit/enums/IncomeClassificationEnum.ts +15 -0
  46. package/src/credit/enums/IncomeFrequencyEnum.ts +17 -0
  47. package/src/credit/index.ts +16 -41
  48. package/src/credit/interfaces/IIncomeDetectionMessage.ts +9 -0
  49. package/src/credit/interfaces/IOfferGenerationMessage.ts +8 -0
  50. package/src/credit/interfaces/IScoringMessage.ts +8 -0
  51. package/src/index.ts +1 -1
  52. package/bin/bankAccount/dtos/ExternalAccountType.d.ts +0 -4
  53. package/bin/bankAccount/dtos/ExternalAccountType.js +0 -6
  54. package/bin/centralPayments/dtos/CentralPaymentsDocumentImages.d.ts +0 -6
  55. package/bin/centralPayments/dtos/CentralPaymentsDocumentImages.js +0 -6
  56. package/bin/centralPayments/dtos/CentralPaymentsDocumentUploadRequest.d.ts +0 -6
  57. package/bin/centralPayments/dtos/CentralPaymentsDocumentUploadRequest.js +0 -6
  58. package/bin/directorySetting/dtos/DirectorySettingCreateResponse.d.ts +0 -0
  59. package/bin/directorySetting/dtos/DirectorySettingCreateResponse.js +0 -0
  60. package/bin/pricelist/dtos/GetPriceListDirectoriesResponse.d.ts +0 -28
  61. package/bin/pricelist/dtos/GetPriceListDirectoriesResponse.js +0 -6
  62. package/bin/services/dtos/GetMembershipListAppResponse.d.ts +0 -4
  63. package/bin/services/dtos/GetMembershipListAppResponse.js +0 -6
  64. package/bin/services/dtos/GetServiceMembershipListAResponse.d.ts +0 -4
  65. package/bin/services/dtos/GetServiceMembershipListAResponse.js +0 -6
  66. package/bin/services/enums/ServiceProviderEnum.d.ts +0 -5
  67. package/bin/services/enums/ServiceProviderEnum.js +0 -9
  68. package/src/credit/dtos/CreditBannerStateResponse.ts +0 -11
  69. package/src/credit/dtos/CreditDetailResponse.ts +0 -24
  70. package/src/credit/dtos/CreditEligibilityResponse.ts +0 -10
  71. package/src/credit/dtos/CreditMovementResponse.ts +0 -22
  72. package/src/credit/dtos/CreditRequestCreate.ts +0 -12
  73. package/src/credit/dtos/CreditRequestResponse.ts +0 -8
  74. package/src/credit/dtos/CreditScheduleResponse.ts +0 -19
  75. package/src/credit/dtos/CreditStatementResponse.ts +0 -12
  76. package/src/credit/dtos/EarlyPaymentRequest.ts +0 -21
  77. package/src/credit/dtos/EarlyPaymentResponse.ts +0 -12
  78. package/src/credit/dtos/internal/CreditBalanceRequest.ts +0 -8
  79. package/src/credit/dtos/internal/CreditBalanceResponse.ts +0 -10
  80. package/src/credit/dtos/internal/CreditCollectionRequest.ts +0 -39
  81. package/src/credit/dtos/internal/CreditCollectionResponse.ts +0 -12
  82. package/src/credit/dtos/internal/CreditDisbursementRequest.ts +0 -26
  83. package/src/credit/dtos/internal/CreditDisbursementResponse.ts +0 -8
  84. package/src/credit/dtos/internal/CreditProfileRequest.ts +0 -10
  85. package/src/credit/dtos/internal/CreditProfileResponse.ts +0 -14
  86. package/src/credit/dtos/internal/CreditQueueMessage.ts +0 -20
  87. package/src/credit/dtos/internal/CreditReversalRequest.ts +0 -16
  88. package/src/credit/dtos/internal/CreditReversalResponse.ts +0 -7
  89. package/src/credit/dtos/internal/CreditTransferLoancoRequest.ts +0 -28
  90. package/src/credit/dtos/internal/CreditTransferLoancoResponse.ts +0 -9
  91. package/src/credit/dtos/internal/DocumentGenerateRequest.ts +0 -34
  92. package/src/credit/dtos/internal/DocumentGenerateResponse.ts +0 -12
  93. package/src/credit/dtos/internal/DocumentSignRequest.ts +0 -8
  94. package/src/credit/dtos/internal/LienApplyRequest.ts +0 -28
  95. package/src/credit/dtos/internal/LienStatusResponse.ts +0 -9
  96. package/src/credit/enums/CollectionFrequencyEnum.ts +0 -5
  97. package/src/credit/enums/CreditOperationEnum.ts +0 -11
  98. package/src/credit/enums/CreditStatusEnum.ts +0 -12
  99. package/src/credit/enums/DelinquencyLevelEnum.ts +0 -9
  100. package/src/credit/enums/DocumentTypeEnum.ts +0 -8
  101. package/src/credit/enums/OfferStatusEnum.ts +0 -8
  102. package/src/credit/enums/PaymentTypeEnum.ts +0 -9
  103. package/src/credit/enums/ReconciliationStatusEnum.ts +0 -6
  104. package/src/credit/enums/TransferStatusEnum.ts +0 -8
@@ -1,12 +0,0 @@
1
- export class CreditStatementItem {
2
- statementId: string;
3
- period: string;
4
- generatedAt: string;
5
- documentId: string;
6
- downloadUrl: string | null;
7
- }
8
-
9
- export class CreditStatementListResponse {
10
- creditId: string;
11
- statements: CreditStatementItem[];
12
- }
@@ -1,21 +0,0 @@
1
- import { IsEnum, IsNotEmpty, IsNumber, IsOptional, IsString } from "class-validator";
2
- import { PaymentTypeEnum } from "../enums/PaymentTypeEnum";
3
-
4
- export class EarlyPaymentRequest {
5
-
6
- @IsString()
7
- @IsNotEmpty()
8
- creditId: string;
9
-
10
- @IsEnum(PaymentTypeEnum)
11
- @IsNotEmpty()
12
- type: PaymentTypeEnum;
13
-
14
- @IsNumber()
15
- @IsOptional()
16
- amount?: number;
17
-
18
- @IsNumber()
19
- @IsOptional()
20
- numberOfCoupons?: number;
21
- }
@@ -1,12 +0,0 @@
1
- import { PaymentTypeEnum } from "../enums/PaymentTypeEnum";
2
-
3
- export class EarlyPaymentResponse {
4
- creditId: string;
5
- type: PaymentTypeEnum;
6
- amountCharged: number;
7
- principalPaid: number;
8
- interestSaved: number;
9
- newBalance: number;
10
- newMaturityDate: string | null;
11
- transactionId: string;
12
- }
@@ -1,8 +0,0 @@
1
- import { IsNotEmpty, IsString } from "class-validator";
2
-
3
- export class CreditBalanceRequest {
4
-
5
- @IsString()
6
- @IsNotEmpty()
7
- creditId: string;
8
- }
@@ -1,10 +0,0 @@
1
- export class CreditBalanceResponse {
2
- creditId: string;
3
- currentBalance: number;
4
- principalBalance: number;
5
- accruedInterest: number;
6
- overdueAmount: number;
7
- nextPaymentAmount: number;
8
- nextPaymentDate: string;
9
- availableForEarlyPayment: number;
10
- }
@@ -1,39 +0,0 @@
1
- import { IsEnum, IsNotEmpty, IsNumber, IsOptional, IsString, Matches } from "class-validator";
2
- import { regexUuidV4 } from "../../../helpers/constans/regex";
3
- import { PaymentTypeEnum } from "../../enums/PaymentTypeEnum";
4
-
5
- export class CreditCollectionRequest {
6
-
7
- @IsString()
8
- @IsNotEmpty()
9
- creditId: string;
10
-
11
- @IsString()
12
- @IsNotEmpty()
13
- @Matches(regexUuidV4, { message: 'directoryId must be a valid UUID v4' })
14
- directoryId: string;
15
-
16
- @IsNumber()
17
- @IsNotEmpty()
18
- amount: number;
19
-
20
- @IsNumber()
21
- @IsNotEmpty()
22
- couponNumber: number;
23
-
24
- @IsEnum(PaymentTypeEnum)
25
- @IsNotEmpty()
26
- paymentType: PaymentTypeEnum;
27
-
28
- @IsString()
29
- @IsNotEmpty()
30
- pagoConfiadoAccountId: string;
31
-
32
- @IsString()
33
- @IsNotEmpty()
34
- fiadoIncAccountId: string;
35
-
36
- @IsString()
37
- @IsOptional()
38
- idempotencyKey?: string;
39
- }
@@ -1,12 +0,0 @@
1
- export class CreditCollectionResponse {
2
- creditId: string;
3
- transactionId: string;
4
- idempotencyKey: string;
5
- amountCollected: number;
6
- principal: number;
7
- interest: number;
8
- iva: number;
9
- newBalance: number;
10
- status: 'COMPLETED' | 'FAILED' | 'INSUFFICIENT_FUNDS';
11
- timestamp: string;
12
- }
@@ -1,26 +0,0 @@
1
- import { IsNotEmpty, IsNumber, IsString, Matches } from "class-validator";
2
- import { regexUuidV4 } from "../../../helpers/constans/regex";
3
-
4
- export class CreditDisbursementRequest {
5
-
6
- @IsString()
7
- @IsNotEmpty()
8
- creditId: string;
9
-
10
- @IsString()
11
- @IsNotEmpty()
12
- @Matches(regexUuidV4, { message: 'directoryId must be a valid UUID v4' })
13
- directoryId: string;
14
-
15
- @IsNumber()
16
- @IsNotEmpty()
17
- amount: number;
18
-
19
- @IsString()
20
- @IsNotEmpty()
21
- pagoConfiadoAccountId: string;
22
-
23
- @IsString()
24
- @IsNotEmpty()
25
- fiadoIncAccountId: string;
26
- }
@@ -1,8 +0,0 @@
1
- export class CreditDisbursementResponse {
2
- creditId: string;
3
- transactionId: string;
4
- idempotencyKey: string;
5
- amount: number;
6
- status: 'COMPLETED' | 'FAILED';
7
- timestamp: string;
8
- }
@@ -1,10 +0,0 @@
1
- import { IsNotEmpty, IsString, Matches } from "class-validator";
2
- import { regexUuidV4 } from "../../../helpers/constans/regex";
3
-
4
- export class CreditProfileRequest {
5
-
6
- @IsString()
7
- @IsNotEmpty()
8
- @Matches(regexUuidV4, { message: 'directoryId must be a valid UUID v4' })
9
- directoryId: string;
10
- }
@@ -1,14 +0,0 @@
1
- import { CreditStatusEnum } from "../../enums/CreditStatusEnum";
2
- import { OfferStatusEnum } from "../../enums/OfferStatusEnum";
3
-
4
- export class CreditProfileResponse {
5
- directoryId: string;
6
- hasActiveCredit: boolean;
7
- creditId: string | null;
8
- creditStatus: CreditStatusEnum | null;
9
- offerStatus: OfferStatusEnum | null;
10
- currentBalance: number | null;
11
- overdueAmount: number | null;
12
- financialScore: number | null;
13
- lastUpdated: string;
14
- }
@@ -1,20 +0,0 @@
1
- export type CreditQueueMessageType =
2
- | 'INCOME_DETECTION'
3
- | 'SCORING'
4
- | 'OFFER_GENERATION'
5
- | 'COLLECTION'
6
- | 'DELINQUENCY'
7
- | 'TRANSFER'
8
- | 'NOTIFICATION'
9
- | 'STATEMENT'
10
- | 'RECONCILIATION'
11
- | 'LIEN_COLLECTION';
12
-
13
- export class CreditQueueMessage {
14
- type: CreditQueueMessageType;
15
- directoryId: string;
16
- creditId: string | null;
17
- payload: Record<string, any>;
18
- timestamp: string;
19
- correlationId: string;
20
- }
@@ -1,16 +0,0 @@
1
- import { IsNotEmpty, IsString } from "class-validator";
2
-
3
- export class CreditReversalRequest {
4
-
5
- @IsString()
6
- @IsNotEmpty()
7
- originalTransactionId: string;
8
-
9
- @IsString()
10
- @IsNotEmpty()
11
- creditId: string;
12
-
13
- @IsString()
14
- @IsNotEmpty()
15
- reason: string;
16
- }
@@ -1,7 +0,0 @@
1
- export class CreditReversalResponse {
2
- reversalTransactionId: string;
3
- originalTransactionId: string;
4
- amount: number;
5
- status: 'COMPLETED' | 'FAILED';
6
- timestamp: string;
7
- }
@@ -1,28 +0,0 @@
1
- import { IsNotEmpty, IsNumber, IsString } from "class-validator";
2
-
3
- export class CreditTransferLoancoRequest {
4
-
5
- @IsString()
6
- @IsNotEmpty()
7
- transferId: string;
8
-
9
- @IsString()
10
- @IsNotEmpty()
11
- creditId: string;
12
-
13
- @IsNumber()
14
- @IsNotEmpty()
15
- amount: number;
16
-
17
- @IsString()
18
- @IsNotEmpty()
19
- fiadoIncAccountId: string;
20
-
21
- @IsString()
22
- @IsNotEmpty()
23
- loancoAccountId: string;
24
-
25
- @IsString()
26
- @IsNotEmpty()
27
- concept: string;
28
- }
@@ -1,9 +0,0 @@
1
- import { TransferStatusEnum } from "../../enums/TransferStatusEnum";
2
-
3
- export class CreditTransferLoancoResponse {
4
- transferId: string;
5
- transactionId: string;
6
- amount: number;
7
- status: TransferStatusEnum;
8
- timestamp: string;
9
- }
@@ -1,34 +0,0 @@
1
- import { IsBoolean, IsEnum, IsNotEmpty, IsNumber, IsOptional, IsString, Matches } from "class-validator";
2
- import { regexUuidV4 } from "../../../helpers/constans/regex";
3
- import { DocumentTypeEnum } from "../../enums/DocumentTypeEnum";
4
-
5
- export class DocumentGenerateRequest {
6
-
7
- @IsString()
8
- @IsNotEmpty()
9
- templateId: string;
10
-
11
- @IsEnum(DocumentTypeEnum)
12
- @IsNotEmpty()
13
- referenceType: DocumentTypeEnum;
14
-
15
- @IsString()
16
- @IsNotEmpty()
17
- referenceId: string;
18
-
19
- @IsString()
20
- @IsNotEmpty()
21
- @Matches(regexUuidV4, { message: 'directoryId must be a valid UUID v4' })
22
- directoryId: string;
23
-
24
- @IsNotEmpty()
25
- variables: Record<string, any>;
26
-
27
- @IsBoolean()
28
- @IsOptional()
29
- sign?: boolean;
30
-
31
- @IsNumber()
32
- @IsOptional()
33
- expiresInDays?: number | null;
34
- }
@@ -1,12 +0,0 @@
1
- export class DocumentGenerateResponse {
2
- documentId: string;
3
- referenceType: string;
4
- referenceId: string;
5
- directoryId: string;
6
- s3Key: string;
7
- signed: boolean;
8
- signedAt: string | null;
9
- createdAt: string;
10
- expiresAt: string | null;
11
- downloadUrl: string | null;
12
- }
@@ -1,8 +0,0 @@
1
- import { IsNotEmpty, IsString } from "class-validator";
2
-
3
- export class DocumentSignRequest {
4
-
5
- @IsString()
6
- @IsNotEmpty()
7
- documentId: string;
8
- }
@@ -1,28 +0,0 @@
1
- import { IsBoolean, IsNotEmpty, IsNumber, IsOptional, IsString, Matches, Max, Min } from "class-validator";
2
- import { regexUuidV4 } from "../../../helpers/constans/regex";
3
-
4
- export class LienApplyRequest {
5
-
6
- @IsString()
7
- @IsNotEmpty()
8
- @Matches(regexUuidV4, { message: 'directoryId must be a valid UUID v4' })
9
- directoryId: string;
10
-
11
- @IsString()
12
- @IsNotEmpty()
13
- creditId: string;
14
-
15
- @IsBoolean()
16
- @IsNotEmpty()
17
- active: boolean;
18
-
19
- @IsNumber()
20
- @IsOptional()
21
- @Min(1)
22
- @Max(100)
23
- percentage?: number;
24
-
25
- @IsNumber()
26
- @IsOptional()
27
- maxAmount?: number;
28
- }
@@ -1,9 +0,0 @@
1
- export class LienStatusResponse {
2
- directoryId: string;
3
- creditId: string;
4
- lienActive: boolean;
5
- lienPercentage: number;
6
- lienMaxAmount: number | null;
7
- totalCollectedByLien: number;
8
- lastLienDate: string | null;
9
- }
@@ -1,5 +0,0 @@
1
- export enum CollectionFrequencyEnum {
2
- WEEKLY = 'WEEKLY',
3
- BIWEEKLY = 'BIWEEKLY',
4
- MONTHLY = 'MONTHLY'
5
- }
@@ -1,11 +0,0 @@
1
- export enum CreditOperationEnum {
2
- DISBURSEMENT = 'DISBURSEMENT',
3
- COLLECTION = 'COLLECTION',
4
- COLLECTION_PARTIAL = 'COLLECTION_PARTIAL',
5
- COLLECTION_LIEN = 'COLLECTION_LIEN',
6
- EARLY_PAYMENT = 'EARLY_PAYMENT',
7
- TRANSFER_LOANCO = 'TRANSFER_LOANCO',
8
- REVERSAL = 'REVERSAL',
9
- INTEREST_ACCRUAL = 'INTEREST_ACCRUAL',
10
- FEE_CHARGE = 'FEE_CHARGE'
11
- }
@@ -1,12 +0,0 @@
1
- export enum CreditStatusEnum {
2
- PENDING_APPROVAL = 'PENDING_APPROVAL',
3
- APPROVED = 'APPROVED',
4
- ACTIVE = 'ACTIVE',
5
- CURRENT = 'CURRENT',
6
- DELINQUENT = 'DELINQUENT',
7
- DEFAULTED = 'DEFAULTED',
8
- PAID_OFF = 'PAID_OFF',
9
- CANCELLED = 'CANCELLED',
10
- RETURNED_TO_LOANCO = 'RETURNED_TO_LOANCO',
11
- WRITTEN_OFF = 'WRITTEN_OFF'
12
- }
@@ -1,9 +0,0 @@
1
- export enum DelinquencyLevelEnum {
2
- CURRENT = 'CURRENT',
3
- EARLY_1_7 = 'EARLY_1_7',
4
- EARLY_8_14 = 'EARLY_8_14',
5
- LATE_15_30 = 'LATE_15_30',
6
- LATE_31_60 = 'LATE_31_60',
7
- SEVERE_61_90 = 'SEVERE_61_90',
8
- DEFAULT_90_PLUS = 'DEFAULT_90_PLUS'
9
- }
@@ -1,8 +0,0 @@
1
- export enum DocumentTypeEnum {
2
- CREDIT_CONTRACT = 'CREDIT_CONTRACT',
3
- CREDIT_STATEMENT = 'CREDIT_STATEMENT',
4
- CREDIT_AMORTIZATION = 'CREDIT_AMORTIZATION',
5
- CREDIT_COVER_SHEET = 'CREDIT_COVER_SHEET',
6
- ONBOARDING_CONTRACT = 'ONBOARDING_CONTRACT',
7
- ONBOARDING_IFPE = 'ONBOARDING_IFPE'
8
- }
@@ -1,8 +0,0 @@
1
- export enum OfferStatusEnum {
2
- NOT_ELIGIBLE = 'NOT_ELIGIBLE',
3
- PRE_QUALIFIED = 'PRE_QUALIFIED',
4
- OFFER_AVAILABLE = 'OFFER_AVAILABLE',
5
- OFFER_CONFIGURED = 'OFFER_CONFIGURED',
6
- OFFER_ACCEPTED = 'OFFER_ACCEPTED',
7
- OFFER_EXPIRED = 'OFFER_EXPIRED'
8
- }
@@ -1,9 +0,0 @@
1
- export enum PaymentTypeEnum {
2
- REGULAR = 'REGULAR',
3
- PARTIAL = 'PARTIAL',
4
- EARLY_ANTICIPATED = 'EARLY_ANTICIPATED',
5
- EARLY_ADVANCED = 'EARLY_ADVANCED',
6
- EARLY_SETTLEMENT = 'EARLY_SETTLEMENT',
7
- LIEN = 'LIEN',
8
- REVERSAL = 'REVERSAL'
9
- }
@@ -1,6 +0,0 @@
1
- export enum ReconciliationStatusEnum {
2
- PENDING = 'PENDING',
3
- MATCHED = 'MATCHED',
4
- DISCREPANCY = 'DISCREPANCY',
5
- RESOLVED = 'RESOLVED'
6
- }
@@ -1,8 +0,0 @@
1
- export enum TransferStatusEnum {
2
- PENDING = 'PENDING',
3
- APPROVED = 'APPROVED',
4
- IN_PROGRESS = 'IN_PROGRESS',
5
- COMPLETED = 'COMPLETED',
6
- FAILED = 'FAILED',
7
- REJECTED = 'REJECTED'
8
- }