@planning-inspectorate/data-model 1.11.0

package/pins_data_model/load_schemas.py

@@ -0,0 +1,51 @@
+"""
+Module with two functions:
+
+load_all_schemas
+load_schemas
+
+They are used to generate a dictionary of schemas and commands
+"""
+
+from typing import TypedDict
+from jsonc_parser.parser import JsoncParser
+from os import path, listdir
+
+schemasDir = path.join(path.dirname(path.realpath(__file__)), "..", "schemas")
+commandsDir = path.join(schemasDir, "commands")
+
+LoadedSchemas = TypedDict(
+    "LoadedSchemas", {"schemas": dict[str, dict], "commands": dict[str, dict]}
+)
+
+
+def load_all_schemas() -> LoadedSchemas:
+    """
+    Load all schemas
+
+    Returns:
+        LoadedSchemas: schemas & commands dictionaries
+    """
+    return {"schemas": load_schemas(schemasDir), "commands": load_schemas(commandsDir)}
+
+
+def load_schemas(dir_path: str) -> dict[str, dict]:
+    """
+    Load schemas
+
+    Args:
+        dir_path (str): The directory to load schemas from
+
+    Returns:
+        dict[str, dict]: a dictionary of schema name to schema
+    """
+
+    schemas_by_name = {}
+
+    for filename in listdir(dir_path):
+        if filename.endswith(".schema.json") or filename.endswith(".schema.jsonc"):
+            schema = JsoncParser.parse_file(path.join(dir_path, filename))
+            name = path.basename(filename)
+            schemas_by_name[name] = schema
+
+    return schemas_by_name

package/pins_data_model/models/model_appeal_document.py

@@ -0,0 +1,294 @@
+# generated by datamodel-codegen:
+#   filename:  appeal-document.schema.json
+#   timestamp: 2025-07-16T14:06:10+00:00
+
+from __future__ import annotations
+
+from enum import Enum
+
+from pydantic import AwareDatetime, BaseModel, ConfigDict, Field
+
+
+class VirusCheckStatus(Enum):
+    """
+    Indicates the virus check status for the current document
+    """
+
+    not_scanned = "not_scanned"
+    scanned = "scanned"
+    affected = "affected"
+    NoneType_None = None
+
+
+class CaseType(Enum):
+    """
+    The internal code for an appeal type, e.g. Householder (D)
+    """
+
+    C = "C"
+    D = "D"
+    F = "F"
+    G = "G"
+    H = "H"
+    L = "L"
+    Q = "Q"
+    S = "S"
+    V = "V"
+    W = "W"
+    X = "X"
+    Y = "Y"
+    Z = "Z"
+    ZA = "ZA"
+    ZP = "ZP"
+    NoneType_None = None
+
+
+class RedactedStatus(Enum):
+    """
+    Indicates the redaction status for the document
+    """
+
+    not_redacted = "not_redacted"
+    redacted = "redacted"
+    no_redaction_required = "no_redaction_required"
+    NoneType_None = None
+
+
+class DocumentType(Enum):
+    """
+    The type of document, used for exchange, migrations and consumption from the appeal back-office system
+    """
+
+    appellantCaseCorrespondence = "appellantCaseCorrespondence"
+    appellantCaseWithdrawalLetter = "appellantCaseWithdrawalLetter"
+    appellantCostsApplication = "appellantCostsApplication"
+    appellantCostsCorrespondence = "appellantCostsCorrespondence"
+    appellantCostsWithdrawal = "appellantCostsWithdrawal"
+    appellantStatement = "appellantStatement"
+    applicationDecisionLetter = "applicationDecisionLetter"
+    changedDescription = "changedDescription"
+    originalApplicationForm = "originalApplicationForm"
+    whoNotified = "whoNotified"
+    whoNotifiedSiteNotice = "whoNotifiedSiteNotice"
+    whoNotifiedLetterToNeighbours = "whoNotifiedLetterToNeighbours"
+    whoNotifiedPressAdvert = "whoNotifiedPressAdvert"
+    conservationMap = "conservationMap"
+    lpaCaseCorrespondence = "lpaCaseCorrespondence"
+    lpaCostsApplication = "lpaCostsApplication"
+    lpaCostsCorrespondence = "lpaCostsCorrespondence"
+    lpaCostsWithdrawal = "lpaCostsWithdrawal"
+    otherPartyRepresentations = "otherPartyRepresentations"
+    planningOfficerReport = "planningOfficerReport"
+    appellantCostsDecisionLetter = "appellantCostsDecisionLetter"
+    lpaCostsDecisionLetter = "lpaCostsDecisionLetter"
+    caseDecisionLetter = "caseDecisionLetter"
+    crossTeamCorrespondence = "crossTeamCorrespondence"
+    inspectorCorrespondence = "inspectorCorrespondence"
+    mainPartyCorrespondence = "mainPartyCorrespondence"
+    uncategorised = "uncategorised"
+    designAccessStatement = "designAccessStatement"
+    plansDrawings = "plansDrawings"
+    newPlansDrawings = "newPlansDrawings"
+    planningObligation = "planningObligation"
+    ownershipCertificate = "ownershipCertificate"
+    otherNewDocuments = "otherNewDocuments"
+    statementCommonGround = "statementCommonGround"
+    communityInfrastructureLevy = "communityInfrastructureLevy"
+    supplementaryPlanning = "supplementaryPlanning"
+    otherRelevantPolicies = "otherRelevantPolicies"
+    emergingPlan = "emergingPlan"
+    developmentPlanPolicies = "developmentPlanPolicies"
+    consultationResponses = "consultationResponses"
+    eiaEnvironmentalStatement = "eiaEnvironmentalStatement"
+    eiaScreeningDirection = "eiaScreeningDirection"
+    eiaScreeningOpinion = "eiaScreeningOpinion"
+    eiaScopingOpinion = "eiaScopingOpinion"
+    definitiveMapStatement = "definitiveMapStatement"
+    treePreservationPlan = "treePreservationPlan"
+    interestedPartyComment = "interestedPartyComment"
+    lpaStatement = "lpaStatement"
+    rule6Statement = "rule6Statement"
+    appellantFinalComment = "appellantFinalComment"
+    lpaFinalComment = "lpaFinalComment"
+    appellantProofOfEvidence = "appellantProofOfEvidence"
+    appellantWitnessesEvidence = "appellantWitnessesEvidence"
+    lpaProofOfEvidence = "lpaProofOfEvidence"
+    lpaWitnessesEvidence = "lpaWitnessesEvidence"
+    rule6ProofOfEvidence = "rule6ProofOfEvidence"
+    rule6WitnessesEvidence = "rule6WitnessesEvidence"
+    environmentalAssessment = "environmentalAssessment"
+    appealNotification = "appealNotification"
+    historicEnglandConsultation = "historicEnglandConsultation"
+    NoneType_None = None
+
+
+class SourceSystem(Enum):
+    """
+    The system mastering the metadata for the current document
+    """
+
+    back_office_appeals = "back-office-appeals"
+    horizon = "horizon"
+    acp = "acp"
+    sharepoint = "sharepoint"
+    NoneType_None = None
+
+
+class Origin(Enum):
+    """
+    Indicates where the documents originates from
+    """
+
+    pins = "pins"
+    citizen = "citizen"
+    lpa = "lpa"
+    ogd = "ogd"
+    NoneType_None = None
+
+
+class CaseStage(Enum):
+    """
+    The stage in the appeal process that has created the document
+    """
+
+    appellant_case = "appellant-case"
+    lpa_questionnaire = "lpa-questionnaire"
+    statements = "statements"
+    third_party_comments = "third-party-comments"
+    evidence = "evidence"
+    witnesses = "witnesses"
+    final_comments = "final-comments"
+    appeal_decision = "appeal-decision"
+    costs = "costs"
+    internal = "internal"
+    NoneType_None = None
+
+
+class AppealDocument(BaseModel):
+    """
+    Schema defining the metadata for appeal documents
+    """
+
+    model_config = ConfigDict(
+        extra="allow",
+    )
+    documentId: str = Field(..., examples=["4547fec8-16b2-47bb-836d-4d0baac04079"])
+    """
+    The unique identifier for the document
+    """
+    caseId: int | None = Field(..., examples=[1200])
+    """
+    Internal case identifier
+    """
+    caseReference: str = Field(..., examples=["7002471"])
+    """
+    External case identifier
+    """
+    version: int = Field(..., examples=[1])
+    """
+    A document can have multiple versions, and this indicates the latest version
+    """
+    filename: str = Field(..., examples=["filename.pdf"])
+    """
+    Current stored name of the document
+    """
+    originalFilename: str = Field(..., examples=["original_filename.pdf"])
+    """
+    Original name of document
+    """
+    size: int = Field(..., examples=[23452])
+    """
+    The file size, in bytes
+    """
+    mime: str = Field(..., examples=["application/pdf"])
+    """
+    The mime type for the current version of the file
+    """
+    documentURI: str = Field(
+        ...,
+        examples=[
+            "https://custom-domain.gov.uk/container-name/appeal/7002471/4547fec8-16b2-47bb-836d-4d0baac04079/v1/filename.pdf"
+        ],
+    )
+    """
+    The internal location of the document
+    """
+    publishedDocumentURI: str | None = Field(
+        ...,
+        examples=[
+            "https://custom-domain.gov.uk/container-name/appeal/7002471/4547fec8-16b2-47bb-836d-4d0baac04079/v1/filename.pdf"
+        ],
+    )
+    """
+    The location of the published document, will be null if the datePublished is not set
+    """
+    virusCheckStatus: VirusCheckStatus
+    """
+    Indicates the virus check status for the current document
+    """
+    fileMD5: str | None = Field(..., examples=["b1946ac92492d2347c6235b4d2611184"])
+    """
+    A MD5 hash to check the validity of the file
+    """
+    dateCreated: AwareDatetime = Field(..., examples=["2023-07-27T20:30:00.000Z"])
+    """
+    The creation date for the document
+    """
+    dateReceived: AwareDatetime | None = Field(
+        ..., examples=["2023-07-27T20:30:00.000Z"]
+    )
+    """
+    The date the document was received
+    """
+    datePublished: AwareDatetime | None = Field(
+        ..., examples=["2023-07-27T20:30:00.000Z"]
+    )
+    """
+    The date the document was published
+    """
+    lastModified: AwareDatetime | None = Field(
+        ..., examples=["2023-07-27T20:30:00.000Z"]
+    )
+    """
+    The last update date for the document
+    """
+    caseType: CaseType
+    """
+    The internal code for an appeal type, e.g. Householder (D)
+    """
+    redactedStatus: RedactedStatus
+    """
+    Indicates the redaction status for the document
+    """
+    documentType: DocumentType
+    """
+    The type of document, used for exchange, migrations and consumption from the appeal back-office system
+    """
+    sourceSystem: SourceSystem
+    """
+    The system mastering the metadata for the current document
+    """
+    origin: Origin
+    """
+    Indicates where the documents originates from
+    """
+    owner: str | None = None
+    """
+    Owner of the current document
+    """
+    author: str | None = None
+    """
+    Name of person who authored document
+    """
+    description: str | None = None
+    """
+    A custom description for the document
+    """
+    caseStage: CaseStage
+    """
+    The stage in the appeal process that has created the document
+    """
+    horizonFolderId: str | None = None
+    """
+    The folder ID containing the document in Horizon
+    """

package/pins_data_model/models/model_appeal_event.py

@@ -0,0 +1,117 @@
+# generated by datamodel-codegen:
+#   filename:  appeal-event.schema.json
+#   timestamp: 2025-07-16T14:06:09+00:00
+
+from __future__ import annotations
+
+from enum import Enum
+
+from pydantic import AwareDatetime, BaseModel, ConfigDict, Field
+
+
+class EventType(Enum):
+    """
+    The type of event
+    """
+
+    site_visit_access_required = "site_visit_access_required"
+    site_visit_accompanied = "site_visit_accompanied"
+    site_visit_unaccompanied = "site_visit_unaccompanied"
+    hearing = "hearing"
+    hearing_virtual = "hearing_virtual"
+    inquiry = "inquiry"
+    inquiry_virtual = "inquiry_virtual"
+    in_house = "in_house"
+    pre_inquiry = "pre_inquiry"
+    pre_inquiry_virtual = "pre_inquiry_virtual"
+
+
+class EventStatus(Enum):
+    """
+    Status of the event
+    """
+
+    withdrawn = "withdrawn"
+    in_abeyance = "in_abeyance"
+    change_of_procedure = "change_of_procedure"
+    new_rescheduled = "new_rescheduled"
+    confirmed = "confirmed"
+    link_to_enforcement = "link_to_enforcement"
+    offered = "offered"
+    postponed = "postponed"
+
+
+class AppealEvent(BaseModel):
+    """
+    Schema defining the metadata for appeal events, such as site visits, inquiries, hearings
+    """
+
+    model_config = ConfigDict(
+        extra="allow",
+    )
+    eventId: str = Field(..., examples=["7000000-1"])
+    """
+    The unique identifier for the event
+    """
+    caseReference: str = Field(..., examples=["7002471"])
+    """
+    External case identifier
+    """
+    eventType: EventType
+    """
+    The type of event
+    """
+    eventName: str | None = Field(..., examples=["A site visit"])
+    """
+    An optional description / name for the event
+    """
+    eventStatus: EventStatus
+    """
+    Status of the event
+    """
+    isUrgent: bool
+    """
+    Indicates if the event is urgent
+    """
+    eventPublished: bool | None = None
+    """
+    Indicates if the event has been published
+    """
+    eventStartDateTime: AwareDatetime = Field(
+        ..., examples=["2023-07-27T20:30:00.000Z"]
+    )
+    """
+    Event start date and time
+    """
+    eventEndDateTime: AwareDatetime | None = Field(
+        ..., examples=["2023-07-27T20:30:00.000Z"]
+    )
+    """
+    Event end date and time
+    """
+    notificationOfSiteVisit: AwareDatetime | None = Field(
+        ..., examples=["2023-07-27T20:30:00.000Z"]
+    )
+    """
+    The date third-parties were informed of the site visit event
+    """
+    addressLine1: str | None = Field(..., examples=["96 The Avenue"])
+    """
+    First line of address for the event site
+    """
+    addressLine2: str | None = None
+    """
+    Second line of address for the event site
+    """
+    addressTown: str | None = Field(..., examples=["Maidstone"])
+    """
+    Town / City of the event address
+    """
+    addressCounty: str | None = Field(..., examples=["Kent"])
+    """
+    County of the event address
+    """
+    addressPostcode: str | None = Field(..., examples=["MD21 5XY"])
+    """
+    Postal code of the event address
+    """

package/pins_data_model/models/model_appeal_event_estimate.py

@@ -0,0 +1,37 @@
+# generated by datamodel-codegen:
+#   filename:  appeal-event-estimate.schema.json
+#   timestamp: 2025-07-16T14:06:09+00:00
+
+from __future__ import annotations
+
+from pydantic import BaseModel, ConfigDict
+
+
+class AppealEventEstimate(BaseModel):
+    """
+    All event estimates belong to a case. A case has only one event estimate.
+    """
+
+    model_config = ConfigDict(
+        extra="allow",
+    )
+    id: int
+    """
+    The unique identifier within the Back Office.
+    """
+    caseReference: str
+    """
+    The case reference the event estimate belongs to.
+    """
+    preparationTime: float | None = None
+    """
+    Estimated inspector time (days) to prepare for event.
+    """
+    sittingTime: float | None = None
+    """
+    Estimated inspector time (days) for event.
+    """
+    reportingTime: float | None = None
+    """
+    Estimated inspector time (days) for event reporting.
+    """