@planning-inspectorate/data-model 2.0.1 → 2.1.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 (27) hide show
  1. package/docs/nsip-project-defs-meeting.md +32 -7
  2. package/docs/nsip-project.md +32 -7
  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 +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_project.py +5 -1
  19. package/pins_data_model/models/model_nsip_project_update.py +1 -1
  20. package/pins_data_model/models/model_nsip_representation.py +1 -1
  21. package/pins_data_model/models/model_nsip_subscription.py +1 -1
  22. package/pins_data_model/models/model_pins_inspector.py +1 -1
  23. package/pins_data_model/models/model_pins_lpa.py +1 -1
  24. package/pins_data_model/models/model_s51_advice.py +1 -1
  25. package/pins_data_model/models/model_service_user.py +1 -1
  26. package/schemas/nsip-project.schema.json +5 -0
  27. package/src/schemas.d.ts +4 -0
package/docs/nsip-project-defs-meeting.md CHANGED
@@ -4,13 +4,38 @@
4
4
 
5
5
  # meeting Properties
6
6
 
7
- | Property | Type | Required | Nullable | Defined by |
8
- | :---------------------------------------------------- | :------- | :------- | :---------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------- |
9
- | [meetingAgenda](#meetingagenda) | `string` | Optional | can be null | [NSIP Project](nsip-project-defs-meeting-properties-meetingagenda.md "nsip-project.schema.json#/$defs/meeting/properties/meetingAgenda") |
10
- | [planningInspectorateRole](#planninginspectoraterole) | `string` | Optional | can be null | [NSIP Project](nsip-project-defs-meeting-properties-planninginspectoraterole.md "nsip-project.schema.json#/$defs/meeting/properties/planningInspectorateRole") |
11
- | [meetingDate](#meetingdate) | `string` | Optional | can be null | [NSIP Project](nsip-project-defs-meeting-properties-meetingdate.md "nsip-project.schema.json#/$defs/meeting/properties/meetingDate") |
12
- | [meetingType](#meetingtype) | `string` | Optional | can be null | [NSIP Project](nsip-project-defs-meeting-properties-meetingtype.md "nsip-project.schema.json#/$defs/meeting/properties/meetingType") |
13
- | Additional Properties | Any | Optional | can be null | |
7
+ | Property | Type | Required | Nullable | Defined by |
8
+ | :---------------------------------------------------- | :-------- | :------- | :---------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------- |
9
+ | [meetingId](#meetingid) | `integer` | Optional | can be null | [NSIP Project](nsip-project-defs-meeting-properties-meetingid.md "nsip-project.schema.json#/$defs/meeting/properties/meetingId") |
10
+ | [meetingAgenda](#meetingagenda) | `string` | Optional | can be null | [NSIP Project](nsip-project-defs-meeting-properties-meetingagenda.md "nsip-project.schema.json#/$defs/meeting/properties/meetingAgenda") |
11
+ | [planningInspectorateRole](#planninginspectoraterole) | `string` | Optional | can be null | [NSIP Project](nsip-project-defs-meeting-properties-planninginspectoraterole.md "nsip-project.schema.json#/$defs/meeting/properties/planningInspectorateRole") |
12
+ | [meetingDate](#meetingdate) | `string` | Optional | can be null | [NSIP Project](nsip-project-defs-meeting-properties-meetingdate.md "nsip-project.schema.json#/$defs/meeting/properties/meetingDate") |
13
+ | [meetingType](#meetingtype) | `string` | Optional | can be null | [NSIP Project](nsip-project-defs-meeting-properties-meetingtype.md "nsip-project.schema.json#/$defs/meeting/properties/meetingType") |
14
+ | Additional Properties | Any | Optional | can be null | |
15
+
16
+ ## meetingId
17
+
18
+ Unique identifier for the meeting
19
+
20
+ `meetingId`
21
+
22
+ * is optional
23
+
24
+ * Type: `integer`
25
+
26
+ * can be null
27
+
28
+ * defined in: [NSIP Project](nsip-project-defs-meeting-properties-meetingid.md "nsip-project.schema.json#/$defs/meeting/properties/meetingId")
29
+
30
+ ### meetingId Type
31
+
32
+ `integer`
33
+
34
+ ### meetingId Examples
35
+
36
+ ```json
37
+ 123
38
+ ```
14
39
 
15
40
  ## meetingAgenda
16
41
 
package/docs/nsip-project.md CHANGED
@@ -3592,13 +3592,38 @@ Reference this group by using
3592
3592
  {"$ref":"nsip-project.schema.json#/$defs/meeting"}
3593
3593
  ```
3594
3594
 
3595
- | Property | Type | Required | Nullable | Defined by |
3596
- | :---------------------------------------------------- | :------- | :------- | :---------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------- |
3597
- | [meetingAgenda](#meetingagenda) | `string` | Optional | can be null | [NSIP Project](nsip-project-defs-meeting-properties-meetingagenda.md "nsip-project.schema.json#/$defs/meeting/properties/meetingAgenda") |
3598
- | [planningInspectorateRole](#planninginspectoraterole) | `string` | Optional | can be null | [NSIP Project](nsip-project-defs-meeting-properties-planninginspectoraterole.md "nsip-project.schema.json#/$defs/meeting/properties/planningInspectorateRole") |
3599
- | [meetingDate](#meetingdate) | `string` | Optional | can be null | [NSIP Project](nsip-project-defs-meeting-properties-meetingdate.md "nsip-project.schema.json#/$defs/meeting/properties/meetingDate") |
3600
- | [meetingType](#meetingtype) | `string` | Optional | can be null | [NSIP Project](nsip-project-defs-meeting-properties-meetingtype.md "nsip-project.schema.json#/$defs/meeting/properties/meetingType") |
3601
- | Additional Properties | Any | Optional | can be null | |
3595
+ | Property | Type | Required | Nullable | Defined by |
3596
+ | :---------------------------------------------------- | :-------- | :------- | :---------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------- |
3597
+ | [meetingId](#meetingid) | `integer` | Optional | can be null | [NSIP Project](nsip-project-defs-meeting-properties-meetingid.md "nsip-project.schema.json#/$defs/meeting/properties/meetingId") |
3598
+ | [meetingAgenda](#meetingagenda) | `string` | Optional | can be null | [NSIP Project](nsip-project-defs-meeting-properties-meetingagenda.md "nsip-project.schema.json#/$defs/meeting/properties/meetingAgenda") |
3599
+ | [planningInspectorateRole](#planninginspectoraterole) | `string` | Optional | can be null | [NSIP Project](nsip-project-defs-meeting-properties-planninginspectoraterole.md "nsip-project.schema.json#/$defs/meeting/properties/planningInspectorateRole") |
3600
+ | [meetingDate](#meetingdate) | `string` | Optional | can be null | [NSIP Project](nsip-project-defs-meeting-properties-meetingdate.md "nsip-project.schema.json#/$defs/meeting/properties/meetingDate") |
3601
+ | [meetingType](#meetingtype) | `string` | Optional | can be null | [NSIP Project](nsip-project-defs-meeting-properties-meetingtype.md "nsip-project.schema.json#/$defs/meeting/properties/meetingType") |
3602
+ | Additional Properties | Any | Optional | can be null | |
3603
+
3604
+ ### meetingId
3605
+
3606
+ Unique identifier for the meeting
3607
+
3608
+ `meetingId`
3609
+
3610
+ * is optional
3611
+
3612
+ * Type: `integer`
3613
+
3614
+ * can be null
3615
+
3616
+ * defined in: [NSIP Project](nsip-project-defs-meeting-properties-meetingid.md "nsip-project.schema.json#/$defs/meeting/properties/meetingId")
3617
+
3618
+ #### meetingId Type
3619
+
3620
+ `integer`
3621
+
3622
+ #### meetingId Examples
3623
+
3624
+ ```json
3625
+ 123
3626
+ ```
3602
3627
 
3603
3628
  ### meetingAgenda
3604
3629
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@planning-inspectorate/data-model",
3
- "version": "2.0.1",
3
+ "version": "2.1.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: 2025-11-04T12:33:59+00:00
3
+ # timestamp: 2025-11-12T14:58:30+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: 2025-11-04T12:33:59+00:00
3
+ # timestamp: 2025-11-12T14:58:30+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: 2025-11-04T12:33:59+00:00
3
+ # timestamp: 2025-11-12T14:58:30+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: 2025-11-07T15:19:29+00:00
3
+ # timestamp: 2025-11-12T14:58:30+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: 2025-11-04T12:33:59+00:00
3
+ # timestamp: 2025-11-12T14:58:30+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: 2025-11-07T15:19:29+00:00
3
+ # timestamp: 2025-11-12T14:58:31+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: 2025-11-04T12:34:00+00:00
3
+ # timestamp: 2025-11-12T14:58:31+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: 2025-11-04T12:34:00+00:00
3
+ # timestamp: 2025-11-12T14:58:31+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: 2025-11-04T12:34:00+00:00
3
+ # timestamp: 2025-11-12T14:58:31+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: 2025-11-04T12:34:00+00:00
3
+ # timestamp: 2025-11-12T14:58:31+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: 2025-11-04T12:34:00+00:00
3
+ # timestamp: 2025-11-12T14:58:31+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: 2025-11-04T12:34:00+00:00
3
+ # timestamp: 2025-11-12T14:58:31+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: 2025-11-04T12:34:00+00:00
3
+ # timestamp: 2025-11-12T14:58:31+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: 2025-11-04T12:34:00+00:00
3
+ # timestamp: 2025-11-12T14:58:31+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: 2025-11-04T12:34:00+00:00
3
+ # timestamp: 2025-11-12T14:58:31+00:00
4
4
 
5
5
  from __future__ import annotations
6
6
 
@@ -300,6 +300,10 @@ class Meeting(BaseModel):
300
300
  model_config = ConfigDict(
301
301
  extra="allow",
302
302
  )
303
+ meetingId: int | None = Field(None, examples=[123])
304
+ """
305
+ Unique identifier for the meeting
306
+ """
303
307
  meetingAgenda: str | None = Field(None, examples=["Flood Risk Assessment (FRA)"])
304
308
  """
305
309
  Meeting agenda
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: 2025-11-04T12:34:00+00:00
3
+ # timestamp: 2025-11-12T14:58:31+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: 2025-11-04T12:34:00+00:00
3
+ # timestamp: 2025-11-12T14:58:31+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: 2025-11-04T12:34:00+00:00
3
+ # timestamp: 2025-11-12T14:58:31+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: 2025-11-04T12:34:00+00:00
3
+ # timestamp: 2025-11-12T14:58:31+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: 2025-11-04T12:34:00+00:00
3
+ # timestamp: 2025-11-12T14:58:31+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: 2025-11-04T12:34:00+00:00
3
+ # timestamp: 2025-11-12T14:58:31+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: 2025-11-04T12:34:00+00:00
3
+ # timestamp: 2025-11-12T14:58:31+00:00
4
4
 
5
5
  from __future__ import annotations
6
6
 
package/schemas/nsip-project.schema.json CHANGED
@@ -872,6 +872,11 @@
872
872
  "additionalProperties": true,
873
873
  "description": "A meeting related to the project",
874
874
  "properties": {
875
+ "meetingId": {
876
+ "type": ["integer", "null"],
877
+ "description": "Unique identifier for the meeting",
878
+ "examples": [123]
879
+ },
875
880
  "meetingAgenda": {
876
881
  "type": ["string", "null"],
877
882
  "description": "Meeting agenda",
package/src/schemas.d.ts CHANGED
@@ -2658,6 +2658,10 @@ export interface NSIPProject {
2658
2658
  * A meeting related to the project
2659
2659
  */
2660
2660
  export interface Meeting {
2661
+ /**
2662
+ * Unique identifier for the meeting
2663
+ */
2664
+ meetingId?: number | null;
2661
2665
  /**
2662
2666
  * Meeting agenda
2663
2667
  */