@planning-inspectorate/data-model 1.19.0 → 1.21.0

package/pins_data_model/models/model_nsip_project.py

@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  nsip-project.schema.json
-#   timestamp: 2025-08-29T10:40:44+00:00
+#   timestamp: 2025-11-04T12:34:00+00:00
 
 from __future__ import annotations
 
@@ -12,12 +12,17 @@ from pydantic import AwareDatetime, BaseModel, ConfigDict, Field
 
 class Decision(Enum):
     """
-    Decision: approved/refused/split-decision
+    Decision outcome: approved/refused/split-decision/granted/partially_consented/quashed/redetermination/withdrawn
     """
 
     approved = "approved"
     refused = "refused"
     split_decision = "split-decision"
+    granted = "granted"
+    partially_consented = "partially_consented"
+    quashed = "quashed"
+    redetermination = "redetermination"
+    withdrawn = "withdrawn"
     NoneType_None = None
 
 
@@ -136,6 +141,254 @@ class MapZoomLevel(Enum):
     NoneType_None = None
 
 
+class Recommendation(Enum):
+    """
+    Recommendation
+    """
+
+    recommend_consent = "recommend_consent"
+    recommend_partial_consent = "recommend_partial_consent"
+    recommend_refusal = "recommend_refusal"
+    NoneType_None = None
+
+
+class Tier(Enum):
+    """
+    Tier
+    """
+
+    basic = "basic"
+    standard = "standard"
+    enhanced = "enhanced"
+    NoneType_None = None
+
+
+class PrincipalAreaDisagreementSummaryStmt(Enum):
+    """
+    Principal area disagreement summary statement (PADSS)
+    """
+
+    submitted_by_applicant = "submitted_by_applicant"
+    awaiting_submission = "awaiting_submission"
+    not_applicable = "not_applicable"
+    NoneType_None = None
+
+
+class PolicyComplianceDocument(Enum):
+    """
+    Policy compliance document (PCD)
+    """
+
+    submitted_by_applicant = "submitted_by_applicant"
+    awaiting_submission = "awaiting_submission"
+    not_applicable = "not_applicable"
+    NoneType_None = None
+
+
+class DesignApproachDocument(Enum):
+    """
+    Design approach document (DAD)
+    """
+
+    submitted_by_applicant = "submitted_by_applicant"
+    awaiting_submission = "awaiting_submission"
+    not_applicable = "not_applicable"
+    NoneType_None = None
+
+
+class MatureOutlineControlDocument(Enum):
+    """
+    Mature outline control documents
+    """
+
+    submitted_by_applicant = "submitted_by_applicant"
+    awaiting_submission = "awaiting_submission"
+    not_applicable = "not_applicable"
+    NoneType_None = None
+
+
+class CaAndTpEvidence(Enum):
+    """
+    CA and TP evidence
+    """
+
+    submitted_by_applicant = "submitted_by_applicant"
+    awaiting_submission = "awaiting_submission"
+    not_applicable = "not_applicable"
+    NoneType_None = None
+
+
+class PublicSectorEqualityDuty(Enum):
+    """
+    Public sector equality duty (PSED)
+    """
+
+    submitted_by_applicant = "submitted_by_applicant"
+    awaiting_submission = "awaiting_submission"
+    not_applicable = "not_applicable"
+    NoneType_None = None
+
+
+class FastTrackAdmissionDocument(Enum):
+    """
+    Fast track admission document
+    """
+
+    submitted_by_applicant = "submitted_by_applicant"
+    awaiting_submission = "awaiting_submission"
+    not_applicable = "not_applicable"
+    NoneType_None = None
+
+
+class MultipartyApplicationCheckDocument(Enum):
+    """
+    Multiparty application readiness gate-check (trial)
+    """
+
+    submitted_by_applicant = "submitted_by_applicant"
+    awaiting_submission = "awaiting_submission"
+    not_applicable = "not_applicable"
+    NoneType_None = None
+
+
+class SubProjectType(Enum):
+    """
+    Project type
+    """
+
+    energy_from_waste = "energy_from_waste"
+    gas_power_station = "gas_power_station"
+    hydrogen_power_station = "hydrogen_power_station"
+    nuclear = "nuclear"
+    offshore_wind = "offshore_wind"
+    onshore_wind = "onshore_wind"
+    solar = "solar"
+    NoneType_None = None
+
+
+class NewMaturity(Enum):
+    """
+    New maturity
+    """
+
+    a = "a"
+    b = "b"
+    c = "c"
+    d = "d"
+    e = "e"
+    f = "f"
+    g = "g"
+    NoneType_None = None
+
+
+class PlanningInspectorateRole(Enum):
+    """
+    Planning Inspectorate role
+    """
+
+    facilitator = "facilitator"
+    advisor = "advisor"
+    observer = "observer"
+    NoneType_None = None
+
+
+class Meeting(BaseModel):
+    """
+    A meeting related to the project
+    """
+
+    model_config = ConfigDict(
+        extra="allow",
+    )
+    meetingAgenda: str | None = Field(None, examples=["Flood Risk Assessment (FRA)"])
+    """
+    Meeting agenda
+    """
+    planningInspectorateRole: PlanningInspectorateRole | None = Field(
+        None, examples=["facilitator"]
+    )
+    """
+    Planning Inspectorate role
+    """
+    meetingDate: AwareDatetime | None = Field(
+        None, examples=["2023-07-27T20:30:00.000Z"]
+    )
+    """
+    Meeting date
+    """
+    meetingType: str | None = None
+    """
+    Type of Meeting
+    """
+
+
+class InvoiceStage(Enum):
+    """
+    Invoice stage
+    """
+
+    pre_acceptance = "pre_acceptance"
+    acceptance = "acceptance"
+    pre_examination = "pre_examination"
+    initial_examination = "initial_examination"
+    final_examination = "final_examination"
+    NoneType_None = None
+
+
+class Invoice(BaseModel):
+    """
+    An invoice related to the project
+    """
+
+    model_config = ConfigDict(
+        extra="allow",
+    )
+    invoiceStage: InvoiceStage | None = Field(None, examples=["pre_acceptance"])
+    """
+    Invoice stage
+    """
+    invoiceNumber: str = Field(..., examples=["1800004419"])
+    """
+    Invoice number
+    """
+    amountDue: float = Field(..., examples=[500])
+    """
+    Amount due
+    """
+    paymentDueDate: AwareDatetime | None = Field(
+        None, examples=["2023-07-27T20:30:00.000Z"]
+    )
+    """
+    Payment due date
+    """
+    invoicedDate: AwareDatetime | None = Field(
+        None, examples=["2023-07-27T20:30:00.000Z"]
+    )
+    """
+    Invoiced date
+    """
+    paymentDate: AwareDatetime | None = Field(
+        None, examples=["2023-07-27T20:30:00.000Z"]
+    )
+    """
+    Date of payment
+    """
+    refundCreditNoteNumber: str | None = Field(None, examples=["1800004419"])
+    """
+    Refund credit note number
+    """
+    refundAmount: float | None = Field(None, examples=[200])
+    """
+    Amount refunded
+    """
+    refundIssueDate: AwareDatetime | None = Field(
+        None, examples=["2023-07-27T20:30:00.000Z"]
+    )
+    """
+    Refund issue date
+    """
+
+
 class NsipProject(BaseModel):
     """
     Subset of Pins Data Model [Case]
@@ -168,7 +421,7 @@ class NsipProject(BaseModel):
     projectDescriptionWelsh: str | None = None
     decision: Decision
     """
-    Decision: approved/refused/split-decision
+    Decision outcome: approved/refused/split-decision/granted/partially_consented/quashed/redetermination/withdrawn
     """
     publishStatus: PublishStatus
     sector: Sector
@@ -486,3 +739,282 @@ class NsipProject(BaseModel):
     """
     Is this an application for a material change?
     """
+    courtDecisionDate: AwareDatetime | None = Field(
+        None, examples=["2023-07-27T20:30:00.000Z"]
+    )
+    """
+    Date of court decision
+    """
+    courtDecisionOutcomeText: str | None = Field(None, examples=["upheld"])
+    """
+    Court decision outcome text; values include 'upheld','partially_upheld','quashed','other:<Text>'
+    """
+    decisionChallengeSubmissionDate: AwareDatetime | None = Field(
+        None, examples=["2023-07-27T20:30:00.000Z"]
+    )
+    """
+    Date of decision challenge submission
+    """
+    recommendation: Recommendation | None = Field(None, examples=["recommend_consent"])
+    """
+    Recommendation
+    """
+    inceptionMeetingDate: AwareDatetime | None = Field(
+        None, examples=["2023-07-27T20:30:00.000Z"]
+    )
+    """
+    Date of inception meeting
+    """
+    draftDocumentSubmissionDate: AwareDatetime | None = Field(
+        None, examples=["2023-07-27T20:30:00.000Z"]
+    )
+    """
+    Date for submission of draft documents
+    """
+    programmeDocumentSubmissionDate: AwareDatetime | None = Field(
+        None, examples=["2023-07-27T20:30:00.000Z"]
+    )
+    """
+    Programme document submission date
+    """
+    tier: Tier | None = Field(None, examples=["basic"])
+    """
+    Tier
+    """
+    s61SummaryURI: str | None = Field(None, examples=["s61.sharepoint.com/"])
+    """
+    Link to s61 summary
+    """
+    estimatedScopingSubmissionDate: AwareDatetime | None = Field(
+        None, examples=["2023-07-27T20:30:00.000Z"]
+    )
+    """
+    Estimated scoping submission date
+    """
+    consultationMilestoneAdequacyDate: AwareDatetime | None = Field(
+        None, examples=["2023-07-27T20:30:00.000Z"]
+    )
+    """
+    Adequacy of Consultation Milestone
+    """
+    planProcessEvidence: bool | None = Field(None, examples=[True])
+    """
+    Evidence plan process
+    """
+    issuesTracker: str | None = Field(None, examples=["tracker.sharepoint.com/"])
+    """
+    Issues tracker
+    """
+    essentialFastTrackComponents: bool | None = Field(None, examples=[True])
+    """
+    Essential fast track components
+    """
+    principalAreaDisagreementSummaryStmt: (
+        PrincipalAreaDisagreementSummaryStmt | None
+    ) = Field(None, examples=["submitted_by_applicant"])
+    """
+    Principal area disagreement summary statement (PADSS)
+    """
+    principalAreaDisagreementSummaryStmtSubmittedDate: AwareDatetime | None = Field(
+        None, examples=["2023-07-27T20:30:00.000Z"]
+    )
+    """
+    Principal area disagreement summary statement (PADSS) Submitted date
+    """
+    policyComplianceDocument: PolicyComplianceDocument | None = Field(
+        None, examples=["submitted_by_applicant"]
+    )
+    """
+    Policy compliance document (PCD)
+    """
+    policyComplianceDocumentSubmittedDate: AwareDatetime | None = Field(
+        None, examples=["2023-07-27T20:30:00.000Z"]
+    )
+    """
+    Policy compliance document (PCD) Submitted Date
+    """
+    designApproachDocument: DesignApproachDocument | None = Field(
+        None, examples=["submitted_by_applicant"]
+    )
+    """
+    Design approach document (DAD)
+    """
+    designApproachDocumentSubmittedDate: AwareDatetime | None = Field(
+        None, examples=["2023-07-27T20:30:00.000Z"]
+    )
+    """
+    Design approach document (DAD) Submitted Date
+    """
+    matureOutlineControlDocument: MatureOutlineControlDocument | None = Field(
+        None, examples=["submitted_by_applicant"]
+    )
+    """
+    Mature outline control documents
+    """
+    matureOutlineControlDocumentSubmittedDate: AwareDatetime | None = Field(
+        None, examples=["2023-07-27T20:30:00.000Z"]
+    )
+    """
+    Mature outline control documents Submitted Date
+    """
+    caAndTpEvidence: CaAndTpEvidence | None = Field(
+        None, examples=["submitted_by_applicant"]
+    )
+    """
+    CA and TP evidence
+    """
+    caAndTpEvidenceSubmittedDate: AwareDatetime | None = Field(
+        None, examples=["2023-07-27T20:30:00.000Z"]
+    )
+    """
+    CA and TP evidence Submitted Date
+    """
+    publicSectorEqualityDuty: PublicSectorEqualityDuty | None = Field(
+        None, examples=["submitted_by_applicant"]
+    )
+    """
+    Public sector equality duty (PSED)
+    """
+    publicSectorEqualityDutySubmittedDate: AwareDatetime | None = Field(
+        None, examples=["2023-07-27T20:30:00.000Z"]
+    )
+    """
+    Public sector equality duty (PSED) Submitted Date
+    """
+    fastTrackAdmissionDocument: FastTrackAdmissionDocument | None = Field(
+        None, examples=["submitted_by_applicant"]
+    )
+    """
+    Fast track admission document
+    """
+    fastTrackAdmissionDocumentSubmittedDate: AwareDatetime | None = Field(
+        None, examples=["2023-07-27T20:30:00.000Z"]
+    )
+    """
+    Fast track admission document Submitted Date
+    """
+    multipartyApplicationCheckDocument: MultipartyApplicationCheckDocument | None = (
+        Field(None, examples=["submitted_by_applicant"])
+    )
+    """
+    Multiparty application readiness gate-check (trial)
+    """
+    multipartyApplicationCheckDocumentSubmittedDate: AwareDatetime | None = Field(
+        None, examples=["2023-07-27T20:30:00.000Z"]
+    )
+    """
+    Multiparty application readiness gate-check Submitted Date (trial)
+    """
+    programmeDocumentURI: str | None = Field(None, examples=["progdoc.sharepoint.com/"])
+    """
+    Link to programme document
+    """
+    updatedProgrammeDocumentReceivedDate: AwareDatetime | None = Field(
+        None, examples=["2023-07-27T20:30:00.000Z"]
+    )
+    """
+    Date updated programme document is received
+    """
+    programmeDocumentReviewedByEstDate: AwareDatetime | None = Field(
+        None, examples=["2023-07-27T20:30:00.000Z"]
+    )
+    """
+    Date programme document reviewed by EST
+    """
+    caseTeamIssuedCommentsDate: AwareDatetime | None = Field(
+        None, examples=["2023-07-27T20:30:00.000Z"]
+    )
+    """
+    Date case team issued comments on programme document
+    """
+    subProjectType: SubProjectType | None = Field(None, examples=["solar"])
+    """
+    Project type
+    """
+    newMaturity: NewMaturity | None = Field(None, examples=["a"])
+    """
+    New maturity
+    """
+    statutoryConsultationPeriodEndDate: AwareDatetime | None = Field(
+        None, examples=["2023-07-27T20:30:00.000Z"]
+    )
+    """
+    Statutory consultation period end date
+    """
+    submissionOfDraftDocumentsDate: AwareDatetime | None = Field(
+        None, examples=["2023-07-27T20:30:00.000Z"]
+    )
+    """
+    Date for submission of draft documents
+    """
+    numberBand2Inspectors: float | None = Field(None, examples=[1])
+    """
+    Number of band 2 inspectors
+    """
+    numberBand3Inspectors: float | None = Field(None, examples=[2])
+    """
+    Number of band 3 inspectors
+    """
+    memLastUpdated: AwareDatetime | None = Field(
+        None, examples=["2023-07-27T20:30:00.000Z"]
+    )
+    """
+    MEM (last updated)
+    """
+    additionalComments: str | None = Field(
+        None,
+        examples=["Very likely to change tier from standard to basic after April 2025"],
+    )
+    """
+    Additional comments
+    """
+    operationsLeadIds: list[str] | None = Field(
+        None,
+        examples=[["9bee96d2-00fe-4269-9d01-8c66", "9bee96d2-00fe-4269-9d01-8c22"]],
+    )
+    """
+    Maps to [Employee].[EmployeeID].
+    """
+    operationsManagerIds: list[str] | None = Field(
+        None,
+        examples=[["9bee96d2-00fe-4269-9d01-8c66", "9bee96d2-00fe-4269-9d01-8c22"]],
+    )
+    """
+    New NSIP role, Maps to [Employee].[EmployeeID]
+    """
+    caseManagerIds: list[str] | None = Field(
+        None,
+        examples=[["9bee96d2-00fe-4269-9d01-8c66", "9bee96d2-00fe-4269-9d01-8c22"]],
+    )
+    """
+    Maps to [Employee].[EmployeeID].
+    """
+    leadInspectorIds: list[str] | None = Field(
+        None,
+        examples=[["9bee96d2-00fe-4269-9d01-8c66", "9bee96d2-00fe-4269-9d01-8c22"]],
+    )
+    """
+    Maps to [Employee].[EmployeeID].
+    """
+    environmentalServicesOfficerIds: list[str] | None = Field(
+        None,
+        examples=[["9bee96d2-00fe-4269-9d01-8c66", "9bee96d2-00fe-4269-9d01-8c22"]],
+    )
+    """
+    Maps to [Employee].[EmployeeID].
+    """
+    legalOfficerIds: list[str] | None = Field(
+        None,
+        examples=[["9bee96d2-00fe-4269-9d01-8c66", "9bee96d2-00fe-4269-9d01-8c22"]],
+    )
+    """
+    Maps to [Employee].[EmployeeID].
+    """
+    meetings: list[Meeting] | None = None
+    """
+    Collection of meetings associated with this project
+    """
+    invoices: list[Invoice] | None = None
+    """
+    Collection of invoices associated with this project
+    """

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: 2025-08-29T10:40:44+00:00
+#   timestamp: 2025-11-04T12:34:00+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: 2025-08-29T10:40:44+00:00
+#   timestamp: 2025-11-04T12:34:00+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: 2025-08-29T10:40:44+00:00
+#   timestamp: 2025-11-04T12:34:00+00:00
 
 from __future__ import annotations
 

package/pins_data_model/models/model_pins_inspector.py

@@ -1,21 +1,58 @@
 # generated by datamodel-codegen:
 #   filename:  pins-inspector.schema.json
-#   timestamp: 2025-08-29T10:40:44+00:00
+#   timestamp: 2025-11-04T12:34:00+00:00
 
 from __future__ import annotations
 
-from pydantic import BaseModel, ConfigDict
+from pydantic import AwareDatetime, BaseModel, ConfigDict, EmailStr, Field
+
+
+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
+
+
+class Specialism(BaseModel):
+    model_config = ConfigDict(
+        extra="allow",
+    )
+    name: str = Field(..., examples=["S62A Casework Major"])
+    """
+    Working above band is stored as a specialism
+    """
+    proficiency: str | None = Field(..., examples=["trained"])
+    """
+    trained or in-training
+    """
+    validFrom: AwareDatetime | None = Field(..., examples=["2023-07-27T20:30:00.000Z"])
+    """
+    Date training started or date training was completed.
+    """
 
 
 class PinsInspector(BaseModel):
     """
-    Inspector attributes as per Horizon. This will be extended with SAP/Entra data
+    Inspector Details originating from Horizon, SAP HR and Entra.
     """
 
     model_config = ConfigDict(
         extra="allow",
     )
-    horizonId: str
+    entraId: str | None = Field(..., examples=["00000000-0000-0000-0000-000000000000"])
+    """
+    EntraID of the Inspector if available in ODW.
+    """
+    sapId: str | None = Field(..., examples=["12345678"])
+    """
+    SAPID of the Inspector if available in ODW.
+    """
+    horizonId: str | None = None
     """
     The PINS-generated unique horizon ID
     """
@@ -47,7 +84,39 @@ class PinsInspector(BaseModel):
     """
     The qualifications of the inspector
     """
-    email: str | None = None
+    email: EmailStr | None = Field(
+        ..., examples=["example@planninginspectorate.gov.uk"]
+    )
+    """
+    PINS Email address for the Inspector
+    """
+    grade: str = Field(..., examples=["B1"])
+    """
+    Grades as a coded value e.g. B1, B2, B3, FTC-B1, FTC-B2, FTC-B3, PL
+    """
+    fte: float = Field(..., examples=[0.75])
+    """
+    FTE Decimal value e.g. 1, 0.5 etc
+    """
+    unit: str = Field(..., examples=["Operations"])
+    """
+    The personnel area of the Inspector
+    """
+    service: str = Field(..., examples=["Planning and Environmental Appeals Service"])
+    """
+    The personnel sub area of the Inspector
+    """
+    group: str = Field(..., examples=["Enforcement Groups"])
+    """
+    Group of the Inspector
+    """
+    inspectorManager: str = Field(..., examples=["Dan Brown"])
+    """
+    Name of the Inspector's manager.
+    """
+    validFrom: AwareDatetime | None = Field(None, examples=["2023-07-27T20:30:00.000Z"])
     """
-    The email address of the inspector
+    Date the Inspector record was first recorded.
     """
+    address: Address
+    specialisms: list[Specialism]