@planning-inspectorate/data-model 2.11.0 → 2.13.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/docs/appeal-s78.md +7 -6
  2. package/package.json +1 -1
  3. package/pins_data_model/models/model_appeal_document.py +1 -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 +2 -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-s78.schema.json +1 -1
  28. package/schemas/commands/appeal-representation-submission.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 +2 -1
package/docs/appeal-s78.md CHANGED
@@ -390,12 +390,13 @@ The type of procedure for the appeal
390
390
 
391
391
  **enum**: the value of this property must be equal to one of the following values:
392
392
 
393
- | Value | Explanation |
394
- | :---------- | :---------- |
395
- | `"written"` | |
396
- | `"hearing"` | |
397
- | `"inquiry"` | |
398
- | `null` | |
393
+ | Value | Explanation |
394
+ | :--------------- | :---------- |
395
+ | `"written"` | |
396
+ | `"hearing"` | |
397
+ | `"inquiry"` | |
398
+ | `"writtenPart1"` | |
399
+ | `null` | |
399
400
 
400
401
  ## lpaCode
401
402
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@planning-inspectorate/data-model",
3
- "version": "2.11.0",
3
+ "version": "2.13.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-01-21T12:30:03+00:00
3
+ # timestamp: 2026-01-27T12:24:06+00:00
4
4
 
5
5
  from __future__ import annotations
6
6
 
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-01-20T11:57:09+00:00
3
+ # timestamp: 2026-01-27T12:24:06+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-01-20T11:57:09+00:00
3
+ # timestamp: 2026-01-27T12:24:06+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-01-21T12:30:03+00:00
3
+ # timestamp: 2026-01-27T12:24:06+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-01-20T11:57:10+00:00
3
+ # timestamp: 2026-01-27T12:24:06+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-01-21T12:30:03+00:00
3
+ # timestamp: 2026-01-27T12:24:06+00:00
4
4
 
5
5
  from __future__ import annotations
6
6
 
@@ -64,6 +64,7 @@ class CaseProcedure(Enum):
64
64
  written = "written"
65
65
  hearing = "hearing"
66
66
  inquiry = "inquiry"
67
+ writtenPart1 = "writtenPart1"
67
68
  NoneType_None = None
68
69
 
69
70
 
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-01-20T11:57:09+00:00
3
+ # timestamp: 2026-01-27T12:24:06+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-01-20T11:57:09+00:00
3
+ # timestamp: 2026-01-27T12:24:06+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-01-20T11:57:09+00:00
3
+ # timestamp: 2026-01-27T12:24:06+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-01-20T11:57:09+00:00
3
+ # timestamp: 2026-01-27T12:24:06+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-01-20T11:57:10+00:00
3
+ # timestamp: 2026-01-27T12:24:06+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-01-20T11:57:10+00:00
3
+ # timestamp: 2026-01-27T12:24:06+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-01-20T11:57:09+00:00
3
+ # timestamp: 2026-01-27T12:24:06+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-01-20T11:57:10+00:00
3
+ # timestamp: 2026-01-27T12:24:06+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-01-20T11:57:09+00:00
3
+ # timestamp: 2026-01-27T12:24:06+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-01-20T11:57:10+00:00
3
+ # timestamp: 2026-01-27T12:24:06+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-01-20T11:57:10+00:00
3
+ # timestamp: 2026-01-27T12:24:06+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-01-20T11:57:09+00:00
3
+ # timestamp: 2026-01-27T12:24:06+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-01-20T11:57:10+00:00
3
+ # timestamp: 2026-01-27T12:24:06+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-01-20T11:57:09+00:00
3
+ # timestamp: 2026-01-27T12:24:06+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-01-20T11:57:09+00:00
3
+ # timestamp: 2026-01-27T12:24:06+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-01-20T11:57:09+00:00
3
+ # timestamp: 2026-01-27T12:24:06+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-01-20T11:57:09+00:00
3
+ # timestamp: 2026-01-27T12:24:06+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-01-20T11:57:09+00:00
3
+ # timestamp: 2026-01-27T12:24:06+00:00
4
4
 
5
5
  from __future__ import annotations
6
6
 
package/schemas/appeal-s78.schema.json CHANGED
@@ -201,7 +201,7 @@
201
201
  },
202
202
  "caseProcedure": {
203
203
  "type": ["string", "null"],
204
- "enum": ["written", "hearing", "inquiry", null],
204
+ "enum": ["written", "hearing", "inquiry", "writtenPart1", null],
205
205
  "description": "The type of procedure for the appeal",
206
206
  "$comment": "Also available on HAS cases"
207
207
  },
package/schemas/commands/appeal-representation-submission.schema.json CHANGED
@@ -87,6 +87,7 @@
87
87
  "lpaWitnessesEvidence",
88
88
  "rule6ProofOfEvidence",
89
89
  "rule6WitnessesEvidence",
90
+ "appellantStatement",
90
91
  null
91
92
  ],
92
93
  "description": "The type of document, used for exchange, migrations and consumption from the appeal back-office system"
package/src/enums.cjs CHANGED
@@ -55,6 +55,7 @@ const APPEAL_CASE_PROCEDURE = Object.freeze({
55
55
  HEARING: 'hearing',
56
56
  INQUIRY: 'inquiry',
57
57
  WRITTEN: 'written',
58
+ WRITTEN_PART_1: 'writtenPart1',
58
59
  });
59
60
 
60
61
  const APPEAL_CASE_STAGE = Object.freeze({
package/src/enums.d.ts CHANGED
@@ -53,6 +53,7 @@ export const APPEAL_CASE_PROCEDURE = {
53
53
  HEARING: 'hearing',
54
54
  INQUIRY: 'inquiry',
55
55
  WRITTEN: 'written',
56
+ WRITTEN_PART_1: 'writtenPart1',
56
57
  } as const;
57
58
 
58
59
  export const APPEAL_CASE_STAGE = {
package/src/enums.js CHANGED
@@ -53,6 +53,7 @@ export const APPEAL_CASE_PROCEDURE = Object.freeze({
53
53
  HEARING: 'hearing',
54
54
  INQUIRY: 'inquiry',
55
55
  WRITTEN: 'written',
56
+ WRITTEN_PART_1: 'writtenPart1',
56
57
  });
57
58
 
58
59
  export const APPEAL_CASE_STAGE = Object.freeze({
package/src/index.cjs CHANGED
@@ -136,6 +136,7 @@ const APPEAL_CASE_PROCEDURE = Object.freeze({
136
136
  HEARING: 'hearing',
137
137
  INQUIRY: 'inquiry',
138
138
  WRITTEN: 'written',
139
+ WRITTEN_PART_1: 'writtenPart1',
139
140
  });
140
141
 
141
142
  const APPEAL_CASE_STAGE = Object.freeze({
package/src/schemas.d.ts CHANGED
@@ -972,7 +972,7 @@ export type AppealS78Case = (
972
972
  /**
973
973
  * The type of procedure for the appeal
974
974
  */
975
- caseProcedure: 'written' | 'hearing' | 'inquiry' | null;
975
+ caseProcedure: 'written' | 'hearing' | 'inquiry' | 'writtenPart1' | null;
976
976
  /**
977
977
  * A unique identifier for the Local Planning Authority
978
978
  */
@@ -3446,6 +3446,7 @@ export type AppealRepresentationSubmission = {
3446
3446
  | 'lpaWitnessesEvidence'
3447
3447
  | 'rule6ProofOfEvidence'
3448
3448
  | 'rule6WitnessesEvidence'
3449
+ | 'appellantStatement'
3449
3450
  | null;
3450
3451
  [k: string]: unknown;
3451
3452
  }[];