@dynamatix/gb-schemas 1.2.80 → 2.0.0

package/entities/applicants/income-source.entity.ts

@@ -0,0 +1,22 @@
+import { ApplicantEntity } from './applicant.entity';
+import { LookupEntity } from '../shared/lookup.entity';
+
+export class IncomeSourceEntity {
+    id!: string;
+    employmentStatusLid?: string;
+    incomeFromEmployment?: string;
+    incomeFromPension?: string;
+    incomeFromProperty?: string;
+    incomeFromSavings?: string;
+    applicantId!: string;
+    createdAt!: Date;
+    updatedAt!: Date;
+
+    // Relations
+    applicant?: ApplicantEntity;
+    employmentStatus?: LookupEntity;
+
+    constructor(partial: Partial<IncomeSourceEntity>) {
+        Object.assign(this, partial);
+    }
+} 

package/entities/applicants/income.entity.ts

@@ -0,0 +1,58 @@
+export class IncomeEntity {
+    id!: string;
+    accountantsAddressLine1!: string;
+    accountantsAddressLine2!: string;
+    accountantsAddressLine3!: string;
+    accountantsCity!: string;
+    accountantsCountryLid!: string;
+    accountantsEmail!: string;
+    accountantsPostCode!: string;
+    accountantsPractice!: string;
+    accountantsTelephoneNumber!: string;
+    businessAddressLine1!: string;
+    businessAddressLine2!: string;
+    businessAddressLine3!: string;
+    businessCity!: string;
+    businessCountryLid!: string;
+    businessPostCode!: string;
+    businessTelephoneNumber!: string;
+    businessTypeLid!: string;
+    charteredCertifiedOrOtherLid!: string;
+    contactName!: string;
+    currentYearEnd!: string;
+    dateEstablished!: string;
+    doYouHaveAccountant!: boolean;
+    isBusinessAddressDifferent!: boolean;
+    nameOfBusiness!: string;
+    natureOfBusiness!: string;
+    netAssets1!: number;
+    netAssets2!: number;
+    netAssets3!: number;
+    pageValidFlag!: boolean;
+    percentageOfShareholding!: number;
+    registeredAddressLine1!: string;
+    registeredAddressLine2!: string;
+    registeredAddressLine3!: string;
+    registeredCity!: string;
+    registeredCountryLid!: string;
+    registeredPostCode!: string;
+    registeredTelephone!: string;
+    selfEmployedDate!: string;
+    turnover1!: number;
+    turnover2!: number;
+    turnover3!: number;
+    year1!: number;
+    year2!: number;
+    year3!: number;
+    yearEnd1?: number;
+    yearEnd2?: number;
+    yearEnd3?: number;
+    createdAt!: Date;
+    updatedAt!: Date;
+
+    constructor(partial: Partial<IncomeEntity>) {
+        Object.assign(this, partial);
+    }
+
+    // Add virtual fields in Mapper {accountantsCountry, businessCountry, businessType, charteredCertifiedOrOther, registeredCountry} etc
+} 

package/entities/applicants/index.ts

@@ -0,0 +1,59 @@
+import type {
+    Applicant,
+    CreditData,
+    RiskNarrative,
+    OtherIncome,
+    IncomeSource,
+    Expenditure,
+    Employment,
+    DirectDebit,
+    CreditProfile,
+    PropertyIncome,
+    Income,
+    SecuredLoanCommitment,
+    UnsecuredLoanCommitment,
+    ResidenceCommitment,
+    MortgageCommitment,
+    LoanCommitment,
+    CreditCardCommitment
+} from '@prisma/client';
+
+// Export Prisma types
+export type {
+    Applicant,
+    CreditData,
+    RiskNarrative,
+    OtherIncome,
+    IncomeSource,
+    Expenditure,
+    Employment,
+    DirectDebit,
+    CreditProfile,
+    PropertyIncome,
+    Income,
+    SecuredLoanCommitment,
+    UnsecuredLoanCommitment,
+    ResidenceCommitment,
+    MortgageCommitment,
+    LoanCommitment,
+    CreditCardCommitment
+};
+
+// Export entity classes
+export * from './applicant.entity';
+export * from './secure-loan-commitment.entity';
+export * from './unsecured-loan-commitment.entity';
+export * from './property-income.entity';
+export * from './residence-commitment.entity';
+export * from './risk-narrative.entity';
+export * from './mortgage-commitment.entity';
+export * from './other-income.entity';
+export * from './income-source.entity';
+export * from './income.entity';
+export * from './loan-commitment.entity';
+export * from './credit-profile.entity';
+export * from './direct-debit.entity';
+export * from './employment.entity';
+export * from './expenditure.entity';
+export * from './credit-card-commitment.entity';
+export * from './credit-data.entity'; 

package/entities/applicants/loan-commitment.entity.ts

@@ -0,0 +1,24 @@
+export class LoanCommitmentEntity {
+    id!: string;
+    applicantId!: string;
+    commitmentId!: string;
+    commitmentTypeLid?: string;
+    lenderName!: string;
+    loanTypeLid!: string;
+    securityDetails!: string;
+    purpose?: string;
+    doHaveSharedResponsibility!: boolean;
+    sharedMortgage!: string;
+    remainingTerm?: string;
+    startDate!: string;
+    outstandingBalance!: number;
+    monthlyPayment!: number;
+    createdAt!: Date;
+    updatedAt!: Date;
+
+    constructor(partial: Partial<LoanCommitmentEntity>) {
+        Object.assign(this, partial);
+    }
+
+    // Add virtual fields in Mapper {commitmentType, loanType} etc
+} 

package/entities/applicants/mortgage-commitment.entity.ts

@@ -0,0 +1,56 @@
+import { ApplicantEntity } from './applicant.entity';
+import { LookupEntity } from '../shared/lookup.entity';
+
+export class MortgageCommitmentEntity {
+    id!: string;
+    applicantId!: string;
+    lenderName!: string;
+    propertyValue!: number;
+    repaymentTypeLid!: string;
+    mortgageTypeLid?: string;
+    fixedTerm!: string;
+    originalLoanAmount!: number;
+    outstandingBalance!: number;
+    startDate!: string;
+    monthlyPayment!: number;
+    commitmentId!: string;
+    commitmentTypeLid?: string;
+    furtherAdvances!: boolean;
+    furtherAdvanceDetails!: string;
+    accountUptoDate!: boolean;
+    accountUptoDateFailDetails!: string;
+    accountInArrears!: boolean;
+    accountInArrearsDetails!: string;
+    doHaveSharedResponsibility!: boolean;
+    sharedMortgage!: string;
+    createdAt!: Date;
+    updatedAt!: Date;
+
+    // Relations
+    applicant?: ApplicantEntity;
+    repaymentType?: LookupEntity;
+    mortgageType?: LookupEntity;
+    commitmentType?: LookupEntity;
+
+    constructor(partial: Partial<MortgageCommitmentEntity>) {
+        Object.assign(this, partial);
+    }
+
+    // Virtual fields from Mongoose model
+    // These are computed properties that were previously virtual in Mongoose
+    get furtherAdvancesDisplay(): string {
+        return this.furtherAdvances ? "Yes" : "No";
+    }
+
+    get accountUptoDateDisplay(): string {
+        return this.accountUptoDate ? "Yes" : "No";
+    }
+
+    get accountInArrearsDisplay(): string {
+        return this.accountInArrears ? "Yes" : "No";
+    }
+
+    get doHaveSharedResponsibilityDisplay(): string {
+        return this.doHaveSharedResponsibility ? "Yes" : "No";
+    }
+} 

package/entities/applicants/other-income.entity.ts

@@ -0,0 +1,68 @@
+import { ApplicantEntity } from './applicant.entity';
+import { LookupEntity } from '../shared/lookup.entity';
+
+export class OtherIncomeEntity {
+    id!: string;
+    // Income Source 1
+    sourceDetails1?: string;
+    amount1!: number;
+    payFrequency1Lid?: string;
+    guaranteed1!: boolean;
+
+    // Income Source 2
+    sourceDetails2?: string;
+    amount2!: number;
+    payFrequency2Lid?: string;
+    guaranteed2!: boolean;
+
+    // Income Source 3
+    sourceDetails3?: string;
+    amount3!: number;
+    payFrequency3Lid?: string;
+    guaranteed3!: boolean;
+
+    // Income Source 4
+    sourceDetails4?: string;
+    amount4!: number;
+    payFrequency4Lid?: string;
+    guaranteed4!: boolean;
+
+    taxCredits!: number;
+    maintenance!: number;
+    otherBenefits!: number;
+    grossPensionIncome!: number;
+    privatePensionIncome!: number;
+    statePensionIncome!: number;
+    applicantId!: string;
+    createdAt!: Date;
+    updatedAt!: Date;
+
+    // Relations
+    applicant?: ApplicantEntity;
+    payFrequency1?: LookupEntity;
+    payFrequency2?: LookupEntity;
+    payFrequency3?: LookupEntity;
+    payFrequency4?: LookupEntity;
+
+    constructor(partial: Partial<OtherIncomeEntity>) {
+        Object.assign(this, partial);
+    }
+
+    // Virtual fields from Mongoose model
+    // These are computed properties that were previously virtual in Mongoose
+    get guaranteed1Display(): string {
+        return this.guaranteed1 ? "Yes" : "No";
+    }
+
+    get guaranteed2Display(): string {
+        return this.guaranteed2 ? "Yes" : "No";
+    }
+
+    get guaranteed3Display(): string {
+        return this.guaranteed3 ? "Yes" : "No";
+    }
+
+    get guaranteed4Display(): string {
+        return this.guaranteed4 ? "Yes" : "No";
+    }
+} 

package/entities/applicants/property-income.entity.ts

@@ -0,0 +1,19 @@
+export class PropertyIncomeEntity {
+    id!: string;
+    pageValidFlag!: boolean;
+    yearEnd1!: number;
+    rentalIncome1!: number;
+    netProfit1!: number;
+    yearEnd2!: number;
+    rentalIncome2!: number;
+    netProfit2!: number;
+    yearEnd3!: number;
+    rentalIncome3!: number;
+    netProfit3!: number;
+    createdAt!: Date;
+    updatedAt!: Date;
+
+    constructor(partial: Partial<PropertyIncomeEntity>) {
+        Object.assign(this, partial);
+    }
+} 

package/entities/applicants/residence-commitment.entity.ts

@@ -0,0 +1,63 @@
+import { ApplicantEntity } from './applicant.entity';
+import { LookupEntity } from '../shared/lookup.entity';
+
+export class ResidenceCommitmentEntity {
+    id!: string;
+    applicantId!: string;
+    pageValidFlag!: boolean;
+    financeTypeHppLid?: string;
+    lenderName!: string;
+    propertyValue!: number;
+    hppRepaymentTypeLid!: string;
+    mortgageTypeLid?: string;
+    fixedTerm!: string;
+    commitmentId!: string;
+    originalLoanAmount!: number;
+    outstandingBalance!: number;
+    startDate!: string;
+    mortgageRate!: number;
+    remainingTermMonth!: number;
+    financeHomeTypeLid!: string;
+    chargeTypeLid!: string;
+    monthlyPayment!: number;
+    furtherAdvances!: boolean;
+    furtherAdvanceDetails!: string;
+    accountUptoDate!: boolean;
+    accountUptoDateFailDetails!: string;
+    accountInArrears!: boolean;
+    accountInArrearsDetails!: string;
+    doHaveSharedResponsibility!: boolean;
+    sharedMortgage!: string;
+    createdAt!: Date;
+    updatedAt!: Date;
+
+    // Relations
+    applicant?: ApplicantEntity;
+    financeTypeHpp?: LookupEntity;
+    hppRepaymentType?: LookupEntity;
+    mortgageType?: LookupEntity;
+    financeHomeType?: LookupEntity;
+    chargeType?: LookupEntity;
+
+    constructor(partial: Partial<ResidenceCommitmentEntity>) {
+        Object.assign(this, partial);
+    }
+
+    // Virtual fields from Mongoose model
+    // These are computed properties that were previously virtual in Mongoose
+    get furtherAdvancesDisplay(): string {
+        return this.furtherAdvances ? "Yes" : "No";
+    }
+
+    get accountUptoDateDisplay(): string {
+        return this.accountUptoDate ? "Yes" : "No";
+    }
+
+    get accountInArrearsDisplay(): string {
+        return this.accountInArrears ? "Yes" : "No";
+    }
+
+    get doHaveSharedResponsibilityDisplay(): string {
+        return this.doHaveSharedResponsibility ? "Yes" : "No";
+    }
+} 

package/entities/applicants/risk-narrative.entity.ts

@@ -0,0 +1,28 @@
+import { ApplicantEntity } from './applicant.entity';
+import { LookupEntity } from '../shared/lookup.entity';
+
+export class RiskNarrativeEntity {
+    id!: string;
+    call2StatusLid?: string;
+    clientReference?: string;
+    docVerificationStatusLid?: string;
+    isPoaTaskGenerated?: string;
+    link?: string;
+    riskLevel?: string;
+    riskRating?: string;
+    statusLid?: string;
+    verificationLinkSentOn?: string;
+    applicantId!: string;
+    createdAt!: Date;
+    updatedAt!: Date;
+
+    // Relations
+    applicant?: ApplicantEntity;
+    call2Status?: LookupEntity;
+    docVerificationStatus?: LookupEntity;
+    status?: LookupEntity;
+
+    constructor(partial: Partial<RiskNarrativeEntity>) {
+        Object.assign(this, partial);
+    }
+} 

package/entities/applicants/secure-loan-commitment.entity.ts

@@ -0,0 +1,30 @@
+import { ApplicantEntity } from './applicant.entity';
+
+export class SecureLoanCommitmentEntity {
+    id!: string;
+    applicantId!: string;
+    lenderName!: string;
+    commitmentId!: string;
+    securityDetails!: string;
+    purpose!: string;
+    doHaveSharedResponsibility!: boolean;
+    sharedMortgage!: string;
+    remainingTerm?: string;
+    startDate!: string;
+    outstandingBalance!: number;
+    monthlyPayment!: number;
+    createdAt!: Date;
+    updatedAt!: Date;
+
+    // Relations
+    applicant?: ApplicantEntity;
+
+    constructor(partial: Partial<SecureLoanCommitmentEntity>) {
+        Object.assign(this, partial);
+    }
+
+    // Virtual fields from Mongoose model
+    get doHaveSharedResponsibilityDisplay(): string {
+        return this.doHaveSharedResponsibility ? "Yes" : "No";
+    }
+} 

package/entities/applicants/unsecured-loan-commitment.entity.ts

@@ -0,0 +1,30 @@
+import { ApplicantEntity } from './applicant.entity';
+
+export class UnsecuredLoanCommitmentEntity {
+    id!: string;
+    applicantId!: string;
+    lenderName!: string;
+    commitmentId!: string;
+    purpose!: string;
+    doHaveSharedResponsibility!: boolean;
+    sharedMortgage!: string;
+    remainingTerm?: string;
+    startDate!: string;
+    outstandingBalance!: number;
+    monthlyPayment!: number;
+    createdAt!: Date;
+    updatedAt!: Date;
+
+    // Relations
+    applicant?: ApplicantEntity;
+
+    constructor(partial: Partial<UnsecuredLoanCommitmentEntity>) {
+        Object.assign(this, partial);
+    }
+
+    // Virtual fields from Mongoose model
+    // These are computed properties that were previously virtual in Mongoose
+    get doHaveSharedResponsibilityDisplay(): string {
+        return this.doHaveSharedResponsibility ? "Yes" : "No";
+    }
+} 

package/entities/applications/application-audit.entity.ts

@@ -0,0 +1,23 @@
+import { ApplicationEntity } from '../applications/application.entity';
+
+export class ApplicationAuditEntity {
+    id!: string;
+    auditId!: string;
+    accountId!: string;
+    auditCorrelationId!: string;
+    auditDate!: Date;
+    changeType!: string;
+    applicationId!: string;
+    name!: string;
+    oldValue!: string;
+    newValue!: string;
+    createdAt!: Date;
+    updatedAt!: Date;
+
+    // Relations
+    application?: ApplicationEntity;
+
+    constructor(partial: Partial<ApplicationAuditEntity>) {
+        Object.assign(this, partial);
+    }
+} 

package/entities/applications/application-company.entity.ts

@@ -0,0 +1,17 @@
+import { ApplicationEntity } from './application.entity';
+
+export class ApplicationCompanyEntity {
+    id!: string;
+    applicationId!: string;
+    name!: string;
+    registrationNumber?: string;
+    createdAt!: Date;
+    updatedAt!: Date;
+
+    // Relations
+    application!: ApplicationEntity;
+
+    constructor(partial: Partial<ApplicationCompanyEntity>) {
+        Object.assign(this, partial);
+    }
+} 

package/entities/applications/application-direct-debit.entity.ts

@@ -0,0 +1,17 @@
+import { ApplicationEntity } from './application.entity';
+
+export class ApplicationDirectDebitEntity {
+    id!: string;
+    applicationId!: string;
+    accountNumber!: string;
+    sortCode!: string;
+    createdAt!: Date;
+    updatedAt!: Date;
+
+    // Relations
+    application!: ApplicationEntity;
+
+    constructor(partial: Partial<ApplicationDirectDebitEntity>) {
+        Object.assign(this, partial);
+    }
+} 

package/entities/applications/application-document.entity.ts

@@ -0,0 +1,33 @@
+import { ApplicationEntity } from './application.entity';
+import { LookupEntity } from '../shared/lookup.entity';
+
+export class ApplicationDocumentEntity {
+    id!: string;
+    applicationId?: string;
+    documentId!: string;
+    owningEntityId?: string;
+    documentTypeLid?: string;
+    documentTypeId?: string;
+    fileName?: string;
+    contentType?: string;
+    created?: string;
+    createdBy?: string;
+    isGenerated?: string;
+    data?: string;
+    envelopeId?: string;
+    signers!: any[];
+    documentTypeDisplayName?: string;
+    documentTypeValue?: string;
+    documentTypeData?: any;
+    documentUrl?: string;
+    createdAt!: Date;
+    updatedAt!: Date;
+
+    // Relations
+    application?: ApplicationEntity;
+    documentType?: LookupEntity;
+
+    constructor(partial: Partial<ApplicationDocumentEntity>) {
+        Object.assign(this, partial);
+    }
+} 

package/entities/applications/application-fieldconfig.entity.ts

@@ -0,0 +1,11 @@
+export class ApplicationFieldConfigEntity {
+    id!: string;
+    fieldName!: string;
+    validateProductOnChange!: string;
+    createdAt!: Date;
+    updatedAt!: Date;
+
+    constructor(partial: Partial<ApplicationFieldConfigEntity>) {
+        Object.assign(this, partial);
+    }
+} 

package/entities/applications/application-illustration.entity.ts

@@ -0,0 +1,10 @@
+export class ApplicationIllustrationEntity {
+    id!: string;
+    date!: Date;
+    createdAt!: Date;
+    updatedAt!: Date;
+
+    constructor(partial: Partial<ApplicationIllustrationEntity>) {
+        Object.assign(this, partial);
+    }
+} 

package/entities/applications/application-legal.entity.ts

@@ -0,0 +1,11 @@
+export class ApplicationLegalEntity {
+    id!: string;
+    assignedSolicitor!: string;
+    solicitorsReference!: string;
+    createdAt!: Date;
+    updatedAt!: Date;
+
+    constructor(partial: Partial<ApplicationLegalEntity>) {
+        Object.assign(this, partial);
+    }
+} 

package/entities/applications/application-mortgage.entity.ts

@@ -0,0 +1,82 @@
+import { ApplicationEntity } from '../applications/application.entity';
+import { LookupEntity } from '../shared/lookup.entity';
+
+export class ApplicationMortgageEntity {
+    id!: string;
+    applicationId!: string;
+    pageValidFlag!: boolean;
+    existingMortgageLender?: string;
+    topSlicing!: boolean;
+    purposeOfMortgage!: string;
+    depositComeFromLids!: string[];
+    ifOtherDetails!: string;
+    purchasePrice!: number;
+    repaymentTypeLid!: string;
+    exitStrategyLid!: string;
+    isCapitalRaise!: boolean;
+    purchaseDate!: string;
+    estimatedValue!: number;
+    loanRequired!: number;
+    monthlyRentalIncome!: number;
+    outstandingBalance!: number;
+    fundRaisedFor!: string;
+    sourceOfFundsLid!: string;
+    sourceOfFundDetails!: string;
+    propertyValuationDetails!: string;
+    telephoneNumber!: string;
+    isDistressedSale!: boolean;
+    isPurchasedBelowMarketValue!: boolean;
+    isPurchasedAsSale!: boolean;
+    isReadyToSell!: boolean;
+    isGovernmentInitiative!: boolean;
+    vendorsName?: string;
+    saleMadeLid?: string;
+    isTheIntentionToLet!: boolean;
+    proposedTenantsLids!: string[];
+    leaseTypeLid!: string;
+    createdAt!: Date;
+    updatedAt!: Date;
+
+    // Relations
+    application?: ApplicationEntity;
+    repaymentType?: LookupEntity;
+    exitStrategy?: LookupEntity;
+    sourceOfFunds?: LookupEntity;
+    saleMade?: LookupEntity;
+    leaseType?: LookupEntity;
+    depositComeFrom?: LookupEntity[];
+    proposedTenants?: LookupEntity[];
+
+    constructor(partial: Partial<ApplicationMortgageEntity>) {
+        Object.assign(this, partial);
+    }
+
+    // Virtual properties from Mongoose model
+    get depositComeFromNames(): string[] | null {
+        return this.depositComeFrom?.map(d => d.name) ?? null;
+    }
+
+    get repaymentTypeName(): string | null {
+        return this.repaymentType?.name ?? null;
+    }
+
+    get exitStrategyName(): string | null {
+        return this.exitStrategy?.name ?? null;
+    }
+
+    get sourceOfFundsName(): string | null {
+        return this.sourceOfFunds?.name ?? null;
+    }
+
+    get saleMadeName(): string | null {
+        return this.saleMade?.name ?? null;
+    }
+
+    get proposedTenantsNames(): string[] | null {
+        return this.proposedTenants?.map(t => t.name) ?? null;
+    }
+
+    get leaseTypeName(): string | null {
+        return this.leaseType?.name ?? null;
+    }
+}