@planning-inspectorate/data-model 1.16.1 → 1.17.0

package/pins_data_model/models/model_appeal_has.py

@@ -1,13 +1,13 @@
 # generated by datamodel-codegen:
 #   filename:  appeal-has.schema.json
-#   timestamp: 2025-08-29T10:40:44+00:00
+#   timestamp: 2025-09-09T11:38:23+00:00
 
 from __future__ import annotations
 
 from enum import Enum
 from uuid import UUID
 
-from pydantic import AwareDatetime, BaseModel, ConfigDict, Field, RootModel
+from pydantic import AwareDatetime, BaseModel, ConfigDict, Field, RootModel, constr
 
 
 class CaseStatus(Enum):
@@ -142,6 +142,17 @@ class ApplicationDecision(Enum):
     not_received = "not_received"
 
 
+class LpaProcedurePreference(Enum):
+    """
+    The procedure preference indicated by the LPA
+    """
+
+    written = "written"
+    hearing = "hearing"
+    inquiry = "inquiry"
+    NoneType_None = None
+
+
 class KnowsOtherOwners(Enum):
     """
     Indicates if the appellant knows other owners of the site
@@ -225,9 +236,9 @@ class TypeOfPlanningApplication(Enum):
     NoneType_None = None
 
 
-class AppealHasCase(BaseModel):
+class AppealHasCase1(BaseModel):
     """
-    Schema defining the metadata for an appeal
+    Group A - Schema defining the metadata for an appeal
     """
 
     model_config = ConfigDict(
@@ -466,7 +477,7 @@ class AppealHasCase(BaseModel):
     """
     The statutory deadline for submitting an appeal from the original LPA decision date
     """
-    siteAddressLine1: str = Field(..., examples=["96 The Avenue"])
+    siteAddressLine1: str | None = Field(None, examples=["96 The Avenue"])
     """
     First line of address for the appeal site
     """
@@ -474,15 +485,15 @@ class AppealHasCase(BaseModel):
     """
     Second line of address for the appeal site
     """
-    siteAddressTown: str = Field(..., examples=["Maidstone"])
+    siteAddressTown: str | None = Field(None, examples=["Maidstone"])
     """
     Town / City of the site address
     """
-    siteAddressCounty: str | None = Field(..., examples=["Kent"])
+    siteAddressCounty: str | None = Field(None, examples=["Kent"])
     """
     County of the site address
     """
-    siteAddressPostcode: str = Field(..., examples=["MD21 5XY"])
+    siteAddressPostcode: str | None = Field(None, examples=["MD21 5XY"])
     """
     Postal code of the site address
     """
@@ -514,6 +525,104 @@ class AppealHasCase(BaseModel):
     """
     Indicates if the site is in a conservation area
     """
+    affectsScheduledMonument: bool | None = None
+    """
+    Indicates if the development affects a scheduled monument
+    """
+    hasProtectedSpecies: bool | None = None
+    """
+    Indicates if the site hosts protected species
+    """
+    isAonbNationalLandscape: bool | None = None
+    """
+    Indicates an area of outstanding beauty (National Landscape)
+    """
+    isSiteOnHighwayLand: bool | None = None
+    """
+    Indicates if site is on highway land
+    """
+    designatedSitesNames: list[str] | None = None
+    """
+    The designated site names
+    """
+    hasInfrastructureLevy: bool | None = None
+    """
+    Indicates the existence of an infrastructure levy
+    """
+    isInfrastructureLevyFormallyAdopted: bool | None = None
+    """
+    Indicates if the infrastructure levy is formally adopted
+    """
+    infrastructureLevyAdoptedDate: AwareDatetime | None = Field(
+        None, examples=["2023-07-27T20:30:00.000Z"]
+    )
+    """
+    The date of the infrastructure levy adoption
+    """
+    infrastructureLevyExpectedDate: AwareDatetime | None = Field(
+        None, examples=["2023-07-27T20:30:00.000Z"]
+    )
+    """
+    The expected date of the infrastructure levy
+    """
+    lpaProcedurePreference: LpaProcedurePreference | None = None
+    """
+    The procedure preference indicated by the LPA
+    """
+    lpaProcedurePreferenceDetails: str | None = None
+    """
+    The procedure details preference indicated by the LPA
+    """
+    lpaProcedurePreferenceDuration: float | None = None
+    """
+    The duration of enquiry indicated by the LPA
+    """
+    caseworkReason: str | None = None
+    """
+    TBC
+    """
+    importantInformation: str | None = None
+    """
+    Information relevant to case...
+    """
+    jurisdiction: str | None = None
+    """
+    Under whose jurisdiction the decision falls
+    """
+    redeterminedIndicator: bool | None = None
+    """
+    Has the case been selected for redetermination
+    """
+    dateCostsReportDespatched: AwareDatetime | None = Field(
+        None, examples=["2023-07-27T20:30:00.000Z"]
+    )
+    """
+    The date that the costs report was sent
+    """
+    dateNotRecoveredOrDerecovered: AwareDatetime | None = Field(
+        None, examples=["2023-07-27T20:30:00.000Z"]
+    )
+    """
+    The date that is TBC
+    """
+    dateRecovered: AwareDatetime | None = Field(
+        None, examples=["2023-07-27T20:30:00.000Z"]
+    )
+    """
+    The date that case was recovered
+    """
+    originalCaseDecisionDate: AwareDatetime | None = Field(
+        None, examples=["2023-07-27T20:30:00.000Z"]
+    )
+    """
+    The original case decision date
+    """
+    targetDate: AwareDatetime | None = Field(
+        None, examples=["2023-07-27T20:30:00.000Z"]
+    )
+    """
+    The target date for case completion
+    """
     ownsAllLand: bool | None = None
     """
     Indicates if the appellant has complete ownership of the site
@@ -584,3 +693,533 @@ class AppealHasCase(BaseModel):
     Indicates if the appellant has applied for costs
     """
     typeOfPlanningApplication: TypeOfPlanningApplication | None = None
+    siteGridReferenceEasting: constr(pattern=r"^\d{6}$") | None = Field(
+        ..., examples=["357144"]
+    )
+    siteGridReferenceNorthing: constr(pattern=r"^\d{6}$") | None = Field(
+        ..., examples=["400534"]
+    )
+    hasLandownersPermission: bool | None = None
+    """
+    Indicates if the appellant has land owners permission
+    """
+    isAdvertInPosition: bool | None = None
+    """
+    Indicates if the advert is already in position
+    """
+    isSiteInAreaOfSpecialControlAdverts: bool | None = None
+    """
+    Indicates if the site is in an area of special control for adverts
+    """
+    wasApplicationRefusedDueToHighwayOrTraffic: bool | None = None
+    """
+    Indicates if the application was refused because of highway or traffic public safety?
+    """
+    didAppellantSubmitCompletePhotosAndPlans: bool | None = None
+    """
+    Indicates if the appellant submitted complete and accurate photographs and plans
+    """
+    advertType: str | None = None
+
+
+class NotificationMethodEnum1EnumEnum(Enum):
+    notice = "notice"
+    letter = "letter"
+    advert = "advert"
+
+
+class NotificationMethodEnum1(RootModel[NotificationMethodEnum1EnumEnum | None]):
+    root: NotificationMethodEnum1EnumEnum | None = None
+
+
+class AppealHasCase2(BaseModel):
+    """
+    Group A - Schema defining the metadata for an appeal
+    """
+
+    model_config = ConfigDict(
+        extra="allow",
+    )
+    caseId: int | None = Field(..., examples=[1200])
+    """
+    Internal case identifier
+    """
+    caseReference: str = Field(..., examples=["7002471"])
+    """
+    External case identifier
+    """
+    submissionId: UUID | None = Field(
+        None, examples=["7f45748c-2342-4b59-b934-ad6183e8d834"]
+    )
+    """
+    Case submission id - link to draft submission created by appellant
+    """
+    caseStatus: CaseStatus
+    """
+    The processing status for the appeal
+    """
+    caseType: CaseType
+    """
+    The internal code for an appeal type, e.g. D (Householder)
+    """
+    caseProcedure: CaseProcedure
+    """
+    The type of procedure for the appeal
+    """
+    lpaCode: str = Field(..., examples=["Q9999"])
+    """
+    A unique identifier for the Local Planning Authority
+    """
+    caseOfficerId: str | None = None
+    """
+    Unique identifier for the case officer assigned to the case
+    """
+    inspectorId: str | None = None
+    """
+    Unique identifier for the inspector assigned to the case
+    """
+    allocationLevel: AllocationLevel
+    """
+    A level used for allocation purposes
+    """
+    allocationBand: AllocationBand
+    """
+    A band used for allocation purposes
+    """
+    caseSpecialisms: list[str] = Field(
+        ...,
+        examples=[
+            "Access",
+            "Listed building and enforcement",
+            "Roads and traffics",
+            "Natural heritage",
+            "Schedule 1",
+        ],
+    )
+    """
+    A list of specialisms for allocation purposes
+    """
+    caseSubmittedDate: AwareDatetime = Field(..., examples=["2023-07-27T20:30:00.000Z"])
+    """
+    The date the appeal was submitted by the appellant
+    """
+    caseCreatedDate: AwareDatetime = Field(..., examples=["2023-07-27T20:30:00.000Z"])
+    """
+    The date the appeal was received
+    """
+    caseUpdatedDate: AwareDatetime = Field(..., examples=["2023-07-27T20:30:00.000Z"])
+    """
+    The date the appeal was last updated in the back-office
+    """
+    caseValidDate: AwareDatetime | None = Field(
+        ..., examples=["2023-07-27T20:30:00.000Z"]
+    )
+    """
+    The date since when the appeal was considered valid
+    """
+    caseValidationDate: AwareDatetime | None = Field(
+        ..., examples=["2023-07-27T20:30:00.000Z"]
+    )
+    """
+    The date the appeal was validated in the back-office
+    """
+    caseValidationOutcome: CaseValidationOutcome
+    """
+    The outcome of the validation action
+    """
+    caseValidationInvalidDetails: list[str]
+    """
+    A list of reasons why the appeal is invalid
+    """
+    caseValidationIncompleteDetails: list[str]
+    """
+    A list of reasons why the appeal is incomplete
+    """
+    caseExtensionDate: AwareDatetime | None = Field(
+        ..., examples=["2023-07-27T20:30:00.000Z"]
+    )
+    """
+    When the validation outcome is incomplete, an extension may be granted to provide missing information
+    """
+    caseStartedDate: AwareDatetime | None = Field(
+        ..., examples=["2023-07-27T20:30:00.000Z"]
+    )
+    """
+    A date indicating when the case was started, resulting in the creation of a timetable
+    """
+    casePublishedDate: AwareDatetime | None = Field(
+        ..., examples=["2023-07-27T20:30:00.000Z"]
+    )
+    """
+    A date indicating when the case was published
+    """
+    linkedCaseStatus: LinkedCaseStatus
+    """
+    Indicates if the case is linked, and the type of relationship
+    """
+    leadCaseReference: str | None = Field(..., examples=["7002471"])
+    """
+    The reference of the lead case, if the case is a child case
+    """
+    lpaQuestionnaireDueDate: AwareDatetime | None = Field(
+        ..., examples=["2023-07-27T20:30:00.000Z"]
+    )
+    """
+    If the case is started and has a timetable, a deadline for the LPA to provide a response
+    """
+    lpaQuestionnaireSubmittedDate: AwareDatetime | None = Field(
+        ..., examples=["2023-07-27T20:30:00.000Z"]
+    )
+    """
+    The date the LPA provided a response to the case
+    """
+    lpaQuestionnaireCreatedDate: AwareDatetime | None = Field(
+        ..., examples=["2023-07-27T20:30:00.000Z"]
+    )
+    """
+    The date the LPA response was receeived
+    """
+    lpaQuestionnairePublishedDate: AwareDatetime | None = Field(
+        ..., examples=["2023-07-27T20:30:00.000Z"]
+    )
+    """
+    The date indicating when the questionnaire review was completed and the questionnaire published
+    """
+    lpaQuestionnaireValidationOutcome: LpaQuestionnaireValidationOutcome
+    """
+    The outcome of the validation action
+    """
+    lpaQuestionnaireValidationOutcomeDate: AwareDatetime | None = Field(
+        ..., examples=["2023-07-27T20:30:00.000Z"]
+    )
+    """
+    The date the LPA response was validated
+    """
+    lpaQuestionnaireValidationDetails: list[str]
+    """
+    A list of reasons why the questionnaire is incomplete
+    """
+    lpaStatement: str | None = Field(
+        ..., examples=["We refused the application because of ..."]
+    )
+    """
+    A statement provided by the LPA
+    """
+    caseWithdrawnDate: AwareDatetime | None = Field(
+        ..., examples=["2023-07-27T20:30:00.000Z"]
+    )
+    """
+    The date the appeal was withdrawn by the appellant
+    """
+    caseTransferredDate: AwareDatetime | None = Field(
+        ..., examples=["2023-07-27T20:30:00.000Z"]
+    )
+    """
+    The date the appeal was transferred to a new case of a different type
+    """
+    transferredCaseClosedDate: AwareDatetime | None = Field(
+        ..., examples=["2023-07-27T20:30:00.000Z"]
+    )
+    """
+    The date the appeal was closed and the appellant requested to resubmit
+    """
+    caseDecisionOutcomeDate: AwareDatetime | None = Field(
+        ..., examples=["2023-07-27T20:30:00.000Z"]
+    )
+    """
+    The date of the appeal decision
+    """
+    caseDecisionPublishedDate: AwareDatetime | None = Field(
+        ..., examples=["2023-07-27T20:30:00.000Z"]
+    )
+    """
+    The date the appeal decision was published
+    """
+    caseDecisionOutcome: CaseDecisionOutcome
+    """
+    The final outcome for the decision
+    """
+    caseCompletedDate: AwareDatetime | None = Field(
+        ..., examples=["2023-07-27T20:30:00.000Z"]
+    )
+    """
+    The date the appeal decision letter
+    """
+    enforcementNotice: bool | None = None
+    """
+    Indicates if an enforcement notice is the reason for the appeal
+    """
+    applicationReference: str = Field(..., examples=["43010/APP/1/290572"])
+    """
+    The unique identifier of the LPA application
+    """
+    applicationDate: AwareDatetime = Field(..., examples=["2023-07-27T20:30:00.000Z"])
+    """
+    The date of the original LPA application
+    """
+    applicationDecision: ApplicationDecision
+    """
+    The outcome of the original LPA decision
+    """
+    applicationDecisionDate: AwareDatetime | None = Field(
+        ..., examples=["2023-07-27T20:30:00.000Z"]
+    )
+    """
+    The date of the original LPA decision
+    """
+    caseSubmissionDueDate: AwareDatetime | None = Field(
+        ..., examples=["2023-07-27T20:30:00.000Z"]
+    )
+    """
+    The statutory deadline for submitting an appeal from the original LPA decision date
+    """
+    siteAddressLine1: str | None = Field(..., examples=["96 The Avenue"])
+    """
+    First line of address for the appeal site
+    """
+    siteAddressLine2: str | None = None
+    """
+    Second line of address for the appeal site
+    """
+    siteAddressTown: str | None = Field(..., examples=["Maidstone"])
+    """
+    Town / City of the site address
+    """
+    siteAddressCounty: str | None = Field(None, examples=["Kent"])
+    """
+    County of the site address
+    """
+    siteAddressPostcode: str | None = Field(..., examples=["MD21 5XY"])
+    """
+    Postal code of the site address
+    """
+    siteAccessDetails: list[str]
+    """
+    Provided information on site accessibility
+    """
+    siteSafetyDetails: list[str]
+    """
+    Provided information on site health and safety
+    """
+    siteAreaSquareMetres: float | None = Field(..., examples=[45.7])
+    """
+    The site area, in square meters
+    """
+    floorSpaceSquareMetres: float | None = Field(..., examples=[3.5])
+    """
+    The floor space, in square meters
+    """
+    isCorrectAppealType: bool | None = None
+    """
+    Indicates if the LPA considers the appeal type appropriate
+    """
+    isGreenBelt: bool | None = None
+    """
+    Indicates if the site is in a green belt
+    """
+    inConservationArea: bool | None = None
+    """
+    Indicates if the site is in a conservation area
+    """
+    affectsScheduledMonument: bool | None = None
+    """
+    Indicates if the development affects a scheduled monument
+    """
+    hasProtectedSpecies: bool | None = None
+    """
+    Indicates if the site hosts protected species
+    """
+    isAonbNationalLandscape: bool | None = None
+    """
+    Indicates an area of outstanding beauty (National Landscape)
+    """
+    isSiteOnHighwayLand: bool | None = None
+    """
+    Indicates if site is on highway land
+    """
+    designatedSitesNames: list[str] | None = None
+    """
+    The designated site names
+    """
+    hasInfrastructureLevy: bool | None = None
+    """
+    Indicates the existence of an infrastructure levy
+    """
+    isInfrastructureLevyFormallyAdopted: bool | None = None
+    """
+    Indicates if the infrastructure levy is formally adopted
+    """
+    infrastructureLevyAdoptedDate: AwareDatetime | None = Field(
+        None, examples=["2023-07-27T20:30:00.000Z"]
+    )
+    """
+    The date of the infrastructure levy adoption
+    """
+    infrastructureLevyExpectedDate: AwareDatetime | None = Field(
+        None, examples=["2023-07-27T20:30:00.000Z"]
+    )
+    """
+    The expected date of the infrastructure levy
+    """
+    lpaProcedurePreference: LpaProcedurePreference | None = None
+    """
+    The procedure preference indicated by the LPA
+    """
+    lpaProcedurePreferenceDetails: str | None = None
+    """
+    The procedure details preference indicated by the LPA
+    """
+    lpaProcedurePreferenceDuration: float | None = None
+    """
+    The duration of enquiry indicated by the LPA
+    """
+    caseworkReason: str | None = None
+    """
+    TBC
+    """
+    importantInformation: str | None = None
+    """
+    Information relevant to case...
+    """
+    jurisdiction: str | None = None
+    """
+    Under whose jurisdiction the decision falls
+    """
+    redeterminedIndicator: bool | None = None
+    """
+    Has the case been selected for redetermination
+    """
+    dateCostsReportDespatched: AwareDatetime | None = Field(
+        None, examples=["2023-07-27T20:30:00.000Z"]
+    )
+    """
+    The date that the costs report was sent
+    """
+    dateNotRecoveredOrDerecovered: AwareDatetime | None = Field(
+        None, examples=["2023-07-27T20:30:00.000Z"]
+    )
+    """
+    The date that is TBC
+    """
+    dateRecovered: AwareDatetime | None = Field(
+        None, examples=["2023-07-27T20:30:00.000Z"]
+    )
+    """
+    The date that case was recovered
+    """
+    originalCaseDecisionDate: AwareDatetime | None = Field(
+        None, examples=["2023-07-27T20:30:00.000Z"]
+    )
+    """
+    The original case decision date
+    """
+    targetDate: AwareDatetime | None = Field(
+        None, examples=["2023-07-27T20:30:00.000Z"]
+    )
+    """
+    The target date for case completion
+    """
+    ownsAllLand: bool | None = None
+    """
+    Indicates if the appellant has complete ownership of the site
+    """
+    ownsSomeLand: bool | None = None
+    """
+    Indicates if the appellant has partial ownership of the site
+    """
+    knowsOtherOwners: KnowsOtherOwners
+    """
+    Indicates if the appellant knows other owners of the site
+    """
+    knowsAllOwners: KnowsAllOwners
+    """
+    Indicates if the appellant knows all owners of the site
+    """
+    advertisedAppeal: bool | None = None
+    """
+    Indicates if the appellant has advertised the appeal to the LPA decision
+    """
+    notificationMethod: list[NotificationMethodEnum1]
+    """
+    The methods used to notify relevant parties
+    """
+    ownersInformed: bool | None = None
+    """
+    Indicates if the appellant has informed other owners of the site
+    """
+    originalDevelopmentDescription: str | None = Field(
+        ..., examples=["Replacement of an existing gate to access the property"]
+    )
+    """
+    The original description of the development, as provided by the appellant
+    """
+    changedDevelopmentDescription: bool | None = None
+    """
+    Indicates that the LPA has changed the development description
+    """
+    newConditionDetails: str | None = Field(
+        ...,
+        examples=["Since the original application, a number of things have changed..."],
+    )
+    """
+    New conditions details provided by the LPA
+    """
+    nearbyCaseReferences: list[str]
+    """
+    A list of related case references known to the appellant and the LPA
+    """
+    neighbouringSiteAddresses: list[NeighbouringSiteAddress]
+    """
+    A list of neighbouring site addresses
+    """
+    reasonForNeighbourVisits: str | None = None
+    """
+    A general reason given for the need to visit any neighbours
+    """
+    affectedListedBuildingNumbers: list[str]
+    """
+    A list of affected listed building IDs from Historic England
+    """
+    appellantCostsAppliedFor: bool | None = None
+    """
+    Indicates if the appellant has applied for costs
+    """
+    lpaCostsAppliedFor: bool | None = None
+    """
+    Indicates if the appellant has applied for costs
+    """
+    typeOfPlanningApplication: TypeOfPlanningApplication | None = None
+    siteGridReferenceEasting: constr(pattern=r"^\d{6}$") | None = Field(
+        None, examples=["357144"]
+    )
+    siteGridReferenceNorthing: constr(pattern=r"^\d{6}$") | None = Field(
+        None, examples=["400534"]
+    )
+    hasLandownersPermission: bool | None = None
+    """
+    Indicates if the appellant has land owners permission
+    """
+    isAdvertInPosition: bool | None = None
+    """
+    Indicates if the advert is already in position
+    """
+    isSiteInAreaOfSpecialControlAdverts: bool | None = None
+    """
+    Indicates if the site is in an area of special control for adverts
+    """
+    wasApplicationRefusedDueToHighwayOrTraffic: bool | None = None
+    """
+    Indicates if the application was refused because of highway or traffic public safety?
+    """
+    didAppellantSubmitCompletePhotosAndPlans: bool | None = None
+    """
+    Indicates if the appellant submitted complete and accurate photographs and plans
+    """
+    advertType: str | None = None
+
+
+class AppealHasCase(RootModel[AppealHasCase1 | AppealHasCase2]):
+    root: AppealHasCase1 | AppealHasCase2 = Field(..., title="Appeal HAS Case")
+    """
+    Group A - Schema defining the metadata for an appeal
+    """