@pdtf/schemas 3.6.0-5 → 3.6.0-7

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@pdtf/schemas",
3
- "version": "3.6.0-5",
3
+ "version": "3.6.0-7",
4
4
  "description": "Property Data Trust Framework Schemas and Utilities",
5
5
  "main": "index.js",
6
6
  "directories": {
@@ -41941,11 +41941,11 @@
41941
41941
  "status": {
41942
41942
  "type": "string",
41943
41943
  "enum": [
41944
- "pending",
41945
- "withdrawn",
41946
- "rejected",
41947
- "accepted",
41948
- "noteOfInterest"
41944
+ "Pending",
41945
+ "Withdrawn",
41946
+ "Rejected",
41947
+ "Accepted",
41948
+ "Note of Interest"
41949
41949
  ]
41950
41950
  },
41951
41951
  "inclusions": { "type": "array", "items": { "type": "string" } },
@@ -41953,9 +41953,187 @@
41953
41953
  "conditions": { "type": "array", "items": { "type": "string" } },
41954
41954
  "externalIds": {
41955
41955
  "type": "object"
41956
+ },
41957
+ "buyerCircumstances": {
41958
+ "title": "Buyer circumstances",
41959
+ "description": "Information about the buyer's circumstances for lender compatibility analysis and conveyancing quotes",
41960
+ "type": "object",
41961
+ "properties": {
41962
+ "intendedUse": {
41963
+ "type": "string",
41964
+ "title": "Intended use of property",
41965
+ "enum": [
41966
+ "Owner occupied",
41967
+ "Buy-to-let",
41968
+ "Holiday let",
41969
+ "Second home"
41970
+ ]
41971
+ },
41972
+ "firstTimeBuyer": {
41973
+ "type": "boolean",
41974
+ "title": "First-time buyer"
41975
+ },
41976
+ "rightToBuy": {
41977
+ "type": "boolean",
41978
+ "title": "Right to Buy purchase"
41979
+ },
41980
+ "ltdCompanyPurchase": {
41981
+ "type": "boolean",
41982
+ "title": "Limited company purchase"
41983
+ },
41984
+ "numberOfOwners": {
41985
+ "type": "integer",
41986
+ "title": "Number of owners",
41987
+ "nullable": true
41988
+ },
41989
+ "numberOfExpats": {
41990
+ "type": "integer",
41991
+ "title": "Number of expat buyers",
41992
+ "nullable": true
41993
+ },
41994
+ "giftedEquity": {
41995
+ "type": "boolean",
41996
+ "title": "Gifted equity"
41997
+ },
41998
+ "numberOfGiftedDeposits": {
41999
+ "type": "integer",
42000
+ "title": "Number of gifted deposits",
42001
+ "nullable": true
42002
+ },
42003
+ "requiresMortgage": {
42004
+ "type": "string",
42005
+ "title": "Requires mortgage",
42006
+ "enum": ["Yes", "No"]
42007
+ }
42008
+ },
42009
+ "discriminator": {
42010
+ "propertyName": "requiresMortgage"
42011
+ },
42012
+ "required": ["requiresMortgage"],
42013
+ "oneOf": [
42014
+ {
42015
+ "properties": {
42016
+ "requiresMortgage": {
42017
+ "enum": ["No"]
42018
+ }
42019
+ }
42020
+ },
42021
+ {
42022
+ "properties": {
42023
+ "requiresMortgage": {
42024
+ "enum": ["Yes"]
42025
+ },
42026
+ "helpToBuyEquityLoan": {
42027
+ "type": "boolean",
42028
+ "title": "Help to Buy equity loan"
42029
+ },
42030
+ "armedForcesHelpToBuy": {
42031
+ "type": "boolean",
42032
+ "title": "Armed Forces Help to Buy"
42033
+ },
42034
+ "numberOfHelpToBuyIsas": {
42035
+ "type": "integer",
42036
+ "title": "Number of Help to Buy ISAs",
42037
+ "nullable": true
42038
+ },
42039
+ "bridgingFinanceRepresentation": {
42040
+ "type": "string",
42041
+ "title": "Bridging finance representation",
42042
+ "enum": ["Dual", "Separate"],
42043
+ "nullable": true
42044
+ },
42045
+ "depositAmount": {
42046
+ "type": "number",
42047
+ "title": "Deposit amount",
42048
+ "minimum": 0
42049
+ },
42050
+ "loanToValue": {
42051
+ "type": "number",
42052
+ "title": "Loan-to-Value (LTV)",
42053
+ "minimum": 0,
42054
+ "maximum": 100
42055
+ },
42056
+ "numberOfBorrowers": {
42057
+ "type": "integer",
42058
+ "title": "Number of borrowers",
42059
+ "minimum": 1,
42060
+ "maximum": 4,
42061
+ "default": 1
42062
+ },
42063
+ "jointProprietorSoleMortgagor": {
42064
+ "type": "boolean",
42065
+ "title": "Joint proprietor, sole mortgagor"
42066
+ },
42067
+ "soleProprietorJointMortgagor": {
42068
+ "type": "boolean",
42069
+ "title": "Sole proprietor, joint mortgagor"
42070
+ },
42071
+ "deedOfPostponement": {
42072
+ "type": "boolean",
42073
+ "title": "Deed of postponement required"
42074
+ },
42075
+ "separateRepresentation": {
42076
+ "type": "boolean",
42077
+ "title": "Separate legal representation required",
42078
+ "nullable": true
42079
+ },
42080
+ "oldestBorrowerAge": {
42081
+ "type": "integer",
42082
+ "title": "Oldest borrower age",
42083
+ "minimum": 18,
42084
+ "maximum": 85
42085
+ },
42086
+ "mortgageTerm": {
42087
+ "type": "integer",
42088
+ "title": "Mortgage term",
42089
+ "minimum": 5,
42090
+ "maximum": 40
42091
+ },
42092
+ "adverseCredit": {
42093
+ "type": "string",
42094
+ "title": "Adverse credit",
42095
+ "enum": ["No", "Yes", "Prefer not to say"]
42096
+ },
42097
+ "employmentType": {
42098
+ "type": "string",
42099
+ "title": "Employment type",
42100
+ "enum": [
42101
+ "Employed",
42102
+ "Self-employed",
42103
+ "Retired",
42104
+ "Contractor",
42105
+ "Other"
42106
+ ]
42107
+ },
42108
+ "existingMortgagedProperties": {
42109
+ "type": "integer",
42110
+ "title": "Existing mortgaged properties",
42111
+ "minimum": 0
42112
+ },
42113
+ "annualIncome": {
42114
+ "type": "number",
42115
+ "title": "Annual gross income",
42116
+ "minimum": 0
42117
+ },
42118
+ "residencyStatus": {
42119
+ "type": "string",
42120
+ "title": "Residency status",
42121
+ "enum": [
42122
+ "UK citizen",
42123
+ "Permanent resident",
42124
+ "Visa holder",
42125
+ "Non-resident"
42126
+ ]
42127
+ },
42128
+ "nominatedLender": {
42129
+ "type": "string",
42130
+ "title": "Nominated lender"
42131
+ }
42132
+ }
42133
+ }
42134
+ ]
41956
42135
  }
41957
- },
41958
- "required": ["amount", "currency", "status"]
42136
+ }
41959
42137
  }
41960
42138
  }
41961
42139
  },
@@ -4104,6 +4104,35 @@
4104
4104
  exclusions[]
4105
4105
  conditions[]
4106
4106
  externalIds
4107
+ buyerCircumstances
4108
+ intendedUse
4109
+ firstTimeBuyer
4110
+ rightToBuy
4111
+ ltdCompanyPurchase
4112
+ numberOfOwners
4113
+ numberOfExpats
4114
+ giftedEquity
4115
+ numberOfGiftedDeposits
4116
+ requiresMortgage
4117
+ helpToBuyEquityLoan
4118
+ armedForcesHelpToBuy
4119
+ numberOfHelpToBuyIsas
4120
+ bridgingFinanceRepresentation
4121
+ depositAmount
4122
+ loanToValue
4123
+ numberOfBorrowers
4124
+ jointProprietorSoleMortgagor
4125
+ soleProprietorJointMortgagor
4126
+ deedOfPostponement
4127
+ separateRepresentation
4128
+ oldestBorrowerAge
4129
+ mortgageTerm
4130
+ adverseCredit
4131
+ employmentType
4132
+ existingMortgagedProperties
4133
+ annualIncome
4134
+ residencyStatus
4135
+ nominatedLender
4107
4136
  enquiries{*}
4108
4137
  subject
4109
4138
  status
@@ -37472,11 +37472,11 @@
37472
37472
  "status": {
37473
37473
  "type": "string",
37474
37474
  "enum": [
37475
- "pending",
37476
- "withdrawn",
37477
- "rejected",
37478
- "accepted",
37479
- "noteOfInterest"
37475
+ "Pending",
37476
+ "Withdrawn",
37477
+ "Rejected",
37478
+ "Accepted",
37479
+ "Note of Interest"
37480
37480
  ]
37481
37481
  },
37482
37482
  "inclusions": {
@@ -37499,13 +37499,200 @@
37499
37499
  },
37500
37500
  "externalIds": {
37501
37501
  "type": "object"
37502
+ },
37503
+ "buyerCircumstances": {
37504
+ "title": "Buyer circumstances",
37505
+ "description": "Information about the buyer's circumstances for lender compatibility analysis and conveyancing quotes",
37506
+ "type": "object",
37507
+ "properties": {
37508
+ "intendedUse": {
37509
+ "type": "string",
37510
+ "title": "Intended use of property",
37511
+ "enum": [
37512
+ "Owner occupied",
37513
+ "Buy-to-let",
37514
+ "Holiday let",
37515
+ "Second home"
37516
+ ]
37517
+ },
37518
+ "firstTimeBuyer": {
37519
+ "type": "boolean",
37520
+ "title": "First-time buyer"
37521
+ },
37522
+ "rightToBuy": {
37523
+ "type": "boolean",
37524
+ "title": "Right to Buy purchase"
37525
+ },
37526
+ "ltdCompanyPurchase": {
37527
+ "type": "boolean",
37528
+ "title": "Limited company purchase"
37529
+ },
37530
+ "numberOfOwners": {
37531
+ "type": "integer",
37532
+ "title": "Number of owners",
37533
+ "nullable": true
37534
+ },
37535
+ "numberOfExpats": {
37536
+ "type": "integer",
37537
+ "title": "Number of expat buyers",
37538
+ "nullable": true
37539
+ },
37540
+ "giftedEquity": {
37541
+ "type": "boolean",
37542
+ "title": "Gifted equity"
37543
+ },
37544
+ "numberOfGiftedDeposits": {
37545
+ "type": "integer",
37546
+ "title": "Number of gifted deposits",
37547
+ "nullable": true
37548
+ },
37549
+ "requiresMortgage": {
37550
+ "type": "string",
37551
+ "title": "Requires mortgage",
37552
+ "enum": [
37553
+ "Yes",
37554
+ "No"
37555
+ ]
37556
+ }
37557
+ },
37558
+ "required": [
37559
+ "requiresMortgage"
37560
+ ],
37561
+ "oneOf": [
37562
+ {
37563
+ "properties": {
37564
+ "requiresMortgage": {
37565
+ "enum": [
37566
+ "No"
37567
+ ]
37568
+ }
37569
+ }
37570
+ },
37571
+ {
37572
+ "properties": {
37573
+ "requiresMortgage": {
37574
+ "enum": [
37575
+ "Yes"
37576
+ ]
37577
+ },
37578
+ "helpToBuyEquityLoan": {
37579
+ "type": "boolean",
37580
+ "title": "Help to Buy equity loan"
37581
+ },
37582
+ "armedForcesHelpToBuy": {
37583
+ "type": "boolean",
37584
+ "title": "Armed Forces Help to Buy"
37585
+ },
37586
+ "numberOfHelpToBuyIsas": {
37587
+ "type": "integer",
37588
+ "title": "Number of Help to Buy ISAs",
37589
+ "nullable": true
37590
+ },
37591
+ "bridgingFinanceRepresentation": {
37592
+ "type": "string",
37593
+ "title": "Bridging finance representation",
37594
+ "enum": [
37595
+ "Dual",
37596
+ "Separate"
37597
+ ],
37598
+ "nullable": true
37599
+ },
37600
+ "depositAmount": {
37601
+ "type": "number",
37602
+ "title": "Deposit amount",
37603
+ "minimum": 0
37604
+ },
37605
+ "loanToValue": {
37606
+ "type": "number",
37607
+ "title": "Loan-to-Value (LTV)",
37608
+ "minimum": 0,
37609
+ "maximum": 100
37610
+ },
37611
+ "numberOfBorrowers": {
37612
+ "type": "integer",
37613
+ "title": "Number of borrowers",
37614
+ "minimum": 1,
37615
+ "maximum": 4,
37616
+ "default": 1
37617
+ },
37618
+ "jointProprietorSoleMortgagor": {
37619
+ "type": "boolean",
37620
+ "title": "Joint proprietor, sole mortgagor"
37621
+ },
37622
+ "soleProprietorJointMortgagor": {
37623
+ "type": "boolean",
37624
+ "title": "Sole proprietor, joint mortgagor"
37625
+ },
37626
+ "deedOfPostponement": {
37627
+ "type": "boolean",
37628
+ "title": "Deed of postponement required"
37629
+ },
37630
+ "separateRepresentation": {
37631
+ "type": "boolean",
37632
+ "title": "Separate legal representation required",
37633
+ "nullable": true
37634
+ },
37635
+ "oldestBorrowerAge": {
37636
+ "type": "integer",
37637
+ "title": "Oldest borrower age",
37638
+ "minimum": 18,
37639
+ "maximum": 85
37640
+ },
37641
+ "mortgageTerm": {
37642
+ "type": "integer",
37643
+ "title": "Mortgage term",
37644
+ "minimum": 5,
37645
+ "maximum": 40
37646
+ },
37647
+ "adverseCredit": {
37648
+ "type": "string",
37649
+ "title": "Adverse credit",
37650
+ "enum": [
37651
+ "No",
37652
+ "Yes",
37653
+ "Prefer not to say"
37654
+ ]
37655
+ },
37656
+ "employmentType": {
37657
+ "type": "string",
37658
+ "title": "Employment type",
37659
+ "enum": [
37660
+ "Employed",
37661
+ "Self-employed",
37662
+ "Retired",
37663
+ "Contractor",
37664
+ "Other"
37665
+ ]
37666
+ },
37667
+ "existingMortgagedProperties": {
37668
+ "type": "integer",
37669
+ "title": "Existing mortgaged properties",
37670
+ "minimum": 0
37671
+ },
37672
+ "annualIncome": {
37673
+ "type": "number",
37674
+ "title": "Annual gross income",
37675
+ "minimum": 0
37676
+ },
37677
+ "residencyStatus": {
37678
+ "type": "string",
37679
+ "title": "Residency status",
37680
+ "enum": [
37681
+ "UK citizen",
37682
+ "Permanent resident",
37683
+ "Visa holder",
37684
+ "Non-resident"
37685
+ ]
37686
+ },
37687
+ "nominatedLender": {
37688
+ "type": "string",
37689
+ "title": "Nominated lender"
37690
+ }
37691
+ }
37692
+ }
37693
+ ]
37502
37694
  }
37503
- },
37504
- "required": [
37505
- "amount",
37506
- "currency",
37507
- "status"
37508
- ]
37695
+ }
37509
37696
  }
37510
37697
  }
37511
37698
  },
@@ -5225,7 +5225,37 @@
5225
5225
  "conditions": [
5226
5226
  "string"
5227
5227
  ],
5228
- "externalIds": {}
5228
+ "externalIds": {},
5229
+ "buyerCircumstances": {
5230
+ "intendedUse": "string",
5231
+ "firstTimeBuyer": "boolean",
5232
+ "rightToBuy": "boolean",
5233
+ "ltdCompanyPurchase": "boolean",
5234
+ "numberOfOwners": "integer",
5235
+ "numberOfExpats": "integer",
5236
+ "giftedEquity": "boolean",
5237
+ "numberOfGiftedDeposits": "integer",
5238
+ "requiresMortgage": "variant",
5239
+ "helpToBuyEquityLoan": "boolean",
5240
+ "armedForcesHelpToBuy": "boolean",
5241
+ "numberOfHelpToBuyIsas": "integer",
5242
+ "bridgingFinanceRepresentation": "string",
5243
+ "depositAmount": "number",
5244
+ "loanToValue": "number",
5245
+ "numberOfBorrowers": "integer",
5246
+ "jointProprietorSoleMortgagor": "boolean",
5247
+ "soleProprietorJointMortgagor": "boolean",
5248
+ "deedOfPostponement": "boolean",
5249
+ "separateRepresentation": "boolean",
5250
+ "oldestBorrowerAge": "integer",
5251
+ "mortgageTerm": "integer",
5252
+ "adverseCredit": "string",
5253
+ "employmentType": "string",
5254
+ "existingMortgagedProperties": "integer",
5255
+ "annualIncome": "number",
5256
+ "residencyStatus": "string",
5257
+ "nominatedLender": "string"
5258
+ }
5229
5259
  }
5230
5260
  },
5231
5261
  "enquiries": {