@pdtf/schemas 3.6.0-dev.19 → 3.6.0-dev.20

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-dev.19",
3
+ "version": "3.6.0-dev.20",
4
4
  "description": "Property Data Trust Framework Schemas and Utilities",
5
5
  "main": "index.js",
6
6
  "files": [
@@ -49495,6 +49495,56 @@
49495
49495
  }
49496
49496
  }
49497
49497
  },
49498
+ "metadata": {
49499
+ "title": "Offer metadata",
49500
+ "description": "Flexible container for vendor-specific metadata items relating to this offer, keyed by vendor namespace (e.g. /offers/{id}/metadata/Moverly/lenderCompatibilityAnalysis). Values may be strings, numbers, booleans or nested objects. Paths are addressable up to three levels below metadata (e.g. /offers/{id}/metadata/vendor/item/field).",
49501
+ "type": "object",
49502
+ "patternProperties": {
49503
+ ".*": {
49504
+ "oneOf": [
49505
+ {
49506
+ "type": "string"
49507
+ },
49508
+ {
49509
+ "type": "number"
49510
+ },
49511
+ {
49512
+ "type": "boolean"
49513
+ },
49514
+ {
49515
+ "type": "object",
49516
+ "patternProperties": {
49517
+ ".*": {
49518
+ "oneOf": [
49519
+ {
49520
+ "type": "string"
49521
+ },
49522
+ {
49523
+ "type": "number"
49524
+ },
49525
+ {
49526
+ "type": "boolean"
49527
+ },
49528
+ {
49529
+ "type": "array"
49530
+ },
49531
+ {
49532
+ "type": "null"
49533
+ },
49534
+ {
49535
+ "type": "object",
49536
+ "patternProperties": {
49537
+ ".*": {}
49538
+ }
49539
+ }
49540
+ ]
49541
+ }
49542
+ }
49543
+ }
49544
+ ]
49545
+ }
49546
+ }
49547
+ },
49498
49548
  "buyerCircumstances": {
49499
49549
  "title": "Buyer circumstances",
49500
49550
  "description": "Information about the buyer's circumstances for lender compatibility analysis and conveyancing quotes",
@@ -49545,6 +49595,52 @@
49545
49595
  "type": "string",
49546
49596
  "title": "Requires mortgage",
49547
49597
  "enum": ["Yes", "No"]
49598
+ },
49599
+ "isAdditionalProperty": {
49600
+ "type": "boolean",
49601
+ "title": "Additional property purchase",
49602
+ "description": "Whether the buyer already owns residential property (SDLT higher rates apply)"
49603
+ },
49604
+ "hasPets": {
49605
+ "type": "boolean",
49606
+ "title": "Buyer has pets",
49607
+ "description": "Relevant to lease and covenant pet restriction assessment"
49608
+ },
49609
+ "intendsSublet": {
49610
+ "type": "boolean",
49611
+ "title": "Buyer intends to sublet",
49612
+ "description": "Relevant to lease and covenant subletting restriction assessment"
49613
+ },
49614
+ "subletType": {
49615
+ "type": "string",
49616
+ "title": "Type of subletting intended",
49617
+ "enum": ["AST", "Lodger", "Airbnb", "HMO", "Company let", "Other"]
49618
+ },
49619
+ "intendsBusiness": {
49620
+ "type": "boolean",
49621
+ "title": "Buyer intends business use",
49622
+ "description": "Relevant to covenant and lease business-use restriction assessment"
49623
+ },
49624
+ "businessType": {
49625
+ "type": "string",
49626
+ "title": "Type of business intended"
49627
+ },
49628
+ "intendsAlterations": {
49629
+ "type": "boolean",
49630
+ "title": "Buyer intends significant alterations",
49631
+ "description": "Relevant to covenant, planning and building regulations assessment"
49632
+ },
49633
+ "financingMethod": {
49634
+ "type": "string",
49635
+ "title": "Primary financing method",
49636
+ "description": "How the purchase is funded, distinct from intendedUse (how the property will be used)",
49637
+ "enum": [
49638
+ "Mortgage",
49639
+ "Cash",
49640
+ "Shared ownership",
49641
+ "Help to Buy",
49642
+ "Right to Buy"
49643
+ ]
49548
49644
  }
49549
49645
  },
49550
49646
  "discriminator": {
@@ -49668,7 +49764,13 @@
49668
49764
  },
49669
49765
  "nominatedLender": {
49670
49766
  "type": "string",
49671
- "title": "Nominated lender"
49767
+ "title": "Nominated lender",
49768
+ "description": "The nominated lender's name as entered or selected"
49769
+ },
49770
+ "nominatedLenderHandbookId": {
49771
+ "type": "string",
49772
+ "title": "Nominated lender (UK Finance Handbook id)",
49773
+ "description": "The nominated lender's identifier in the UK Finance Mortgage Lenders' Handbook, e.g. nationwide-building-society, so lender requirements can be looked up without matching on name"
49672
49774
  }
49673
49775
  }
49674
49776
  }
@@ -4495,6 +4495,7 @@
4495
4495
  exclusions[]
4496
4496
  conditions[]
4497
4497
  externalIds{*}
4498
+ metadata{*}
4498
4499
  buyerCircumstances
4499
4500
  intendedUse
4500
4501
  firstTimeBuyer
@@ -4505,6 +4506,14 @@
4505
4506
  giftedEquity
4506
4507
  numberOfGiftedDeposits
4507
4508
  requiresMortgage
4509
+ isAdditionalProperty
4510
+ hasPets
4511
+ intendsSublet
4512
+ subletType
4513
+ intendsBusiness
4514
+ businessType
4515
+ intendsAlterations
4516
+ financingMethod
4508
4517
  helpToBuyEquityLoan
4509
4518
  armedForcesHelpToBuy
4510
4519
  numberOfHelpToBuyIsas
@@ -4524,6 +4533,7 @@
4524
4533
  annualIncome
4525
4534
  residencyStatus
4526
4535
  nominatedLender
4536
+ nominatedLenderHandbookId
4527
4537
  enquiries{*}
4528
4538
  subject
4529
4539
  status
@@ -41522,6 +41522,56 @@
41522
41522
  }
41523
41523
  }
41524
41524
  },
41525
+ "metadata": {
41526
+ "title": "Offer metadata",
41527
+ "description": "Flexible container for vendor-specific metadata items relating to this offer, keyed by vendor namespace (e.g. /offers/{id}/metadata/Moverly/lenderCompatibilityAnalysis). Values may be strings, numbers, booleans or nested objects. Paths are addressable up to three levels below metadata (e.g. /offers/{id}/metadata/vendor/item/field).",
41528
+ "type": "object",
41529
+ "patternProperties": {
41530
+ ".*": {
41531
+ "oneOf": [
41532
+ {
41533
+ "type": "string"
41534
+ },
41535
+ {
41536
+ "type": "number"
41537
+ },
41538
+ {
41539
+ "type": "boolean"
41540
+ },
41541
+ {
41542
+ "type": "object",
41543
+ "patternProperties": {
41544
+ ".*": {
41545
+ "oneOf": [
41546
+ {
41547
+ "type": "string"
41548
+ },
41549
+ {
41550
+ "type": "number"
41551
+ },
41552
+ {
41553
+ "type": "boolean"
41554
+ },
41555
+ {
41556
+ "type": "array"
41557
+ },
41558
+ {
41559
+ "type": "null"
41560
+ },
41561
+ {
41562
+ "type": "object",
41563
+ "patternProperties": {
41564
+ ".*": {}
41565
+ }
41566
+ }
41567
+ ]
41568
+ }
41569
+ }
41570
+ }
41571
+ ]
41572
+ }
41573
+ }
41574
+ },
41525
41575
  "buyerCircumstances": {
41526
41576
  "title": "Buyer circumstances",
41527
41577
  "description": "Information about the buyer's circumstances for lender compatibility analysis and conveyancing quotes",
@@ -41575,6 +41625,59 @@
41575
41625
  "Yes",
41576
41626
  "No"
41577
41627
  ]
41628
+ },
41629
+ "isAdditionalProperty": {
41630
+ "type": "boolean",
41631
+ "title": "Additional property purchase",
41632
+ "description": "Whether the buyer already owns residential property (SDLT higher rates apply)"
41633
+ },
41634
+ "hasPets": {
41635
+ "type": "boolean",
41636
+ "title": "Buyer has pets",
41637
+ "description": "Relevant to lease and covenant pet restriction assessment"
41638
+ },
41639
+ "intendsSublet": {
41640
+ "type": "boolean",
41641
+ "title": "Buyer intends to sublet",
41642
+ "description": "Relevant to lease and covenant subletting restriction assessment"
41643
+ },
41644
+ "subletType": {
41645
+ "type": "string",
41646
+ "title": "Type of subletting intended",
41647
+ "enum": [
41648
+ "AST",
41649
+ "Lodger",
41650
+ "Airbnb",
41651
+ "HMO",
41652
+ "Company let",
41653
+ "Other"
41654
+ ]
41655
+ },
41656
+ "intendsBusiness": {
41657
+ "type": "boolean",
41658
+ "title": "Buyer intends business use",
41659
+ "description": "Relevant to covenant and lease business-use restriction assessment"
41660
+ },
41661
+ "businessType": {
41662
+ "type": "string",
41663
+ "title": "Type of business intended"
41664
+ },
41665
+ "intendsAlterations": {
41666
+ "type": "boolean",
41667
+ "title": "Buyer intends significant alterations",
41668
+ "description": "Relevant to covenant, planning and building regulations assessment"
41669
+ },
41670
+ "financingMethod": {
41671
+ "type": "string",
41672
+ "title": "Primary financing method",
41673
+ "description": "How the purchase is funded, distinct from intendedUse (how the property will be used)",
41674
+ "enum": [
41675
+ "Mortgage",
41676
+ "Cash",
41677
+ "Shared ownership",
41678
+ "Help to Buy",
41679
+ "Right to Buy"
41680
+ ]
41578
41681
  }
41579
41682
  },
41580
41683
  "required": [
@@ -41708,7 +41811,13 @@
41708
41811
  },
41709
41812
  "nominatedLender": {
41710
41813
  "type": "string",
41711
- "title": "Nominated lender"
41814
+ "title": "Nominated lender",
41815
+ "description": "The nominated lender's name as entered or selected"
41816
+ },
41817
+ "nominatedLenderHandbookId": {
41818
+ "type": "string",
41819
+ "title": "Nominated lender (UK Finance Handbook id)",
41820
+ "description": "The nominated lender's identifier in the UK Finance Mortgage Lenders' Handbook, e.g. nationwide-building-society, so lender requirements can be looked up without matching on name"
41712
41821
  }
41713
41822
  }
41714
41823
  }
@@ -5749,6 +5749,13 @@
5749
5749
  "*": {}
5750
5750
  }
5751
5751
  },
5752
+ "metadata": {
5753
+ "*": {
5754
+ "*": {
5755
+ "*": {}
5756
+ }
5757
+ }
5758
+ },
5752
5759
  "buyerCircumstances": {
5753
5760
  "intendedUse": "string",
5754
5761
  "firstTimeBuyer": "boolean",
@@ -5759,6 +5766,14 @@
5759
5766
  "giftedEquity": "boolean",
5760
5767
  "numberOfGiftedDeposits": "integer",
5761
5768
  "requiresMortgage": "variant",
5769
+ "isAdditionalProperty": "boolean",
5770
+ "hasPets": "boolean",
5771
+ "intendsSublet": "boolean",
5772
+ "subletType": "string",
5773
+ "intendsBusiness": "boolean",
5774
+ "businessType": "string",
5775
+ "intendsAlterations": "boolean",
5776
+ "financingMethod": "string",
5762
5777
  "helpToBuyEquityLoan": "boolean",
5763
5778
  "armedForcesHelpToBuy": "boolean",
5764
5779
  "numberOfHelpToBuyIsas": "integer",
@@ -5777,7 +5792,8 @@
5777
5792
  "existingMortgagedProperties": "integer",
5778
5793
  "annualIncome": "number",
5779
5794
  "residencyStatus": "string",
5780
- "nominatedLender": "string"
5795
+ "nominatedLender": "string",
5796
+ "nominatedLenderHandbookId": "string"
5781
5797
  }
5782
5798
  }
5783
5799
  },