@planning-inspectorate/data-model 2.27.0 → 2.28.0

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 (33) hide show
  1. package/.azure/ci.yml +1 -1
  2. package/docs/appeal-document.md +1 -0
  3. package/package.json +1 -1
  4. package/pins_data_model/models/model_appeal_document.py +2 -1
  5. package/pins_data_model/models/model_appeal_event.py +1 -1
  6. package/pins_data_model/models/model_appeal_event_estimate.py +1 -1
  7. package/pins_data_model/models/model_appeal_has.py +1 -1
  8. package/pins_data_model/models/model_appeal_representation.py +1 -1
  9. package/pins_data_model/models/model_appeal_s78.py +1 -1
  10. package/pins_data_model/models/model_dart_response.py +1 -1
  11. package/pins_data_model/models/model_entraid.py +1 -1
  12. package/pins_data_model/models/model_folder.py +1 -1
  13. package/pins_data_model/models/model_gettimesheets_response.py +1 -1
  14. package/pins_data_model/models/model_listed_building.py +1 -1
  15. package/pins_data_model/models/model_listed_buildings.py +1 -1
  16. package/pins_data_model/models/model_nsip_document.py +1 -1
  17. package/pins_data_model/models/model_nsip_exam_timetable.py +1 -1
  18. package/pins_data_model/models/model_nsip_invoice.py +1 -1
  19. package/pins_data_model/models/model_nsip_meeting.py +1 -1
  20. package/pins_data_model/models/model_nsip_project.py +1 -1
  21. package/pins_data_model/models/model_nsip_project_update.py +1 -1
  22. package/pins_data_model/models/model_nsip_representation.py +1 -1
  23. package/pins_data_model/models/model_nsip_subscription.py +1 -1
  24. package/pins_data_model/models/model_pins_inspector.py +1 -1
  25. package/pins_data_model/models/model_pins_lpa.py +1 -1
  26. package/pins_data_model/models/model_s51_advice.py +1 -1
  27. package/pins_data_model/models/model_service_user.py +1 -1
  28. package/schemas/appeal-document.schema.json +1 -0
  29. package/src/enums.cjs +1 -0
  30. package/src/enums.d.ts +1 -0
  31. package/src/enums.js +1 -0
  32. package/src/index.cjs +1 -0
  33. package/src/schemas.d.ts +1 -0
package/.azure/ci.yml CHANGED
@@ -16,7 +16,7 @@ resources:
16
16
  type: github
17
17
  endpoint: Planning-Inspectorate
18
18
  name: Planning-Inspectorate/common-pipeline-templates
19
- ref: refs/tags/release/3.24.2
19
+ ref: refs/tags/release/3.25.2
20
20
 
21
21
  extends:
22
22
  template: stages/wrapper_ci.yml@templates
@@ -626,6 +626,7 @@ The type of document, used for exchange, migrations and consumption from the app
626
626
  | `"groundISupporting"` | |
627
627
  | `"groundJSupporting"` | |
628
628
  | `"groundKSupporting"` | |
629
+ | `"lpaEnforcementNoticeWithdrawal"` | |
629
630
  | `null` | |
630
631
 
631
632
  ## sourceSystem
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@planning-inspectorate/data-model",
3
- "version": "2.27.0",
3
+ "version": "2.28.0",
4
4
  "description": "JSON Schemas for the Planning Inspectorate's Data Model",
5
5
  "main": "src/index.js",
6
6
  "type": "module",
@@ -1,6 +1,6 @@
1
1
  # generated by datamodel-codegen:
2
2
  # filename: appeal-document.schema.json
3
- # timestamp: 2026-03-02T10:53:29+00:00
3
+ # timestamp: 2026-03-03T17:10:31+00:00
4
4
 
5
5
  from __future__ import annotations
6
6
 
@@ -148,6 +148,7 @@ class DocumentType(Enum):
148
148
  groundISupporting = "groundISupporting"
149
149
  groundJSupporting = "groundJSupporting"
150
150
  groundKSupporting = "groundKSupporting"
151
+ lpaEnforcementNoticeWithdrawal = "lpaEnforcementNoticeWithdrawal"
151
152
  NoneType_None = None
152
153
 
153
154
 
@@ -1,6 +1,6 @@
1
1
  # generated by datamodel-codegen:
2
2
  # filename: appeal-event.schema.json
3
- # timestamp: 2026-03-02T10:53:30+00:00
3
+ # timestamp: 2026-03-03T17:10:30+00:00
4
4
 
5
5
  from __future__ import annotations
6
6
 
@@ -1,6 +1,6 @@
1
1
  # generated by datamodel-codegen:
2
2
  # filename: appeal-event-estimate.schema.json
3
- # timestamp: 2026-03-02T10:53:30+00:00
3
+ # timestamp: 2026-03-03T17:10:30+00:00
4
4
 
5
5
  from __future__ import annotations
6
6
 
@@ -1,6 +1,6 @@
1
1
  # generated by datamodel-codegen:
2
2
  # filename: appeal-has.schema.json
3
- # timestamp: 2026-03-02T10:53:30+00:00
3
+ # timestamp: 2026-03-03T17:10:30+00:00
4
4
 
5
5
  from __future__ import annotations
6
6
 
@@ -1,6 +1,6 @@
1
1
  # generated by datamodel-codegen:
2
2
  # filename: appeal-representation.schema.json
3
- # timestamp: 2026-03-02T10:53:30+00:00
3
+ # timestamp: 2026-03-03T17:10:30+00:00
4
4
 
5
5
  from __future__ import annotations
6
6
 
@@ -1,6 +1,6 @@
1
1
  # generated by datamodel-codegen:
2
2
  # filename: appeal-s78.schema.json
3
- # timestamp: 2026-03-02T10:53:30+00:00
3
+ # timestamp: 2026-03-03T17:10:31+00:00
4
4
 
5
5
  from __future__ import annotations
6
6
 
@@ -1,6 +1,6 @@
1
1
  # generated by datamodel-codegen:
2
2
  # filename: dart-response.schema.json
3
- # timestamp: 2026-03-02T10:53:30+00:00
3
+ # timestamp: 2026-03-03T17:10:30+00:00
4
4
 
5
5
  from __future__ import annotations
6
6
 
@@ -1,6 +1,6 @@
1
1
  # generated by datamodel-codegen:
2
2
  # filename: entraid.schema.json
3
- # timestamp: 2026-03-02T10:53:30+00:00
3
+ # timestamp: 2026-03-03T17:10:30+00:00
4
4
 
5
5
  from __future__ import annotations
6
6
 
@@ -1,6 +1,6 @@
1
1
  # generated by datamodel-codegen:
2
2
  # filename: folder.schema.json
3
- # timestamp: 2026-03-02T10:53:30+00:00
3
+ # timestamp: 2026-03-03T17:10:30+00:00
4
4
 
5
5
  from __future__ import annotations
6
6
 
@@ -1,6 +1,6 @@
1
1
  # generated by datamodel-codegen:
2
2
  # filename: gettimesheets-response.schema.json
3
- # timestamp: 2026-03-02T10:53:30+00:00
3
+ # timestamp: 2026-03-03T17:10:30+00:00
4
4
 
5
5
  from __future__ import annotations
6
6
 
@@ -1,6 +1,6 @@
1
1
  # generated by datamodel-codegen:
2
2
  # filename: listed-building.schema.json
3
- # timestamp: 2026-03-02T10:53:30+00:00
3
+ # timestamp: 2026-03-03T17:10:30+00:00
4
4
 
5
5
  from __future__ import annotations
6
6
 
@@ -1,6 +1,6 @@
1
1
  # generated by datamodel-codegen:
2
2
  # filename: listed-buildings.schema.json
3
- # timestamp: 2026-03-02T10:53:30+00:00
3
+ # timestamp: 2026-03-03T17:10:31+00:00
4
4
 
5
5
  from __future__ import annotations
6
6
 
@@ -1,6 +1,6 @@
1
1
  # generated by datamodel-codegen:
2
2
  # filename: nsip-document.schema.json
3
- # timestamp: 2026-03-02T10:53:30+00:00
3
+ # timestamp: 2026-03-03T17:10:30+00:00
4
4
 
5
5
  from __future__ import annotations
6
6
 
@@ -1,6 +1,6 @@
1
1
  # generated by datamodel-codegen:
2
2
  # filename: nsip-exam-timetable.schema.json
3
- # timestamp: 2026-03-02T10:53:30+00:00
3
+ # timestamp: 2026-03-03T17:10:31+00:00
4
4
 
5
5
  from __future__ import annotations
6
6
 
@@ -1,6 +1,6 @@
1
1
  # generated by datamodel-codegen:
2
2
  # filename: nsip-invoice.schema.json
3
- # timestamp: 2026-03-02T10:53:30+00:00
3
+ # timestamp: 2026-03-03T17:10:30+00:00
4
4
 
5
5
  from __future__ import annotations
6
6
 
@@ -1,6 +1,6 @@
1
1
  # generated by datamodel-codegen:
2
2
  # filename: nsip-meeting.schema.json
3
- # timestamp: 2026-03-02T10:53:31+00:00
3
+ # timestamp: 2026-03-03T17:10:30+00:00
4
4
 
5
5
  from __future__ import annotations
6
6
 
@@ -1,6 +1,6 @@
1
1
  # generated by datamodel-codegen:
2
2
  # filename: nsip-project.schema.json
3
- # timestamp: 2026-03-02T10:53:31+00:00
3
+ # timestamp: 2026-03-03T17:10:30+00:00
4
4
 
5
5
  from __future__ import annotations
6
6
 
@@ -1,6 +1,6 @@
1
1
  # generated by datamodel-codegen:
2
2
  # filename: nsip-project-update.schema.json
3
- # timestamp: 2026-03-02T10:53:31+00:00
3
+ # timestamp: 2026-03-03T17:10:30+00:00
4
4
 
5
5
  from __future__ import annotations
6
6
 
@@ -1,6 +1,6 @@
1
1
  # generated by datamodel-codegen:
2
2
  # filename: nsip-representation.schema.json
3
- # timestamp: 2026-03-02T10:53:31+00:00
3
+ # timestamp: 2026-03-03T17:10:31+00:00
4
4
 
5
5
  from __future__ import annotations
6
6
 
@@ -1,6 +1,6 @@
1
1
  # generated by datamodel-codegen:
2
2
  # filename: nsip-subscription.schema.json
3
- # timestamp: 2026-03-02T10:53:31+00:00
3
+ # timestamp: 2026-03-03T17:10:30+00:00
4
4
 
5
5
  from __future__ import annotations
6
6
 
@@ -1,6 +1,6 @@
1
1
  # generated by datamodel-codegen:
2
2
  # filename: pins-inspector.schema.json
3
- # timestamp: 2026-03-02T10:53:31+00:00
3
+ # timestamp: 2026-03-03T17:10:30+00:00
4
4
 
5
5
  from __future__ import annotations
6
6
 
@@ -1,6 +1,6 @@
1
1
  # generated by datamodel-codegen:
2
2
  # filename: pins-lpa.schema.json
3
- # timestamp: 2026-03-02T10:53:31+00:00
3
+ # timestamp: 2026-03-03T17:10:30+00:00
4
4
 
5
5
  from __future__ import annotations
6
6
 
@@ -1,6 +1,6 @@
1
1
  # generated by datamodel-codegen:
2
2
  # filename: s51-advice.schema.json
3
- # timestamp: 2026-03-02T10:53:31+00:00
3
+ # timestamp: 2026-03-03T17:10:30+00:00
4
4
 
5
5
  from __future__ import annotations
6
6
 
@@ -1,6 +1,6 @@
1
1
  # generated by datamodel-codegen:
2
2
  # filename: service-user.schema.json
3
- # timestamp: 2026-03-02T10:53:31+00:00
3
+ # timestamp: 2026-03-03T17:10:30+00:00
4
4
 
5
5
  from __future__ import annotations
6
6
 
@@ -226,6 +226,7 @@
226
226
  "groundISupporting",
227
227
  "groundJSupporting",
228
228
  "groundKSupporting",
229
+ "lpaEnforcementNoticeWithdrawal",
229
230
  null
230
231
  ],
231
232
  "description": "The type of document, used for exchange, migrations and consumption from the appeal back-office system"
package/src/enums.cjs CHANGED
@@ -220,6 +220,7 @@ const APPEAL_DOCUMENT_TYPE = Object.freeze({
220
220
  LPA_COSTS_WITHDRAWAL: 'lpaCostsWithdrawal',
221
221
  LPA_ENFORCEMENT_NOTICE: 'lpaEnforcementNotice',
222
222
  LPA_ENFORCEMENT_NOTICE_PLAN: 'lpaEnforcementNoticePlan',
223
+ LPA_ENFORCEMENT_NOTICE_WITHDRAWAL: 'lpaEnforcementNoticeWithdrawal',
223
224
  LPA_FINAL_COMMENT: 'lpaFinalComment',
224
225
  LPA_PROOF_OF_EVIDENCE: 'lpaProofOfEvidence',
225
226
  LPA_STATEMENT: 'lpaStatement',
package/src/enums.d.ts CHANGED
@@ -218,6 +218,7 @@ export const APPEAL_DOCUMENT_TYPE = {
218
218
  LPA_COSTS_WITHDRAWAL: 'lpaCostsWithdrawal',
219
219
  LPA_ENFORCEMENT_NOTICE: 'lpaEnforcementNotice',
220
220
  LPA_ENFORCEMENT_NOTICE_PLAN: 'lpaEnforcementNoticePlan',
221
+ LPA_ENFORCEMENT_NOTICE_WITHDRAWAL: 'lpaEnforcementNoticeWithdrawal',
221
222
  LPA_FINAL_COMMENT: 'lpaFinalComment',
222
223
  LPA_PROOF_OF_EVIDENCE: 'lpaProofOfEvidence',
223
224
  LPA_STATEMENT: 'lpaStatement',
package/src/enums.js CHANGED
@@ -218,6 +218,7 @@ export const APPEAL_DOCUMENT_TYPE = Object.freeze({
218
218
  LPA_COSTS_WITHDRAWAL: 'lpaCostsWithdrawal',
219
219
  LPA_ENFORCEMENT_NOTICE: 'lpaEnforcementNotice',
220
220
  LPA_ENFORCEMENT_NOTICE_PLAN: 'lpaEnforcementNoticePlan',
221
+ LPA_ENFORCEMENT_NOTICE_WITHDRAWAL: 'lpaEnforcementNoticeWithdrawal',
221
222
  LPA_FINAL_COMMENT: 'lpaFinalComment',
222
223
  LPA_PROOF_OF_EVIDENCE: 'lpaProofOfEvidence',
223
224
  LPA_STATEMENT: 'lpaStatement',
package/src/index.cjs CHANGED
@@ -301,6 +301,7 @@ const APPEAL_DOCUMENT_TYPE = Object.freeze({
301
301
  LPA_COSTS_WITHDRAWAL: 'lpaCostsWithdrawal',
302
302
  LPA_ENFORCEMENT_NOTICE: 'lpaEnforcementNotice',
303
303
  LPA_ENFORCEMENT_NOTICE_PLAN: 'lpaEnforcementNoticePlan',
304
+ LPA_ENFORCEMENT_NOTICE_WITHDRAWAL: 'lpaEnforcementNoticeWithdrawal',
304
305
  LPA_FINAL_COMMENT: 'lpaFinalComment',
305
306
  LPA_PROOF_OF_EVIDENCE: 'lpaProofOfEvidence',
306
307
  LPA_STATEMENT: 'lpaStatement',
package/src/schemas.d.ts CHANGED
@@ -174,6 +174,7 @@ export interface AppealDocument {
174
174
  | 'groundISupporting'
175
175
  | 'groundJSupporting'
176
176
  | 'groundKSupporting'
177
+ | 'lpaEnforcementNoticeWithdrawal'
177
178
  | null;
178
179
  /**
179
180
  * The system mastering the metadata for the current document