@dynamatix/gb-schemas 2.0.59 → 2.0.60

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

@@ -0,0 +1,61 @@
+import { LookupEntity } from '../shared/lookup.entity';
+
+export class ApplicantIncomeEntity {
+    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;
+
+    // Relations
+    accountantsCountry?: LookupEntity;
+    businessCountry?: LookupEntity;
+    businessType?: LookupEntity;
+    charteredCertifiedOrOther?: LookupEntity;
+    registeredCountry?: LookupEntity;
+} 

package/entities/applicants/applicant-share-holding.entity.ts

@@ -0,0 +1,23 @@
+import { ApplicantEntity } from "../applicants/applicant.entity";
+import { LookupEntity } from "../shared/lookup.entity";
+import { ApplicationCompanyEntity } from "../applications/application-company.entity";
+
+export class ApplicantShareholdingEntity {
+    id!: string;
+    companyId!: string;
+    applicantId!: string;
+    applicantName!: string;
+    directorShareholderLid?: string;
+    shareholding?: number;
+    createdAt!: Date;
+    updatedAt!: Date;
+
+    // Relations
+    company?: ApplicationCompanyEntity;
+    applicant?: ApplicantEntity;
+    directorShareholder?: LookupEntity;
+
+    constructor(partial: Partial<ApplicantShareholdingEntity>) {
+        Object.assign(this, partial);
+    }
+}

package/entities/applicants/applicant.entity.ts

@@ -0,0 +1,193 @@
+import { ApplicationEntity } from '../applications/application.entity';
+import { LookupEntity } from '../shared/lookup.entity';
+import { OtherIncomeEntity } from './other-income.entity';
+import { ApplicantExpenditureEntity } from './applicant-expenditure.entity';
+import { ApplicantCreditProfileEntity } from './applicant-credit-profile.entity';
+import { PropertyIncomeEntity } from './property-income.entity';
+import { ApplicantIncomeEntity } from './applicant-income.entity';
+import { ApplicantCreditDataEntity } from './applicant-credit-data.entity';
+import { ApplicantEmploymentEntity } from './applicant-employment.entity';
+import { ApplicantIncomeSourceEntity } from './applicant-income-source.entity';
+
+export class ApplicantEntity {
+    id!: string;
+    applicantId!: string;
+    applicationId!: string;
+    addressCity?: string;
+    addressCountryLid?: string;
+    addressLine1?: string;
+    addressLine2?: string;
+    addressLine3?: string;
+    addressMovedDate?: string;
+    addressPostCode?: string;
+    correspondenceAddressCity?: string;
+    correspondenceAddressCountryLid?: string;
+    correspondenceAddressLine1?: string;
+    correspondenceAddressLine2?: string;
+    correspondenceAddressLine3?: string;
+    correspondenceAddressPostCode?: string;
+    countryOfResidenceLid!: string;
+    dateOfBirth?: string;
+    dependant10Age!: number;
+    dependant1Age!: number;
+    dependant2Age!: number;
+    dependant3Age!: number;
+    dependant4Age!: number;
+    dependant5Age!: number;
+    dependant6Age!: number;
+    dependant7Age!: number;
+    dependant8Age!: number;
+    dependant9Age!: number;
+    email?: string;
+    employmentStatusDetails?: string;
+    firstName!: string;
+    isFirstTimelandlord!: boolean;
+    foreignIdForNationals?: string;
+    gdprEmail!: boolean;
+    gdprPost!: boolean;
+    gdprTelephone!: boolean;
+    gdprTextMessage!: boolean;
+    gender!: string;
+    hasBrokerGivenConsentForVulnerabilities!: boolean;
+    hasLinkedJurisdiction!: boolean;
+    isCorrespondence!: boolean;
+    isCommitmentConfirmed!: boolean;
+    isCurrentContract!: boolean;
+    isCustomerVulnerable!: boolean;
+    isExpat!: boolean;
+    isFirstApplicant!: boolean;
+    isUkPassport!: boolean;
+    isUkResident!: boolean;
+    classLid?: string;
+    pageValidFlag!: boolean;
+    lastName!: string;
+    linkedJurisdictionCountryLid?: string;
+    linkedJurisdictionDetails?: string;
+    maidenName?: string;
+    maritalStatusLid!: string;
+    mobileNumber?: string;
+    nationalityLid!: string;
+    netIncome!: number;
+    niNumber?: string;
+    numberOfDependants!: number;
+    isOneYearPrior!: boolean;
+    phoneNumber?: string;
+    previous1AddressCity?: string;
+    previous1AddressCountryLid?: string;
+    previous1AddressLine1?: string;
+    previous1AddressLine2?: string;
+    previous1AddressLine3?: string;
+    previous1AddressMovedDate?: string;
+    previous1AddressPostCode?: string;
+    previous1AddressPropertyOwnedBy?: string;
+    previous2AddressCity?: string;
+    previous2AddressCountryLid?: string;
+    previous2AddressLine1?: string;
+    previous2AddressLine2?: string;
+    previous2AddressLine3?: string;
+    previous2AddressMovedDate?: string;
+    previous2AddressPostCode?: string;
+    previous2AddressPropertyOwnedBy?: string;
+    relationshipToOthers!: string;
+    residentialStatusLid?: string;
+    retirementAge!: number;
+    taxJurisdictionLid!: string;
+    taxPayerLid!: string;
+    timeResidedAtCountryOfResidence!: number;
+    title!: string;
+    isTwoYearPrior!: boolean;
+    understandEnglish!: boolean;
+    vulnerabilityNotes?: string;
+    vulnerabilityTypeLids!: string[];
+    ukPassportProfessionLid?: string;
+    createdAt!: Date;
+    updatedAt!: Date;
+
+    // Relations
+    application?: ApplicationEntity;
+    addressCountry?: LookupEntity;
+    correspondenceAddressCountry?: LookupEntity;
+    countryOfResidence?: LookupEntity;
+    class?: LookupEntity;
+    linkedJurisdictionCountry?: LookupEntity;
+    maritalStatus?: LookupEntity;
+    nationality?: LookupEntity;
+    previous1AddressCountry?: LookupEntity;
+    previous2AddressCountry?: LookupEntity;
+    residentialStatus?: LookupEntity;
+    taxJurisdiction?: LookupEntity;
+    taxPayer?: LookupEntity;
+    ukPassportProfession?: LookupEntity;
+    vulnerabilityTypes?: LookupEntity[];
+
+    // Nested schemas
+    creditData?: ApplicantCreditDataEntity;
+    otherIncome?: OtherIncomeEntity;
+    incomeSource?: ApplicantIncomeSourceEntity;
+    expenditure?: ApplicantExpenditureEntity;
+    creditProfile?: ApplicantCreditProfileEntity;
+    propertyIncome?: PropertyIncomeEntity;
+    income?: ApplicantIncomeEntity;
+    employment?: ApplicantEmploymentEntity;
+
+    constructor(partial: Partial<ApplicantEntity>) {
+        Object.assign(this, partial);
+    }
+
+    // Virtual fields from Mongoose model
+    get nationalityName(): string | null {
+        return this.nationality?.name ?? null;
+    }
+
+    get residenceName(): string | null {
+        return this.countryOfResidence?.name ?? null;
+    }
+
+    get employmentClassName(): string | null {
+        return this.class?.name ?? null;
+    }
+
+    get addressCountryName(): string | null {
+        return this.addressCountry?.name ?? null;
+    }
+
+    get previous1AddressCountryName(): string | null {
+        return this.previous1AddressCountry?.name ?? null;
+    }
+
+    get previous2AddressCountryName(): string | null {
+        return this.previous2AddressCountry?.name ?? null;
+    }
+
+    get maritalStatusName(): string | null {
+        return this.maritalStatus?.name ?? null;
+    }
+
+    get residentialStatusName(): string | null {
+        return this.residentialStatus?.name ?? null;
+    }
+
+    get taxPayerName(): string | null {
+        return this.taxPayer?.name ?? null;
+    }
+
+    get vulnerabilityTypeNames(): string[] | null {
+        return this.vulnerabilityTypes?.map(v => v.name) ?? null;
+    }
+
+    get fullName(): string {
+        return `${this.firstName ?? ''} ${this.lastName ?? ''}`.trim();
+    }
+
+    get applicationTypeName(): string | null {
+        return this.application?.applicationType?.name ?? null;
+    }
+
+    get lendingTypeName(): string | null {
+        return this.application?.lendingType?.name ?? null;
+    }
+
+    get numberOfApplicants(): number | null {
+        return this.application?.applicants?.length ?? null;
+    }
+} 

package/entities/applicants/credit-card-commitment.entity.ts

@@ -0,0 +1,31 @@
+import { ApplicantEntity } from './applicant.entity';
+import { LookupEntity } from '../shared/lookup.entity';
+
+export class CreditCardCommitmentEntity {
+  id!: string;
+  applicantId!: string;
+  commitmentId!: string;
+  lenderName!: string;
+  creditLimit!: number;
+  outstandingBalance!: number;
+  creditCardRepaymentTypeLid?: string;
+  monthlyPayment!: number;
+  jointNames?: boolean;
+  source!: string;
+  isSelected!: boolean;
+  createdAt!: Date;
+  updatedAt!: Date;
+
+  // Relations
+  applicant?: ApplicantEntity;
+  repaymentType?: LookupEntity;
+
+  // Virtual property
+  get applicationId(): string | undefined {
+    return this.applicant?.applicationId;
+  }
+
+  constructor(partial: Partial<CreditCardCommitmentEntity>) {
+    Object.assign(this, partial);
+  }
+}

package/entities/applicants/index.ts

@@ -0,0 +1,59 @@
+import type {
+    Applicant,
+    ApplicantCreditData,
+    ApplicantCreditProfile,
+    ApplicantEmployment,
+    ApplicantEmploymentIncome,
+    ApplicantExpenditure,
+    ApplicantIncome,
+    ApplicantIncomeSource,
+    ApplicantOtherIncome,
+    ApplicantPropertyIncome,
+    CreditCardCommitment,
+    LoanCommitment,
+    MortgageCommitment,
+    ResidenceCommitment,
+    SecuredLoanCommitment,
+    UnsecuredLoanCommitment,
+    ApplicantShareholding
+} from '@prisma/client';
+
+// Export Prisma types
+export type {
+    Applicant,
+    ApplicantCreditData,
+    ApplicantCreditProfile,
+    ApplicantEmployment,
+    ApplicantEmploymentIncome,
+    ApplicantExpenditure,
+    ApplicantIncome,
+    ApplicantIncomeSource,
+    ApplicantOtherIncome,
+    ApplicantPropertyIncome,
+    CreditCardCommitment,
+    LoanCommitment,
+    MortgageCommitment,
+    ResidenceCommitment,
+    SecuredLoanCommitment,
+    UnsecuredLoanCommitment,
+    ApplicantShareholding
+};
+
+// Export entity classes
+export * from './applicant.entity';
+export * from './applicant-credit-data.entity';
+export * from './applicant-credit-profile.entity';
+export * from './applicant-employment.entity';
+export * from './applicant-expenditure.entity';
+export * from './applicant-income.entity';
+export * from './applicant-income-source.entity';
+export * from './credit-card-commitment.entity';
+export * from './loan-commitment.entity';
+export * from './mortgage-commitment.entity';
+export * from './other-income.entity';
+export * from './property-income.entity';
+export * from './residence-commitment.entity';
+export * from './secure-loan-commitment.entity';
+export * from './unsecured-loan-commitment.entity'; 
+export * from './applicant-employment-income.entity';
+export * from './applicant-share-holding.entity';

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

@@ -0,0 +1,44 @@
+import { ApplicantEntity } from './applicant.entity';
+import { LookupEntity } from '../shared/lookup.entity';
+
+export class LoanCommitmentEntity {
+    id!: string;
+    applicantId!: string;
+    commitmentId!: string;
+    lenderName!: string;
+    loanTypeLid?: string;
+    securityDetails?: string;
+    purpose!: string;
+    doHaveSharedResponsibility?: boolean;
+    sharedMortgage?: string;
+    remainingTerm?: string;
+    startDate!: string;
+    outstandingBalance!: number;
+    monthlyPayment!: number;
+    source?: string;
+    isSelected?: boolean;
+    loanRationale?: string;
+    createdAt!: Date;
+    updatedAt!: Date;
+
+    // Relations
+    applicant?: ApplicantEntity;
+    loanType?: LookupEntity; // Relation field for loanType
+
+    constructor(partial: Partial<LoanCommitmentEntity>) {
+        Object.assign(this, partial);
+    }
+
+    // Virtual properties from Mongoose model
+    get applicationId(): string | undefined {
+        return this.applicant?.applicationId;
+    }
+
+    get lendingType(): string | undefined {
+        return this.applicant?.application?.lendingType?.name;
+    }
+
+    get doHaveSharedResponsibilityDisplay(): string {
+        return this.doHaveSharedResponsibility ? "Yes" : "No";
+    }
+}

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

@@ -0,0 +1,77 @@
+import { ApplicantEntity } from './applicant.entity';
+import { LookupEntity } from '../shared/lookup.entity';
+
+export class MortgageCommitmentEntity {
+    id!: string;
+    applicantId!: string;
+    commitmentId!: string;
+    lenderName?: string;
+    propertyValue?: number;
+    repaymentTypeLid?: string;
+    mortgageTypeLid?: string;
+    fixedTerm?: string;
+    originalLoanAmount?: number;
+    outstandingBalance?: number;
+    startDate?: string;
+    monthlyPayment?: number;
+    furtherAdvances?: boolean;
+    furtherAdvanceDetails?: string;
+    accountUptoDate?: boolean;
+    accountUptoDateFailDetails?: string;
+    accountInArrears?: boolean;
+    accountInArrearsDetails?: string;
+    doHaveSharedResponsibility?: boolean;
+    sharedMortgage?: string;
+    source!: string;
+    isSelected!: boolean;
+    financeTypeHppLid?: string;
+    hppRepaymentTypeLid?: string;
+    mortgageRate?: number;
+    financeHomeTypeLid?: string;
+    remainingTermMonth?: number;
+    chargeTypeLid?: string;
+    createdAt!: Date;
+    updatedAt!: Date;
+
+    // Relations
+    applicant?: ApplicantEntity;
+    repaymentType?: LookupEntity;
+    mortgageType?: LookupEntity;
+    financeTypeHpp?: LookupEntity;
+    hppRepaymentType?: LookupEntity;
+    financeHomeType?: LookupEntity;
+    chargeType?: LookupEntity;
+
+    constructor(partial: Partial<MortgageCommitmentEntity>) {
+        Object.assign(this, partial);
+    }
+
+    // Virtual properties from Mongoose model
+    get applicationId(): string | undefined {
+        return this.applicant?.applicationId;
+    }
+
+    get lendingType(): string | undefined {
+        return this.applicant?.application?.lendingType?.name;
+    }
+
+    get applicationType(): string | undefined {
+        return this.applicant?.application?.applicationType?.name;
+    }
+
+    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/secure-loan-commitment.entity.ts

@@ -0,0 +1,41 @@
+import { ApplicantEntity } from './applicant.entity';
+import { LookupEntity } from '../shared/lookup.entity';
+
+export class SecureLoanCommitmentEntity {
+    id!: string;
+    applicantId!: string;
+    lenderName!: string;
+    commitmentId!: string;
+    securityDetails?: string;
+    purpose?: string;
+    doHaveSharedResponsibility?: boolean;
+    sharedMortgage?: string;
+    remainingTerm?: number;
+    startDate?: string;
+    outstandingBalance!: number;
+    monthlyPayment!: number;
+    source!: string;
+    isSelected!: boolean;
+    commitmentTypeLid?: string;
+    loanTypeLid?: string;
+    createdAt!: Date;
+    updatedAt!: Date;
+
+    // Relations
+    applicant?: ApplicantEntity;
+    commitmentType?: LookupEntity;
+    loanType?: LookupEntity;
+
+    constructor(partial: Partial<SecureLoanCommitmentEntity>) {
+        Object.assign(this, partial);
+    }
+
+    // Virtual fields from Mongoose model
+    get doHaveSharedResponsibilityDisplay(): string {
+        return this.doHaveSharedResponsibility ? "Yes" : "No";
+    }
+
+    get lendingType(): string | undefined {
+        return this.applicant?.application?.lendingType?.name;
+    }
+}