@pdtf/schemas 3.0.0-20 → 3.0.0-22

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 (13) hide show
  1. package/package.json +1 -1
  2. package/src/examples/v3/exampleTransaction.json +16 -9
  3. package/src/schemas/v3/combined.json +563 -535
  4. package/src/schemas/v3/overlays/baspi.json +299 -264
  5. package/src/schemas/v3/overlays/con29DW.json +21 -6
  6. package/src/schemas/v3/overlays/lpe1.json +3 -2
  7. package/src/schemas/v3/overlays/nts.json +61 -15
  8. package/src/schemas/v3/overlays/piq.json +59 -90
  9. package/src/schemas/v3/overlays/rds.json +130 -122
  10. package/src/schemas/v3/overlays/ta6.json +227 -158
  11. package/src/schemas/v3/overlays/ta7.json +35 -112
  12. package/src/schemas/v3/pdtf-transaction.json +377 -356
  13. package/src/schemas/v3/skeleton.json +49 -51
package/src/schemas/v3/overlays/baspi.json CHANGED
@@ -483,7 +483,7 @@
483
483
  "leaseholdInformation": {
484
484
  "baspiRef": "A1.5",
485
485
  "required": [
486
- "typeOfLeasehold",
486
+ "sharedOwnership",
487
487
  "leaseTerm",
488
488
  "contactDetails",
489
489
  "groundRent",
@@ -491,27 +491,26 @@
491
491
  "serviceCharge"
492
492
  ],
493
493
  "properties": {
494
- "typeOfLeasehold": {
494
+ "sharedOwnership": {
495
495
  "baspiRef": "A1.3.1",
496
496
  "discriminator": {
497
- "propertyName": "leaseholdType"
497
+ "propertyName": "isSharedOwnership"
498
498
  },
499
499
  "oneOf": [
500
500
  {
501
501
  "properties": {
502
- "leaseholdType": {
502
+ "isSharedOwnership": {
503
503
  "enum": [
504
- "Flat",
505
- "Long leasehold house"
504
+ "No"
506
505
  ]
507
506
  }
508
507
  }
509
508
  },
510
509
  {
511
510
  "properties": {
512
- "leaseholdType": {
511
+ "isSharedOwnership": {
513
512
  "enum": [
514
- "Shared ownership"
513
+ "Yes"
515
514
  ]
516
515
  },
517
516
  "sharedOwnershipPercentage": {
@@ -532,10 +531,10 @@
532
531
  }
533
532
  ],
534
533
  "required": [
535
- "leaseholdType"
534
+ "isSharedOwnership"
536
535
  ],
537
536
  "properties": {
538
- "leaseholdType": {
537
+ "isSharedOwnership": {
539
538
  "baspiRef": "A1.3.1"
540
539
  }
541
540
  }
@@ -3354,8 +3353,25 @@
3354
3353
  },
3355
3354
  "supplier": {
3356
3355
  "baspiRef": "A7.1.0.1.2"
3356
+ },
3357
+ "electricityMeter": {
3358
+ "baspiRef": "B4.4",
3359
+ "required": [
3360
+ "location"
3361
+ ],
3362
+ "properties": {
3363
+ "location": {
3364
+ "baspiRef": "4.4.1"
3365
+ },
3366
+ "attachments": {
3367
+ "baspiRef": "4.4.2"
3368
+ }
3369
+ }
3357
3370
  }
3358
- }
3371
+ },
3372
+ "required": [
3373
+ "electricityMeter"
3374
+ ]
3359
3375
  },
3360
3376
  {
3361
3377
  "properties": {
@@ -3409,8 +3425,175 @@
3409
3425
  },
3410
3426
  "supplier": {
3411
3427
  "baspiRef": "A7.1.0.8.2"
3428
+ },
3429
+ "yearInstalled": {
3430
+ "baspiRef": "B4.3.1"
3431
+ },
3432
+ "panelsOwnedOutright": {
3433
+ "baspiRef": "B4.3.2",
3434
+ "discriminator": {
3435
+ "propertyName": "yesNo"
3436
+ },
3437
+ "oneOf": [
3438
+ {
3439
+ "properties": {
3440
+ "yesNo": {
3441
+ "enum": [
3442
+ "Yes"
3443
+ ]
3444
+ }
3445
+ }
3446
+ },
3447
+ {
3448
+ "properties": {
3449
+ "yesNo": {
3450
+ "enum": [
3451
+ "No"
3452
+ ]
3453
+ },
3454
+ "details": {
3455
+ "baspiRef": "B4.3.2.2"
3456
+ },
3457
+ "attachments": {
3458
+ "baspiRef": "B4.3.2.3"
3459
+ }
3460
+ },
3461
+ "required": [
3462
+ "details",
3463
+ "attachments"
3464
+ ]
3465
+ }
3466
+ ],
3467
+ "required": [
3468
+ "yesNo"
3469
+ ],
3470
+ "properties": {
3471
+ "yesNo": {
3472
+ "baspiRef": "B4.3.2.1"
3473
+ }
3474
+ }
3475
+ },
3476
+ "panelProviderLease": {
3477
+ "baspiRef": "B4.3.3",
3478
+ "discriminator": {
3479
+ "propertyName": "yesNo"
3480
+ },
3481
+ "oneOf": [
3482
+ {
3483
+ "properties": {
3484
+ "yesNo": {
3485
+ "enum": [
3486
+ "No"
3487
+ ]
3488
+ }
3489
+ }
3490
+ },
3491
+ {
3492
+ "properties": {
3493
+ "yesNo": {
3494
+ "enum": [
3495
+ "Yes"
3496
+ ]
3497
+ },
3498
+ "details": {
3499
+ "baspiRef": "4.3.3.2"
3500
+ },
3501
+ "attachments": {
3502
+ "baspiRef": "4.3.3.3"
3503
+ }
3504
+ },
3505
+ "required": [
3506
+ "details",
3507
+ "attachments"
3508
+ ]
3509
+ }
3510
+ ],
3511
+ "required": [
3512
+ "yesNo"
3513
+ ],
3514
+ "properties": {
3515
+ "yesNo": {
3516
+ "baspiRef": "4.3.3.1"
3517
+ }
3518
+ }
3519
+ },
3520
+ "lastMaintained": {
3521
+ "baspiRef": "B4.3.4"
3522
+ },
3523
+ "inGoodWorkingOrder": {
3524
+ "baspiRef": "B4.3.5",
3525
+ "discriminator": {
3526
+ "propertyName": "yesNo"
3527
+ },
3528
+ "oneOf": [
3529
+ {
3530
+ "properties": {
3531
+ "yesNo": {
3532
+ "enum": [
3533
+ "Yes"
3534
+ ]
3535
+ }
3536
+ }
3537
+ },
3538
+ {
3539
+ "properties": {
3540
+ "yesNo": {
3541
+ "enum": [
3542
+ "No"
3543
+ ]
3544
+ },
3545
+ "details": {
3546
+ "baspiRef": "B4.3.5.2"
3547
+ }
3548
+ },
3549
+ "required": [
3550
+ "details"
3551
+ ]
3552
+ }
3553
+ ],
3554
+ "required": [
3555
+ "yesNo"
3556
+ ],
3557
+ "properties": {
3558
+ "yesNo": {
3559
+ "baspiRef": "B4.3.5.1"
3560
+ }
3561
+ }
3562
+ },
3563
+ "isConnectedToNationalGrid": {
3564
+ "baspiRef": "B4.3.6"
3565
+ },
3566
+ "photovoltaicMeterPanelLocation": {
3567
+ "baspiRef": "B4.7",
3568
+ "properties": {
3569
+ "description": {
3570
+ "baspiRef": "4.7.1"
3571
+ },
3572
+ "attachments": {
3573
+ "baspiRef": "4.7.2"
3574
+ }
3575
+ }
3576
+ },
3577
+ "photovoltaicBatteriesLocation": {
3578
+ "baspiRef": "B4.8",
3579
+ "properties": {
3580
+ "description": {
3581
+ "baspiRef": "4.8.1"
3582
+ },
3583
+ "attachments": {
3584
+ "baspiRef": "4.8.2"
3585
+ }
3586
+ }
3412
3587
  }
3413
- }
3588
+ },
3589
+ "required": [
3590
+ "yearInstalled",
3591
+ "panelsOwnedOutright",
3592
+ "panelProviderLease",
3593
+ "lastMaintained",
3594
+ "inGoodWorkingOrder",
3595
+ "isConnectedToNationalGrid"
3596
+ ]
3414
3597
  },
3415
3598
  {
3416
3599
  "properties": {
@@ -3538,8 +3721,66 @@
3538
3721
  },
3539
3722
  "supplier": {
3540
3723
  "baspiRef": "A7.1.0.10.2"
3724
+ },
3725
+ "stopcock": {
3726
+ "baspiRef": "B4.6.1",
3727
+ "properties": {
3728
+ "location": {
3729
+ "baspiRef": "4.6.1.1"
3730
+ },
3731
+ "attachments": {
3732
+ "baspiRef": "4.6.1.2"
3733
+ }
3734
+ }
3735
+ },
3736
+ "waterMeter": {
3737
+ "baspiRef": "A7.",
3738
+ "discriminator": {
3739
+ "propertyName": "isSupplyMetered"
3740
+ },
3741
+ "oneOf": [
3742
+ {
3743
+ "properties": {
3744
+ "isSupplyMetered": {
3745
+ "enum": [
3746
+ "No"
3747
+ ]
3748
+ }
3749
+ }
3750
+ },
3751
+ {
3752
+ "properties": {
3753
+ "isSupplyMetered": {
3754
+ "enum": [
3755
+ "Yes"
3756
+ ]
3757
+ },
3758
+ "location": {
3759
+ "baspiRef": "4.6.2.1"
3760
+ },
3761
+ "attachments": {
3762
+ "baspiRef": "4.6.2.2"
3763
+ }
3764
+ },
3765
+ "required": [
3766
+ "location"
3767
+ ]
3768
+ }
3769
+ ],
3770
+ "required": [
3771
+ "isSupplyMetered"
3772
+ ],
3773
+ "properties": {
3774
+ "isSupplyMetered": {
3775
+ "baspiRef": "B4.6.2"
3776
+ }
3777
+ }
3541
3778
  }
3542
- }
3779
+ },
3780
+ "required": [
3781
+ "stopcock",
3782
+ "waterMeter"
3783
+ ]
3543
3784
  },
3544
3785
  {
3545
3786
  "properties": {
@@ -4039,12 +4280,52 @@
4039
4280
  "properties": {
4040
4281
  "centralHeatingFuelType": {
4041
4282
  "enum": [
4042
- "Mains gas",
4043
- "Electricity",
4283
+ "Mains gas"
4284
+ ]
4285
+ },
4286
+ "supplier": {
4287
+ "baspiRef": "A7.1.0"
4288
+ },
4289
+ "gasMeter": {
4290
+ "baspiRef": "B4.5",
4291
+ "required": [
4292
+ "location"
4293
+ ],
4294
+ "properties": {
4295
+ "location": {
4296
+ "baspiRef": "4.5.1"
4297
+ },
4298
+ "attachments": {
4299
+ "baspiRef": "4.5.2"
4300
+ }
4301
+ }
4302
+ }
4303
+ },
4304
+ "required": [
4305
+ "supplier",
4306
+ "gasMeter"
4307
+ ]
4308
+ },
4309
+ {
4310
+ "properties": {
4311
+ "centralHeatingFuelType": {
4312
+ "enum": [
4313
+ "Electricity"
4314
+ ]
4315
+ }
4316
+ }
4317
+ },
4318
+ {
4319
+ "properties": {
4320
+ "centralHeatingFuelType": {
4321
+ "enum": [
4044
4322
  "Oil",
4045
4323
  "LPG",
4046
4324
  "Biomass"
4047
4325
  ]
4326
+ },
4327
+ "supplier": {
4328
+ "baspiRef": "A7.1.0"
4048
4329
  }
4049
4330
  }
4050
4331
  },
@@ -5743,7 +6024,7 @@
5743
6024
  "sellersCapacity",
5744
6025
  "legalBoundaries",
5745
6026
  "servicesCrossing",
5746
- "energyAndMeters",
6027
+ "electricalWorks",
5747
6028
  "smartHomeSystems",
5748
6029
  "guaranteesWarrantiesAndIndemnityInsurances",
5749
6030
  "occupiers",
@@ -6220,12 +6501,11 @@
6220
6501
  }
6221
6502
  }
6222
6503
  },
6223
- "energyAndMeters": {
6504
+ "electricalWorks": {
6224
6505
  "baspiRef": "B4",
6225
6506
  "required": [
6226
6507
  "testedByQualifiedElectrician",
6227
- "electricalWorkSince2005",
6228
- "solarPanels"
6508
+ "electricalWorkSince2005"
6229
6509
  ],
6230
6510
  "properties": {
6231
6511
  "testedByQualifiedElectrician": {
@@ -6325,251 +6605,6 @@
6325
6605
  "baspiRef": "B4.2.1"
6326
6606
  }
6327
6607
  }
6328
- },
6329
- "solarPanels": {
6330
- "baspiRef": "B4.3",
6331
- "discriminator": {
6332
- "propertyName": "hasSolarPanels"
6333
- },
6334
- "oneOf": [
6335
- {
6336
- "properties": {
6337
- "hasSolarPanels": {
6338
- "enum": [
6339
- "No"
6340
- ]
6341
- }
6342
- }
6343
- },
6344
- {
6345
- "properties": {
6346
- "hasSolarPanels": {
6347
- "enum": [
6348
- "Yes"
6349
- ]
6350
- },
6351
- "yearInstalled": {
6352
- "baspiRef": "B4.3.1"
6353
- },
6354
- "panelsOwnedOutright": {
6355
- "baspiRef": "B4.3.2",
6356
- "discriminator": {
6357
- "propertyName": "yesNo"
6358
- },
6359
- "oneOf": [
6360
- {
6361
- "properties": {
6362
- "yesNo": {
6363
- "enum": [
6364
- "Yes"
6365
- ]
6366
- }
6367
- }
6368
- },
6369
- {
6370
- "properties": {
6371
- "yesNo": {
6372
- "enum": [
6373
- "No"
6374
- ]
6375
- },
6376
- "details": {
6377
- "baspiRef": "B4.3.2.2"
6378
- },
6379
- "attachments": {
6380
- "baspiRef": "B4.3.2.3"
6381
- }
6382
- },
6383
- "required": [
6384
- "details",
6385
- "attachments"
6386
- ]
6387
- }
6388
- ],
6389
- "required": [
6390
- "yesNo"
6391
- ],
6392
- "properties": {
6393
- "yesNo": {
6394
- "baspiRef": "B4.3.2.1"
6395
- }
6396
- }
6397
- },
6398
- "panelProviderLease": {
6399
- "baspiRef": "B4.3.3",
6400
- "discriminator": {
6401
- "propertyName": "yesNo"
6402
- },
6403
- "oneOf": [
6404
- {
6405
- "properties": {
6406
- "yesNo": {
6407
- "enum": [
6408
- "No"
6409
- ]
6410
- }
6411
- }
6412
- },
6413
- {
6414
- "properties": {
6415
- "yesNo": {
6416
- "enum": [
6417
- "Yes"
6418
- ]
6419
- },
6420
- "details": {
6421
- "baspiRef": "4.3.3.2"
6422
- },
6423
- "attachments": {
6424
- "baspiRef": "4.3.3.3"
6425
- }
6426
- },
6427
- "required": [
6428
- "details",
6429
- "attachments"
6430
- ]
6431
- }
6432
- ],
6433
- "required": [
6434
- "yesNo"
6435
- ],
6436
- "properties": {
6437
- "yesNo": {
6438
- "baspiRef": "4.3.3.1"
6439
- }
6440
- }
6441
- },
6442
- "lastMaintained": {
6443
- "baspiRef": "B4.3.4"
6444
- },
6445
- "inGoodWorkingOrder": {
6446
- "baspiRef": "B4.3.5",
6447
- "discriminator": {
6448
- "propertyName": "yesNo"
6449
- },
6450
- "oneOf": [
6451
- {
6452
- "properties": {
6453
- "yesNo": {
6454
- "enum": [
6455
- "Yes"
6456
- ]
6457
- }
6458
- }
6459
- },
6460
- {
6461
- "properties": {
6462
- "yesNo": {
6463
- "enum": [
6464
- "No"
6465
- ]
6466
- },
6467
- "details": {
6468
- "baspiRef": "B4.3.5.2"
6469
- }
6470
- },
6471
- "required": [
6472
- "details"
6473
- ]
6474
- }
6475
- ],
6476
- "required": [
6477
- "yesNo"
6478
- ],
6479
- "properties": {
6480
- "yesNo": {
6481
- "baspiRef": "B4.3.5.1"
6482
- }
6483
- }
6484
- },
6485
- "isConnectedToNationalGrid": {
6486
- "baspiRef": "B4.3.6"
6487
- },
6488
- "photovoltaicMeterPanelLocation": {
6489
- "baspiRef": "B4.7",
6490
- "properties": {
6491
- "description": {
6492
- "baspiRef": "4.7.1"
6493
- },
6494
- "attachments": {
6495
- "baspiRef": "4.7.2"
6496
- }
6497
- }
6498
- },
6499
- "photovoltaicBatteriesLocation": {
6500
- "baspiRef": "B4.8",
6501
- "properties": {
6502
- "description": {
6503
- "baspiRef": "4.8.1"
6504
- },
6505
- "attachments": {
6506
- "baspiRef": "4.8.2"
6507
- }
6508
- }
6509
- }
6510
- },
6511
- "required": [
6512
- "yearInstalled",
6513
- "panelsOwnedOutright",
6514
- "panelProviderLease",
6515
- "lastMaintained",
6516
- "inGoodWorkingOrder",
6517
- "isConnectedToNationalGrid"
6518
- ]
6519
- }
6520
- ],
6521
- "required": [
6522
- "hasSolarPanels"
6523
- ],
6524
- "properties": {
6525
- "hasSolarPanels": {
6526
- "baspiRef": "B4.3.0"
6527
- }
6528
- }
6529
- },
6530
- "electricityMeter": {
6531
- "baspiRef": "B4.4",
6532
- "properties": {
6533
- "location": {
6534
- "baspiRef": "4.4.1"
6535
- },
6536
- "attachments": {
6537
- "baspiRef": "4.4.2"
6538
- }
6539
- }
6540
- },
6541
- "gasMeter": {
6542
- "baspiRef": "B4.5",
6543
- "properties": {
6544
- "location": {
6545
- "baspiRef": "4.5.1"
6546
- },
6547
- "attachments": {
6548
- "baspiRef": "4.5.2"
6549
- }
6550
- }
6551
- },
6552
- "stopcock": {
6553
- "baspiRef": "B4.6.1",
6554
- "properties": {
6555
- "location": {
6556
- "baspiRef": "4.6.1.1"
6557
- },
6558
- "attachments": {
6559
- "baspiRef": "4.6.1.2"
6560
- }
6561
- }
6562
- },
6563
- "waterMeter": {
6564
- "baspiRef": "B4.6.2",
6565
- "properties": {
6566
- "location": {
6567
- "baspiRef": "4.6.2.1"
6568
- },
6569
- "attachments": {
6570
- "baspiRef": "4.6.2.2"
6571
- }
6572
- }
6573
6608
  }
6574
6609
  }
6575
6610
  },