@planning-inspectorate/data-model 2.49.0 → 2.51.0

package/pins_data_model/models/model_pins_inspector.py

@@ -10,11 +10,11 @@ class Address(BaseModel):
     model_config = ConfigDict(
         extra="allow",
     )
-    addressLine1: str | None = None
-    addressLine2: str | None = None
-    townCity: str | None = None
-    county: str | None = None
-    postcode: str | None = None
+    addressLine1: str | None
+    addressLine2: str | None
+    townCity: str | None
+    county: str | None
+    postcode: str | None
 
 
 class Specialism(BaseModel):

package/pins_data_model/models/model_s51_advice.py

@@ -65,11 +65,11 @@ class S51Advice(BaseModel):
     """
     Who the enquiry is from
     """
-    agent: str | None = None
+    agent: str | None
     """
     Who the enquiry is on behalf of
     """
-    method: Method
+    method: Method | None
     """
     How the enquiry was made
     """
@@ -79,7 +79,7 @@ class S51Advice(BaseModel):
     """
     Date the enquiry was made
     """
-    enquiryDetails: str | None = None
+    enquiryDetails: str | None
     """
     Details of the enquiry
     """
@@ -87,7 +87,7 @@ class S51Advice(BaseModel):
     """
     Details of the enquiry in Welsh
     """
-    adviceGivenBy: str | None = None
+    adviceGivenBy: str | None
     """
     Who issued the advice
     """
@@ -95,7 +95,7 @@ class S51Advice(BaseModel):
     """
     Date the advice was given
     """
-    adviceDetails: str | None = None
+    adviceDetails: str | None
     """
     Details of the advice
     """
@@ -103,6 +103,6 @@ class S51Advice(BaseModel):
     """
     Details of the advice in Welsh
     """
-    status: Status
-    redactionStatus: RedactionStatus
+    status: Status | None
+    redactionStatus: RedactionStatus | None
     attachmentIds: list[str]

package/pins_data_model/models/model_service_user.py

@@ -3,12 +3,12 @@
 
 from __future__ import annotations
 
-from enum import Enum
+from enum import StrEnum
 
 from pydantic import BaseModel, ConfigDict, Field
 
 
-class ServiceUserType(Enum):
+class ServiceUserType(StrEnum):
     """
     Type or category of the service user.
     """

package/requirements.txt

@@ -1,2 +1,2 @@
-datamodel-code-generator==0.25.2
+datamodel-code-generator==0.64.0
 jsonc-parser==1.1.0

package/schemas/address.schema.json

@@ -0,0 +1,87 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "address.schema.json",
+  "title": "PINS Address Schema",
+  "description": "A schema to define the structure of an Address object in PINS.",
+  "type": "object",
+  "additionalProperties": true,
+  "required": ["addressDimKey", "caseReference", "caseId", "caseType"],
+  "properties": {
+    "addressDimKey": {
+      "type": "number",
+      "description": "Primary Key for an Address.",
+      "example": 12345
+    },
+    "addressType": {
+      "type": "string",
+      "description": "The type of thing this address is for.",
+      "example": "site",
+      "enum": ["site", "neighbouring", "organisation", "contact"]
+    },
+    "caseReference": {
+      "type": "string",
+      "description": "Business Key for the related case",
+      "example": "CROWN/2025/12345"
+    },
+    "caseId": {
+      "type": "string",
+      "description": "The unique ID for the case this representation belongs to.",
+      "example": "AAAAAAAA-1234-1234-1234-AAAAAAAAAAAA"
+    },
+    "caseType": {
+      "type": "string",
+      "description": "The type of case this representation is for.",
+      "example": "Crown Development Application"
+    },
+    "description": {
+      "type": ["string", "null"],
+      "description": "Some sites may have a postcode, but do not have postal addresses.",
+      "example": "The field behind the crown pub"
+    },
+    "line1": {
+      "type": ["string", "null"]
+    },
+    "line2": {
+      "type": ["string", "null"]
+    },
+    "townCity": {
+      "type": ["string", "null"]
+    },
+    "county": {
+      "type": ["string", "null"]
+    },
+    "postcode": {
+      "type": ["string", "null"]
+    },
+    "country": {
+      "type": ["string", "null"]
+    },
+    "easting": {
+      "type": ["string", "null"],
+      "example": "358267"
+    },
+    "northing": {
+      "type": ["string", "null"],
+      "example": "172797"
+    },
+    "latitudeWGS84": {
+      "type": ["number", "null"],
+      "example": 51.452608
+    },
+    "longitudeWGS84": {
+      "type": ["number", "null"],
+      "example": -2.6019821
+    },
+    "UPRN": {
+      "type": ["string", "null"],
+      "example": 100023336956,
+      "description": "The Unique Property Reference Number (UPRN) is a unique number (a geocode) for every addressable location—e.g., a building, a bus stop, a post box, a feature in the landscape, or a defibrillator—in Great Britain."
+    },
+    "dependentRequired": {
+      "easting": ["northing"],
+      "northing": ["easting"],
+      "latitudeWGS84": ["longitudeWGS84"],
+      "longitudeWGS84": ["latitudeWGS84"]
+    }
+  }
+}

package/schemas/{application-update.schema.json → applications-application-update.schema.json}

@@ -1,6 +1,6 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema#",
-  "$id": "application-update.schema.json",
+  "$id": "applications-application-update.schema.json",
   "title": "Application Update Schema",
   "description": "Application Update for Casework Project",
   "type": "object",