@planning-inspectorate/data-model 2.53.0 → 2.55.0

package/pins_data_model/models/model_nsip_project.py

@@ -25,6 +25,23 @@ class Decision(Enum):
     NoneType_None = None
 
 
+class DcoStatus(Enum):
+    """
+    Decision outcome: approved/refused/split-decision/granted/partially_consented/quashed/redetermination/withdrawn/revoked
+    """
+
+    approved = "approved"
+    refused = "refused"
+    split_decision = "split-decision"
+    granted = "granted"
+    partially_consented = "partially_consented"
+    quashed = "quashed"
+    redetermination = "redetermination"
+    withdrawn = "withdrawn"
+    revoked = "revoked"
+    NoneType_None = None
+
+
 class PublishStatus(Enum):
     published = "published"
     unpublished = "unpublished"
@@ -440,6 +457,10 @@ class NsipProject(BaseModel):
     """
     Decision outcome: approved/refused/split-decision/granted/partially_consented/quashed/redetermination/withdrawn
     """
+    dcoStatus: DcoStatus | None = None
+    """
+    Decision outcome: approved/refused/split-decision/granted/partially_consented/quashed/redetermination/withdrawn/revoked
+    """
     publishStatus: PublishStatus | None
     sector: Sector | None
     """

package/schemas/{applications-application.schema.json → applications-crowndev-application.schema.json}

@@ -1,6 +1,6 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema#",
-  "$id": "applications-application.schema.json",
+  "$id": "applications-crowndev-application.schema.json",
   "title": "Crown Development Application",
   "description": "Main application details for Crown Development Project",
   "type": "object",
@@ -43,7 +43,7 @@
       "type": ["string", "null"],
       "description": "SubType applies to Planning permissions and LBC",
       "example": "Listed building consent (LBC)",
-      "enum": ["Planning permission", "Listed building consent (LBC)"]
+      "enum": ["Planning permission", "Listed building consent (LBC)", null]
     },
     "linkedParentId": {
       "type": ["string", "null"],
@@ -132,7 +132,8 @@
         "Written representations",
         "Inquiry",
         "Hearing/Inquiry date set",
-        "Final decision"
+        "Final decision",
+        null
       ]
     },
     "nationallyImportant": {
@@ -176,7 +177,8 @@
         "Relevant demolition",
         "Other",
         "Listed building consent to alter/extend",
-        "Listed building consent to demolish"
+        "Listed building consent to demolish",
+        null
       ]
     },
     "isGreenBelt": {
@@ -273,7 +275,7 @@
     "decisionOutcome": {
       "type": ["string", "null"],
       "description": "As displayed to users",
-      "enum": ["Approved", "Approved with conditions", "Refused", "Withdrawn"]
+      "enum": ["Approved", "Approved with conditions", "Refused", "Withdrawn", null]
     },
     "turnedAwayDate": {
       "type": ["string", "null"],
@@ -326,7 +328,7 @@
     "eiaScreeningOutcome": {
       "type": ["string", "null"],
       "description": "What was the outcome of the Environmental Impact Assessment",
-      "enum": ["required", "not required"]
+      "enum": ["required", "not required", null]
     },
     "environmentalStatementReceivedDate": {
       "type": ["string", "null"],
@@ -340,7 +342,7 @@
     "procedure": {
       "type": ["string", "null"],
       "description": "Name displayed to users",
-      "enum": ["Written Representations", "Hearing", "Inquiry"]
+      "enum": ["Written Representations", "Hearing", "Inquiry", null]
     },
     "procedureNotificationDate": {
       "type": ["string", "null"],
@@ -459,7 +461,7 @@
       "additionalProperties": true,
       "required": ["contactRoleType", "organisationId"],
       "properties": {
-        "roleType": {
+        "contactRoleType": {
           "type": "string",
           "description": "Agent or Applicant details",
           "example": "agent",
@@ -501,7 +503,7 @@
         "contactPreference": {
           "type": ["string", "null"],
           "example": "email",
-          "enum": ["email", "post"]
+          "enum": ["email", "post", null]
         },
         "writtenRepOrgName": {
           "type": ["string", "null"],

package/schemas/applications-notify-email.schema.json

@@ -93,7 +93,7 @@
     "Contact": {
       "type": "object",
       "description": "Contact the email was sent to",
-      "required": ["contactId", "addressId"],
+      "required": ["contactId"],
       "properties": {
         "contactId": {
           "type": "string",
@@ -102,7 +102,7 @@
         },
         "contactPreference": {
           "type": ["string", "null"],
-          "enum": ["email", "post"],
+          "enum": ["email", "post", null],
           "description": "Preferred contact method",
           "example": "email"
         },

package/schemas/applications-representation.schema.json

@@ -68,7 +68,7 @@
     "submittedReceivedMethod": {
       "type": ["string", "null"],
       "description": "How we received the representation",
-      "enum": ["Online", "Phone", "Email", "Post", "In person"]
+      "enum": ["Online", "Phone", "Email", "Post", "In person", null]
     },
     "submissionMethodReason": {
       "type": ["string", "null"]
@@ -86,7 +86,8 @@
       "enum": [
         "A person",
         "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",
+        null
       ]
     },
     "representedContact": {
@@ -98,7 +99,7 @@
     },
     "representedCategory": {
       "type": ["string", "null"],
-      "enum": ["Consultees", "Interested party"]
+      "enum": ["Consultees", "Interested party", null]
     },
     "wantsToBeHeard": {
       "type": ["boolean", "null"],
@@ -124,7 +125,7 @@
     "withdrawalReason": {
       "type": ["string", "null"],
       "description": "Reason for the withdrawal",
-      "enum": ["Change of opinion", "Mistaken Submission", "Misunderstanding", "Personal Reasons"]
+      "enum": ["Change of opinion", "Mistaken Submission", "Misunderstanding", "Personal Reasons", null]
     },
     "dateWithdrawn": {
       "type": ["string", "null"],
@@ -151,7 +152,7 @@
         "contactPreference": {
           "type": ["string", "null"],
           "example": "email",
-          "enum": ["email", "post"]
+          "enum": ["email", "post", null]
         },
         "writtenRepOrgName": {
           "type": ["string", "null"]

package/schemas/nsip-project.schema.json

@@ -118,6 +118,22 @@
         null
       ]
     },
+    "dcoStatus": {
+      "type": ["string", "null"],
+      "description": "Decision outcome: approved/refused/split-decision/granted/partially_consented/quashed/redetermination/withdrawn/revoked",
+      "enum": [
+        "approved",
+        "refused",
+        "split-decision",
+        "granted",
+        "partially_consented",
+        "quashed",
+        "redetermination",
+        "withdrawn",
+        "revoked",
+        null
+      ]
+    },
     "publishStatus": {
       "type": ["string", "null"],
       "enum": ["published", "unpublished", null]

package/src/enums.cjs

@@ -626,6 +626,18 @@ const NSIP_CASE_TYPE = Object.freeze({
   NSIP: 'nsip',
 });
 
+const NSIP_DCO_STATUS = Object.freeze({
+  APPROVED: 'approved',
+  GRANTED: 'granted',
+  PARTIALLY_CONSENTED: 'partially_consented',
+  QUASHED: 'quashed',
+  REDETERMINATION: 'redetermination',
+  REFUSED: 'refused',
+  REVOKED: 'revoked',
+  SPLIT_DECISION: 'split-decision',
+  WITHDRAWN: 'withdrawn',
+});
+
 const NSIP_DECISION = Object.freeze({
   APPROVED: 'approved',
   GRANTED: 'granted',
@@ -1024,6 +1036,7 @@ exports.MESSAGE_EVENT_TYPE = MESSAGE_EVENT_TYPE;
 exports.METHOD = METHOD;
 exports.NSIP_CASE_TYPE = NSIP_CASE_TYPE;
 exports.NSIP_CA_AND_TP_EVIDENCE = NSIP_CA_AND_TP_EVIDENCE;
+exports.NSIP_DCO_STATUS = NSIP_DCO_STATUS;
 exports.NSIP_DECISION = NSIP_DECISION;
 exports.NSIP_DESIGN_APPROACH_DOCUMENT = NSIP_DESIGN_APPROACH_DOCUMENT;
 exports.NSIP_DOCUMENT_CASE_STAGE = NSIP_DOCUMENT_CASE_STAGE;

package/src/enums.d.ts

@@ -624,6 +624,18 @@ export const NSIP_CASE_TYPE = {
   NSIP: 'nsip',
 } as const;
 
+export const NSIP_DCO_STATUS = {
+  APPROVED: 'approved',
+  GRANTED: 'granted',
+  PARTIALLY_CONSENTED: 'partially_consented',
+  QUASHED: 'quashed',
+  REDETERMINATION: 'redetermination',
+  REFUSED: 'refused',
+  REVOKED: 'revoked',
+  SPLIT_DECISION: 'split-decision',
+  WITHDRAWN: 'withdrawn',
+} as const;
+
 export const NSIP_DECISION = {
   APPROVED: 'approved',
   GRANTED: 'granted',

package/src/enums.js

@@ -624,6 +624,18 @@ export const NSIP_CASE_TYPE = Object.freeze({
   NSIP: 'nsip',
 });
 
+export const NSIP_DCO_STATUS = Object.freeze({
+  APPROVED: 'approved',
+  GRANTED: 'granted',
+  PARTIALLY_CONSENTED: 'partially_consented',
+  QUASHED: 'quashed',
+  REDETERMINATION: 'redetermination',
+  REFUSED: 'refused',
+  REVOKED: 'revoked',
+  SPLIT_DECISION: 'split-decision',
+  WITHDRAWN: 'withdrawn',
+});
+
 export const NSIP_DECISION = Object.freeze({
   APPROVED: 'approved',
   GRANTED: 'granted',

package/src/index.cjs

@@ -707,6 +707,18 @@ const NSIP_CASE_TYPE = Object.freeze({
   NSIP: 'nsip',
 });
 
+const NSIP_DCO_STATUS = Object.freeze({
+  APPROVED: 'approved',
+  GRANTED: 'granted',
+  PARTIALLY_CONSENTED: 'partially_consented',
+  QUASHED: 'quashed',
+  REDETERMINATION: 'redetermination',
+  REFUSED: 'refused',
+  REVOKED: 'revoked',
+  SPLIT_DECISION: 'split-decision',
+  WITHDRAWN: 'withdrawn',
+});
+
 const NSIP_DECISION = Object.freeze({
   APPROVED: 'approved',
   GRANTED: 'granted',
@@ -1137,6 +1149,7 @@ exports.MESSAGE_EVENT_TYPE = MESSAGE_EVENT_TYPE;
 exports.METHOD = METHOD;
 exports.NSIP_CASE_TYPE = NSIP_CASE_TYPE;
 exports.NSIP_CA_AND_TP_EVIDENCE = NSIP_CA_AND_TP_EVIDENCE;
+exports.NSIP_DCO_STATUS = NSIP_DCO_STATUS;
 exports.NSIP_DECISION = NSIP_DECISION;
 exports.NSIP_DESIGN_APPROACH_DOCUMENT = NSIP_DESIGN_APPROACH_DOCUMENT;
 exports.NSIP_DOCUMENT_CASE_STAGE = NSIP_DOCUMENT_CASE_STAGE;

package/src/schemas.d.ts

@@ -1913,7 +1913,7 @@ export interface CrownDevelopmentApplication {
   /**
    * SubType applies to Planning permissions and LBC
    */
-  subType?: ('Planning permission' | 'Listed building consent (LBC)') | null;
+  subType?: 'Planning permission' | 'Listed building consent (LBC)' | null;
   /**
    * Self-referencial for parent to children relationship
    */
@@ -1980,15 +1980,13 @@ export interface CrownDevelopmentApplication {
    * Current stage of the case (enum)
    */
   applicationStage?:
-    | (
-        | 'Accepted'
-        | 'Consultation'
-        | 'Procedure choice'
-        | 'Written representations'
-        | 'Inquiry'
-        | 'Hearing/Inquiry date set'
-        | 'Final decision'
-      )
+    | 'Accepted'
+    | 'Consultation'
+    | 'Procedure choice'
+    | 'Written representations'
+    | 'Inquiry'
+    | 'Hearing/Inquiry date set'
+    | 'Final decision'
     | null;
   /**
    * Site is nationally important (Yes/No)
@@ -2014,25 +2012,23 @@ export interface CrownDevelopmentApplication {
    * Application category (enum)
    */
   category?:
-    | (
-        | 'Major Development'
-        | 'Buildings over 1000 square metres'
-        | 'Development of a site above 1 hectare'
-        | 'Dwellings numbering 10 or more'
-        | 'Dwellings of 0.5 hectare or more'
-        | 'Minerals'
-        | 'Waste'
-        | 'Non-Major Development'
-        | 'Buildings less than 1000 square metres'
-        | 'Development of a site less than 1 hectare'
-        | 'Dwellings numbering between 1 and 9'
-        | 'Dwellings of less than 0.5 hectare'
-        | 'Change of use'
-        | 'Relevant demolition'
-        | 'Other'
-        | 'Listed building consent to alter/extend'
-        | 'Listed building consent to demolish'
-      )
+    | 'Major Development'
+    | 'Buildings over 1000 square metres'
+    | 'Development of a site above 1 hectare'
+    | 'Dwellings numbering 10 or more'
+    | 'Dwellings of 0.5 hectare or more'
+    | 'Minerals'
+    | 'Waste'
+    | 'Non-Major Development'
+    | 'Buildings less than 1000 square metres'
+    | 'Development of a site less than 1 hectare'
+    | 'Dwellings numbering between 1 and 9'
+    | 'Dwellings of less than 0.5 hectare'
+    | 'Change of use'
+    | 'Relevant demolition'
+    | 'Other'
+    | 'Listed building consent to alter/extend'
+    | 'Listed building consent to demolish'
     | null;
   /**
    * Is the site in green belt land
@@ -2113,7 +2109,7 @@ export interface CrownDevelopmentApplication {
   /**
    * As displayed to users
    */
-  decisionOutcome?: ('Approved' | 'Approved with conditions' | 'Refused' | 'Withdrawn') | null;
+  decisionOutcome?: 'Approved' | 'Approved with conditions' | 'Refused' | 'Withdrawn' | null;
   /**
    * Date application was turned away
    */
@@ -2161,7 +2157,7 @@ export interface CrownDevelopmentApplication {
   /**
    * What was the outcome of the Environmental Impact Assessment
    */
-  eiaScreeningOutcome?: ('required' | 'not required') | null;
+  eiaScreeningOutcome?: 'required' | 'not required' | null;
   /**
    * Date the environmental statement was received
    */
@@ -2173,7 +2169,7 @@ export interface CrownDevelopmentApplication {
   /**
    * Name displayed to users
    */
-  procedure?: ('Written Representations' | 'Hearing' | 'Inquiry') | null;
+  procedure?: 'Written Representations' | 'Hearing' | 'Inquiry' | null;
   procedureNotificationDate?: string | null;
   eventDate?: string | null;
   eventPrepDuration?: number | null;
@@ -2252,7 +2248,7 @@ export interface Organisation {
   /**
    * Agent or Applicant details
    */
-  roleType?: 'agent' | 'applicant';
+  contactRoleType: 'agent' | 'applicant';
   /**
    * Source PK for Organisation
    */
@@ -2278,7 +2274,7 @@ export interface Contact {
    * Source PK for Contact
    */
   contactId: string;
-  contactPreference?: ('email' | 'post') | null;
+  contactPreference?: 'email' | 'post' | null;
   /**
    * Organisation Name used for written-representation on behalf of an organisation
    */
@@ -2375,7 +2371,7 @@ export interface Contact {
   /**
    * Preferred contact method
    */
-  contactPreference?: ('email' | 'post') | null;
+  contactPreference?: 'email' | 'post' | null;
   writtenRepOrgName?: string | null;
   writtenRepJobTitleorRole?: string | null;
 }
@@ -2413,7 +2409,7 @@ export interface CaseworkRepresentationSchema {
   /**
    * How we received the representation
    */
-  submittedReceivedMethod?: ('Online' | 'Phone' | 'Email' | 'Post' | 'In person') | null;
+  submittedReceivedMethod?: 'Online' | 'Phone' | 'Email' | 'Post' | 'In person' | null;
   submissionMethodReason?: string | null;
   comment: string;
   /**
@@ -2424,17 +2420,15 @@ export interface CaseworkRepresentationSchema {
    * When representation is on behalf of a person/org/group
    */
   representedType?:
-    | (
-        | 'A person'
-        | 'An organisation or charity I work or volunteer for'
-        | 'An organisation or charity I do not work or volunteer for'
-      )
+    | 'A person'
+    | 'An organisation or charity I work or volunteer for'
+    | 'An organisation or charity I do not work or volunteer for'
     | null;
   /**
    * When representation is on behalf of a person/org/group
    */
   representedContact?: Contact[] | null;
-  representedCategory?: ('Consultees' | 'Interested party') | null;
+  representedCategory?: 'Consultees' | 'Interested party' | null;
   /**
    * Internal: wants to be heard at a hearing
    */
@@ -2458,7 +2452,7 @@ export interface CaseworkRepresentationSchema {
   /**
    * Reason for the withdrawal
    */
-  withdrawalReason?: ('Change of opinion' | 'Mistaken Submission' | 'Misunderstanding' | 'Personal Reasons') | null;
+  withdrawalReason?: 'Change of opinion' | 'Mistaken Submission' | 'Misunderstanding' | 'Personal Reasons' | null;
   /**
    * Date the representation was withdrawn
    */
@@ -2471,7 +2465,7 @@ export interface Contact {
    * Source PK for Contact
    */
   contactId: string;
-  contactPreference?: ('email' | 'post') | null;
+  contactPreference?: 'email' | 'post' | null;
   writtenRepOrgName?: string | null;
   writtenRepJobTitleorRole?: string | null;
 }
@@ -3245,6 +3239,20 @@ export interface NSIPProject {
     | 'redetermination'
     | 'withdrawn'
     | null;
+  /**
+   * Decision outcome: approved/refused/split-decision/granted/partially_consented/quashed/redetermination/withdrawn/revoked
+   */
+  dcoStatus?:
+    | 'approved'
+    | 'refused'
+    | 'split-decision'
+    | 'granted'
+    | 'partially_consented'
+    | 'quashed'
+    | 'redetermination'
+    | 'withdrawn'
+    | 'revoked'
+    | null;
   publishStatus: 'published' | 'unpublished' | null;
   /**
    * {Sector Abbreviation} - {Sector Display Name}
@@ -5910,7 +5918,7 @@ export type SchemaMap = {
     'appeal-representation.schema.json': AppealRepresentation;
     'appeal-s78.schema.json': AppealS78Case;
     'applications-application-update.schema.json': ApplicationUpdateSchema;
-    'applications-application.schema.json': CrownDevelopmentApplication;
+    'applications-crowndev-application.schema.json': CrownDevelopmentApplication;
     'applications-notify-email.schema.json': EmailNotificationRecordSchema;
     'applications-representation.schema.json': CaseworkRepresentationSchema;
     'dart-response.schema.json': DaRTAPIResponse;