@dynamatix/gb-schemas 2.0.59 → 2.0.60

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

@@ -0,0 +1,41 @@
+import { ApplicantEntity } from './applicant.entity';
+import { LookupEntity } from '../shared/lookup.entity';
+
+export class UnsecuredLoanCommitmentEntity {
+    id!: string;
+    applicantId!: string;
+    lenderName!: string;
+    commitmentId!: string;
+    purpose?: string;
+    doHaveSharedResponsibility?: boolean;
+    sharedMortgage?: string;
+    remainingTerm?: number;
+    startDate?: string;
+    outstandingBalance!: number;
+    monthlyPayment!: number;
+    source!: string;
+    isSelected!: boolean;
+    commitmentTypeLid?: string;
+    loanTypeLid?: string;
+    securityDetails?: string;
+    createdAt!: Date;
+    updatedAt!: Date;
+
+    // Relations
+    applicant?: ApplicantEntity;
+    commitmentType?: LookupEntity;
+    loanType?: LookupEntity;
+
+    constructor(partial: Partial<UnsecuredLoanCommitmentEntity>) {
+        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;
+    }
+}

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,76 @@
+import { ApplicantEntity } from "../applicants/applicant.entity";
+import { LookupEntity } from "../shared/lookup.entity";
+import { ApplicationEntity } from "./application.entity";
+import { ApplicantShareholdingEntity } from "../applicants/applicant-share-holding.entity";
+
+export class ApplicationCompanyEntity {
+    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;
+    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;
+    applicantShareholdings?: ApplicantShareholdingEntity[];
+
+    constructor(partial: Partial<ApplicationCompanyEntity>) {
+        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;
+    }
+}

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

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

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

@@ -0,0 +1,29 @@
+import { ApplicationEntity } from './application.entity';
+import { LookupEntity } from '../shared/lookup.entity';
+
+export class ApplicationDirectDebitEntity {
+  id!: string;
+  applicationId!: string;
+  applicantId?: string;
+  accountNumber!: number;
+  addressLine1?: string;
+  addressLine2?: string;
+  branch!: string;
+  city?: string;
+  contactPostcode!: string;
+  institution?: string;
+  isConfirmDeclaration!: boolean;
+  nameOfAccountHolder!: string;
+  selectedPaymentDayLid!: string;
+  sortCode!: string;
+  createdAt!: Date;
+  updatedAt!: Date;
+
+  // Relations
+  application!: ApplicationEntity;
+  selectedPaymentDay?: LookupEntity;
+
+  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;
+    purposeOfMortgage!: string;
+    depositComeFromLids!: string[];
+    ifOtherDetails!: string;
+    giftDetails?: 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;
+    }
+} 

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

@@ -0,0 +1,42 @@
+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;
+  prettyCreatedOn?: string;
+  createdBy?: number;
+  username?: string;
+  createdByUserId?: string;
+  typeLid?: string;
+  subTypeLid?: string;
+  subject?: string;
+  note!: string;
+  reminderDate?: string;
+  reminderStatus!: number;
+  attachmentDocumentId?: string;
+  assignedOperation!: string;
+  autoCreated!: boolean;
+  additionalData?: string;
+  autoCreatedId?: string;
+  assignedTo!: string;
+  assignedBy?: number;
+  assignedByUserId?: string;
+  comments?: any;
+  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.entity.ts

@@ -0,0 +1,168 @@
+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';
+import { ApplicationCreditProfileEntity } from './application-credit-profile.entity';
+
+export class ApplicationEntity {
+    id!: string;
+    queueId!: string[];
+    assignedToUserId?: string;
+    applicationId!: string;
+    isApplicationFeePaid!: boolean;
+    applicationNumber!: string;
+    applicationTypeLid!: string;
+    bankSolicitor!: string;
+    brokerId!: string;
+    caseManager!: string;
+    caseManagerAccepted!: boolean;
+    completedReason!: string;
+    isIntendToOccupy!: boolean;
+    introducer!: string;
+    isIntroducerSubmission!: boolean;
+    isBrokerAssigned!: boolean;
+    isFinanceRecommendedToApplicant!: boolean;
+    isWorkflowTaskCreated!: boolean;
+    lastUpdated?: Date;
+    lendingTypeLid!: string;
+    networkClubName!: string;
+    isNetworkClubSubmission!: boolean;
+    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?: Date;
+    isValuationFeePaid!: boolean;
+    withdrawalReason!: string;
+    withdrawalReasonCode!: string;
+    productId?: string;
+    securityId!: string;
+    solicitorId!: string;
+    isActive!: boolean;
+    isUkResident!: boolean;
+    riskRating?: string;
+    directDebitId?: string;
+    mortgageId?: string;
+    companyId?: string;
+    rationaleId?: string;
+    newAuditRecordsCount!: string;
+    currentApprivoAuditId?: string;
+    applicantIds!: 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;
+    creditProfile?: ApplicationCreditProfileEntity;
+    mortgage?: ApplicationMortgageEntity;
+    company?: ApplicationCompanyEntity;
+    rationale?: ApplicationRationaleEntity;
+    applicants?: ApplicantEntity[];
+    sourceOfWealth?: LookupEntity[];
+    properties?: PropertyEntity[];
+    companies?: ApplicationCompanyEntity[];
+
+    constructor(partial: Partial<ApplicationEntity>) {
+        Object.assign(this, partial);
+    }
+
+    // Virtual properties from Mongoose model
+    get noOfApplicants(): number {
+        return this.applicantIds?.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;
+    }
+}