@pdtf/schemas 3.6.0-5 → 3.6.0-8

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.
Files changed (7) hide show
  1. package/package.json +3 -2
  2. package/src/schemas/v3/combined.json +345 -17
  3. package/src/schemas/v3/compactSkeleton.txt +38 -9
  4. package/src/schemas/v3/pdtf-transaction.json +418 -21
  5. package/src/schemas/v3/skeleton.json +57 -9
  6. package/src/tests/v3/offers.test.js +37 -40
  7. package/src/tests/v3/patternProperties.test.js +26 -30
package/src/schemas/v3/pdtf-transaction.json CHANGED
@@ -13,7 +13,28 @@
13
13
  "type": "string"
14
14
  },
15
15
  "externalIds": {
16
- "type": "object"
16
+ "type": "object",
17
+ "patternProperties": {
18
+ ".*": {
19
+ "oneOf": [
20
+ {
21
+ "type": "string"
22
+ },
23
+ {
24
+ "type": "number"
25
+ },
26
+ {
27
+ "type": "boolean"
28
+ },
29
+ {
30
+ "type": "object",
31
+ "patternProperties": {
32
+ ".*": {}
33
+ }
34
+ }
35
+ ]
36
+ }
37
+ }
17
38
  },
18
39
  "status": {
19
40
  "type": "string",
@@ -181,7 +202,28 @@
181
202
  ]
182
203
  },
183
204
  "externalIds": {
184
- "type": "object"
205
+ "type": "object",
206
+ "patternProperties": {
207
+ ".*": {
208
+ "oneOf": [
209
+ {
210
+ "type": "string"
211
+ },
212
+ {
213
+ "type": "number"
214
+ },
215
+ {
216
+ "type": "boolean"
217
+ },
218
+ {
219
+ "type": "object",
220
+ "patternProperties": {
221
+ ".*": {}
222
+ }
223
+ }
224
+ ]
225
+ }
226
+ }
185
227
  },
186
228
  "participantStatus": {
187
229
  "type": "string",
@@ -22152,7 +22194,28 @@
22152
22194
  "format": "date-time"
22153
22195
  },
22154
22196
  "externalIds": {
22155
- "type": "object"
22197
+ "type": "object",
22198
+ "patternProperties": {
22199
+ ".*": {
22200
+ "oneOf": [
22201
+ {
22202
+ "type": "string"
22203
+ },
22204
+ {
22205
+ "type": "number"
22206
+ },
22207
+ {
22208
+ "type": "boolean"
22209
+ },
22210
+ {
22211
+ "type": "object",
22212
+ "patternProperties": {
22213
+ ".*": {}
22214
+ }
22215
+ }
22216
+ ]
22217
+ }
22218
+ }
22156
22219
  }
22157
22220
  }
22158
22221
  }
@@ -34297,7 +34360,28 @@
34297
34360
  "minLength": 1
34298
34361
  },
34299
34362
  "externalIds": {
34300
- "type": "object"
34363
+ "type": "object",
34364
+ "patternProperties": {
34365
+ ".*": {
34366
+ "oneOf": [
34367
+ {
34368
+ "type": "string"
34369
+ },
34370
+ {
34371
+ "type": "number"
34372
+ },
34373
+ {
34374
+ "type": "boolean"
34375
+ },
34376
+ {
34377
+ "type": "object",
34378
+ "patternProperties": {
34379
+ ".*": {}
34380
+ }
34381
+ }
34382
+ ]
34383
+ }
34384
+ }
34301
34385
  },
34302
34386
  "isDeleted": {
34303
34387
  "type": "boolean"
@@ -37079,7 +37163,28 @@
37079
37163
  "format": "uri"
37080
37164
  },
37081
37165
  "externalIds": {
37082
- "type": "object"
37166
+ "type": "object",
37167
+ "patternProperties": {
37168
+ ".*": {
37169
+ "oneOf": [
37170
+ {
37171
+ "type": "string"
37172
+ },
37173
+ {
37174
+ "type": "number"
37175
+ },
37176
+ {
37177
+ "type": "boolean"
37178
+ },
37179
+ {
37180
+ "type": "object",
37181
+ "patternProperties": {
37182
+ ".*": {}
37183
+ }
37184
+ }
37185
+ ]
37186
+ }
37187
+ }
37083
37188
  },
37084
37189
  "requiredSignatories": {
37085
37190
  "type": "array",
@@ -37135,7 +37240,28 @@
37135
37240
  "format": "date-time"
37136
37241
  },
37137
37242
  "externalIds": {
37138
- "type": "object"
37243
+ "type": "object",
37244
+ "patternProperties": {
37245
+ ".*": {
37246
+ "oneOf": [
37247
+ {
37248
+ "type": "string"
37249
+ },
37250
+ {
37251
+ "type": "number"
37252
+ },
37253
+ {
37254
+ "type": "boolean"
37255
+ },
37256
+ {
37257
+ "type": "object",
37258
+ "patternProperties": {
37259
+ ".*": {}
37260
+ }
37261
+ }
37262
+ ]
37263
+ }
37264
+ }
37139
37265
  }
37140
37266
  },
37141
37267
  "role": {
@@ -37181,7 +37307,28 @@
37181
37307
  "type": "string"
37182
37308
  },
37183
37309
  "externalIds": {
37184
- "type": "object"
37310
+ "type": "object",
37311
+ "patternProperties": {
37312
+ ".*": {
37313
+ "oneOf": [
37314
+ {
37315
+ "type": "string"
37316
+ },
37317
+ {
37318
+ "type": "number"
37319
+ },
37320
+ {
37321
+ "type": "boolean"
37322
+ },
37323
+ {
37324
+ "type": "object",
37325
+ "patternProperties": {
37326
+ ".*": {}
37327
+ }
37328
+ }
37329
+ ]
37330
+ }
37331
+ }
37185
37332
  },
37186
37333
  "address": {
37187
37334
  "title": "Address",
@@ -37263,7 +37410,28 @@
37263
37410
  "type": "string"
37264
37411
  },
37265
37412
  "externalIds": {
37266
- "type": "object"
37413
+ "type": "object",
37414
+ "patternProperties": {
37415
+ ".*": {
37416
+ "oneOf": [
37417
+ {
37418
+ "type": "string"
37419
+ },
37420
+ {
37421
+ "type": "number"
37422
+ },
37423
+ {
37424
+ "type": "boolean"
37425
+ },
37426
+ {
37427
+ "type": "object",
37428
+ "patternProperties": {
37429
+ ".*": {}
37430
+ }
37431
+ }
37432
+ ]
37433
+ }
37434
+ }
37267
37435
  },
37268
37436
  "address": {
37269
37437
  "title": "Address",
@@ -37472,11 +37640,11 @@
37472
37640
  "status": {
37473
37641
  "type": "string",
37474
37642
  "enum": [
37475
- "pending",
37476
- "withdrawn",
37477
- "rejected",
37478
- "accepted",
37479
- "noteOfInterest"
37643
+ "Pending",
37644
+ "Withdrawn",
37645
+ "Rejected",
37646
+ "Accepted",
37647
+ "Note of Interest"
37480
37648
  ]
37481
37649
  },
37482
37650
  "inclusions": {
@@ -37498,14 +37666,222 @@
37498
37666
  }
37499
37667
  },
37500
37668
  "externalIds": {
37501
- "type": "object"
37669
+ "type": "object",
37670
+ "patternProperties": {
37671
+ ".*": {
37672
+ "oneOf": [
37673
+ {
37674
+ "type": "string"
37675
+ },
37676
+ {
37677
+ "type": "number"
37678
+ },
37679
+ {
37680
+ "type": "boolean"
37681
+ },
37682
+ {
37683
+ "type": "object",
37684
+ "patternProperties": {
37685
+ ".*": {}
37686
+ }
37687
+ }
37688
+ ]
37689
+ }
37690
+ }
37691
+ },
37692
+ "buyerCircumstances": {
37693
+ "title": "Buyer circumstances",
37694
+ "description": "Information about the buyer's circumstances for lender compatibility analysis and conveyancing quotes",
37695
+ "type": "object",
37696
+ "properties": {
37697
+ "intendedUse": {
37698
+ "type": "string",
37699
+ "title": "Intended use of property",
37700
+ "enum": [
37701
+ "Owner occupied",
37702
+ "Buy-to-let",
37703
+ "Holiday let",
37704
+ "Second home"
37705
+ ]
37706
+ },
37707
+ "firstTimeBuyer": {
37708
+ "type": "boolean",
37709
+ "title": "First-time buyer"
37710
+ },
37711
+ "rightToBuy": {
37712
+ "type": "boolean",
37713
+ "title": "Right to Buy purchase"
37714
+ },
37715
+ "ltdCompanyPurchase": {
37716
+ "type": "boolean",
37717
+ "title": "Limited company purchase"
37718
+ },
37719
+ "numberOfOwners": {
37720
+ "type": "integer",
37721
+ "title": "Number of owners",
37722
+ "nullable": true
37723
+ },
37724
+ "numberOfExpats": {
37725
+ "type": "integer",
37726
+ "title": "Number of expat buyers",
37727
+ "nullable": true
37728
+ },
37729
+ "giftedEquity": {
37730
+ "type": "boolean",
37731
+ "title": "Gifted equity"
37732
+ },
37733
+ "numberOfGiftedDeposits": {
37734
+ "type": "integer",
37735
+ "title": "Number of gifted deposits",
37736
+ "nullable": true
37737
+ },
37738
+ "requiresMortgage": {
37739
+ "type": "string",
37740
+ "title": "Requires mortgage",
37741
+ "enum": [
37742
+ "Yes",
37743
+ "No"
37744
+ ]
37745
+ }
37746
+ },
37747
+ "required": [
37748
+ "requiresMortgage"
37749
+ ],
37750
+ "oneOf": [
37751
+ {
37752
+ "properties": {
37753
+ "requiresMortgage": {
37754
+ "enum": [
37755
+ "No"
37756
+ ]
37757
+ }
37758
+ }
37759
+ },
37760
+ {
37761
+ "properties": {
37762
+ "requiresMortgage": {
37763
+ "enum": [
37764
+ "Yes"
37765
+ ]
37766
+ },
37767
+ "helpToBuyEquityLoan": {
37768
+ "type": "boolean",
37769
+ "title": "Help to Buy equity loan"
37770
+ },
37771
+ "armedForcesHelpToBuy": {
37772
+ "type": "boolean",
37773
+ "title": "Armed Forces Help to Buy"
37774
+ },
37775
+ "numberOfHelpToBuyIsas": {
37776
+ "type": "integer",
37777
+ "title": "Number of Help to Buy ISAs",
37778
+ "nullable": true
37779
+ },
37780
+ "bridgingFinanceRepresentation": {
37781
+ "type": "string",
37782
+ "title": "Bridging finance representation",
37783
+ "enum": [
37784
+ "Dual",
37785
+ "Separate"
37786
+ ],
37787
+ "nullable": true
37788
+ },
37789
+ "depositAmount": {
37790
+ "type": "number",
37791
+ "title": "Deposit amount",
37792
+ "minimum": 0
37793
+ },
37794
+ "loanToValue": {
37795
+ "type": "number",
37796
+ "title": "Loan-to-Value (LTV)",
37797
+ "minimum": 0,
37798
+ "maximum": 100
37799
+ },
37800
+ "numberOfBorrowers": {
37801
+ "type": "integer",
37802
+ "title": "Number of borrowers",
37803
+ "minimum": 1,
37804
+ "maximum": 4,
37805
+ "default": 1
37806
+ },
37807
+ "jointProprietorSoleMortgagor": {
37808
+ "type": "boolean",
37809
+ "title": "Joint proprietor, sole mortgagor"
37810
+ },
37811
+ "soleProprietorJointMortgagor": {
37812
+ "type": "boolean",
37813
+ "title": "Sole proprietor, joint mortgagor"
37814
+ },
37815
+ "deedOfPostponement": {
37816
+ "type": "boolean",
37817
+ "title": "Deed of postponement required"
37818
+ },
37819
+ "separateRepresentation": {
37820
+ "type": "boolean",
37821
+ "title": "Separate legal representation required",
37822
+ "nullable": true
37823
+ },
37824
+ "oldestBorrowerAge": {
37825
+ "type": "integer",
37826
+ "title": "Oldest borrower age",
37827
+ "minimum": 18,
37828
+ "maximum": 85
37829
+ },
37830
+ "mortgageTerm": {
37831
+ "type": "integer",
37832
+ "title": "Mortgage term",
37833
+ "minimum": 5,
37834
+ "maximum": 40
37835
+ },
37836
+ "adverseCredit": {
37837
+ "type": "string",
37838
+ "title": "Adverse credit",
37839
+ "enum": [
37840
+ "No",
37841
+ "Yes",
37842
+ "Prefer not to say"
37843
+ ]
37844
+ },
37845
+ "employmentType": {
37846
+ "type": "string",
37847
+ "title": "Employment type",
37848
+ "enum": [
37849
+ "Employed",
37850
+ "Self-employed",
37851
+ "Retired",
37852
+ "Contractor",
37853
+ "Other"
37854
+ ]
37855
+ },
37856
+ "existingMortgagedProperties": {
37857
+ "type": "integer",
37858
+ "title": "Existing mortgaged properties",
37859
+ "minimum": 0
37860
+ },
37861
+ "annualIncome": {
37862
+ "type": "number",
37863
+ "title": "Annual gross income",
37864
+ "minimum": 0
37865
+ },
37866
+ "residencyStatus": {
37867
+ "type": "string",
37868
+ "title": "Residency status",
37869
+ "enum": [
37870
+ "UK citizen",
37871
+ "Permanent resident",
37872
+ "Visa holder",
37873
+ "Non-resident"
37874
+ ]
37875
+ },
37876
+ "nominatedLender": {
37877
+ "type": "string",
37878
+ "title": "Nominated lender"
37879
+ }
37880
+ }
37881
+ }
37882
+ ]
37502
37883
  }
37503
- },
37504
- "required": [
37505
- "amount",
37506
- "currency",
37507
- "status"
37508
- ]
37884
+ }
37509
37885
  }
37510
37886
  }
37511
37887
  },
@@ -37589,7 +37965,28 @@
37589
37965
  }
37590
37966
  },
37591
37967
  "externalIds": {
37592
- "type": "object"
37968
+ "type": "object",
37969
+ "patternProperties": {
37970
+ ".*": {
37971
+ "oneOf": [
37972
+ {
37973
+ "type": "string"
37974
+ },
37975
+ {
37976
+ "type": "number"
37977
+ },
37978
+ {
37979
+ "type": "boolean"
37980
+ },
37981
+ {
37982
+ "type": "object",
37983
+ "patternProperties": {
37984
+ ".*": {}
37985
+ }
37986
+ }
37987
+ ]
37988
+ }
37989
+ }
37593
37990
  }
37594
37991
  },
37595
37992
  "required": [
package/src/schemas/v3/skeleton.json CHANGED
@@ -1,6 +1,8 @@
1
1
  {
2
2
  "transactionId": "string",
3
- "externalIds": {},
3
+ "externalIds": {
4
+ "*": {}
5
+ },
4
6
  "status": "string",
5
7
  "participants": [
6
8
  {
@@ -30,7 +32,9 @@
30
32
  "organisation": "string",
31
33
  "organisationReference": "string",
32
34
  "role": "variant",
33
- "externalIds": {},
35
+ "externalIds": {
36
+ "*": {}
37
+ },
34
38
  "participantStatus": "string",
35
39
  "verification": {
36
40
  "identity": {
@@ -2972,7 +2976,9 @@
2972
2976
  {
2973
2977
  "name": "string",
2974
2978
  "signedOn": "string",
2975
- "externalIds": {}
2979
+ "externalIds": {
2980
+ "*": {}
2981
+ }
2976
2982
  }
2977
2983
  ]
2978
2984
  },
@@ -4279,7 +4285,9 @@
4279
4285
  "fileName": "string",
4280
4286
  "mimeType": "string",
4281
4287
  "documentType": "string",
4282
- "externalIds": {},
4288
+ "externalIds": {
4289
+ "*": {}
4290
+ },
4283
4291
  "isDeleted": "boolean",
4284
4292
  "summary": {}
4285
4293
  }
@@ -5139,7 +5147,9 @@
5139
5147
  "template": {
5140
5148
  "name": "string",
5141
5149
  "url": "string",
5142
- "externalIds": {},
5150
+ "externalIds": {
5151
+ "*": {}
5152
+ },
5143
5153
  "requiredSignatories": [
5144
5154
  {
5145
5155
  "role": "string",
@@ -5153,7 +5163,9 @@
5153
5163
  {
5154
5164
  "name": "string",
5155
5165
  "signedOn": "string",
5156
- "externalIds": {}
5166
+ "externalIds": {
5167
+ "*": {}
5168
+ }
5157
5169
  }
5158
5170
  ]
5159
5171
  }
@@ -5162,7 +5174,9 @@
5162
5174
  "onwardPurchase": [
5163
5175
  {
5164
5176
  "transactionId": "string",
5165
- "externalIds": {},
5177
+ "externalIds": {
5178
+ "*": {}
5179
+ },
5166
5180
  "address": {
5167
5181
  "buildingNumber": "string",
5168
5182
  "buildingName": "string",
@@ -5225,7 +5239,39 @@
5225
5239
  "conditions": [
5226
5240
  "string"
5227
5241
  ],
5228
- "externalIds": {}
5242
+ "externalIds": {
5243
+ "*": {}
5244
+ },
5245
+ "buyerCircumstances": {
5246
+ "intendedUse": "string",
5247
+ "firstTimeBuyer": "boolean",
5248
+ "rightToBuy": "boolean",
5249
+ "ltdCompanyPurchase": "boolean",
5250
+ "numberOfOwners": "integer",
5251
+ "numberOfExpats": "integer",
5252
+ "giftedEquity": "boolean",
5253
+ "numberOfGiftedDeposits": "integer",
5254
+ "requiresMortgage": "variant",
5255
+ "helpToBuyEquityLoan": "boolean",
5256
+ "armedForcesHelpToBuy": "boolean",
5257
+ "numberOfHelpToBuyIsas": "integer",
5258
+ "bridgingFinanceRepresentation": "string",
5259
+ "depositAmount": "number",
5260
+ "loanToValue": "number",
5261
+ "numberOfBorrowers": "integer",
5262
+ "jointProprietorSoleMortgagor": "boolean",
5263
+ "soleProprietorJointMortgagor": "boolean",
5264
+ "deedOfPostponement": "boolean",
5265
+ "separateRepresentation": "boolean",
5266
+ "oldestBorrowerAge": "integer",
5267
+ "mortgageTerm": "integer",
5268
+ "adverseCredit": "string",
5269
+ "employmentType": "string",
5270
+ "existingMortgagedProperties": "integer",
5271
+ "annualIncome": "number",
5272
+ "residencyStatus": "string",
5273
+ "nominatedLender": "string"
5274
+ }
5229
5275
  }
5230
5276
  },
5231
5277
  "enquiries": {
@@ -5240,7 +5286,9 @@
5240
5286
  "messageText": "string"
5241
5287
  }
5242
5288
  },
5243
- "externalIds": {},
5289
+ "externalIds": {
5290
+ "*": {}
5291
+ },
5244
5292
  "resolutionCondition": "string"
5245
5293
  }
5246
5294
  }