@planning-inspectorate/data-model 2.9.0 → 2.10.0

package/docs/appeal-s78.md

@@ -53,9 +53,9 @@ any of
 | [caseDecisionOutcome](#casedecisionoutcome)                                                     | `string`  | Required | can be null    | [Appeal S78 Case](appeal-s78-properties-casedecisionoutcome.md "appeal-s78.schema.json#/properties/caseDecisionOutcome")                                                     |
 | [caseCompletedDate](#casecompleteddate)                                                         | `string`  | Required | can be null    | [Appeal S78 Case](appeal-s78-properties-casecompleteddate.md "appeal-s78.schema.json#/properties/caseCompletedDate")                                                         |
 | [enforcementNotice](#enforcementnotice)                                                         | `boolean` | Required | can be null    | [Appeal S78 Case](appeal-s78-properties-enforcementnotice.md "appeal-s78.schema.json#/properties/enforcementNotice")                                                         |
-| [applicationReference](#applicationreference)                                                   | `string`  | Required | cannot be null | [Appeal S78 Case](appeal-s78-properties-applicationreference.md "appeal-s78.schema.json#/properties/applicationReference")                                                   |
-| [applicationDate](#applicationdate)                                                             | `string`  | Required | cannot be null | [Appeal S78 Case](appeal-s78-properties-applicationdate.md "appeal-s78.schema.json#/properties/applicationDate")                                                             |
-| [applicationDecision](#applicationdecision)                                                     | `string`  | Required | cannot be null | [Appeal S78 Case](appeal-s78-properties-applicationdecision.md "appeal-s78.schema.json#/properties/applicationDecision")                                                     |
+| [applicationReference](#applicationreference)                                                   | `string`  | Required | can be null    | [Appeal S78 Case](appeal-s78-properties-applicationreference.md "appeal-s78.schema.json#/properties/applicationReference")                                                   |
+| [applicationDate](#applicationdate)                                                             | `string`  | Required | can be null    | [Appeal S78 Case](appeal-s78-properties-applicationdate.md "appeal-s78.schema.json#/properties/applicationDate")                                                             |
+| [applicationDecision](#applicationdecision)                                                     | `string`  | Required | can be null    | [Appeal S78 Case](appeal-s78-properties-applicationdecision.md "appeal-s78.schema.json#/properties/applicationDecision")                                                     |
 | [applicationDecisionDate](#applicationdecisiondate)                                             | `string`  | Required | can be null    | [Appeal S78 Case](appeal-s78-properties-applicationdecisiondate.md "appeal-s78.schema.json#/properties/applicationDecisionDate")                                             |
 | [caseSubmissionDueDate](#casesubmissionduedate)                                                 | `string`  | Required | can be null    | [Appeal S78 Case](appeal-s78-properties-casesubmissionduedate.md "appeal-s78.schema.json#/properties/caseSubmissionDueDate")                                                 |
 | [siteAddressLine1](#siteaddressline1)                                                           | `string`  | Optional | can be null    | [Appeal S78 Case](appeal-s78-properties-siteaddressline1.md "appeal-s78.schema.json#/properties/siteAddressLine1")                                                           |
@@ -156,6 +156,9 @@ any of
 | [isSiteInAreaOfSpecialControlAdverts](#issiteinareaofspecialcontroladverts)                     | `boolean` | Optional | can be null    | [Appeal S78 Case](appeal-s78-properties-issiteinareaofspecialcontroladverts.md "appeal-s78.schema.json#/properties/isSiteInAreaOfSpecialControlAdverts")                     |
 | [advertDetails](#advertdetails)                                                                 | `array`   | Optional | can be null    | [Appeal S78 Case](appeal-s78-properties-advertdetails.md "appeal-s78.schema.json#/properties/advertDetails")                                                                 |
 | [padsSapId](#padssapid)                                                                         | `string`  | Optional | can be null    | [Appeal S78 Case](appeal-s78-properties-padssapid.md "appeal-s78.schema.json#/properties/padsSapId")                                                                         |
+| [enforcementNoticeReference](#enforcementnoticereference)                                       | `string`  | Optional | can be null    | [Appeal S78 Case](appeal-s78-properties-enforcementnoticereference.md "appeal-s78.schema.json#/properties/enforcementNoticeReference")                                       |
+| [descriptionOfAllegedBreach](#descriptionofallegedbreach)                                       | `string`  | Optional | can be null    | [Appeal S78 Case](appeal-s78-properties-descriptionofallegedbreach.md "appeal-s78.schema.json#/properties/descriptionOfAllegedBreach")                                       |
+| [dateAppellantContactedPins](#dateappellantcontactedpins)                                       | `string`  | Optional | can be null    | [Appeal S78 Case](appeal-s78-properties-dateappellantcontactedpins.md "appeal-s78.schema.json#/properties/dateAppellantContactedPins")                                       |
 | [ownerOccupancyStatus](#owneroccupancystatus)                                                   | `string`  | Optional | can be null    | [Appeal S78 Case](appeal-s78-properties-owneroccupancystatus.md "appeal-s78.schema.json#/properties/ownerOccupancyStatus")                                                   |
 | [occupancyConditionsMet](#occupancyconditionsmet)                                               | `boolean` | Optional | can be null    | [Appeal S78 Case](appeal-s78-properties-occupancyconditionsmet.md "appeal-s78.schema.json#/properties/occupancyConditionsMet")                                               |
 | [enforcementAppealGroundsDetails](#enforcementappealgroundsdetails)                             | `array`   | Optional | can be null    | [Appeal S78 Case](appeal-s78-properties-enforcementappealgroundsdetails.md "appeal-s78.schema.json#/properties/enforcementAppealGroundsDetails")                             |
@@ -1398,7 +1401,7 @@ The unique identifier of the LPA application
 
 * Type: `string`
 
-* cannot be null
+* can be null
 
 * defined in: [Appeal S78 Case](appeal-s78-properties-applicationreference.md "appeal-s78.schema.json#/properties/applicationReference")
 
@@ -1424,7 +1427,7 @@ The date of the original LPA application
 
 * Type: `string`
 
-* cannot be null
+* can be null
 
 * defined in: [Appeal S78 Case](appeal-s78-properties-applicationdate.md "appeal-s78.schema.json#/properties/applicationDate")
 
@@ -1454,7 +1457,7 @@ The outcome of the original LPA decision
 
 * Type: `string`
 
-* cannot be null
+* can be null
 
 * defined in: [Appeal S78 Case](appeal-s78-properties-applicationdecision.md "appeal-s78.schema.json#/properties/applicationDecision")
 
@@ -3776,6 +3779,84 @@ padsSapId for PADS inspectors
 
 `string`
 
+## enforcementNoticeReference
+
+The reference number of the enforcement notice
+
+`enforcementNoticeReference`
+
+* is optional
+
+* Type: `string`
+
+* can be null
+
+* defined in: [Appeal S78 Case](appeal-s78-properties-enforcementnoticereference.md "appeal-s78.schema.json#/properties/enforcementNoticeReference")
+
+### enforcementNoticeReference Type
+
+`string`
+
+### enforcementNoticeReference Examples
+
+```json
+"myC45e-123"
+```
+
+## descriptionOfAllegedBreach
+
+A description of the alleged breach
+
+`descriptionOfAllegedBreach`
+
+* is optional
+
+* Type: `string`
+
+* can be null
+
+* defined in: [Appeal S78 Case](appeal-s78-properties-descriptionofallegedbreach.md "appeal-s78.schema.json#/properties/descriptionOfAllegedBreach")
+
+### descriptionOfAllegedBreach Type
+
+`string`
+
+### descriptionOfAllegedBreach Examples
+
+```json
+"My breach description"
+```
+
+## dateAppellantContactedPins
+
+The date of the appellant contacted PINS prior to submitting an appeal
+
+> Relevant if enforcement effective date already passed
+
+`dateAppellantContactedPins`
+
+* is optional
+
+* Type: `string`
+
+* can be null
+
+* defined in: [Appeal S78 Case](appeal-s78-properties-dateappellantcontactedpins.md "appeal-s78.schema.json#/properties/dateAppellantContactedPins")
+
+### dateAppellantContactedPins Type
+
+`string`
+
+### dateAppellantContactedPins Constraints
+
+**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")
+
+### dateAppellantContactedPins Examples
+
+```json
+"2025-12-26T10:00:00.000Z"
+```
+
 ## ownerOccupancyStatus
 
 The nature of the appellant's interest in the appeal site

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@planning-inspectorate/data-model",
-  "version": "2.9.0",
+  "version": "2.10.0",
   "description": "JSON Schemas for the Planning Inspectorate's Data Model",
   "main": "src/index.js",
   "type": "module",

package/pins_data_model/models/model_appeal_document.py

@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  appeal-document.schema.json
-#   timestamp: 2026-01-12T14:59:51+00:00
+#   timestamp: 2026-01-15T10:15:03+00:00
 
 from __future__ import annotations
 

package/pins_data_model/models/model_appeal_event.py

@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  appeal-event.schema.json
-#   timestamp: 2026-01-12T14:59:50+00:00
+#   timestamp: 2026-01-15T10:15:02+00:00
 
 from __future__ import annotations
 

package/pins_data_model/models/model_appeal_event_estimate.py

@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  appeal-event-estimate.schema.json
-#   timestamp: 2026-01-12T14:59:50+00:00
+#   timestamp: 2026-01-15T10:15:02+00:00
 
 from __future__ import annotations
 

package/pins_data_model/models/model_appeal_has.py

@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  appeal-has.schema.json
-#   timestamp: 2026-01-12T14:59:51+00:00
+#   timestamp: 2026-01-15T10:15:02+00:00
 
 from __future__ import annotations
 

package/pins_data_model/models/model_appeal_representation.py

@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  appeal-representation.schema.json
-#   timestamp: 2026-01-12T14:59:51+00:00
+#   timestamp: 2026-01-15T10:15:02+00:00
 
 from __future__ import annotations
 

package/pins_data_model/models/model_appeal_s78.py

@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  appeal-s78.schema.json
-#   timestamp: 2026-01-12T14:59:51+00:00
+#   timestamp: 2026-01-15T10:15:02+00:00
 
 from __future__ import annotations
 
@@ -579,11 +579,13 @@ class AppealS78Case1(BaseModel):
     """
     Indicates if an enforcement notice is the reason for the appeal
     """
-    applicationReference: str = Field(..., examples=["43010/APP/1/290572"])
+    applicationReference: str | None = Field(..., examples=["43010/APP/1/290572"])
     """
     The unique identifier of the LPA application
     """
-    applicationDate: AwareDatetime = Field(..., examples=["2023-07-27T20:30:00.000Z"])
+    applicationDate: AwareDatetime | None = Field(
+        ..., examples=["2023-07-27T20:30:00.000Z"]
+    )
     """
     The date of the original LPA application
     """
@@ -962,6 +964,22 @@ class AppealS78Case1(BaseModel):
     """
     padsSapId for PADS inspectors
     """
+    enforcementNoticeReference: str | None = Field(None, examples=["myC45e-123"])
+    """
+    The reference number of the enforcement notice
+    """
+    descriptionOfAllegedBreach: str | None = Field(
+        None, examples=["My breach description"]
+    )
+    """
+    A description of the alleged breach
+    """
+    dateAppellantContactedPins: AwareDatetime | None = Field(
+        None, examples=["2025-12-26T10:00:00.000Z"]
+    )
+    """
+    The date of the appellant contacted PINS prior to submitting an appeal
+    """
     ownerOccupancyStatus: str | None = Field(
         None, examples=["Owner", "Tenant", "Mortgage lender"]
     )
@@ -1287,11 +1305,13 @@ class AppealS78Case2(BaseModel):
     """
     Indicates if an enforcement notice is the reason for the appeal
     """
-    applicationReference: str = Field(..., examples=["43010/APP/1/290572"])
+    applicationReference: str | None = Field(..., examples=["43010/APP/1/290572"])
     """
     The unique identifier of the LPA application
     """
-    applicationDate: AwareDatetime = Field(..., examples=["2023-07-27T20:30:00.000Z"])
+    applicationDate: AwareDatetime | None = Field(
+        ..., examples=["2023-07-27T20:30:00.000Z"]
+    )
     """
     The date of the original LPA application
     """
@@ -1670,6 +1690,22 @@ class AppealS78Case2(BaseModel):
     """
     padsSapId for PADS inspectors
     """
+    enforcementNoticeReference: str | None = Field(None, examples=["myC45e-123"])
+    """
+    The reference number of the enforcement notice
+    """
+    descriptionOfAllegedBreach: str | None = Field(
+        None, examples=["My breach description"]
+    )
+    """
+    A description of the alleged breach
+    """
+    dateAppellantContactedPins: AwareDatetime | None = Field(
+        None, examples=["2025-12-26T10:00:00.000Z"]
+    )
+    """
+    The date of the appellant contacted PINS prior to submitting an appeal
+    """
     ownerOccupancyStatus: str | None = Field(
         None, examples=["Owner", "Tenant", "Mortgage lender"]
     )

package/pins_data_model/models/model_dart_response.py

@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  dart-response.schema.json
-#   timestamp: 2026-01-12T14:59:50+00:00
+#   timestamp: 2026-01-15T10:15:02+00:00
 
 from __future__ import annotations
 

package/pins_data_model/models/model_entraid.py

@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  entraid.schema.json
-#   timestamp: 2026-01-12T14:59:50+00:00
+#   timestamp: 2026-01-15T10:15:02+00:00
 
 from __future__ import annotations
 

package/pins_data_model/models/model_folder.py

@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  folder.schema.json
-#   timestamp: 2026-01-12T14:59:50+00:00
+#   timestamp: 2026-01-15T10:15:02+00:00
 
 from __future__ import annotations
 

package/pins_data_model/models/model_gettimesheets_response.py

@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  gettimesheets-response.schema.json
-#   timestamp: 2026-01-12T14:59:50+00:00
+#   timestamp: 2026-01-15T10:15:02+00:00
 
 from __future__ import annotations
 

package/pins_data_model/models/model_listed_building.py

@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  listed-building.schema.json
-#   timestamp: 2026-01-12T14:59:50+00:00
+#   timestamp: 2026-01-15T10:15:02+00:00
 
 from __future__ import annotations
 

package/pins_data_model/models/model_listed_buildings.py

@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  listed-buildings.schema.json
-#   timestamp: 2026-01-12T14:59:51+00:00
+#   timestamp: 2026-01-15T10:15:02+00:00
 
 from __future__ import annotations
 

package/pins_data_model/models/model_nsip_document.py

@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  nsip-document.schema.json
-#   timestamp: 2026-01-12T14:59:50+00:00
+#   timestamp: 2026-01-15T10:15:02+00:00
 
 from __future__ import annotations
 

package/pins_data_model/models/model_nsip_exam_timetable.py

@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  nsip-exam-timetable.schema.json
-#   timestamp: 2026-01-12T14:59:51+00:00
+#   timestamp: 2026-01-15T10:15:02+00:00
 
 from __future__ import annotations
 

package/pins_data_model/models/model_nsip_invoice.py

@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  nsip-invoice.schema.json
-#   timestamp: 2026-01-12T14:59:50+00:00
+#   timestamp: 2026-01-15T10:15:02+00:00
 
 from __future__ import annotations
 

package/pins_data_model/models/model_nsip_meeting.py

@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  nsip-meeting.schema.json
-#   timestamp: 2026-01-12T14:59:50+00:00
+#   timestamp: 2026-01-15T10:15:02+00:00
 
 from __future__ import annotations
 

package/pins_data_model/models/model_nsip_project.py

@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  nsip-project.schema.json
-#   timestamp: 2026-01-12T14:59:50+00:00
+#   timestamp: 2026-01-15T10:15:02+00:00
 
 from __future__ import annotations
 

package/pins_data_model/models/model_nsip_project_update.py

@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  nsip-project-update.schema.json
-#   timestamp: 2026-01-12T14:59:50+00:00
+#   timestamp: 2026-01-15T10:15:02+00:00
 
 from __future__ import annotations
 

package/pins_data_model/models/model_nsip_representation.py

@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  nsip-representation.schema.json
-#   timestamp: 2026-01-12T14:59:51+00:00
+#   timestamp: 2026-01-15T10:15:02+00:00
 
 from __future__ import annotations
 

package/pins_data_model/models/model_nsip_subscription.py

@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  nsip-subscription.schema.json
-#   timestamp: 2026-01-12T14:59:50+00:00
+#   timestamp: 2026-01-15T10:15:02+00:00
 
 from __future__ import annotations
 

package/pins_data_model/models/model_pins_inspector.py

@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  pins-inspector.schema.json
-#   timestamp: 2026-01-12T14:59:50+00:00
+#   timestamp: 2026-01-15T10:15:02+00:00
 
 from __future__ import annotations
 

package/pins_data_model/models/model_pins_lpa.py

@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  pins-lpa.schema.json
-#   timestamp: 2026-01-12T14:59:50+00:00
+#   timestamp: 2026-01-15T10:15:02+00:00
 
 from __future__ import annotations
 

package/pins_data_model/models/model_s51_advice.py

@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  s51-advice.schema.json
-#   timestamp: 2026-01-12T14:59:50+00:00
+#   timestamp: 2026-01-15T10:15:02+00:00
 
 from __future__ import annotations
 

package/pins_data_model/models/model_service_user.py

@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  service-user.schema.json
-#   timestamp: 2026-01-12T14:59:50+00:00
+#   timestamp: 2026-01-15T10:15:02+00:00
 
 from __future__ import annotations
 

package/schemas/appeal-s78.schema.json

@@ -464,20 +464,20 @@
       "$comment": "Also available on HAS cases"
     },
     "applicationReference": {
-      "type": "string",
+      "type": ["string", "null"],
       "examples": ["43010/APP/1/290572"],
       "description": "The unique identifier of the LPA application",
       "$comment": "Also available on HAS cases"
     },
     "applicationDate": {
-      "type": "string",
+      "type": ["string", "null"],
       "format": "date-time",
       "examples": ["2023-07-27T20:30:00.000Z"],
       "description": "The date of the original LPA application",
       "$comment": "Also available on HAS cases"
     },
     "applicationDecision": {
-      "type": "string",
+      "type": ["string", "null"],
       "enum": ["granted", "refused", "not_received"],
       "description": "The outcome of the original LPA decision",
       "$comment": "Also available on HAS cases"
@@ -1107,6 +1107,23 @@
       "type": ["string", "null"],
       "description": "padsSapId for PADS inspectors"
     },
+    "enforcementNoticeReference": {
+      "type": ["string", "null"],
+      "description": "The reference number of the enforcement notice",
+      "examples": ["myC45e-123"]
+    },
+    "descriptionOfAllegedBreach": {
+      "type": ["string", "null"],
+      "description": "A description of the alleged breach",
+      "examples": ["My breach description"]
+    },
+    "dateAppellantContactedPins": {
+      "type": ["string", "null"],
+      "format": "date-time",
+      "examples": ["2025-12-26T10:00:00.000Z"],
+      "description": "The date of the appellant contacted PINS prior to submitting an appeal",
+      "$comment": "Relevant if enforcement effective date already passed"
+    },
     "ownerOccupancyStatus": {
       "type": ["string", "null"],
       "description": "The nature of the appellant's interest in the appeal site",