@planning-inspectorate/data-model 2.48.1 → 2.50.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
+
+from pydantic import AwareDatetime, BaseModel, ConfigDict, EmailStr, Field
+
+
+class EmailStatus(Enum):
+    """
+    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
+
+from pydantic import AwareDatetime, BaseModel, ConfigDict, Field
+
+
+class RepresentationStatus(Enum):
+    Awaiting_review = "Awaiting review"
+    Accepted = "Accepted"
+    Rejected = "Rejected"
+    Withdrawn = "Withdrawn"
+
+
+class SubmittedFor(Enum):
+    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(Enum):
+    """
+    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/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/appeal-has.schema.json

@@ -135,8 +135,8 @@
       "description": "The internal code for an appeal type, e.g. D (Householder)"
     },
     "caseProcedure": {
-      "type": "string",
-      "enum": ["written", "hearing", "inquiry"],
+      "type": ["string", "null"],
+      "enum": ["written", "hearing", "inquiry", "writtenPart1", "writtenPart2", null],
       "description": "The type of procedure for the appeal"
     },
     "lpaCode": {

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",