@planning-inspectorate/data-model 2.53.0 → 2.54.0

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/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;
 }
@@ -5910,7 +5904,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;