@planning-inspectorate/data-model 2.31.2 → 2.32.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 (34) hide show
  1. package/docs/appeal-s78-definitions-significantchangesaffectingapplication.md +1 -0
  2. package/docs/nsip-document.md +1 -0
  3. package/package.json +1 -1
  4. package/pins_data_model/models/model_appeal_document.py +1 -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 +2 -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-s78.schema.json +4 -4
  29. package/schemas/nsip-document.schema.json +9 -1
  30. package/src/enums.cjs +1 -0
  31. package/src/enums.d.ts +1 -0
  32. package/src/enums.js +1 -0
  33. package/src/index.cjs +1 -0
  34. package/src/schemas.d.ts +10 -3
@@ -12,3 +12,4 @@
12
12
  | `"national-policy-change"` | |
13
13
  | `"court-judgement"` | |
14
14
  | `"other"` | |
15
+ | `null` | |
@@ -672,6 +672,7 @@ The location of the published document. Only applicable to documents which are p
672
672
  | :--------------------------- | :---------- |
673
673
  | `"back-office-appeals"` | |
674
674
  | `"back-office-applications"` | |
675
+ | `"dco-portal"` | |
675
676
  | `"horizon"` | |
676
677
  | `"ni_file"` | |
677
678
  | `"sharepoint"` | |
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@planning-inspectorate/data-model",
3
- "version": "2.31.2",
3
+ "version": "2.32.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-04-13T16:15:35+00:00
3
+ # timestamp: 2026-04-15T12:58:38+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.schema.json
3
- # timestamp: 2026-04-13T16:15:34+00:00
3
+ # timestamp: 2026-04-15T12:58:37+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-04-13T16:15:34+00:00
3
+ # timestamp: 2026-04-15T12:58:37+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-04-13T16:15:34+00:00
3
+ # timestamp: 2026-04-15T12:58:37+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-04-13T16:15:34+00:00
3
+ # timestamp: 2026-04-15T12:58:37+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-04-13T16:15:34+00:00
3
+ # timestamp: 2026-04-15T12:58:37+00:00
4
4
 
5
5
  from __future__ import annotations
6
6
 
@@ -501,6 +501,7 @@ class SignificantChangesAffectingApplication(Enum):
501
501
  national_policy_change = "national-policy-change"
502
502
  court_judgement = "court-judgement"
503
503
  other = "other"
504
+ NoneType_None = None
504
505
 
505
506
 
506
507
  class SignificantChangesAffectingApplicationAppellantItem(BaseModel):
@@ -1,6 +1,6 @@
1
1
  # generated by datamodel-codegen:
2
2
  # filename: dart-response.schema.json
3
- # timestamp: 2026-04-13T16:15:34+00:00
3
+ # timestamp: 2026-04-15T12:58:37+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-04-13T16:15:34+00:00
3
+ # timestamp: 2026-04-15T12:58:37+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-04-13T16:15:34+00:00
3
+ # timestamp: 2026-04-15T12:58:37+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-04-13T16:15:34+00:00
3
+ # timestamp: 2026-04-15T12:58:37+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-04-13T16:15:34+00:00
3
+ # timestamp: 2026-04-15T12:58:37+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-04-13T16:15:34+00:00
3
+ # timestamp: 2026-04-15T12:58:37+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-04-13T16:15:34+00:00
3
+ # timestamp: 2026-04-15T12:58:37+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-04-13T16:15:34+00:00
3
+ # timestamp: 2026-04-15T12:58:37+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-04-13T16:15:34+00:00
3
+ # timestamp: 2026-04-15T12:58:37+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-04-13T16:15:34+00:00
3
+ # timestamp: 2026-04-15T12:58:37+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-04-13T16:15:34+00:00
3
+ # timestamp: 2026-04-15T12:58:37+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-04-13T16:15:34+00:00
3
+ # timestamp: 2026-04-15T12:58:37+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-04-13T16:15:34+00:00
3
+ # timestamp: 2026-04-15T12:58:37+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-04-13T16:15:34+00:00
3
+ # timestamp: 2026-04-15T12:58:37+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-04-13T16:15:34+00:00
3
+ # timestamp: 2026-04-15T12:58:37+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-04-13T16:15:34+00:00
3
+ # timestamp: 2026-04-15T12:58:37+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-04-13T16:15:34+00:00
3
+ # timestamp: 2026-04-15T12:58:37+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-04-13T16:15:34+00:00
3
+ # timestamp: 2026-04-15T12:58:37+00:00
4
4
 
5
5
  from __future__ import annotations
6
6
 
@@ -1364,7 +1364,7 @@
1364
1364
  "properties": {
1365
1365
  "value": {
1366
1366
  "$ref": "#/definitions/SignificantChangesAffectingApplication",
1367
- "type": "string"
1367
+ "type": ["string", "null"]
1368
1368
  },
1369
1369
  "comment": {
1370
1370
  "type": ["string", "null"]
@@ -1381,7 +1381,7 @@
1381
1381
  "properties": {
1382
1382
  "value": {
1383
1383
  "$ref": "#/definitions/SignificantChangesAffectingApplication",
1384
- "type": "string"
1384
+ "type": ["string", "null"]
1385
1385
  },
1386
1386
  "comment": {
1387
1387
  "type": ["string", "null"]
@@ -1394,8 +1394,8 @@
1394
1394
  },
1395
1395
  "definitions": {
1396
1396
  "SignificantChangesAffectingApplication": {
1397
- "type": "string",
1398
- "enum": ["adopted-a-new-local-plan", "national-policy-change", "court-judgement", "other"]
1397
+ "type": ["string", "null"],
1398
+ "enum": ["adopted-a-new-local-plan", "national-policy-change", "court-judgement", "other", null]
1399
1399
  }
1400
1400
  }
1401
1401
  }
@@ -172,7 +172,15 @@
172
172
  },
173
173
  "sourceSystem": {
174
174
  "type": ["string", "null"],
175
- "enum": ["back-office-appeals", "back-office-applications", "horizon", "ni_file", "sharepoint", null]
175
+ "enum": [
176
+ "back-office-appeals",
177
+ "back-office-applications",
178
+ "dco-portal",
179
+ "horizon",
180
+ "ni_file",
181
+ "sharepoint",
182
+ null
183
+ ]
176
184
  },
177
185
  "origin": {
178
186
  "type": ["string", "null"],
package/src/enums.cjs CHANGED
@@ -719,6 +719,7 @@ const NSIP_SECURITY_CLASSIFICATION = Object.freeze({
719
719
  const NSIP_SOURCE_SYSTEM = Object.freeze({
720
720
  BACK_OFFICE_APPEALS: 'back-office-appeals',
721
721
  BACK_OFFICE_APPLICATIONS: 'back-office-applications',
722
+ DCO_PORTAL: 'dco-portal',
722
723
  HORIZON: 'horizon',
723
724
  NI_FILE: 'ni_file',
724
725
  SHAREPOINT: 'sharepoint',
package/src/enums.d.ts CHANGED
@@ -717,6 +717,7 @@ export const NSIP_SECURITY_CLASSIFICATION = {
717
717
  export const NSIP_SOURCE_SYSTEM = {
718
718
  BACK_OFFICE_APPEALS: 'back-office-appeals',
719
719
  BACK_OFFICE_APPLICATIONS: 'back-office-applications',
720
+ DCO_PORTAL: 'dco-portal',
720
721
  HORIZON: 'horizon',
721
722
  NI_FILE: 'ni_file',
722
723
  SHAREPOINT: 'sharepoint',
package/src/enums.js CHANGED
@@ -717,6 +717,7 @@ export const NSIP_SECURITY_CLASSIFICATION = Object.freeze({
717
717
  export const NSIP_SOURCE_SYSTEM = Object.freeze({
718
718
  BACK_OFFICE_APPEALS: 'back-office-appeals',
719
719
  BACK_OFFICE_APPLICATIONS: 'back-office-applications',
720
+ DCO_PORTAL: 'dco-portal',
720
721
  HORIZON: 'horizon',
721
722
  NI_FILE: 'ni_file',
722
723
  SHAREPOINT: 'sharepoint',
package/src/index.cjs CHANGED
@@ -800,6 +800,7 @@ const NSIP_SECURITY_CLASSIFICATION = Object.freeze({
800
800
  const NSIP_SOURCE_SYSTEM = Object.freeze({
801
801
  BACK_OFFICE_APPEALS: 'back-office-appeals',
802
802
  BACK_OFFICE_APPLICATIONS: 'back-office-applications',
803
+ DCO_PORTAL: 'dco-portal',
803
804
  HORIZON: 'horizon',
804
805
  NI_FILE: 'ni_file',
805
806
  SHAREPOINT: 'sharepoint',
package/src/schemas.d.ts CHANGED
@@ -1718,7 +1718,7 @@ export type AppealS78Case = (GridReference | SiteAddress) & {
1718
1718
  */
1719
1719
  significantChangesAffectingApplicationAppellant?:
1720
1720
  | {
1721
- value: 'adopted-a-new-local-plan' | 'national-policy-change' | 'court-judgement' | 'other';
1721
+ value: 'adopted-a-new-local-plan' | 'national-policy-change' | 'court-judgement' | 'other' | null;
1722
1722
  comment?: string | null;
1723
1723
  }[]
1724
1724
  | null;
@@ -1727,7 +1727,7 @@ export type AppealS78Case = (GridReference | SiteAddress) & {
1727
1727
  */
1728
1728
  significantChangesAffectingApplicationLpa?:
1729
1729
  | {
1730
- value: 'adopted-a-new-local-plan' | 'national-policy-change' | 'court-judgement' | 'other';
1730
+ value: 'adopted-a-new-local-plan' | 'national-policy-change' | 'court-judgement' | 'other' | null;
1731
1731
  comment?: string | null;
1732
1732
  }[]
1733
1733
  | null;
@@ -2216,7 +2216,14 @@ export interface NSIPDocument {
2216
2216
  datePublished: string | null;
2217
2217
  documentType: string | null;
2218
2218
  securityClassification: 'public' | 'official' | 'secret' | 'top-secret' | null;
2219
- sourceSystem: 'back-office-appeals' | 'back-office-applications' | 'horizon' | 'ni_file' | 'sharepoint' | null;
2219
+ sourceSystem:
2220
+ | 'back-office-appeals'
2221
+ | 'back-office-applications'
2222
+ | 'dco-portal'
2223
+ | 'horizon'
2224
+ | 'ni_file'
2225
+ | 'sharepoint'
2226
+ | null;
2220
2227
  origin: 'pins' | 'citizen' | 'lpa' | 'ogd' | null;
2221
2228
  owner: string | null;
2222
2229
  /**