@planning-inspectorate/data-model 1.14.0 → 1.15.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 (26) hide show
  1. package/docs/appeal-s78.md +62 -0
  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 +7 -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_project.py +1 -1
  18. package/pins_data_model/models/model_nsip_project_update.py +1 -1
  19. package/pins_data_model/models/model_nsip_representation.py +1 -1
  20. package/pins_data_model/models/model_nsip_subscription.py +1 -1
  21. package/pins_data_model/models/model_pins_inspector.py +1 -1
  22. package/pins_data_model/models/model_pins_lpa.py +1 -1
  23. package/pins_data_model/models/model_s51_advice.py +1 -1
  24. package/pins_data_model/models/model_service_user.py +1 -1
  25. package/schemas/appeal-s78.schema.json +12 -0
  26. package/src/schemas.d.ts +2 -0
@@ -141,6 +141,8 @@
141
141
  | [siteWithinSSSI](#sitewithinsssi) | `boolean` | Required | can be null | [Appeal S78 Case](appeal-s78-properties-sitewithinsssi.md "appeal-s78.schema.json#/properties/siteWithinSSSI") |
142
142
  | [typeOfPlanningApplication](#typeofplanningapplication) | `string` | Required | can be null | [Appeal S78 Case](appeal-s78-properties-typeofplanningapplication.md "appeal-s78.schema.json#/properties/typeOfPlanningApplication") |
143
143
  | [developmentType](#developmenttype) | `string` | Required | can be null | [Appeal S78 Case](appeal-s78-properties-developmenttype.md "appeal-s78.schema.json#/properties/developmentType") |
144
+ | [statementOfCommonGroundDueDate](#statementofcommongroundduedate) | `string` | Optional | can be null | [Appeal S78 Case](appeal-s78-properties-statementofcommongroundduedate.md "appeal-s78.schema.json#/properties/statementOfCommonGroundDueDate") |
145
+ | [planningObligationDueDate](#planningobligationduedate) | `string` | Optional | can be null | [Appeal S78 Case](appeal-s78-properties-planningobligationduedate.md "appeal-s78.schema.json#/properties/planningObligationDueDate") |
144
146
  | Additional Properties | Any | Optional | can be null | |
145
147
 
146
148
  ## caseId
@@ -3602,6 +3604,66 @@ The net gain in residences of the proposed development
3602
3604
  | `"other-minor"` | |
3603
3605
  | `null` | |
3604
3606
 
3607
+ ## statementOfCommonGroundDueDate
3608
+
3609
+
3610
+
3611
+ > Only available in S78 cases
3612
+
3613
+ `statementOfCommonGroundDueDate`
3614
+
3615
+ * is optional
3616
+
3617
+ * Type: `string`
3618
+
3619
+ * can be null
3620
+
3621
+ * defined in: [Appeal S78 Case](appeal-s78-properties-statementofcommongroundduedate.md "appeal-s78.schema.json#/properties/statementOfCommonGroundDueDate")
3622
+
3623
+ ### statementOfCommonGroundDueDate Type
3624
+
3625
+ `string`
3626
+
3627
+ ### statementOfCommonGroundDueDate Constraints
3628
+
3629
+ **date time**: the string must be a date time string, according to [RFC 3339, section 5.6](https://tools.ietf.org/html/rfc3339 "check the specification")
3630
+
3631
+ ### statementOfCommonGroundDueDate Examples
3632
+
3633
+ ```json
3634
+ "2023-07-27T20:30:00.000Z"
3635
+ ```
3636
+
3637
+ ## planningObligationDueDate
3638
+
3639
+
3640
+
3641
+ > Only available in S78 cases
3642
+
3643
+ `planningObligationDueDate`
3644
+
3645
+ * is optional
3646
+
3647
+ * Type: `string`
3648
+
3649
+ * can be null
3650
+
3651
+ * defined in: [Appeal S78 Case](appeal-s78-properties-planningobligationduedate.md "appeal-s78.schema.json#/properties/planningObligationDueDate")
3652
+
3653
+ ### planningObligationDueDate Type
3654
+
3655
+ `string`
3656
+
3657
+ ### planningObligationDueDate Constraints
3658
+
3659
+ **date time**: the string must be a date time string, according to [RFC 3339, section 5.6](https://tools.ietf.org/html/rfc3339 "check the specification")
3660
+
3661
+ ### planningObligationDueDate Examples
3662
+
3663
+ ```json
3664
+ "2023-07-27T20:30:00.000Z"
3665
+ ```
3666
+
3605
3667
  ## Additional Properties
3606
3668
 
3607
3669
  Additional properties are allowed and do not have to follow a specific schema
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@planning-inspectorate/data-model",
3
- "version": "1.14.0",
3
+ "version": "1.15.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: 2025-07-16T14:06:10+00:00
3
+ # timestamp: 2025-08-27T11:15:00+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: 2025-07-16T14:06:09+00:00
3
+ # timestamp: 2025-08-27T11:15:00+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: 2025-07-16T14:06:09+00:00
3
+ # timestamp: 2025-08-27T11:15:00+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: 2025-07-16T14:06:09+00:00
3
+ # timestamp: 2025-08-27T11:15:00+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: 2025-07-16T14:06:09+00:00
3
+ # timestamp: 2025-08-27T11:15:00+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: 2025-07-16T14:06:09+00:00
3
+ # timestamp: 2025-08-27T11:15:00+00:00
4
4
 
5
5
  from __future__ import annotations
6
6
 
@@ -862,3 +862,9 @@ class AppealS78Case(BaseModel):
862
862
  siteWithinSSSI: bool | None = None
863
863
  typeOfPlanningApplication: TypeOfPlanningApplication
864
864
  developmentType: DevelopmentType
865
+ statementOfCommonGroundDueDate: AwareDatetime | None = Field(
866
+ None, examples=["2023-07-27T20:30:00.000Z"]
867
+ )
868
+ planningObligationDueDate: AwareDatetime | None = Field(
869
+ None, examples=["2023-07-27T20:30:00.000Z"]
870
+ )
@@ -1,6 +1,6 @@
1
1
  # generated by datamodel-codegen:
2
2
  # filename: dart-response.schema.json
3
- # timestamp: 2025-07-16T14:06:10+00:00
3
+ # timestamp: 2025-08-27T11:15:00+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: 2025-07-16T14:06:09+00:00
3
+ # timestamp: 2025-08-27T11:15:00+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: 2025-07-16T14:06:10+00:00
3
+ # timestamp: 2025-08-27T11:15:00+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: 2025-07-16T14:06:09+00:00
3
+ # timestamp: 2025-08-27T11:15:00+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: 2025-07-16T14:06:09+00:00
3
+ # timestamp: 2025-08-27T11:15:00+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: 2025-07-16T14:06:09+00:00
3
+ # timestamp: 2025-08-27T11:15:00+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: 2025-07-16T14:06:10+00:00
3
+ # timestamp: 2025-08-27T11:15:00+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: 2025-07-16T14:06:09+00:00
3
+ # timestamp: 2025-08-27T11:15:00+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: 2025-07-16T14:06:09+00:00
3
+ # timestamp: 2025-08-27T11:15:00+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: 2025-07-16T14:06:09+00:00
3
+ # timestamp: 2025-08-27T11:15:00+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: 2025-07-16T14:06:09+00:00
3
+ # timestamp: 2025-08-27T11:15:00+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: 2025-07-16T14:06:10+00:00
3
+ # timestamp: 2025-08-27T11:15:00+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: 2025-07-16T14:06:09+00:00
3
+ # timestamp: 2025-08-27T11:15:00+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: 2025-07-16T14:06:10+00:00
3
+ # timestamp: 2025-08-27T11:15:00+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: 2025-07-16T14:06:09+00:00
3
+ # timestamp: 2025-08-27T11:15:00+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: 2025-07-16T14:06:10+00:00
3
+ # timestamp: 2025-08-27T11:15:00+00:00
4
4
 
5
5
  from __future__ import annotations
6
6
 
@@ -1055,6 +1055,18 @@
1055
1055
  "other-minor",
1056
1056
  null
1057
1057
  ]
1058
+ },
1059
+ "statementOfCommonGroundDueDate": {
1060
+ "type": ["string", "null"],
1061
+ "format": "date-time",
1062
+ "examples": ["2023-07-27T20:30:00.000Z"],
1063
+ "$comment": "Only available in S78 cases"
1064
+ },
1065
+ "planningObligationDueDate": {
1066
+ "type": ["string", "null"],
1067
+ "format": "date-time",
1068
+ "examples": ["2023-07-27T20:30:00.000Z"],
1069
+ "$comment": "Only available in S78 cases"
1058
1070
  }
1059
1071
  }
1060
1072
  }
package/src/schemas.d.ts CHANGED
@@ -1301,6 +1301,8 @@ export interface AppealS78Case {
1301
1301
  | 'other-major'
1302
1302
  | 'other-minor'
1303
1303
  | null;
1304
+ statementOfCommonGroundDueDate?: string | null;
1305
+ planningObligationDueDate?: string | null;
1304
1306
  [k: string]: unknown;
1305
1307
  }
1306
1308