@planning-inspectorate/data-model 2.28.1 → 2.29.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 (32) hide show
  1. package/docs/appeal-document.md +2 -0
  2. package/package.json +1 -1
  3. package/pins_data_model/models/model_appeal_document.py +3 -1
  4. package/pins_data_model/models/model_appeal_event.py +1 -1
  5. package/pins_data_model/models/model_appeal_event_estimate.py +1 -1
  6. package/pins_data_model/models/model_appeal_has.py +1 -1
  7. package/pins_data_model/models/model_appeal_representation.py +1 -1
  8. package/pins_data_model/models/model_appeal_s78.py +1 -1
  9. package/pins_data_model/models/model_dart_response.py +1 -1
  10. package/pins_data_model/models/model_entraid.py +1 -1
  11. package/pins_data_model/models/model_folder.py +1 -1
  12. package/pins_data_model/models/model_gettimesheets_response.py +1 -1
  13. package/pins_data_model/models/model_listed_building.py +1 -1
  14. package/pins_data_model/models/model_listed_buildings.py +1 -1
  15. package/pins_data_model/models/model_nsip_document.py +1 -1
  16. package/pins_data_model/models/model_nsip_exam_timetable.py +1 -1
  17. package/pins_data_model/models/model_nsip_invoice.py +1 -1
  18. package/pins_data_model/models/model_nsip_meeting.py +1 -1
  19. package/pins_data_model/models/model_nsip_project.py +1 -1
  20. package/pins_data_model/models/model_nsip_project_update.py +1 -1
  21. package/pins_data_model/models/model_nsip_representation.py +1 -1
  22. package/pins_data_model/models/model_nsip_subscription.py +1 -1
  23. package/pins_data_model/models/model_pins_inspector.py +1 -1
  24. package/pins_data_model/models/model_pins_lpa.py +1 -1
  25. package/pins_data_model/models/model_s51_advice.py +1 -1
  26. package/pins_data_model/models/model_service_user.py +1 -1
  27. package/schemas/appeal-document.schema.json +2 -0
  28. package/src/enums.cjs +2 -0
  29. package/src/enums.d.ts +2 -0
  30. package/src/enums.js +2 -0
  31. package/src/index.cjs +2 -0
  32. package/src/schemas.d.ts +2 -0
package/docs/appeal-document.md CHANGED
@@ -607,6 +607,7 @@ The type of document, used for exchange, migrations and consumption from the app
607
607
  | `"planningPermission"` | |
608
608
  | `"lpaEnforcementNotice"` | |
609
609
  | `"lpaEnforcementNoticePlan"` | |
610
+ | `"lpaEnforcementNoticeWithdrawal"` | |
610
611
  | `"planningContraventionNotice"` | |
611
612
  | `"priorCorrespondenceWithPINS"` | |
612
613
  | `"enforcementNotice"` | |
@@ -778,6 +779,7 @@ The stage in the appeal process that has created the document
778
779
  | `"appeal-decision"` | |
779
780
  | `"costs"` | |
780
781
  | `"internal"` | |
782
+ | `"cancellation"` | |
781
783
  | `null` | |
782
784
 
783
785
  ## horizonFolderId
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@planning-inspectorate/data-model",
3
- "version": "2.28.1",
3
+ "version": "2.29.0",
4
4
  "description": "JSON Schemas for the Planning Inspectorate's Data Model",
5
5
  "main": "src/index.js",
6
6
  "type": "module",
package/pins_data_model/models/model_appeal_document.py CHANGED
@@ -1,6 +1,6 @@
1
1
  # generated by datamodel-codegen:
2
2
  # filename: appeal-document.schema.json
3
- # timestamp: 2026-03-05T13:03:23+00:00
3
+ # timestamp: 2026-03-06T13:54:17+00:00
4
4
 
5
5
  from __future__ import annotations
6
6
 
@@ -129,6 +129,7 @@ class DocumentType(Enum):
129
129
  planningPermission = "planningPermission"
130
130
  lpaEnforcementNotice = "lpaEnforcementNotice"
131
131
  lpaEnforcementNoticePlan = "lpaEnforcementNoticePlan"
132
+ lpaEnforcementNoticeWithdrawal = "lpaEnforcementNoticeWithdrawal"
132
133
  planningContraventionNotice = "planningContraventionNotice"
133
134
  priorCorrespondenceWithPINS = "priorCorrespondenceWithPINS"
134
135
  enforcementNotice = "enforcementNotice"
@@ -190,6 +191,7 @@ class CaseStage(Enum):
190
191
  appeal_decision = "appeal-decision"
191
192
  costs = "costs"
192
193
  internal = "internal"
194
+ cancellation = "cancellation"
193
195
  NoneType_None = None
194
196
 
195
197
 
package/pins_data_model/models/model_appeal_event.py CHANGED
@@ -1,6 +1,6 @@
1
1
  # generated by datamodel-codegen:
2
2
  # filename: appeal-event.schema.json
3
- # timestamp: 2026-03-05T13:03:22+00:00
3
+ # timestamp: 2026-03-06T13:54:17+00:00
4
4
 
5
5
  from __future__ import annotations
6
6
 
package/pins_data_model/models/model_appeal_event_estimate.py CHANGED
@@ -1,6 +1,6 @@
1
1
  # generated by datamodel-codegen:
2
2
  # filename: appeal-event-estimate.schema.json
3
- # timestamp: 2026-03-05T13:03:22+00:00
3
+ # timestamp: 2026-03-06T13:54:17+00:00
4
4
 
5
5
  from __future__ import annotations
6
6
 
package/pins_data_model/models/model_appeal_has.py CHANGED
@@ -1,6 +1,6 @@
1
1
  # generated by datamodel-codegen:
2
2
  # filename: appeal-has.schema.json
3
- # timestamp: 2026-03-05T13:03:22+00:00
3
+ # timestamp: 2026-03-06T13:54:17+00:00
4
4
 
5
5
  from __future__ import annotations
6
6
 
package/pins_data_model/models/model_appeal_representation.py CHANGED
@@ -1,6 +1,6 @@
1
1
  # generated by datamodel-codegen:
2
2
  # filename: appeal-representation.schema.json
3
- # timestamp: 2026-03-05T13:03:22+00:00
3
+ # timestamp: 2026-03-06T13:54:17+00:00
4
4
 
5
5
  from __future__ import annotations
6
6
 
package/pins_data_model/models/model_appeal_s78.py CHANGED
@@ -1,6 +1,6 @@
1
1
  # generated by datamodel-codegen:
2
2
  # filename: appeal-s78.schema.json
3
- # timestamp: 2026-03-05T13:03:23+00:00
3
+ # timestamp: 2026-03-06T13:54:17+00:00
4
4
 
5
5
  from __future__ import annotations
6
6
 
package/pins_data_model/models/model_dart_response.py CHANGED
@@ -1,6 +1,6 @@
1
1
  # generated by datamodel-codegen:
2
2
  # filename: dart-response.schema.json
3
- # timestamp: 2026-03-05T13:03:22+00:00
3
+ # timestamp: 2026-03-06T13:54:17+00:00
4
4
 
5
5
  from __future__ import annotations
6
6
 
package/pins_data_model/models/model_entraid.py CHANGED
@@ -1,6 +1,6 @@
1
1
  # generated by datamodel-codegen:
2
2
  # filename: entraid.schema.json
3
- # timestamp: 2026-03-05T13:03:22+00:00
3
+ # timestamp: 2026-03-06T13:54:17+00:00
4
4
 
5
5
  from __future__ import annotations
6
6
 
package/pins_data_model/models/model_folder.py CHANGED
@@ -1,6 +1,6 @@
1
1
  # generated by datamodel-codegen:
2
2
  # filename: folder.schema.json
3
- # timestamp: 2026-03-05T13:03:22+00:00
3
+ # timestamp: 2026-03-06T13:54:17+00:00
4
4
 
5
5
  from __future__ import annotations
6
6
 
package/pins_data_model/models/model_gettimesheets_response.py CHANGED
@@ -1,6 +1,6 @@
1
1
  # generated by datamodel-codegen:
2
2
  # filename: gettimesheets-response.schema.json
3
- # timestamp: 2026-03-05T13:03:22+00:00
3
+ # timestamp: 2026-03-06T13:54:17+00:00
4
4
 
5
5
  from __future__ import annotations
6
6
 
package/pins_data_model/models/model_listed_building.py CHANGED
@@ -1,6 +1,6 @@
1
1
  # generated by datamodel-codegen:
2
2
  # filename: listed-building.schema.json
3
- # timestamp: 2026-03-05T13:03:22+00:00
3
+ # timestamp: 2026-03-06T13:54:17+00:00
4
4
 
5
5
  from __future__ import annotations
6
6
 
package/pins_data_model/models/model_listed_buildings.py CHANGED
@@ -1,6 +1,6 @@
1
1
  # generated by datamodel-codegen:
2
2
  # filename: listed-buildings.schema.json
3
- # timestamp: 2026-03-05T13:03:23+00:00
3
+ # timestamp: 2026-03-06T13:54:17+00:00
4
4
 
5
5
  from __future__ import annotations
6
6
 
package/pins_data_model/models/model_nsip_document.py CHANGED
@@ -1,6 +1,6 @@
1
1
  # generated by datamodel-codegen:
2
2
  # filename: nsip-document.schema.json
3
- # timestamp: 2026-03-05T13:03:22+00:00
3
+ # timestamp: 2026-03-06T13:54:17+00:00
4
4
 
5
5
  from __future__ import annotations
6
6
 
package/pins_data_model/models/model_nsip_exam_timetable.py CHANGED
@@ -1,6 +1,6 @@
1
1
  # generated by datamodel-codegen:
2
2
  # filename: nsip-exam-timetable.schema.json
3
- # timestamp: 2026-03-05T13:03:23+00:00
3
+ # timestamp: 2026-03-06T13:54:17+00:00
4
4
 
5
5
  from __future__ import annotations
6
6
 
package/pins_data_model/models/model_nsip_invoice.py CHANGED
@@ -1,6 +1,6 @@
1
1
  # generated by datamodel-codegen:
2
2
  # filename: nsip-invoice.schema.json
3
- # timestamp: 2026-03-05T13:03:22+00:00
3
+ # timestamp: 2026-03-06T13:54:17+00:00
4
4
 
5
5
  from __future__ import annotations
6
6
 
package/pins_data_model/models/model_nsip_meeting.py CHANGED
@@ -1,6 +1,6 @@
1
1
  # generated by datamodel-codegen:
2
2
  # filename: nsip-meeting.schema.json
3
- # timestamp: 2026-03-05T13:03:22+00:00
3
+ # timestamp: 2026-03-06T13:54:17+00:00
4
4
 
5
5
  from __future__ import annotations
6
6
 
package/pins_data_model/models/model_nsip_project.py CHANGED
@@ -1,6 +1,6 @@
1
1
  # generated by datamodel-codegen:
2
2
  # filename: nsip-project.schema.json
3
- # timestamp: 2026-03-05T13:03:22+00:00
3
+ # timestamp: 2026-03-06T13:54:17+00:00
4
4
 
5
5
  from __future__ import annotations
6
6
 
package/pins_data_model/models/model_nsip_project_update.py CHANGED
@@ -1,6 +1,6 @@
1
1
  # generated by datamodel-codegen:
2
2
  # filename: nsip-project-update.schema.json
3
- # timestamp: 2026-03-05T13:03:22+00:00
3
+ # timestamp: 2026-03-06T13:54:17+00:00
4
4
 
5
5
  from __future__ import annotations
6
6
 
package/pins_data_model/models/model_nsip_representation.py CHANGED
@@ -1,6 +1,6 @@
1
1
  # generated by datamodel-codegen:
2
2
  # filename: nsip-representation.schema.json
3
- # timestamp: 2026-03-05T13:03:23+00:00
3
+ # timestamp: 2026-03-06T13:54:17+00:00
4
4
 
5
5
  from __future__ import annotations
6
6
 
package/pins_data_model/models/model_nsip_subscription.py CHANGED
@@ -1,6 +1,6 @@
1
1
  # generated by datamodel-codegen:
2
2
  # filename: nsip-subscription.schema.json
3
- # timestamp: 2026-03-05T13:03:22+00:00
3
+ # timestamp: 2026-03-06T13:54:17+00:00
4
4
 
5
5
  from __future__ import annotations
6
6
 
package/pins_data_model/models/model_pins_inspector.py CHANGED
@@ -1,6 +1,6 @@
1
1
  # generated by datamodel-codegen:
2
2
  # filename: pins-inspector.schema.json
3
- # timestamp: 2026-03-05T13:03:22+00:00
3
+ # timestamp: 2026-03-06T13:54:17+00:00
4
4
 
5
5
  from __future__ import annotations
6
6
 
package/pins_data_model/models/model_pins_lpa.py CHANGED
@@ -1,6 +1,6 @@
1
1
  # generated by datamodel-codegen:
2
2
  # filename: pins-lpa.schema.json
3
- # timestamp: 2026-03-05T13:03:22+00:00
3
+ # timestamp: 2026-03-06T13:54:17+00:00
4
4
 
5
5
  from __future__ import annotations
6
6
 
package/pins_data_model/models/model_s51_advice.py CHANGED
@@ -1,6 +1,6 @@
1
1
  # generated by datamodel-codegen:
2
2
  # filename: s51-advice.schema.json
3
- # timestamp: 2026-03-05T13:03:22+00:00
3
+ # timestamp: 2026-03-06T13:54:17+00:00
4
4
 
5
5
  from __future__ import annotations
6
6
 
package/pins_data_model/models/model_service_user.py CHANGED
@@ -1,6 +1,6 @@
1
1
  # generated by datamodel-codegen:
2
2
  # filename: service-user.schema.json
3
- # timestamp: 2026-03-05T13:03:22+00:00
3
+ # timestamp: 2026-03-06T13:54:17+00:00
4
4
 
5
5
  from __future__ import annotations
6
6
 
package/schemas/appeal-document.schema.json CHANGED
@@ -207,6 +207,7 @@
207
207
  "planningPermission",
208
208
  "lpaEnforcementNotice",
209
209
  "lpaEnforcementNoticePlan",
210
+ "lpaEnforcementNoticeWithdrawal",
210
211
  "planningContraventionNotice",
211
212
  "priorCorrespondenceWithPINS",
212
213
  "enforcementNotice",
@@ -265,6 +266,7 @@
265
266
  "appeal-decision",
266
267
  "costs",
267
268
  "internal",
269
+ "cancellation",
268
270
  null
269
271
  ],
270
272
  "description": "The stage in the appeal process that has created the document",
package/src/enums.cjs CHANGED
@@ -90,6 +90,7 @@ const APPEAL_CASE_PROCEDURE = Object.freeze({
90
90
  const APPEAL_CASE_STAGE = Object.freeze({
91
91
  APPEAL_DECISION: 'appeal-decision',
92
92
  APPELLANT_CASE: 'appellant-case',
93
+ CANCELLATION: 'cancellation',
93
94
  COSTS: 'costs',
94
95
  EVIDENCE: 'evidence',
95
96
  FINAL_COMMENTS: 'final-comments',
@@ -220,6 +221,7 @@ const APPEAL_DOCUMENT_TYPE = Object.freeze({
220
221
  LPA_COSTS_WITHDRAWAL: 'lpaCostsWithdrawal',
221
222
  LPA_ENFORCEMENT_NOTICE: 'lpaEnforcementNotice',
222
223
  LPA_ENFORCEMENT_NOTICE_PLAN: 'lpaEnforcementNoticePlan',
224
+ LPA_ENFORCEMENT_NOTICE_WITHDRAWAL: 'lpaEnforcementNoticeWithdrawal',
223
225
  LPA_FINAL_COMMENT: 'lpaFinalComment',
224
226
  LPA_PROOF_OF_EVIDENCE: 'lpaProofOfEvidence',
225
227
  LPA_STATEMENT: 'lpaStatement',
package/src/enums.d.ts CHANGED
@@ -88,6 +88,7 @@ export const APPEAL_CASE_PROCEDURE = {
88
88
  export const APPEAL_CASE_STAGE = {
89
89
  APPEAL_DECISION: 'appeal-decision',
90
90
  APPELLANT_CASE: 'appellant-case',
91
+ CANCELLATION: 'cancellation',
91
92
  COSTS: 'costs',
92
93
  EVIDENCE: 'evidence',
93
94
  FINAL_COMMENTS: 'final-comments',
@@ -218,6 +219,7 @@ export const APPEAL_DOCUMENT_TYPE = {
218
219
  LPA_COSTS_WITHDRAWAL: 'lpaCostsWithdrawal',
219
220
  LPA_ENFORCEMENT_NOTICE: 'lpaEnforcementNotice',
220
221
  LPA_ENFORCEMENT_NOTICE_PLAN: 'lpaEnforcementNoticePlan',
222
+ LPA_ENFORCEMENT_NOTICE_WITHDRAWAL: 'lpaEnforcementNoticeWithdrawal',
221
223
  LPA_FINAL_COMMENT: 'lpaFinalComment',
222
224
  LPA_PROOF_OF_EVIDENCE: 'lpaProofOfEvidence',
223
225
  LPA_STATEMENT: 'lpaStatement',
package/src/enums.js CHANGED
@@ -88,6 +88,7 @@ export const APPEAL_CASE_PROCEDURE = Object.freeze({
88
88
  export const APPEAL_CASE_STAGE = Object.freeze({
89
89
  APPEAL_DECISION: 'appeal-decision',
90
90
  APPELLANT_CASE: 'appellant-case',
91
+ CANCELLATION: 'cancellation',
91
92
  COSTS: 'costs',
92
93
  EVIDENCE: 'evidence',
93
94
  FINAL_COMMENTS: 'final-comments',
@@ -218,6 +219,7 @@ export const APPEAL_DOCUMENT_TYPE = Object.freeze({
218
219
  LPA_COSTS_WITHDRAWAL: 'lpaCostsWithdrawal',
219
220
  LPA_ENFORCEMENT_NOTICE: 'lpaEnforcementNotice',
220
221
  LPA_ENFORCEMENT_NOTICE_PLAN: 'lpaEnforcementNoticePlan',
222
+ LPA_ENFORCEMENT_NOTICE_WITHDRAWAL: 'lpaEnforcementNoticeWithdrawal',
221
223
  LPA_FINAL_COMMENT: 'lpaFinalComment',
222
224
  LPA_PROOF_OF_EVIDENCE: 'lpaProofOfEvidence',
223
225
  LPA_STATEMENT: 'lpaStatement',
package/src/index.cjs CHANGED
@@ -171,6 +171,7 @@ const APPEAL_CASE_PROCEDURE = Object.freeze({
171
171
  const APPEAL_CASE_STAGE = Object.freeze({
172
172
  APPEAL_DECISION: 'appeal-decision',
173
173
  APPELLANT_CASE: 'appellant-case',
174
+ CANCELLATION: 'cancellation',
174
175
  COSTS: 'costs',
175
176
  EVIDENCE: 'evidence',
176
177
  FINAL_COMMENTS: 'final-comments',
@@ -301,6 +302,7 @@ const APPEAL_DOCUMENT_TYPE = Object.freeze({
301
302
  LPA_COSTS_WITHDRAWAL: 'lpaCostsWithdrawal',
302
303
  LPA_ENFORCEMENT_NOTICE: 'lpaEnforcementNotice',
303
304
  LPA_ENFORCEMENT_NOTICE_PLAN: 'lpaEnforcementNoticePlan',
305
+ LPA_ENFORCEMENT_NOTICE_WITHDRAWAL: 'lpaEnforcementNoticeWithdrawal',
304
306
  LPA_FINAL_COMMENT: 'lpaFinalComment',
305
307
  LPA_PROOF_OF_EVIDENCE: 'lpaProofOfEvidence',
306
308
  LPA_STATEMENT: 'lpaStatement',
package/src/schemas.d.ts CHANGED
@@ -155,6 +155,7 @@ export interface AppealDocument {
155
155
  | 'planningPermission'
156
156
  | 'lpaEnforcementNotice'
157
157
  | 'lpaEnforcementNoticePlan'
158
+ | 'lpaEnforcementNoticeWithdrawal'
158
159
  | 'planningContraventionNotice'
159
160
  | 'priorCorrespondenceWithPINS'
160
161
  | 'enforcementNotice'
@@ -209,6 +210,7 @@ export interface AppealDocument {
209
210
  | 'appeal-decision'
210
211
  | 'costs'
211
212
  | 'internal'
213
+ | 'cancellation'
212
214
  | null;
213
215
  /**
214
216
  * The folder ID containing the document in Horizon