@planning-inspectorate/data-model 2.49.0 → 2.51.0

package/pins_data_model/models/model_applications_notify_email.py

@@ -0,0 +1,124 @@
+# generated by datamodel-codegen:
+#   filename:  applications-notify-email.schema.json
+
+from __future__ import annotations
+
+from enum import Enum, StrEnum
+
+from pydantic import AwareDatetime, BaseModel, ConfigDict, EmailStr, Field
+
+
+class EmailStatus(StrEnum):
+    """
+    Outcome of the email (status)
+    """
+
+    Sending = "Sending"
+    Delivered = "Delivered"
+    Permanent_failure = "Permanent failure"
+    Temporary_failure = "Temporary failure"
+    Technical_failure = "Technical failure"
+
+
+class ContactPreference(Enum):
+    """
+    Preferred contact method
+    """
+
+    email = "email"
+    post = "post"
+
+
+class Contact(BaseModel):
+    """
+    Contact the email was sent to
+    """
+
+    contactId: str = Field(..., examples=["AAAAAAAA-1234-1234-1234-AAAAAAAAAAAA"])
+    """
+    Source PK for Contact
+    """
+    contactPreference: ContactPreference | None = Field(None, examples=["email"])
+    """
+    Preferred contact method
+    """
+    writtenRepOrgName: str | None = None
+    writtenRepJobTitleorRole: str | None = None
+
+
+class EmailNotificationRecordSchema(BaseModel):
+    """
+    Email Notifications for Casework Projects
+    """
+
+    model_config = ConfigDict(
+        extra="allow",
+    )
+    id: str = Field(..., examples=["AAAAAAAA-1234-1234-1234-AAAAAAAAAAAA"])
+    """
+    Internal Identifier UUID
+    """
+    notifyId: str | None = None
+    """
+    Id used by Notify
+    """
+    reference: str | None = None
+    """
+    Reference passed to notify (used to identify the case or representation it relates to)
+    """
+    caseReference: str = Field(..., examples=["CROWN/2025/12345"])
+    """
+    Business Key for the related case
+    """
+    caseId: str = Field(..., examples=["AAAAAAAA-1234-1234-1234-AAAAAAAAAAAA"])
+    """
+    The unique ID for the case this notification belongs to.
+    """
+    caseType: str = Field(..., examples=["Crown Development Application"])
+    """
+    The type of case this notification is for.
+    """
+    createdDate: AwareDatetime | None = None
+    """
+    Date the email was created
+    """
+    createdBy: str | None = None
+    """
+    Name of the person that triggered the email (only applies when done manually)
+    """
+    completedDate: AwareDatetime | None = None
+    """
+    When the email completed (succeeded or failed)
+    """
+    email: EmailStr | None = None
+    """
+    Email address sent to if unable to be linked to an LPA or Contact
+    """
+    contact: list[Contact] | None = None
+    """
+    Contact(s) the email was sent to
+    """
+    lpaCode: str = Field(..., examples=["Z0116"])
+    """
+    Planning Body code
+    """
+    emailStatus: EmailStatus | None = Field(None, examples=["Delivered"])
+    """
+    Outcome of the email (status)
+    """
+    templateId: str | None = None
+    """
+    The id of the template sent in Notify
+    """
+    templateVersion: int | None = None
+    """
+    The version of the template sent
+    """
+    body: str | None = None
+    """
+    The full HTML/plain text body of the email
+    """
+    subject: str | None = None
+    """
+    The full HTML/plain text subject of the email
+    """

package/pins_data_model/models/model_applications_representation.py

@@ -0,0 +1,207 @@
+# generated by datamodel-codegen:
+#   filename:  applications-representation.schema.json
+
+from __future__ import annotations
+
+from enum import Enum, StrEnum
+
+from pydantic import AwareDatetime, BaseModel, ConfigDict, Field
+
+
+class RepresentationStatus(StrEnum):
+    Awaiting_review = "Awaiting review"
+    Accepted = "Accepted"
+    Rejected = "Rejected"
+    Withdrawn = "Withdrawn"
+
+
+class SubmittedFor(StrEnum):
+    Myself = "Myself"
+    On_behalf_of_another_person_or_an_organisation = (
+        "On behalf of another person or an organisation"
+    )
+
+
+class SubmittedReceivedMethod(Enum):
+    """
+    How we received the representation
+    """
+
+    Online = "Online"
+    Phone = "Phone"
+    Email = "Email"
+    Post = "Post"
+    In_person = "In person"
+
+
+class RepresentedType(Enum):
+    """
+    When representation is on behalf of a person/org/group
+    """
+
+    A_person = "A person"
+    An_organisation_or_charity_I_work_or_volunteer_for = (
+        "An organisation or charity I work or volunteer for"
+    )
+    An_organisation_or_charity_I_do_not_work_or_volunteer_for = (
+        "An organisation or charity I do not work or volunteer for"
+    )
+
+
+class RepresentedCategory(Enum):
+    Consultees = "Consultees"
+    Interested_party = "Interested party"
+
+
+class WithdrawalReason(Enum):
+    """
+    Reason for the withdrawal
+    """
+
+    Change_of_opinion = "Change of opinion"
+    Mistaken_Submission = "Mistaken Submission"
+    Misunderstanding = "Misunderstanding"
+    Personal_Reasons = "Personal Reasons"
+
+
+class ContactPreference(Enum):
+    email = "email"
+    post = "post"
+
+
+class Contact(BaseModel):
+    contactId: str = Field(..., examples=["AAAAAAAA-1234-1234-1234-AAAAAAAAAAAA"])
+    """
+    Source PK for Contact
+    """
+    contactPreference: ContactPreference | None = Field(None, examples=["email"])
+    writtenRepOrgName: str | None = None
+    writtenRepJobTitleorRole: str | None = None
+
+
+class Status(StrEnum):
+    """
+    The status of the document
+    """
+
+    Awaiting_review = "Awaiting review"
+    Accepted = "Accepted"
+    Rejected = "Rejected"
+    Withdrawn = "Withdrawn"
+
+
+class RepresentationDocument(BaseModel):
+    id: str = Field(..., examples=["AAAAAAAA-1234-1234-1234-AAAAAAAAAAAA"])
+    """
+    Source Key for Representation Document
+    """
+    representationId: str = Field(
+        ..., examples=["AAAAAAAA-1234-1234-1234-AAAAAAAAAAAA"]
+    )
+    """
+    The representation this relates to
+    """
+    itemId: str
+    """
+    The id of the item in SharePoint
+    """
+    fileName: str
+    """
+    The name of the file
+    """
+    redactedItemId: str | None = None
+    """
+    The id of the redacted version of the item in sharepoint
+    """
+    redactedFileName: str | None = None
+    """
+    the name of the redacted file
+    """
+    status: Status
+    """
+    The status of the document
+    """
+
+
+class CaseworkRepresentationSchema(BaseModel):
+    """
+    Representations and related document metadata for Casework Projects
+    """
+
+    model_config = ConfigDict(
+        extra="allow",
+    )
+    id: str = Field(..., examples=["AAAAAAAA-1234-1234-1234-AAAAAAAAAAAA"])
+    """
+    Primary key
+    """
+    reference: str
+    """
+    Auto-generated hexadecimal reference: AAAAA-BBBBB
+    """
+    caseReference: str = Field(..., examples=["CROWN/2025/12345"])
+    """
+    Business Key for the related case
+    """
+    caseId: str = Field(..., examples=["AAAAAAAA-1234-1234-1234-AAAAAAAAAAAA"])
+    """
+    The unique ID for the case this representation belongs to.
+    """
+    caseType: str = Field(..., examples=["Crown Development Application"])
+    """
+    The type of case this representation is for.
+    """
+    representationStatus: RepresentationStatus | None = None
+    submittedFor: SubmittedFor
+    submittedByContact: list[Contact] | None = None
+    submittedByAgentFlag: bool | None = None
+    submittedByAgentOrgName: str | None = None
+    submittedDate: AwareDatetime
+    submittedReceivedMethod: SubmittedReceivedMethod | None = None
+    """
+    How we received the representation
+    """
+    submissionMethodReason: str | None = None
+    comment: str
+    commentRedacted: str | None = None
+    """
+    redacted version of the comment, null if not redacted
+    """
+    representedType: RepresentedType | None = None
+    """
+    When representation is on behalf of a person/org/group
+    """
+    representedContact: list[Contact] | None = None
+    """
+    When representation is on behalf of a person/org/group
+    """
+    representedCategory: RepresentedCategory | None = None
+    wantsToBeHeard: bool | None = None
+    """
+    Internal: wants to be heard at a hearing
+    """
+    containsAttachments: bool | None = None
+    """
+    Is a document attached to the representation
+    """
+    sharePointFolderCreated: bool | None = None
+    """
+    to avoid creating new folders for documents when managing representations
+    """
+    distressingContentInRepresentation: bool | None = None
+    """
+    Flags the representation as containing distressing content
+    """
+    withdrawalRequestDate: AwareDatetime | None = None
+    """
+    Date the representing party requested that the representation be withdrawn
+    """
+    withdrawalReason: WithdrawalReason | None = None
+    """
+    Reason for the withdrawal
+    """
+    dateWithdrawn: AwareDatetime | None = None
+    """
+    Date the representation was withdrawn
+    """
+    representationDocuments: list[RepresentationDocument] | None = None

package/pins_data_model/models/model_dart_response.py

@@ -14,7 +14,7 @@ class NeighbouringSiteAddress(BaseModel):
     """
     First line of address of the neighbouring site
     """
-    neighbouringSiteAddressLine2: str | None = None
+    neighbouringSiteAddressLine2: str | None
     """
     Second line of address of the neighbouring site
     """

package/pins_data_model/models/model_folder.py

@@ -44,12 +44,12 @@ class Folder(BaseModel):
     """
     Folder display name in English.
     """
-    displayNameWelsh: str | None = None
+    displayNameWelsh: str | None
     """
     Folder display name in Welsh.
     """
-    parentFolderId: int | None = None
+    parentFolderId: int | None
     """
     Optional parent folder ID.
     """
-    caseStage: CaseStage
+    caseStage: CaseStage | None

package/pins_data_model/models/model_nsip_document.py

@@ -147,24 +147,24 @@ class NsipDocument(BaseModel):
             "EN010011/2. Post-Submission/Application Documents/Application Form/Letter.PDF"
         ],
     )
-    virusCheckStatus: VirusCheckStatus
+    virusCheckStatus: VirusCheckStatus | None
     fileMD5: str | None = Field(..., examples=["b1946ac92492d2347c6235b4d2611184"])
     dateCreated: AwareDatetime = Field(..., examples=["2023-07-27T20:30:00.000Z"])
     lastModified: AwareDatetime | None = Field(
         ..., examples=["2023-07-27T20:30:00.000Z"]
     )
-    caseType: CaseType
-    redactedStatus: RedactedStatus
-    publishedStatus: PublishedStatus
+    caseType: CaseType | None
+    redactedStatus: RedactedStatus | None
+    publishedStatus: PublishedStatus | None
     datePublished: AwareDatetime | None = Field(
         ..., examples=["2023-07-27T20:30:00.000Z"]
     )
     documentType: str | None = Field(..., examples=["Rule 8 letter"])
-    securityClassification: SecurityClassification
-    sourceSystem: SourceSystem
-    origin: Origin
-    owner: str | None = None
-    author: str | None = None
+    securityClassification: SecurityClassification | None
+    sourceSystem: SourceSystem | None
+    origin: Origin | None
+    owner: str | None
+    author: str | None
     """
     Name of person who authored document
     """
@@ -183,7 +183,7 @@ class NsipDocument(BaseModel):
         ],
     )
     descriptionWelsh: str | None = None
-    documentCaseStage: DocumentCaseStage
+    documentCaseStage: DocumentCaseStage | None
     filter1: str | None = Field(..., examples=["Deadline 2"])
     """
     Filter field to provide additional filtering
@@ -196,11 +196,11 @@ class NsipDocument(BaseModel):
     """
     Filter field to provide additional filtering
     """
-    horizonFolderId: str | None = None
+    horizonFolderId: str | None
     """
     The folder where the document exists
     """
-    transcriptId: str | None = None
+    transcriptId: str | None
     """
     The GUID of the transcript document (if one was provided).
     """

package/pins_data_model/models/model_nsip_exam_timetable.py

@@ -3,12 +3,12 @@
 
 from __future__ import annotations
 
-from enum import Enum
+from enum import StrEnum
 
 from pydantic import AwareDatetime, BaseModel, ConfigDict, Field
 
 
-class Type(Enum):
+class Type(StrEnum):
     """
     Compulsory Acquisition Hearing/Deadline/Issue Specific Hearing etc
     """
@@ -25,6 +25,7 @@ class Type(Enum):
     Procedural_Deadline__Pre_Examination_ = "Procedural Deadline (Pre-Examination)"
     Procedural_Decision = "Procedural Decision"
     Publication_Of = "Publication Of"
+    Unaccompanied_Site_Inspection = "Unaccompanied Site Inspection"
 
 
 class LineItem(BaseModel):

package/pins_data_model/models/model_nsip_invoice.py

@@ -3,12 +3,12 @@
 
 from __future__ import annotations
 
-from enum import Enum
+from enum import StrEnum
 
 from pydantic import AwareDatetime, BaseModel, ConfigDict, Field
 
 
-class InvoiceStage(Enum):
+class InvoiceStage(StrEnum):
     """
     Invoice stage
     """

package/pins_data_model/models/model_nsip_project.py

@@ -3,7 +3,7 @@
 
 from __future__ import annotations
 
-from enum import Enum
+from enum import Enum, StrEnum
 from typing import Any
 
 from pydantic import AwareDatetime, BaseModel, ConfigDict, Field
@@ -85,7 +85,7 @@ class ProjectType(Enum):
     NoneType_None = None
 
 
-class SourceSystem(Enum):
+class SourceSystem(StrEnum):
     back_office_applications = "back-office-applications"
     horizon = "horizon"
 
@@ -107,7 +107,7 @@ class Stage(Enum):
     NoneType_None = None
 
 
-class Region(Enum):
+class Region(StrEnum):
     """
     Geographical region of UK. Applications can cover multiple regions.
     """
@@ -340,7 +340,7 @@ class Meeting(BaseModel):
     """
 
 
-class InvoiceStage(Enum):
+class InvoiceStage(StrEnum):
     """
     Invoice stage
     """
@@ -436,21 +436,21 @@ class NsipProject(BaseModel):
         ],
     )
     projectDescriptionWelsh: str | None = None
-    decision: Decision
+    decision: Decision | None
     """
     Decision outcome: approved/refused/split-decision/granted/partially_consented/quashed/redetermination/withdrawn
     """
-    publishStatus: PublishStatus
-    sector: Sector
+    publishStatus: PublishStatus | None
+    sector: Sector | None
     """
     {Sector Abbreviation} - {Sector Display Name}
     """
-    projectType: ProjectType
+    projectType: ProjectType | None
     """
     {SubSector Abbreviation} - {SubSector Display Name}
     """
     sourceSystem: SourceSystem
-    stage: Stage
+    stage: Stage | None
     """
     Process stage identifier
     """
@@ -490,11 +490,11 @@ class NsipProject(BaseModel):
     """
     Welsh Language translation required.
     """
-    mapZoomLevel: MapZoomLevel
+    mapZoomLevel: MapZoomLevel | None
     """
     Resolution of pinned map. Set when co-ordinates are created.
     """
-    secretaryOfState: str | None = None
+    secretaryOfState: str | None
     """
     Relevant Government Department. [TODO]
     """
@@ -705,38 +705,38 @@ class NsipProject(BaseModel):
     """
     DateProjectWithdrawn by applicant
     """
-    operationsLeadId: str | None = None
+    operationsLeadId: str | None
     """
     Maps to [Employee].[EmployeeID].
     """
-    operationsManagerId: str | None = None
+    operationsManagerId: str | None
     """
     New NSIP role, Maps to [Employee].[EmployeeID]
     """
-    caseManagerId: str | None = None
+    caseManagerId: str | None
     """
     Maps to [Employee].[EmployeeID]
     """
     nsipOfficerIds: list[str]
     nsipAdministrationOfficerIds: list[str]
-    leadInspectorId: str | None = None
+    leadInspectorId: str | None
     """
     Maps to [Employee].[EmployeeID]
     """
     inspectorIds: list[str]
-    environmentalServicesOfficerId: str | None = None
+    environmentalServicesOfficerId: str | None
     """
     Maps to [Employee].[EmployeeID]
     """
-    legalOfficerId: str | None = None
+    legalOfficerId: str | None
     """
     Maps to [Employee].[EmployeeID]
     """
-    applicantId: str | None = None
+    applicantId: str | None
     """
     Maps to [ServiceUser].[id] where the serviceUserType is Applicant
     """
-    migrationStatus: bool | None = None
+    migrationStatus: bool | None
     """
     Has this case been migrated from the legacy system? True if so.
     """

package/pins_data_model/models/model_nsip_project_update.py

@@ -3,12 +3,12 @@
 
 from __future__ import annotations
 
-from enum import Enum
+from enum import StrEnum
 
 from pydantic import AwareDatetime, BaseModel, ConfigDict
 
 
-class UpdateStatus(Enum):
+class UpdateStatus(StrEnum):
     """
     The current status of this update
     """
@@ -37,11 +37,11 @@ class NsipProjectUpdate(BaseModel):
     """
     the case reference this update relates to
     """
-    updateDate: AwareDatetime | None = None
+    updateDate: AwareDatetime | None
     """
     The date the update was published
     """
-    updateName: str | None = None
+    updateName: str | None
     """
     Internal title or name of the update
     """
@@ -49,7 +49,7 @@ class NsipProjectUpdate(BaseModel):
     """
     HTML content of the update in English. Can only include `<a> <b> <ul> <li>` tags.
     """
-    updateContentWelsh: str | None = None
+    updateContentWelsh: str | None
     """
     HTML content of the update in Welsh. Can only include `<a> <b> <ul> <li>` tags.
     """

package/pins_data_model/models/model_nsip_representation.py

@@ -62,22 +62,22 @@ class Representation(BaseModel):
     """
     The unique identifier within the Back Office. This is not the same as the case reference
     """
-    status: Status
+    status: Status | None
     originalRepresentation: str
-    redacted: bool | None = None
-    redactedRepresentation: str | None = None
+    redacted: bool | None
+    redactedRepresentation: str | None
     redactedBy: str | None = Field(..., examples=["Joe Blogs"])
     redactedNotes: str | None = Field(..., examples=["Removed names of family members"])
-    representationFrom: RepresentationFrom
+    representationFrom: RepresentationFrom | None
     representedId: str
     """
     ServiceUser Id of the person or organisation being represented
     """
-    representativeId: str | None = None
+    representativeId: str | None
     """
     ServiceUser Id of the person or organisation submitting representation in the case of Agent representationFrom
     """
-    registerFor: RegisterFor
-    representationType: RepresentationType
+    registerFor: RegisterFor | None
+    representationType: RepresentationType | None
     dateReceived: AwareDatetime = Field(..., examples=["2023-07-27T20:30:00.000Z"])
     attachmentIds: list[str]

package/pins_data_model/models/model_nsip_subscription.py

@@ -3,12 +3,12 @@
 
 from __future__ import annotations
 
-from enum import Enum
+from enum import Enum, StrEnum
 
 from pydantic import AwareDatetime, BaseModel, ConfigDict, EmailStr, Field
 
 
-class SubscriptionType(Enum):
+class SubscriptionType(StrEnum):
     """
     which update does the subscriber want to get notified of. For multiple types, use multiple messages.
     """
@@ -33,7 +33,7 @@ class NsipSubscription(BaseModel):
     model_config = ConfigDict(
         extra="allow",
     )
-    subscriptionId: int | None = None
+    subscriptionId: int | None
     """
     The unique identifier within the Back Office. Ignored as part of register-nsip-subscription.
     """
@@ -48,12 +48,12 @@ class NsipSubscription(BaseModel):
     """
     which update does the subscriber want to get notified of. For multiple types, use multiple messages.
     """
-    startDate: AwareDatetime | None = None
+    startDate: AwareDatetime | None
     """
     The date to start getting updates
     """
-    endDate: AwareDatetime | None = None
+    endDate: AwareDatetime | None
     """
     The date to stop getting updates
     """
-    language: Language
+    language: Language | None