@dynamatix/gb-schemas 1.2.80 → 2.0.0

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

@@ -0,0 +1,41 @@
+import { LookupEntity } from '../shared/lookup.entity';
+import { ApplicationEntity } from "./application.entity";
+import { UserEntity } from "../users";
+
+export class ApplicationNoteEntity {
+    id!: string;
+    applicationId!: string;
+    noteId?: string;
+    createdOn?: string;
+    createdBy?: string;
+    username?: string;
+    createdByUserId?: string;
+    typeLid?: string;
+    subTypeLid?: string;
+    subject?: string;
+    note!: string;
+    reminderDate?: string;
+    attachmentDocumentId?: string;
+    assignedOperation!: string;
+    autoCreated!: string;
+    additionalData?: any;
+    autoCreatedId?: string;
+    assignedTo!: string;
+    assignedBy?: string;
+    assignedByUserId?: string;
+    comment?: string;
+    reminderStatus!: string;
+    createdAt!: Date;
+    updatedAt!: Date;
+
+    // Relations
+    application?: ApplicationEntity;
+    type?: LookupEntity;
+    subType?: LookupEntity;
+    createdByUser?: UserEntity;
+    assignedByUser?: UserEntity;
+
+    constructor(partial: Partial<ApplicationNoteEntity>) {
+        Object.assign(this, partial);
+    }
+} 

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

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

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

@@ -0,0 +1,13 @@
+export class ApplicationOnboardingEntity {
+    id!: string;
+    errors!: string;
+    status!: string;
+    statusDate?: string;
+    warnings!: string;
+    createdAt!: Date;
+    updatedAt!: Date;
+
+    constructor(partial: Partial<ApplicationOnboardingEntity>) {
+        Object.assign(this, partial);
+    }
+} 

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

@@ -0,0 +1,38 @@
+import { ApplicationEntity } from '../applications';
+import { LookupEntity } from '../shared/lookup.entity';
+
+export class ApplicationProductEntity {
+    id!: string;
+    applicationId!: string;
+    selectedProduct!: string;
+    lendingTypeLid?: string;
+    pageValidFlag!: boolean;
+    repaymentTypeLid?: string;
+    numberOfYearsToRepay!: number;
+    repaymentVehicle!: string;
+    fixedAmount!: number;
+    isFinanceRecommendedToApplicantLid?: string;
+    procFeeRateLid?: string;
+    networkClubSubmission!: boolean;
+    clubNetworkNameLid?: string;
+    introducerSubmission!: boolean;
+    introducer!: string;
+    bdm!: string;
+    tempAppFee!: number;
+    productFeePaymentTypeLid?: string;
+    createdAt!: Date;
+    updatedAt!: Date;
+
+    // Relations
+    application?: ApplicationEntity;
+    lendingType?: LookupEntity;
+    repaymentType?: LookupEntity;
+    isFinanceRecommendedToApplicant?: LookupEntity;
+    procFeeRate?: LookupEntity;
+    clubNetworkName?: LookupEntity;
+    productFeePaymentType?: LookupEntity;
+
+    constructor(partial: Partial<ApplicationProductEntity>) {
+        Object.assign(this, partial);
+    }
+} 

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

@@ -0,0 +1,56 @@
+import { ApplicationEntity } from '../applications';
+import { LookupEntity } from '../shared/lookup.entity';
+
+export class ApplicationRationaleEntity {
+    id!: string;
+    applicationId!: string;
+    affordabilityDescription!: string;
+    affordabilityAreaOfOfferCondition!: string;
+    affordabilityAreaOfConcern!: string;
+    affordabilityStatusLid?: string;
+    applicantsDescription!: string;
+    applicantsAreaOfOfferCondition!: string;
+    applicantsAreaOfConcern!: string;
+    applicantsStatusLid?: string;
+    creditConductDescription!: string;
+    creditConductAreaOfOfferCondition!: string;
+    creditConductAreaOfConcern!: string;
+    creditConductStatusLid?: string;
+    fraudCheckDescription!: string;
+    fraudCheckAreaOfOfferCondition!: string;
+    fraudCheckAreaOfConcern!: string;
+    fraudCheckStatusLid?: string;
+    incomeSourceDescription!: string;
+    incomeSourceAreaOfOfferCondition!: string;
+    incomeSourceAreaOfConcern!: string;
+    incomeSourceStatusLid?: string;
+    loanDescription!: string;
+    loanAreaOfOfferCondition!: string;
+    loanAreaOfConcern!: string;
+    loanStatusLid?: string;
+    securityDescription!: string;
+    securityAreaOfOfferCondition!: string;
+    securityAreaOfConcern!: string;
+    securityStatusLid?: string;
+    propertyDescription!: string;
+    propertyAreaOfOfferCondition!: string;
+    propertyAreaOfConcern!: string;
+    propertyStatusLid?: string;
+    createdAt!: Date;
+    updatedAt!: Date;
+
+    // Relations
+    application?: ApplicationEntity;
+    affordabilityStatus?: LookupEntity;
+    applicantsStatus?: LookupEntity;
+    creditConductStatus?: LookupEntity;
+    fraudCheckStatus?: LookupEntity;
+    incomeSourceStatus?: LookupEntity;
+    loanStatus?: LookupEntity;
+    securityStatus?: LookupEntity;
+    propertyStatus?: LookupEntity;
+
+    constructor(partial: Partial<ApplicationRationaleEntity>) {
+        Object.assign(this, partial);
+    }
+} 

package/entities/applications/application-risk-narrative.entity.ts

@@ -0,0 +1,22 @@
+import { LookupEntity } from '../shared/lookup.entity';
+
+export class ApplicationRiskNarrativeEntity {
+    id!: string;
+    call1RequestedOn?: string;
+    call2RequestedOn?: string;
+    call2StatusLid?: string;
+    rationaleForRiskRating?: string;
+    retryCount?: string;
+    riskRating?: string;
+    statusLid?: string;
+    createdAt!: Date;
+    updatedAt!: Date;
+
+    // Relations
+    call2Status?: LookupEntity;
+    status?: LookupEntity;
+
+    constructor(partial: Partial<ApplicationRiskNarrativeEntity>) {
+        Object.assign(this, partial);
+    }
+} 

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

@@ -0,0 +1,20 @@
+export class ApplicationValuationEntity {
+    id!: string;
+    amount?: string;
+    epcRating!: string;
+    epcScore?: string;
+    estimatedRentalValue?: string;
+    instructionId!: string;
+    instructionStatus!: string;
+    instructionStatusComment!: string;
+    isManual!: string;
+    squareMetres?: string;
+    valuerNotes!: string;
+    version!: string;
+    createdAt!: Date;
+    updatedAt!: Date;
+
+    constructor(partial: Partial<ApplicationValuationEntity>) {
+        Object.assign(this, partial);
+    }
+} 

package/entities/applications/application.entity.ts

@@ -0,0 +1,165 @@
+import { LookupEntity } from '../shared/lookup.entity';
+import { BrokerEntity } from './broker.entity';
+import { SecurityEntity } from '../properties/security.entity';
+import { SolicitorEntity } from './solicitor.entity';
+import { ProductEntity } from '../product-catalogues/product.entity';
+import { ApplicationDirectDebitEntity } from './application-direct-debit.entity';
+import { ApplicationMortgageEntity } from './application-mortgage.entity';
+import { ApplicationCompanyEntity } from './application-company.entity';
+import { ApplicationRationaleEntity } from './application-rationale.entity';
+import { ApplicantEntity } from '../applicants/applicant.entity';
+import { PropertyEntity } from '../properties/property.entity';
+
+export class ApplicationEntity {
+    id!: string;
+    queueId!: string[];
+    assignedToUserId?: string;
+    applicationId!: string;
+    isApplicationFeePaid!: string;
+    applicationNumber!: string;
+    applicationTypeLid!: string;
+    bankSolicitor!: string;
+    brokerId!: string;
+    caseManager!: string;
+    caseManagerAccepted!: string;
+    completedReason!: string;
+    isIntendToOccupy!: string;
+    introducer!: string;
+    isIntroducerSubmission!: string;
+    isBrokerAssigned!: string;
+    isFinanceRecommendedToApplicant!: string;
+    isWorkflowTaskCreated!: string;
+    lastUpdated?: string;
+    lendingTypeLid!: string;
+    networkClubName!: string;
+    isNetworkClubSubmission!: string;
+    newReason!: string;
+    purchaseTypeLid!: string;
+    rejectedReason!: string;
+    repaymentTypeLid!: string;
+    selectedProduct?: string;
+    sourceOfWealthLids!: string[];
+    sowBusiness!: string;
+    sowInheritance!: string;
+    sowOther!: string;
+    sowProperty!: string;
+    sowSalary!: string;
+    statusLid!: string;
+    submitReason!: string;
+    submittedDate?: string;
+    underwriter!: string;
+    isValuationFeePaid!: string;
+    withdrawalReason!: string;
+    withdrawalReasonCode!: string;
+    productId?: string;
+    securityId!: string;
+    solicitorId!: string;
+    isActive!: string;
+    isUkResident!: string;
+    riskRating?: string;
+    directDebitId?: string;
+    mortgageId?: string;
+    companyId?: string;
+    rationaleId?: string;
+    newAuditRecordsCount!: string;
+    currentApprivoAuditId?: string;
+    propertyIds!: string[];
+    createdAt!: Date;
+    updatedAt!: Date;
+
+    // Relations
+    applicationType?: LookupEntity;
+    lendingType?: LookupEntity;
+    purchaseType?: LookupEntity;
+    status?: LookupEntity;
+    repaymentType?: LookupEntity;
+    broker?: BrokerEntity;
+    security?: SecurityEntity;
+    solicitor?: SolicitorEntity;
+    product?: ProductEntity;
+    directDebit?: ApplicationDirectDebitEntity;
+    mortgage?: ApplicationMortgageEntity;
+    company?: ApplicationCompanyEntity;
+    rationale?: ApplicationRationaleEntity;
+    applicants?: ApplicantEntity[];
+    sourceOfWealth?: LookupEntity[];
+    properties?: PropertyEntity[];
+
+    constructor(partial: Partial<ApplicationEntity>) {
+        Object.assign(this, partial);
+    }
+
+    // Virtual properties from Mongoose model
+    get noOfApplicants(): number {
+        return this.applicants?.length ?? 0;
+    }
+
+    get applicationTypeName(): string | null {
+        return this.applicationType?.name ?? null;
+    }
+
+    get lendingTypeName(): string | null {
+        return this.lendingType?.name ?? null;
+    }
+
+    get purchaseTypeName(): string | null {
+        return this.purchaseType?.name ?? null;
+    }
+
+    get statusName(): string | null {
+        return this.status?.name ?? null;
+    }
+
+    get ltv(): string | null {
+        if (this.mortgage?.purchasePrice && this.mortgage?.loanRequired) {
+            const parseCurrency = (value: string | number): number => {
+                if (typeof value === 'string') {
+                    return parseFloat(value.replace(/[^0-9.-]+/g, ""));
+                }
+                return value;
+            };
+
+            const parsedPurchasePrice = parseCurrency(this.mortgage.purchasePrice);
+            const parsedLoanRequired = parseCurrency(this.mortgage.loanRequired);
+            const ltv = (parsedLoanRequired / parsedPurchasePrice) * 100;
+            return ltv.toFixed(2) + "%";
+        }
+        return null;
+    }
+
+    get submittedDateFormatted(): string | null {
+        if (!this.submittedDate) return null;
+        const date = new Date(this.submittedDate);
+        const day = String(date.getDate()).padStart(2, '0');
+        const month = String(date.getMonth() + 1).padStart(2, '0');
+        const year = date.getFullYear();
+        return `${day}-${month}-${year}`;
+    }
+
+    get brokerName(): string | null {
+        if (this.broker?.firstName && this.broker?.lastName) {
+            return `${this.broker.firstName} ${this.broker.lastName}`;
+        }
+        return null;
+    }
+
+    get brokerEmail(): string | null {
+        return this.broker?.email ?? null;
+    }
+
+    get solicitorName(): string | null {
+        return this.solicitor?.nameOfAccountHolder ?? null;
+    }
+
+    get solicitorEmail(): string | null {
+        return this.solicitor?.email ?? null;
+    }
+
+    get brokerPhone(): string | null {
+        return this.broker?.mobileTelephone ?? null;
+    }
+
+    get solicitorPhone(): string | null {
+        return this.solicitor?.telephone ?? null;
+    }
+}

package/entities/applications/broker.entity.ts

@@ -0,0 +1,25 @@
+export class BrokerEntity {
+    id!: string;
+    brokerId?: string;
+    landlinePhone?: string;
+    mobileTelephone?: string;
+    addressPostCode?: string;
+    addressLine1?: string;
+    addressLine2?: string;
+    addressLine3?: string;
+    addressCity?: string;
+    addressCountry?: string;
+    tradingName?: string;
+    fcaNumber?: string;
+    brokerType?: string;
+    email?: string;
+    network?: string;
+    firstName?: string;
+    lastName?: string;
+    createdAt!: Date;
+    updatedAt!: Date;
+
+    constructor(partial: Partial<BrokerEntity>) {
+        Object.assign(this, partial);
+    }
+} 

package/entities/applications/checklist-item.entity.ts

@@ -0,0 +1,49 @@
+export class ChecklistItemEntity {
+    id!: string;
+    additionalOfferConditions!: string;
+    appFormSignedNotes!: string;
+    applicationCompletionDate?: string;
+    buildingInsuranceInsurerName!: string;
+    buildingInsurancePolicyNumber!: string;
+    buildingInsuranceReceived!: string;
+    buildingInsuranceRenewalDate?: string;
+    dateOfValuationReceived?: string;
+    feePaidDocumentsDownloaded!: string;
+    feePaidNotes!: string;
+    fundsNotes!: string;
+    fundsReleasedDate?: string;
+    hasAllDocsReviewedAndAccepted!: string;
+    idnPorReceived!: string;
+    legalCompletionDate?: string;
+    legalDocsReceived!: string;
+    legalNotes!: string;
+    ninetyDaysValuationAmount!: string;
+    offerConditionsItems!: string;
+    offerConditionsMet!: string;
+    offerNotes!: string;
+    offerOfferPrepared!: string;
+    offerOfferReviewed!: string;
+    offerSignedNotes!: string;
+    offerSolicitorInstructedDate?: string;
+    packagingNotes!: string;
+    preOfferNotes!: string;
+    reinstatementAmount!: string;
+    rotReceived!: string;
+    rotReceivedDate?: string;
+    salesContractReceived!: string;
+    underwritingNotes!: string;
+    underwritingValuationNotes!: string;
+    valuationAccepted?: string;
+    valuationFurtherConditions!: string;
+    valuationNotes!: string;
+    valuationReceived?: string;
+    valuationRequestedDate?: string;
+    valuationScheduledDate?: string;
+    valuationSurveyorDetails!: string;
+    createdAt!: Date;
+    updatedAt!: Date;
+
+    constructor(partial: Partial<ChecklistItemEntity>) {
+        Object.assign(this, partial);
+    }
+} 

package/entities/applications/company.entity.ts

@@ -0,0 +1,102 @@
+import { ApplicantEntity } from '../applicants/applicant.entity';
+import { LookupEntity } from '../shared/lookup.entity';
+import { ApplicationEntity } from "./application.entity";
+
+
+export class ApplicantShareholdingEntity {
+    id!: string;
+    companyId!: string;
+    applicantId!: string;
+    applicantName!: string;
+    directorShareholderLid?: string;
+    shareholding?: number;
+    createdAt!: Date;
+    updatedAt!: Date;
+
+    // Relations
+    company?: CompanyEntity;
+    applicant?: ApplicantEntity;
+    directorShareholder?: LookupEntity;
+
+    constructor(partial: Partial<ApplicantShareholdingEntity>) {
+        Object.assign(this, partial);
+    }
+}
+
+export class CompanyEntity {
+    id!: string;
+    applicationId!: string;
+    pageValidFlag!: boolean;
+    registeredName!: string;
+    businessTypeLid!: string;
+    registeredNumber!: number;
+    taxJurisdictionLid!: string;
+    tradingSince?: string;
+    natureOfBusiness!: string;
+    yearEnd?: string;
+    addressPostCode!: string;
+    addressLine1!: string;
+    addressLine2?: string;
+    addressLine3?: string;
+    addressCity?: string;
+    addressCountryLid!: string;
+    applicationTypeLid!: string;
+    yearEnd1!: number;
+    turnoverYear1!: number;
+    netProfitYear1!: number;
+    yearEnd2!: number;
+    turnoverYear2!: number;
+    netProfitYear2!: number;
+    yearEnd3!: number;
+    turnoverYear3!: number;
+    netProfitYear3!: number;
+    companyCreditDefaults!: string;
+    companyCountyCourtJudgment!: string;
+    companySecuredArrears!: string;
+    companyUnsecuredArrears!: string;
+    companyBankruptcy!: string;
+    companyBankruptcyYes!: boolean;
+    companyBankruptcyNo!: boolean;
+    companyCCJInLastThreeYearYes!: boolean;
+    companyCCJInLastThreeYearNo!: boolean;
+    companyDefaultsInLastYearYes!: boolean;
+    companyDefaultsInLastYearNo!: boolean;
+    companyAnyVoluntaryEnforcedPossessionYes!: boolean;
+    companyAnyVoluntaryEnforcedPossessionNo!: boolean;
+    doYouKnowRegisteredNumber!: boolean;
+    sicCodes!: string[];
+    epc!: string;
+    remainingLease!: string;
+    dateOfIncorporation?: string;
+    createdAt!: Date;
+    updatedAt!: Date;
+
+    // Relations
+    application?: ApplicationEntity;
+    businessType?: LookupEntity;
+    taxJurisdiction?: LookupEntity;
+    addressCountry?: LookupEntity;
+    applicationType?: LookupEntity;
+    applicantShareholdings?: ApplicantShareholdingEntity[];
+
+    constructor(partial: Partial<CompanyEntity>) {
+        Object.assign(this, partial);
+    }
+
+    // Virtual fields from Mongoose model
+    get businessTypeName(): string | null {
+        return this.businessType?.name ?? null;
+    }
+
+    get taxJurisdictionName(): string | null {
+        return this.taxJurisdiction?.name ?? null;
+    }
+
+    get addressCountryName(): string | null {
+        return this.addressCountry?.name ?? null;
+    }
+
+    get applicationTypeName(): string | null {
+        return this.applicationType?.name ?? null;
+    }
+} 

package/entities/applications/credit-profile.entity.ts

@@ -0,0 +1,13 @@
+export class CreditProfileEntity {
+    id!: string;
+    anyVoluntaryEnforcedPossessionNo!: string;
+    bankruptcyNo!: string;
+    ccjInLastThreeYearNo!: string;
+    defaultsInLastYearNo!: string;
+    createdAt!: Date;
+    updatedAt!: Date;
+
+    constructor(partial: Partial<CreditProfileEntity>) {
+        Object.assign(this, partial);
+    }
+} 

package/entities/applications/index.ts

@@ -0,0 +1,74 @@
+import type {
+    Application,
+    ProductFeatures,
+    Solicitor,
+    Broker,
+    ChecklistItem,
+    Company,
+    CreditProfile,
+    ApplicationRationale,
+    ApplicationRiskNarrative,
+    ApplicationValuation,
+    ApplicationProduct,
+    ApplicationNote,
+    ApplicationOffer,
+    ApplicationOnboarding,
+    ApplicationIllustration,
+    ApplicationLegal,
+    ApplicationMortgage,
+    ApplicationDocument,
+    ApplicationFieldConfig,
+    ApplicationAudit,
+    ApplicationCompany,
+    ApplicationDirectDebit
+} from '@prisma/client';
+
+// Export Prisma types
+export type {
+    Application,
+    ProductFeatures,
+    Solicitor,
+    Broker,
+    ChecklistItem,
+    Company,
+    CreditProfile,
+    ApplicationRationale,
+    ApplicationRiskNarrative,
+    ApplicationValuation,
+    ApplicationProduct,
+    ApplicationNote,
+    ApplicationOffer,
+    ApplicationOnboarding,
+    ApplicationIllustration,
+    ApplicationLegal,
+    ApplicationMortgage,
+    ApplicationDocument,
+    ApplicationFieldConfig,
+    ApplicationAudit,
+    ApplicationCompany,
+    ApplicationDirectDebit
+};
+
+// Export entity classes
+export * from './application.entity';
+export * from './product-features.entity';
+export * from './solicitor.entity';
+export * from './broker.entity';
+export * from './checklist-item.entity';
+export * from './company.entity';
+export * from './credit-profile.entity';
+export * from './application-rationale.entity';
+export * from './application-risk-narrative.entity';
+export * from './application-valuation.entity';
+export * from './application-product.entity';
+export * from './application-note.entity';
+export * from './application-offer.entity';
+export * from './application-onboarding.entity';
+export * from './application-illustration.entity';
+export * from './application-legal.entity';
+export * from './application-mortgage.entity';
+export * from './application-document.entity';
+export * from './application-fieldconfig.entity';
+export * from './application-audit.entity';
+export * from './application-company.entity';
+export * from './application-direct-debit.entity'; 

package/entities/applications/product-features.entity.ts

@@ -0,0 +1,56 @@
+export class ProductFeaturesEntity {
+    id!: string;
+    name!: string;
+    clientAdvance!: string;
+    ltv!: string;
+    repayment!: string;
+    variableRepayment!: string;
+    reversionRateWithoutBaseRate?: string;
+    totalReversionRate?: string;
+    initialRate!: string;
+    fixedTerm!: string;
+    fixedTermEndDate?: string;
+    baseRate?: string;
+    productRate?: string;
+    apr?: string;
+    rentalCoverage?: string;
+    repaymentType?: string;
+    applicationCategory?: string;
+    securityType?: string;
+    erc?: string;
+    loanType?: string;
+    maxLtvLimit?: string;
+    reimbursement?: string;
+    reimbursementPerPound?: string;
+    stressedApr?: string;
+    stressedRate?: string;
+    stressedRepayment?: string;
+    liborFloorRate?: string;
+    totalTermInMonths?: string;
+    chargeType!: string;
+    productCategory!: string;
+    ercCode!: string;
+    variableTerm?: string;
+    totalFeePayable?: string;
+    dipIssueDate?: string;
+    estimatedCompletionDate?: string;
+    dipExpiryDate?: string;
+    fixedRepaymentUntillDate?: string;
+    rentalReviewDate?: string;
+    totalReimbursementWithFee?: string;
+    finalRentPayment?: string;
+    clientDeposit?: string;
+    firstRentPayment?: string;
+    ercFeatures?: any;
+    icr?: string;
+    ufssProductCode?: string;
+    ufssInterestRateCode?: string;
+    stressedPayment?: string;
+    stressedPaymentRate?: string;
+    createdAt!: Date;
+    updatedAt!: Date;
+
+    constructor(partial: Partial<ProductFeaturesEntity>) {
+        Object.assign(this, partial);
+    }
+}