@dynamatix/gb-schemas 2.0.59 → 2.0.60

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/index.ts

@@ -0,0 +1,63 @@
+import type {
+    Application,
+    ProductFeatures,
+    Solicitor,
+    Broker,
+    ChecklistItem,
+    ApplicationRationale,
+    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,
+    ApplicationRationale,
+    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 './application-credit-profile.entity';
+export * from './application-rationale.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,118 @@
+export class FeeEntity {
+  id!: string;
+  applicationProductFeatureId!: string;
+  feeType!: string;
+  description!: string;
+  feeAmount!: number;
+  rate!: number;
+  addedToLoan!: boolean;
+  allowOverride!: boolean;
+  additionalData?: any;
+
+  constructor(partial: Partial<FeeEntity>) {
+    Object.assign(this, partial);
+  }
+}
+
+export class CashflowPeriodEntity {
+  id!: string;
+  applicationProductFeatureId!: string;
+  type!: string;
+  from?: number;
+  to?: number;
+  instalmentAmount?: number;
+  instalmentInterest?: number;
+  instalmentCapitalRepaid?: number;
+  otherCosts?: number;
+  outstandingCapital?: number;
+
+  constructor(partial: Partial<CashflowPeriodEntity>) {
+    Object.assign(this, partial);
+  }
+}
+
+export class CalculationsEntity {
+  id!: string;
+  applicationProductFeatureId!: string;
+  ltv?: number;
+  rentalCoverageRatioRate?: number;
+  bankContributionRate?: number;
+  bankInitialShareRate?: number;
+  totalAmountPayable?: number;
+  fixedMonthlyPayment?: number;
+  fixedMonthlyCapital?: number;
+  fixedMonthlyInterest?: number;
+  variableMonthlyPayment?: number;
+  summaryTotal?: number;
+  reimbursementPerPound?: number;
+  stressedPayment?: number;
+  stressedPaymentRate?: number;
+  rentalCoverage?: number;
+  rentalCoverageWithoutTopUp?: number;
+
+  constructor(partial: Partial<CalculationsEntity>) {
+    Object.assign(this, partial);
+  }
+}
+
+export class ProductFeaturesEntity {
+  id!: string;
+  applicationId!: string;
+  name!: string;
+  clientAdvance!: number;
+  ltv!: number;
+  repayment!: number;
+  variableRepayment!: number;
+  reversionRateWithoutBaseRate?: number;
+  totalReversionRate?: number;
+  initialRate!: number;
+  fixedTerm!: number;
+  fixedTermEndDate?: string;
+  baseRate?: number;
+  productRate?: number;
+  apr?: number;
+  rentalCoverage?: number;
+  repaymentType?: string;
+  applicationCategory?: string;
+  securityType?: string;
+  erc?: string;
+  loanType?: string;
+  maxLtvLimit?: string;
+  reimbursement?: number;
+  reimbursementPerPound?: number;
+  stressedApr?: number;
+  stressedRate?: number;
+  stressedRepayment?: number;
+  liborFloorRate?: string;
+  totalTermInMonths?: number;
+  chargeType!: string;
+  productCategory!: string;
+  ercCode!: string;
+  variableTerm?: number;
+  totalFeePayable?: number;
+  dipIssueDate?: string;
+  estimatedCompletionDate?: string;
+  dipExpiryDate?: string;
+  fixedRepaymentUntillDate?: string;
+  rentalReviewDate?: string;
+  totalReimbursementWithFee?: number;
+  finalRentPayment?: number;
+  clientDeposit?: number;
+  firstRentPayment?: number;
+  ercFeatures?: any;
+  icr?: string;
+  ufssProductCode?: string;
+  ufssInterestRateCode?: string;
+  stressedPayment?: number;
+  stressedPaymentRate?: number;
+  createdAt!: Date;
+  updatedAt!: Date;
+  cashflowPeriodsTotalNoOfPayments?: number;
+  fees!: FeeEntity[];
+  cashflowPeriods!: CashflowPeriodEntity[];
+  calculations?: CalculationsEntity;
+
+  constructor(partial: Partial<ProductFeaturesEntity>) {
+    Object.assign(this, partial);
+  }
+}

package/entities/applications/solicitor.entity.ts

@@ -0,0 +1,38 @@
+import { LookupEntity } from "../shared/lookup.entity";
+import { ApplicationEntity } from "./application.entity";
+
+export class SolicitorEntity {
+    id!: string;
+    applicationId!: string;
+    pageValidFlag!: boolean;
+    accountNumber?: number;
+    addressCity?: string;
+    addressCountryLid!: string;
+    addressLine1!: string;
+    addressLine2?: string;
+    addressLine3?: string;
+    addressPostCode!: string;
+    bankAddressLine1?: string;
+    bankAddressLine2?: string;
+    bankBranch?: string;
+    bankCity?: string;
+    contactPostcode?: string;
+    email!: string;
+    institution?: string;
+    nameOfAccountHolder?: string;
+    nameOfFirm!: string;
+    signatory?: string;
+    solicitorActing!: string;
+    sortCode?: string;
+    telephone!: string;
+    createdAt!: Date;
+    updatedAt!: Date;
+
+    // Relations
+    application?: ApplicationEntity;
+    addressCountry?: LookupEntity;
+
+    constructor(partial: Partial<SolicitorEntity>) {
+        Object.assign(this, partial);
+    }
+} 

package/entities/index.ts

@@ -0,0 +1,14 @@
+// Export Prisma client
+export { prisma } from './prisma';
+
+// Export all entities from each domain
+export * as ApplicantEntities from './applicants';
+export * as ApplicationEntities from './applications';
+export * as ProductCatalogueEntities from './product-catalogues';
+export * as PropertyEntities from './properties';
+export * as SharedEntities from './shared';
+export * as UnderwriterEntities from './underwriter';
+export * as UserEntities from './users';
+
+// Export Prisma types
+export type { PrismaClient } from '@prisma/client'; 

package/entities/prisma.ts

@@ -0,0 +1,13 @@
+import { PrismaClient } from '@prisma/client';
+
+// PrismaClient is attached to the `global` object in development to prevent
+// exhausting your database connection limit.
+const globalForPrisma = global as unknown as { prisma: PrismaClient };
+
+export const prisma =
+    globalForPrisma.prisma ||
+    new PrismaClient({
+        log: ['query'],
+    });
+
+if (process.env.NODE_ENV !== 'production') globalForPrisma.prisma = prisma; 

package/entities/product-catalogues/index.ts

@@ -0,0 +1,23 @@
+import type {
+    ProductCatalogue,
+    ProductDefinition,
+    ProductVariant,
+    Product,
+    Rule
+} from '@prisma/client';
+
+// Export Prisma types
+export type {
+    ProductCatalogue,
+    ProductDefinition,
+    ProductVariant,
+    Product,
+    Rule
+};
+
+// Export entity classes
+export * from './product-catalogue.entity';
+export * from './product-definition.entity';
+export * from './product-variant.entity';
+export * from './product.entity';
+export * from './rule.entity'; 

package/entities/product-catalogues/product-catalogue.entity.ts

@@ -0,0 +1,27 @@
+import { ProductDefinitionEntity } from './product-definition.entity';
+import { ProductVariantEntity } from './product-variant.entity';
+
+export class ProductCatalogueEntity {
+    id!: string;
+    productCatalogueId!: string;
+    name!: string;
+    description?: string;
+    applyFrom!: string;
+    applyUntil!: string;
+    submitUntil!: string;
+    status!: string;
+    lockedForEdit!: string;
+    baseRateName?: string;
+    baseRate?: string;
+    mapperName?: string;
+    createdAt!: Date;
+    updatedAt!: Date;
+
+    // Relations
+    productDefinitions?: ProductDefinitionEntity[];
+    productVariants?: ProductVariantEntity[];
+
+    constructor(partial: Partial<ProductCatalogueEntity>) {
+        Object.assign(this, partial);
+    }
+} 

package/entities/product-catalogues/product-definition.entity.ts

@@ -0,0 +1,21 @@
+import { ProductCatalogueEntity } from './product-catalogue.entity';
+import { RuleEntity } from './rule.entity';
+
+export class ProductDefinitionEntity {
+    id!: string;
+    productDefinitionId!: string;
+    productCatalogueId!: string;
+    name!: string;
+    atLeastOnePass!: string;
+    elements!: any[];
+    createdAt!: Date;
+    updatedAt!: Date;
+
+    // Relations
+    productCatalogue?: ProductCatalogueEntity;
+    rules?: RuleEntity[];
+
+    constructor(partial: Partial<ProductDefinitionEntity>) {
+        Object.assign(this, partial);
+    }
+} 

package/entities/product-catalogues/product-variant.entity.ts

@@ -0,0 +1,19 @@
+import { ProductCatalogueEntity } from './product-catalogue.entity';
+
+export class ProductVariantEntity {
+    id!: string;
+    productCatalogueId!: string;
+    variantid!: string;
+    name!: string;
+    variantCode!: string;
+    label?: string;
+    createdAt!: Date;
+    updatedAt!: Date;
+
+    // Relations
+    productCatalogue?: ProductCatalogueEntity;
+
+    constructor(partial: Partial<ProductVariantEntity>) {
+        Object.assign(this, partial);
+    }
+} 

package/entities/product-catalogues/product.entity.ts

@@ -0,0 +1,16 @@
+import { ApplicationEntity } from '../applications/application.entity';
+
+export class ProductEntity {
+    id!: string;
+    name!: string;
+    description?: string;
+    createdAt!: Date;
+    updatedAt!: Date;
+
+    // Relations
+    applications?: ApplicationEntity[];
+
+    constructor(partial: Partial<ProductEntity>) {
+        Object.assign(this, partial);
+    }
+} 

package/entities/product-catalogues/rule.entity.ts

@@ -0,0 +1,26 @@
+import { ProductDefinitionEntity } from './product-definition.entity';
+
+export class RuleEntity {
+    id!: string;
+    ruleId!: string;
+    rule!: string;
+    name!: string;
+    description?: string;
+    scope?: string;
+    mandatory!: string;
+    overrideRuleType?: string;
+    overrideRuleMessage?: string;
+    inheritedFrom?: string;
+    anyPass!: string;
+    preCashflow!: string;
+    productDefinitionId!: string;
+    createdAt!: Date;
+    updatedAt!: Date;
+
+    // Relations
+    productDefinition?: ProductDefinitionEntity;
+
+    constructor(partial: Partial<RuleEntity>) {
+        Object.assign(this, partial);
+    }
+} 

package/entities/properties/data-street.entity.ts

@@ -0,0 +1,27 @@
+import { SecurityEntity } from './security.entity';
+
+export class DataStreetEntity {
+    id!: number;
+    floorArea!: string;
+    propertyType!: string;
+    noOfBedrooms!: string;
+    noOfBathrooms!: string;
+    lats?: string;
+    longs?: string;
+    lmkKey!: string;
+    matchConfidence!: string;
+    transactions!: any[];
+    nearByListings!: any[];
+    nearByCompletedTransactions!: any[];
+    risk!: any;
+    securityId!: number;
+    createdAt!: Date;
+    updatedAt!: Date;
+
+    // Relations
+    security?: SecurityEntity;
+
+    constructor(partial: Partial<DataStreetEntity>) {
+        Object.assign(this, partial);
+    }
+} 

package/entities/properties/index.ts

@@ -0,0 +1,17 @@
+import type {
+    Property,
+    Security,
+    DataStreet
+} from '@prisma/client';
+
+// Export Prisma types
+export type {
+    Property,
+    Security,
+    DataStreet
+};
+
+// Export entity classes
+export * from './property.entity';
+export * from './security.entity';
+export * from './data-street.entity'; 

package/entities/properties/property.entity.ts

@@ -0,0 +1,35 @@
+import { ApplicationEntity } from "../applications/application.entity";
+import { LookupEntity } from "../shared/lookup.entity";
+
+export class PropertyEntity {
+    id!: string;
+    applicationId!: string;
+    pageValidFlag!: boolean;
+    propertyId!: string;
+    postCode!: string;
+    addressLine1?: string;
+    addressLine2?: string;
+    addressLine3?: string;
+    city?: string;
+    countryLid!: string;
+    marketValue!: number;
+    lender!: string;
+    remainingTerm!: number;
+    monthlyRepayment!: number;
+    monthlyRent!: number;
+    originalLoanBalance!: number;
+    outstandingBalance!: number;
+    associatedLoanPartiesIds!: string[];
+    otherOwnershipParties?: string;
+    portfolioFile?: string;
+    createdAt!: Date;
+    updatedAt!: Date;
+
+    // Relations
+    application?: ApplicationEntity;
+    country?: LookupEntity;
+
+    constructor(partial: Partial<PropertyEntity>) {
+        Object.assign(this, partial);
+    }
+} 

package/entities/properties/security.entity.ts

@@ -0,0 +1,63 @@
+import { ApplicationEntity } from '../applications/application.entity';
+import { LookupEntity } from '../shared/lookup.entity';
+import { DataStreetEntity } from './data-street.entity';
+
+export class SecurityEntity {
+    id!: string;
+    applicationId!: string;
+    pageValidFlag!: boolean;
+    haveAnyBuyToLetProperties!: boolean;
+    isPropertyInEnglandOrWales!: boolean;
+    noOfBuyToLetProperties!: number;
+    totalMonthlyRentalIncome!: number;
+    totalMonthlyRepayment!: number;
+    totalOutstandingBalance!: number;
+    areAllBedRoomsOver10sqm!: boolean;
+    isBrickTileConstruction!: boolean;
+    constructionDetails!: string;
+    isExLAExclusion!: boolean;
+    isFlatLift!: boolean;
+    flatNumberOfBedrooms!: number;
+    isGreenEPC!: boolean;
+    isGroundRent!: number;
+    isHouseLicensed!: boolean;
+    houseNumberOfFloors!: number;
+    houseNumberOfKitchens!: number;
+    houseNumberOfLivingRooms!: number;
+    houseNumberOfBathrooms!: number;
+    houseNumberOfTenancies!: number;
+    hasHousePlanningPermission!: boolean;
+    isGarage!: boolean;
+    isNewBuild!: boolean;
+    propertyAddressCity?: string;
+    propertyAddressCountryLid!: string;
+    propertyAddressLine1!: string;
+    propertyAddressLine2?: string;
+    propertyAddressLine3?: string;
+    propertyAddressPostCode!: string;
+    propertyTenureLid?: string;
+    propertyTypeLid!: string;
+    propertyYearBuilt!: number;
+    receiptOfAnyDiscount!: boolean;
+    receiptOfDiscountDetails!: string;
+    sectorExperienceLid!: string;
+    serviceCharge!: number;
+    unexpiredRemainingLease!: number;
+    yearLeaseExpires!: string;
+    energyEfficiencyRating?: string;
+    energyEfficiencyRatingValue?: string;
+    createdAt!: Date;
+    updatedAt!: Date;
+
+    // Relations
+    application?: ApplicationEntity;
+    propertyAddressCountry?: LookupEntity;
+    propertyTenure?: LookupEntity;
+    propertyType?: LookupEntity;
+    dataStreet?: DataStreetEntity;
+    sectorExperience?: LookupEntity;
+
+    constructor(partial: Partial<SecurityEntity>) {
+        Object.assign(this, partial);
+    }
+}

package/entities/shared/alert.entity.ts

@@ -0,0 +1,19 @@
+import { UserEntity } from '../users/user.entity';
+
+export class AlertEntity {
+    id!: string;
+    title!: string;
+    message!: string;
+    type!: string;
+    isRead!: boolean;
+    userId!: string;
+    createdAt!: Date;
+    updatedAt!: Date;
+
+    // Relations
+    user?: UserEntity;
+
+    constructor(partial: Partial<AlertEntity>) {
+        Object.assign(this, partial);
+    }
+} 

package/entities/shared/apprivo-sync-journey.entity.ts

@@ -0,0 +1,25 @@
+
+import { LookupEntity } from './lookup.entity';
+import { JobRunEntity } from './job-run.entity';
+
+export class ApprivoSyncJourneyEntity  {
+    id!: string;
+    applicationId!: string;
+    milestoneLid?: string;
+    mileStoneStatus!: 'Completed' | 'Errored' | 'Not Applicable';
+    error?: string;
+    isFirstPull!: boolean;
+    jobRunId?: string;
+    startTime?: Date;
+    endTime?: Date;
+    createdAt!: Date;
+    updatedAt!: Date;
+
+    // Relations
+    milestone?: LookupEntity;
+    jobRun?: JobRunEntity;
+
+    constructor(partial: Partial<ApprivoSyncJourneyEntity>) {
+        Object.assign(this, partial);
+    }
+} 

package/entities/shared/apprivo-sync-journey.model.ts

@@ -0,0 +1,13 @@
+export interface ApprivoSyncJourneyModel {
+    id: string;
+    applicationId: string;
+    milestoneLid?: string;
+    mileStoneStatus: 'Completed' | 'Errored' | 'Not Applicable';
+    error?: string;
+    isFirstPull: string;
+    jobRunId?: string;
+    startTime?: Date;
+    endTime?: Date;
+    createdAt: Date;
+    updatedAt: Date;
+}