@planning-inspectorate/data-model 2.15.0 → 2.16.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 (29) hide show
  1. package/docs/nsip-project-defs-meeting.md +39 -10
  2. package/docs/nsip-project.md +39 -10
  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_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 +8 -2
  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/nsip-project.schema.json +8 -1
  29. package/src/schemas.d.ts +5 -1
@@ -4,14 +4,15 @@
4
4
 
5
5
  # meeting Properties
6
6
 
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 | |
7
+ | Property | Type | Required | Nullable | Defined by |
8
+ | :-------------------------------------------------------- | :-------- | :------- | :------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------- |
9
+ | [meetingId](#meetingid) | `integer` | Required | cannot 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
+ | [estimatedPrelimMeetingDate](#estimatedprelimmeetingdate) | `string` | Optional | can be null | [NSIP Project](nsip-project-defs-meeting-properties-estimatedprelimmeetingdate.md "nsip-project.schema.json#/$defs/meeting/properties/estimatedPrelimMeetingDate") |
14
+ | [meetingType](#meetingtype) | `string` | Optional | can be null | [NSIP Project](nsip-project-defs-meeting-properties-meetingtype.md "nsip-project.schema.json#/$defs/meeting/properties/meetingType") |
15
+ | Additional Properties | Any | Optional | can be null | |
15
16
 
16
17
  ## meetingId
17
18
 
@@ -19,11 +20,11 @@ Unique identifier for the meeting
19
20
 
20
21
  `meetingId`
21
22
 
22
- * is optional
23
+ * is required
23
24
 
24
25
  * Type: `integer`
25
26
 
26
- * can be null
27
+ * cannot be null
27
28
 
28
29
  * defined in: [NSIP Project](nsip-project-defs-meeting-properties-meetingid.md "nsip-project.schema.json#/$defs/meeting/properties/meetingId")
29
30
 
@@ -124,6 +125,34 @@ Meeting date
124
125
  "2023-07-27T20:30:00.000Z"
125
126
  ```
126
127
 
128
+ ## estimatedPrelimMeetingDate
129
+
130
+ Estimated Preliminary Meeting date
131
+
132
+ `estimatedPrelimMeetingDate`
133
+
134
+ * is optional
135
+
136
+ * Type: `string`
137
+
138
+ * can be null
139
+
140
+ * defined in: [NSIP Project](nsip-project-defs-meeting-properties-estimatedprelimmeetingdate.md "nsip-project.schema.json#/$defs/meeting/properties/estimatedPrelimMeetingDate")
141
+
142
+ ### estimatedPrelimMeetingDate Type
143
+
144
+ `string`
145
+
146
+ ### estimatedPrelimMeetingDate Constraints
147
+
148
+ **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")
149
+
150
+ ### estimatedPrelimMeetingDate Examples
151
+
152
+ ```json
153
+ "2023-07-27T20:30:00.000Z"
154
+ ```
155
+
127
156
  ## meetingType
128
157
 
129
158
  Type of Meeting
@@ -3592,14 +3592,15 @@ 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
- | [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 | |
3595
+ | Property | Type | Required | Nullable | Defined by |
3596
+ | :-------------------------------------------------------- | :-------- | :------- | :------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------- |
3597
+ | [meetingId](#meetingid) | `integer` | Required | cannot 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
+ | [estimatedPrelimMeetingDate](#estimatedprelimmeetingdate) | `string` | Optional | can be null | [NSIP Project](nsip-project-defs-meeting-properties-estimatedprelimmeetingdate.md "nsip-project.schema.json#/$defs/meeting/properties/estimatedPrelimMeetingDate") |
3602
+ | [meetingType](#meetingtype) | `string` | Optional | can be null | [NSIP Project](nsip-project-defs-meeting-properties-meetingtype.md "nsip-project.schema.json#/$defs/meeting/properties/meetingType") |
3603
+ | Additional Properties | Any | Optional | can be null | |
3603
3604
 
3604
3605
  ### meetingId
3605
3606
 
@@ -3607,11 +3608,11 @@ Unique identifier for the meeting
3607
3608
 
3608
3609
  `meetingId`
3609
3610
 
3610
- * is optional
3611
+ * is required
3611
3612
 
3612
3613
  * Type: `integer`
3613
3614
 
3614
- * can be null
3615
+ * cannot be null
3615
3616
 
3616
3617
  * defined in: [NSIP Project](nsip-project-defs-meeting-properties-meetingid.md "nsip-project.schema.json#/$defs/meeting/properties/meetingId")
3617
3618
 
@@ -3712,6 +3713,34 @@ Meeting date
3712
3713
  "2023-07-27T20:30:00.000Z"
3713
3714
  ```
3714
3715
 
3716
+ ### estimatedPrelimMeetingDate
3717
+
3718
+ Estimated Preliminary Meeting date
3719
+
3720
+ `estimatedPrelimMeetingDate`
3721
+
3722
+ * is optional
3723
+
3724
+ * Type: `string`
3725
+
3726
+ * can be null
3727
+
3728
+ * defined in: [NSIP Project](nsip-project-defs-meeting-properties-estimatedprelimmeetingdate.md "nsip-project.schema.json#/$defs/meeting/properties/estimatedPrelimMeetingDate")
3729
+
3730
+ #### estimatedPrelimMeetingDate Type
3731
+
3732
+ `string`
3733
+
3734
+ #### estimatedPrelimMeetingDate Constraints
3735
+
3736
+ **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")
3737
+
3738
+ #### estimatedPrelimMeetingDate Examples
3739
+
3740
+ ```json
3741
+ "2023-07-27T20:30:00.000Z"
3742
+ ```
3743
+
3715
3744
  ### meetingType
3716
3745
 
3717
3746
  Type of Meeting
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@planning-inspectorate/data-model",
3
- "version": "2.15.0",
3
+ "version": "2.16.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-02-05T10:08:01+00:00
3
+ # timestamp: 2026-02-05T18:48:25+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-02-05T10:08:01+00:00
3
+ # timestamp: 2026-02-05T18:48:25+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-02-05T10:08:01+00:00
3
+ # timestamp: 2026-02-05T18:48:25+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-02-05T10:08:01+00:00
3
+ # timestamp: 2026-02-05T18:48:25+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-02-05T10:08:01+00:00
3
+ # timestamp: 2026-02-05T18:48:25+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-02-05T10:08:01+00:00
3
+ # timestamp: 2026-02-05T18:48:26+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: dart-response.schema.json
3
- # timestamp: 2026-02-05T10:08:01+00:00
3
+ # timestamp: 2026-02-05T18:48:26+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-02-05T10:08:01+00:00
3
+ # timestamp: 2026-02-05T18:48:26+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-02-05T10:08:01+00:00
3
+ # timestamp: 2026-02-05T18:48:26+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-02-05T10:08:01+00:00
3
+ # timestamp: 2026-02-05T18:48:26+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-02-05T10:08:01+00:00
3
+ # timestamp: 2026-02-05T18:48:26+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-02-05T10:08:01+00:00
3
+ # timestamp: 2026-02-05T18:48:26+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-02-05T10:08:01+00:00
3
+ # timestamp: 2026-02-05T18:48:26+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-02-05T10:08:01+00:00
3
+ # timestamp: 2026-02-05T18:48:26+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-02-05T10:08:01+00:00
3
+ # timestamp: 2026-02-05T18:48:26+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-02-05T10:08:01+00:00
3
+ # timestamp: 2026-02-05T18:48:26+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-02-05T10:08:01+00:00
3
+ # timestamp: 2026-02-05T18:48:26+00:00
4
4
 
5
5
  from __future__ import annotations
6
6
 
@@ -310,7 +310,7 @@ class Meeting(BaseModel):
310
310
  model_config = ConfigDict(
311
311
  extra="allow",
312
312
  )
313
- meetingId: int | None = Field(None, examples=[123])
313
+ meetingId: int = Field(..., examples=[123])
314
314
  """
315
315
  Unique identifier for the meeting
316
316
  """
@@ -330,6 +330,12 @@ class Meeting(BaseModel):
330
330
  """
331
331
  Meeting date
332
332
  """
333
+ estimatedPrelimMeetingDate: AwareDatetime | None = Field(
334
+ None, examples=["2023-07-27T20:30:00.000Z"]
335
+ )
336
+ """
337
+ Estimated Preliminary Meeting date
338
+ """
333
339
  meetingType: MeetingType | None = None
334
340
  """
335
341
  Type of Meeting
@@ -1,6 +1,6 @@
1
1
  # generated by datamodel-codegen:
2
2
  # filename: nsip-project-update.schema.json
3
- # timestamp: 2026-02-05T10:08:01+00:00
3
+ # timestamp: 2026-02-05T18:48:26+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-02-05T10:08:01+00:00
3
+ # timestamp: 2026-02-05T18:48:26+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-02-05T10:08:01+00:00
3
+ # timestamp: 2026-02-05T18:48:26+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-02-05T10:08:01+00:00
3
+ # timestamp: 2026-02-05T18:48:26+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-02-05T10:08:01+00:00
3
+ # timestamp: 2026-02-05T18:48:26+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-02-05T10:08:01+00:00
3
+ # timestamp: 2026-02-05T18:48:26+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-02-05T10:08:01+00:00
3
+ # timestamp: 2026-02-05T18:48:26+00:00
4
4
 
5
5
  from __future__ import annotations
6
6
 
@@ -871,9 +871,10 @@
871
871
  "type": "object",
872
872
  "additionalProperties": true,
873
873
  "description": "A meeting related to the project",
874
+ "required": ["meetingId"],
874
875
  "properties": {
875
876
  "meetingId": {
876
- "type": ["integer", "null"],
877
+ "type": "integer",
877
878
  "description": "Unique identifier for the meeting",
878
879
  "examples": [123]
879
880
  },
@@ -894,6 +895,12 @@
894
895
  "format": "date-time",
895
896
  "examples": ["2023-07-27T20:30:00.000Z"]
896
897
  },
898
+ "estimatedPrelimMeetingDate": {
899
+ "type": ["string", "null"],
900
+ "description": "Estimated Preliminary Meeting date",
901
+ "format": "date-time",
902
+ "examples": ["2023-07-27T20:30:00.000Z"]
903
+ },
897
904
  "meetingType": {
898
905
  "type": ["string", "null"],
899
906
  "description": "Type of Meeting",
package/src/schemas.d.ts CHANGED
@@ -2914,7 +2914,7 @@ export interface Meeting {
2914
2914
  /**
2915
2915
  * Unique identifier for the meeting
2916
2916
  */
2917
- meetingId?: number | null;
2917
+ meetingId: number;
2918
2918
  /**
2919
2919
  * Meeting agenda
2920
2920
  */
@@ -2927,6 +2927,10 @@ export interface Meeting {
2927
2927
  * Meeting date
2928
2928
  */
2929
2929
  meetingDate?: string | null;
2930
+ /**
2931
+ * Estimated Preliminary Meeting date
2932
+ */
2933
+ estimatedPrelimMeetingDate?: string | null;
2930
2934
  /**
2931
2935
  * Type of Meeting
2932
2936
  */