@planning-inspectorate/data-model 2.30.0 → 2.31.1

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 (39) hide show
  1. package/docs/README.md +4 -0
  2. package/docs/appeal-document.md +96 -94
  3. package/docs/appeal-s78-definitions-significantchangesaffectingapplication.md +14 -0
  4. package/docs/appeal-s78-definitions.md +3 -0
  5. package/docs/appeal-s78.md +292 -198
  6. package/package.json +1 -1
  7. package/pins_data_model/models/model_appeal_document.py +3 -1
  8. package/pins_data_model/models/model_appeal_event.py +1 -1
  9. package/pins_data_model/models/model_appeal_event_estimate.py +1 -1
  10. package/pins_data_model/models/model_appeal_has.py +1 -1
  11. package/pins_data_model/models/model_appeal_representation.py +1 -1
  12. package/pins_data_model/models/model_appeal_s78.py +128 -70
  13. package/pins_data_model/models/model_dart_response.py +1 -1
  14. package/pins_data_model/models/model_entraid.py +1 -1
  15. package/pins_data_model/models/model_folder.py +1 -1
  16. package/pins_data_model/models/model_gettimesheets_response.py +1 -1
  17. package/pins_data_model/models/model_listed_building.py +1 -1
  18. package/pins_data_model/models/model_listed_buildings.py +1 -1
  19. package/pins_data_model/models/model_nsip_document.py +1 -1
  20. package/pins_data_model/models/model_nsip_exam_timetable.py +1 -1
  21. package/pins_data_model/models/model_nsip_invoice.py +1 -1
  22. package/pins_data_model/models/model_nsip_meeting.py +1 -1
  23. package/pins_data_model/models/model_nsip_project.py +1 -1
  24. package/pins_data_model/models/model_nsip_project_update.py +1 -1
  25. package/pins_data_model/models/model_nsip_representation.py +1 -1
  26. package/pins_data_model/models/model_nsip_subscription.py +1 -1
  27. package/pins_data_model/models/model_pins_inspector.py +1 -1
  28. package/pins_data_model/models/model_pins_lpa.py +1 -1
  29. package/pins_data_model/models/model_s51_advice.py +1 -1
  30. package/pins_data_model/models/model_service_user.py +1 -1
  31. package/schemas/appeal-document.schema.json +2 -0
  32. package/schemas/appeal-s78.schema.json +48 -5
  33. package/schemas/commands/appellant-submission.schema.json +3 -1
  34. package/src/enums.cjs +3 -0
  35. package/src/enums.d.ts +3 -0
  36. package/src/enums.js +3 -0
  37. package/src/index.cjs +3 -0
  38. package/src/schemas.d.ts +41 -6
  39. package/tests/appeals/expedited-appeals.test.js +238 -0
package/docs/README.md CHANGED
@@ -66,6 +66,10 @@
66
66
 
67
67
  * [Untitled object in Appeal S78 Case](./appeal-s78-properties-applicationelbappealgroundsdetails-items.md) – `appeal-s78.schema.json#/properties/applicationElbAppealGroundsDetails/items`
68
68
 
69
+ * [Untitled object in Appeal S78 Case](./appeal-s78-properties-significantchangesaffectingapplicationappellant-items.md) – `appeal-s78.schema.json#/properties/significantChangesAffectingApplicationAppellant/items`
70
+
71
+ * [Untitled object in Appeal S78 Case](./appeal-s78-properties-significantchangesaffectingapplicationlpa-items.md) – `appeal-s78.schema.json#/properties/significantChangesAffectingApplicationLpa/items`
72
+
69
73
  * [Untitled object in DaRT API response](./dart-response-properties-neighbouringsiteaddresses-items.md) – `dart-response.schema.json#/properties/neighbouringSiteAddresses/items`
70
74
 
71
75
  * [Untitled object in Examination Timetable](./nsip-exam-timetable-defs-event.md) – `nsip-exam-timetable.schema.json#/$defs/event`
package/docs/appeal-document.md CHANGED
@@ -535,100 +535,102 @@ The type of document, used for exchange, migrations and consumption from the app
535
535
 
536
536
  **enum**: the value of this property must be equal to one of the following values:
537
537
 
538
- | Value | Explanation |
539
- | :----------------------------------- | :---------- |
540
- | `"appellantCaseCorrespondence"` | |
541
- | `"appellantCaseWithdrawalLetter"` | |
542
- | `"appellantCostsApplication"` | |
543
- | `"appellantCostsCorrespondence"` | |
544
- | `"appellantCostsWithdrawal"` | |
545
- | `"appellantStatement"` | |
546
- | `"applicationDecisionLetter"` | |
547
- | `"changedDescription"` | |
548
- | `"originalApplicationForm"` | |
549
- | `"whoNotified"` | |
550
- | `"whoNotifiedSiteNotice"` | |
551
- | `"whoNotifiedLetterToNeighbours"` | |
552
- | `"whoNotifiedPressAdvert"` | |
553
- | `"conservationMap"` | |
554
- | `"lpaCaseCorrespondence"` | |
555
- | `"lpaCostsApplication"` | |
556
- | `"lpaCostsCorrespondence"` | |
557
- | `"lpaCostsWithdrawal"` | |
558
- | `"otherPartyRepresentations"` | |
559
- | `"planningOfficerReport"` | |
560
- | `"appellantCostsDecisionLetter"` | |
561
- | `"lpaCostsDecisionLetter"` | |
562
- | `"caseDecisionLetter"` | |
563
- | `"crossTeamCorrespondence"` | |
564
- | `"inspectorCorrespondence"` | |
565
- | `"mainPartyCorrespondence"` | |
566
- | `"uncategorised"` | |
567
- | `"designAccessStatement"` | |
568
- | `"plansDrawings"` | |
569
- | `"newPlansDrawings"` | |
570
- | `"planningObligation"` | |
571
- | `"ownershipCertificate"` | |
572
- | `"otherNewDocuments"` | |
573
- | `"statementCommonGround"` | |
574
- | `"communityInfrastructureLevy"` | |
575
- | `"supplementaryPlanning"` | |
576
- | `"otherRelevantPolicies"` | |
577
- | `"emergingPlan"` | |
578
- | `"developmentPlanPolicies"` | |
579
- | `"consultationResponses"` | |
580
- | `"eiaEnvironmentalStatement"` | |
581
- | `"eiaScreeningDirection"` | |
582
- | `"eiaScreeningOpinion"` | |
583
- | `"eiaScopingOpinion"` | |
584
- | `"definitiveMapStatement"` | |
585
- | `"treePreservationPlan"` | |
586
- | `"interestedPartyComment"` | |
587
- | `"lpaStatement"` | |
588
- | `"rule6Statement"` | |
589
- | `"appellantFinalComment"` | |
590
- | `"lpaFinalComment"` | |
591
- | `"appellantProofOfEvidence"` | |
592
- | `"appellantWitnessesEvidence"` | |
593
- | `"lpaProofOfEvidence"` | |
594
- | `"lpaWitnessesEvidence"` | |
595
- | `"rule6ProofOfEvidence"` | |
596
- | `"rule6WitnessesEvidence"` | |
597
- | `"environmentalAssessment"` | |
598
- | `"appealNotification"` | |
599
- | `"historicEnglandConsultation"` | |
600
- | `"conservationDocuments"` | |
601
- | `"planShowingExtentOfOrder"` | |
602
- | `"definitiveMapAndStatementExtract"` | |
603
- | `"stopNotice"` | |
604
- | `"article4Direction"` | |
605
- | `"enforcementList"` | |
606
- | `"localDevelopmentOrder"` | |
607
- | `"planningPermission"` | |
608
- | `"lpaEnforcementNotice"` | |
609
- | `"lpaEnforcementNoticePlan"` | |
610
- | `"lpaEnforcementNoticeWithdrawal"` | |
611
- | `"planningContraventionNotice"` | |
612
- | `"priorCorrespondenceWithPINS"` | |
613
- | `"enforcementNotice"` | |
614
- | `"enforcementNoticePlan"` | |
615
- | `"groundASupporting"` | |
616
- | `"groundBSupporting"` | |
617
- | `"groundCSupporting"` | |
618
- | `"groundDSupporting"` | |
619
- | `"groundESupporting"` | |
620
- | `"groundFSupporting"` | |
621
- | `"groundGSupporting"` | |
622
- | `"groundAFeeReceipt"` | |
623
- | `"delegatedReport"` | |
624
- | `"relatedApplications"` | |
625
- | `"otherRelevantMatters"` | |
626
- | `"groundHSupporting"` | |
627
- | `"groundISupporting"` | |
628
- | `"groundJSupporting"` | |
629
- | `"groundKSupporting"` | |
630
- | `"discontinuanceNotice"` | |
631
- | `null` | |
538
+ | Value | Explanation |
539
+ | :-------------------------------------- | :---------- |
540
+ | `"appellantCaseCorrespondence"` | |
541
+ | `"appellantCaseWithdrawalLetter"` | |
542
+ | `"appellantCostsApplication"` | |
543
+ | `"appellantCostsCorrespondence"` | |
544
+ | `"appellantCostsWithdrawal"` | |
545
+ | `"appellantStatement"` | |
546
+ | `"applicationDecisionLetter"` | |
547
+ | `"changedDescription"` | |
548
+ | `"originalApplicationForm"` | |
549
+ | `"whoNotified"` | |
550
+ | `"whoNotifiedSiteNotice"` | |
551
+ | `"whoNotifiedLetterToNeighbours"` | |
552
+ | `"whoNotifiedPressAdvert"` | |
553
+ | `"conservationMap"` | |
554
+ | `"lpaCaseCorrespondence"` | |
555
+ | `"lpaCostsApplication"` | |
556
+ | `"lpaCostsCorrespondence"` | |
557
+ | `"lpaCostsWithdrawal"` | |
558
+ | `"otherPartyRepresentations"` | |
559
+ | `"planningOfficerReport"` | |
560
+ | `"appellantCostsDecisionLetter"` | |
561
+ | `"lpaCostsDecisionLetter"` | |
562
+ | `"caseDecisionLetter"` | |
563
+ | `"crossTeamCorrespondence"` | |
564
+ | `"inspectorCorrespondence"` | |
565
+ | `"mainPartyCorrespondence"` | |
566
+ | `"uncategorised"` | |
567
+ | `"designAccessStatement"` | |
568
+ | `"plansDrawings"` | |
569
+ | `"newPlansDrawings"` | |
570
+ | `"planningObligation"` | |
571
+ | `"ownershipCertificate"` | |
572
+ | `"otherNewDocuments"` | |
573
+ | `"statementCommonGround"` | |
574
+ | `"communityInfrastructureLevy"` | |
575
+ | `"supplementaryPlanning"` | |
576
+ | `"otherRelevantPolicies"` | |
577
+ | `"emergingPlan"` | |
578
+ | `"developmentPlanPolicies"` | |
579
+ | `"consultationResponses"` | |
580
+ | `"eiaEnvironmentalStatement"` | |
581
+ | `"eiaScreeningDirection"` | |
582
+ | `"eiaScreeningOpinion"` | |
583
+ | `"eiaScopingOpinion"` | |
584
+ | `"definitiveMapStatement"` | |
585
+ | `"treePreservationPlan"` | |
586
+ | `"interestedPartyComment"` | |
587
+ | `"lpaStatement"` | |
588
+ | `"rule6Statement"` | |
589
+ | `"appellantFinalComment"` | |
590
+ | `"lpaFinalComment"` | |
591
+ | `"appellantProofOfEvidence"` | |
592
+ | `"appellantWitnessesEvidence"` | |
593
+ | `"lpaProofOfEvidence"` | |
594
+ | `"lpaWitnessesEvidence"` | |
595
+ | `"rule6ProofOfEvidence"` | |
596
+ | `"rule6WitnessesEvidence"` | |
597
+ | `"environmentalAssessment"` | |
598
+ | `"appealNotification"` | |
599
+ | `"historicEnglandConsultation"` | |
600
+ | `"conservationDocuments"` | |
601
+ | `"planShowingExtentOfOrder"` | |
602
+ | `"definitiveMapAndStatementExtract"` | |
603
+ | `"stopNotice"` | |
604
+ | `"article4Direction"` | |
605
+ | `"enforcementList"` | |
606
+ | `"localDevelopmentOrder"` | |
607
+ | `"planningPermission"` | |
608
+ | `"lpaEnforcementNotice"` | |
609
+ | `"lpaEnforcementNoticePlan"` | |
610
+ | `"lpaEnforcementNoticeWithdrawal"` | |
611
+ | `"planningContraventionNotice"` | |
612
+ | `"priorCorrespondenceWithPINS"` | |
613
+ | `"enforcementNotice"` | |
614
+ | `"enforcementNoticePlan"` | |
615
+ | `"groundASupporting"` | |
616
+ | `"groundBSupporting"` | |
617
+ | `"groundCSupporting"` | |
618
+ | `"groundDSupporting"` | |
619
+ | `"groundESupporting"` | |
620
+ | `"groundFSupporting"` | |
621
+ | `"groundGSupporting"` | |
622
+ | `"groundAFeeReceipt"` | |
623
+ | `"delegatedReport"` | |
624
+ | `"relatedApplications"` | |
625
+ | `"otherRelevantMatters"` | |
626
+ | `"groundHSupporting"` | |
627
+ | `"groundISupporting"` | |
628
+ | `"groundJSupporting"` | |
629
+ | `"groundKSupporting"` | |
630
+ | `"discontinuanceNotice"` | |
631
+ | `"otherSupportingInformationAppellant"` | |
632
+ | `"eiaEnvironmentalStatementAppellant"` | |
633
+ | `null` | |
632
634
 
633
635
  ## sourceSystem
634
636
 
package/docs/appeal-s78-definitions-significantchangesaffectingapplication.md ADDED
@@ -0,0 +1,14 @@
1
+ ## SignificantChangesAffectingApplication Type
2
+
3
+ `string`
4
+
5
+ ## SignificantChangesAffectingApplication Constraints
6
+
7
+ **enum**: the value of this property must be equal to one of the following values:
8
+
9
+ | Value | Explanation |
10
+ | :--------------------------- | :---------- |
11
+ | `"adopted-a-new-local-plan"` | |
12
+ | `"national-policy-change"` | |
13
+ | `"court-judgement"` | |
14
+ | `"other"` | |
package/docs/appeal-s78-definitions.md ADDED
@@ -0,0 +1,3 @@
1
+ ## definitions Type
2
+
3
+ unknown