@planning-inspectorate/data-model 2.51.1 → 2.53.0

package/.azure/ci.yml

@@ -35,7 +35,7 @@ extends:
             displayName: Cache NPM
           - template: ../steps/node_script.yml
             parameters:
-              nodeVersion: 22
+              nodeVersion: 24
               script: npm ci
               environmentVariables:
                 npm_config_cache: $(pipeline.workspace)/.npm
@@ -43,23 +43,23 @@ extends:
             parameters:
               # only run commitlint on branches, not main
               condition: ne(variables['Build.SourceBranchName'], 'main')
-              nodeVersion: 22
+              nodeVersion: 24
               script: npm run commitlint
           - template: ../steps/node_script.yml
             parameters:
-              nodeVersion: 22
+              nodeVersion: 24
               script: npm run lint
           - template: ../steps/node_script.yml
             parameters:
-              nodeVersion: 22
+              nodeVersion: 24
               script: npm run format-check
           - template: ../steps/node_script.yml
             parameters:
-              nodeVersion: 22
+              nodeVersion: 24
               script: npm run gen
           - template: ../steps/node_script.yml
             parameters:
-              nodeVersion: 22
+              nodeVersion: 24
               script: node --test
           - script: |
               set -e

package/.azure/release.yml

@@ -44,11 +44,11 @@ jobs:
             - checkout: self
             - template: steps/node_script.yml@templates
               parameters:
-                nodeVersion: 22
+                nodeVersion: 24
                 script: npm ci
             - template: steps/node_script.yml@templates
               parameters:
-                nodeVersion: 22
+                nodeVersion: 24
                 script: npx semantic-release --branches main --tag-format '${version}' ${{ variables.dryRunFlag }}
                 environmentVariables:
                   GH_TOKEN: $(GITHUB_TOKEN)

package/docs/README.md

@@ -80,13 +80,17 @@
 
 * [Untitled object in Appeal S78 Case](./appeal-s78-properties-applicationelbappealgroundsdetails-items.md) – `appeal-s78.schema.json#/properties/applicationElbAppealGroundsDetails/items`
 
+* [Untitled object in Appeal S78 Case](./appeal-s78-properties-enforcementcasegroundsofappeal-items.md) – `appeal-s78.schema.json#/properties/enforcementCaseGroundsOfAppeal/items`
+
+* [Untitled object in Appeal S78 Case](./appeal-s78-properties-elbcasegroundsofappeal-items.md) – `appeal-s78.schema.json#/properties/elbCaseGroundsOfAppeal/items`
+
 * [Untitled object in Appeal S78 Case](./appeal-s78-properties-significantchangesaffectingapplicationappellant-items.md) – `appeal-s78.schema.json#/properties/significantChangesAffectingApplicationAppellant/items`
 
 * [Untitled object in Appeal S78 Case](./appeal-s78-properties-significantchangesaffectingapplicationlpa-items.md) – `appeal-s78.schema.json#/properties/significantChangesAffectingApplicationLpa/items`
 
-* [Untitled object in Casework Representation Schema](./applications-representation-definitions-contact.md) – `applications-representation.schema.json#/definitions/contact`
+* [Untitled object in Casework Representation Schema](./applications-representation-defs-contact.md) – `applications-representation.schema.json#/$defs/contact`
 
-* [Untitled object in Casework Representation Schema](./applications-representation-definitions-representationdocument.md) – `applications-representation.schema.json#/definitions/representationDocument`
+* [Untitled object in Casework Representation Schema](./applications-representation-defs-representationdocument.md) – `applications-representation.schema.json#/$defs/representationDocument`
 
 * [Untitled object in Crown Development Application](./applications-application-defs-organisation.md) – `applications-application.schema.json#/$defs/organisation`
 

package/docs/appeal-document.md

@@ -636,6 +636,7 @@ The type of document, used for exchange, migrations and consumption from the app
 | `"hearingProcess"`                     |             |
 | `"inquiryCore"`                        |             |
 | `"inquiryPostEvent"`                   |             |
+| `"noticeWithdrawal"`                   |             |
 | `null`                                 |             |
 
 ## sourceSystem

package/docs/appeal-has.md

@@ -221,21 +221,23 @@ The processing status for the appeal
 
 **enum**: the value of this property must be equal to one of the following values:
 
-| Value                   | Explanation |
-| :---------------------- | :---------- |
-| `"assign_case_officer"` |             |
-| `"validation"`          |             |
-| `"ready_to_start"`      |             |
-| `"lpa_questionnaire"`   |             |
-| `"issue_determination"` |             |
-| `"complete"`            |             |
-| `"invalid"`             |             |
-| `"closed"`              |             |
-| `"withdrawn"`           |             |
-| `"awaiting_transfer"`   |             |
-| `"transferred"`         |             |
-| `"event"`               |             |
-| `"awaiting_event"`      |             |
+| Value                      | Explanation |
+| :------------------------- | :---------- |
+| `"assign_case_officer"`    |             |
+| `"validation"`             |             |
+| `"ready_to_start"`         |             |
+| `"lpa_questionnaire"`      |             |
+| `"issue_determination"`    |             |
+| `"complete"`               |             |
+| `"invalid"`                |             |
+| `"closed"`                 |             |
+| `"withdrawn"`              |             |
+| `"awaiting_transfer"`      |             |
+| `"transferred"`            |             |
+| `"event"`                  |             |
+| `"awaiting_event"`         |             |
+| `"notice_withdrawn"`       |             |
+| `"closed_opened_in_error"` |             |
 
 ## caseType
 

package/docs/appeal-s78.md

@@ -167,6 +167,8 @@ any of
 | [occupancyConditionsMet](#occupancyconditionsmet)                                                   | `boolean` | Optional | can be null    | [Appeal S78 Case](appeal-s78-properties-occupancyconditionsmet.md "appeal-s78.schema.json#/properties/occupancyConditionsMet")                                                   |
 | [enforcementAppealGroundsDetails](#enforcementappealgroundsdetails)                                 | `array`   | Optional | can be null    | [Appeal S78 Case](appeal-s78-properties-enforcementappealgroundsdetails.md "appeal-s78.schema.json#/properties/enforcementAppealGroundsDetails")                                 |
 | [applicationElbAppealGroundsDetails](#applicationelbappealgroundsdetails)                           | `array`   | Optional | can be null    | [Appeal S78 Case](appeal-s78-properties-applicationelbappealgroundsdetails.md "appeal-s78.schema.json#/properties/applicationElbAppealGroundsDetails")                           |
+| [enforcementCaseGroundsOfAppeal](#enforcementcasegroundsofappeal)                                   | `array`   | Optional | can be null    | [Appeal S78 Case](appeal-s78-properties-enforcementcasegroundsofappeal.md "appeal-s78.schema.json#/properties/enforcementCaseGroundsOfAppeal")                                   |
+| [elbCaseGroundsOfAppeal](#elbcasegroundsofappeal)                                                   | `array`   | Optional | can be null    | [Appeal S78 Case](appeal-s78-properties-elbcasegroundsofappeal.md "appeal-s78.schema.json#/properties/elbCaseGroundsOfAppeal")                                                   |
 | [applicationMadeAndFeePaid](#applicationmadeandfeepaid)                                             | `boolean` | Optional | can be null    | [Appeal S78 Case](appeal-s78-properties-applicationmadeandfeepaid.md "appeal-s78.schema.json#/properties/applicationMadeAndFeePaid")                                             |
 | [noticeRelatesToBuildingEngineeringMiningOther](#noticerelatestobuildingengineeringminingother)     | `boolean` | Optional | can be null    | [Appeal S78 Case](appeal-s78-properties-noticerelatestobuildingengineeringminingother.md "appeal-s78.schema.json#/properties/noticeRelatesToBuildingEngineeringMiningOther")     |
 | [changeOfUseRefuseOrWaste](#changeofuserefuseorwaste)                                               | `boolean` | Optional | can be null    | [Appeal S78 Case](appeal-s78-properties-changeofuserefuseorwaste.md "appeal-s78.schema.json#/properties/changeOfUseRefuseOrWaste")                                               |
@@ -316,25 +318,27 @@ The processing status for the appeal
 
 **enum**: the value of this property must be equal to one of the following values:
 
-| Value                   | Explanation |
-| :---------------------- | :---------- |
-| `"assign_case_officer"` |             |
-| `"validation"`          |             |
-| `"ready_to_start"`      |             |
-| `"lpa_questionnaire"`   |             |
-| `"issue_determination"` |             |
-| `"statements"`          |             |
-| `"evidence"`            |             |
-| `"witnesses"`           |             |
-| `"final_comments"`      |             |
-| `"complete"`            |             |
-| `"invalid"`             |             |
-| `"closed"`              |             |
-| `"withdrawn"`           |             |
-| `"awaiting_transfer"`   |             |
-| `"transferred"`         |             |
-| `"event"`               |             |
-| `"awaiting_event"`      |             |
+| Value                      | Explanation |
+| :------------------------- | :---------- |
+| `"assign_case_officer"`    |             |
+| `"validation"`             |             |
+| `"ready_to_start"`         |             |
+| `"lpa_questionnaire"`      |             |
+| `"issue_determination"`    |             |
+| `"statements"`             |             |
+| `"evidence"`               |             |
+| `"witnesses"`              |             |
+| `"final_comments"`         |             |
+| `"complete"`               |             |
+| `"invalid"`                |             |
+| `"closed"`                 |             |
+| `"withdrawn"`              |             |
+| `"awaiting_transfer"`      |             |
+| `"transferred"`            |             |
+| `"event"`                  |             |
+| `"awaiting_event"`         |             |
+| `"notice_withdrawn"`       |             |
+| `"closed_opened_in_error"` |             |
 
 ## caseType
 
@@ -4070,6 +4074,46 @@ A list of grounds for the appeal, supporting facts & start dates. Enforcement ca
 
 `object[]` ([Details](appeal-s78-properties-applicationelbappealgroundsdetails-items.md))
 
+## enforcementCaseGroundsOfAppeal
+
+Case Officer list of grounds for the appeal & start dates. Enforcement cases (C) can have grounds (a) to (g)
+
+> Enforcement Listed Building cases (F) have a separate list of grounds (a) to (k)
+
+`enforcementCaseGroundsOfAppeal`
+
+* is optional
+
+* Type: `object[]` ([Details](appeal-s78-properties-enforcementcasegroundsofappeal-items.md))
+
+* can be null
+
+* defined in: [Appeal S78 Case](appeal-s78-properties-enforcementcasegroundsofappeal.md "appeal-s78.schema.json#/properties/enforcementCaseGroundsOfAppeal")
+
+### enforcementCaseGroundsOfAppeal Type
+
+`object[]` ([Details](appeal-s78-properties-enforcementcasegroundsofappeal-items.md))
+
+## elbCaseGroundsOfAppeal
+
+Case Officer list of grounds for the appeal & start dates. Enforcement cases (C) can have grounds (a) to (g)
+
+> Enforcement Listed Building cases (F) have a separate list of grounds (a) to (k)
+
+`elbCaseGroundsOfAppeal`
+
+* is optional
+
+* Type: `object[]` ([Details](appeal-s78-properties-elbcasegroundsofappeal-items.md))
+
+* can be null
+
+* defined in: [Appeal S78 Case](appeal-s78-properties-elbcasegroundsofappeal.md "appeal-s78.schema.json#/properties/elbCaseGroundsOfAppeal")
+
+### elbCaseGroundsOfAppeal Type
+
+`object[]` ([Details](appeal-s78-properties-elbcasegroundsofappeal-items.md))
+
 ## applicationMadeAndFeePaid
 
 Was an application made and paid for

package/docs/applications-notify-email.md

@@ -18,7 +18,7 @@
 | [email](#email)                     | `string`  | Optional | can be null    | [Email Notification Record Schema](applications-notify-email-properties-email.md "applications-notify-email.schema.json#/properties/email")                     |
 | [contact](#contact)                 | `array`   | Optional | can be null    | [Email Notification Record Schema](applications-notify-email-properties-contact.md "applications-notify-email.schema.json#/properties/contact")                 |
 | [lpaCode](#lpacode)                 | `string`  | Required | cannot be null | [Email Notification Record Schema](applications-notify-email-properties-lpacode.md "applications-notify-email.schema.json#/properties/lpaCode")                 |
-| [emailStatus](#emailstatus)         | `string`  | Optional | cannot be null | [Email Notification Record Schema](applications-notify-email-properties-emailstatus.md "applications-notify-email.schema.json#/properties/emailStatus")         |
+| [emailStatus](#emailstatus)         | `string`  | Required | cannot be null | [Email Notification Record Schema](applications-notify-email-properties-emailstatus.md "applications-notify-email.schema.json#/properties/emailStatus")         |
 | [templateId](#templateid)           | `string`  | Optional | can be null    | [Email Notification Record Schema](applications-notify-email-properties-templateid.md "applications-notify-email.schema.json#/properties/templateId")           |
 | [templateVersion](#templateversion) | `integer` | Optional | can be null    | [Email Notification Record Schema](applications-notify-email-properties-templateversion.md "applications-notify-email.schema.json#/properties/templateVersion") |
 | [body](#body)                       | `string`  | Optional | can be null    | [Email Notification Record Schema](applications-notify-email-properties-body.md "applications-notify-email.schema.json#/properties/body")                       |
@@ -259,7 +259,7 @@ Outcome of the email (status)
 
 `emailStatus`
 
-* is optional
+* is required
 
 * Type: `string`
 

package/docs/applications-representation-defs-contact.md

@@ -0,0 +1,93 @@
+## contact Type
+
+`object` ([Details](applications-representation-defs-contact.md))
+
+# contact Properties
+
+| Property                                              | Type     | Required | Nullable       | Defined by                                                                                                                                                                                                     |
+| :---------------------------------------------------- | :------- | :------- | :------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| [contactId](#contactid)                               | `string` | Required | cannot be null | [Casework Representation Schema](applications-representation-defs-contact-properties-contactid.md "applications-representation.schema.json#/$defs/contact/properties/contactId")                               |
+| [contactPreference](#contactpreference)               | `string` | Optional | can be null    | [Casework Representation Schema](applications-representation-defs-contact-properties-contactpreference.md "applications-representation.schema.json#/$defs/contact/properties/contactPreference")               |
+| [writtenRepOrgName](#writtenreporgname)               | `string` | Optional | can be null    | [Casework Representation Schema](applications-representation-defs-contact-properties-writtenreporgname.md "applications-representation.schema.json#/$defs/contact/properties/writtenRepOrgName")               |
+| [writtenRepJobTitleorRole](#writtenrepjobtitleorrole) | `string` | Optional | can be null    | [Casework Representation Schema](applications-representation-defs-contact-properties-writtenrepjobtitleorrole.md "applications-representation.schema.json#/$defs/contact/properties/writtenRepJobTitleorRole") |
+
+## contactId
+
+Source PK for Contact
+
+`contactId`
+
+* is required
+
+* Type: `string`
+
+* cannot be null
+
+* defined in: [Casework Representation Schema](applications-representation-defs-contact-properties-contactid.md "applications-representation.schema.json#/$defs/contact/properties/contactId")
+
+### contactId Type
+
+`string`
+
+## contactPreference
+
+
+
+`contactPreference`
+
+* is optional
+
+* Type: `string`
+
+* can be null
+
+* defined in: [Casework Representation Schema](applications-representation-defs-contact-properties-contactpreference.md "applications-representation.schema.json#/$defs/contact/properties/contactPreference")
+
+### contactPreference Type
+
+`string`
+
+### contactPreference Constraints
+
+**enum**: the value of this property must be equal to one of the following values:
+
+| Value     | Explanation |
+| :-------- | :---------- |
+| `"email"` |             |
+| `"post"`  |             |
+
+## writtenRepOrgName
+
+
+
+`writtenRepOrgName`
+
+* is optional
+
+* Type: `string`
+
+* can be null
+
+* defined in: [Casework Representation Schema](applications-representation-defs-contact-properties-writtenreporgname.md "applications-representation.schema.json#/$defs/contact/properties/writtenRepOrgName")
+
+### writtenRepOrgName Type
+
+`string`
+
+## writtenRepJobTitleorRole
+
+
+
+`writtenRepJobTitleorRole`
+
+* is optional
+
+* Type: `string`
+
+* can be null
+
+* defined in: [Casework Representation Schema](applications-representation-defs-contact-properties-writtenrepjobtitleorrole.md "applications-representation.schema.json#/$defs/contact/properties/writtenRepJobTitleorRole")
+
+### writtenRepJobTitleorRole Type
+
+`string`

package/docs/applications-representation-defs-representationdocument.md

@@ -0,0 +1,152 @@
+## representationDocument Type
+
+`object` ([Details](applications-representation-defs-representationdocument.md))
+
+# representationDocument Properties
+
+| Property                              | Type     | Required | Nullable       | Defined by                                                                                                                                                                                                                   |
+| :------------------------------------ | :------- | :------- | :------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| [id](#id)                             | `string` | Required | cannot be null | [Casework Representation Schema](applications-representation-defs-representationdocument-properties-id.md "applications-representation.schema.json#/$defs/representationDocument/properties/id")                             |
+| [representationId](#representationid) | `string` | Required | cannot be null | [Casework Representation Schema](applications-representation-defs-representationdocument-properties-representationid.md "applications-representation.schema.json#/$defs/representationDocument/properties/representationId") |
+| [itemId](#itemid)                     | `string` | Required | cannot be null | [Casework Representation Schema](applications-representation-defs-representationdocument-properties-itemid.md "applications-representation.schema.json#/$defs/representationDocument/properties/itemId")                     |
+| [fileName](#filename)                 | `string` | Required | cannot be null | [Casework Representation Schema](applications-representation-defs-representationdocument-properties-filename.md "applications-representation.schema.json#/$defs/representationDocument/properties/fileName")                 |
+| [redactedItemId](#redacteditemid)     | `string` | Optional | can be null    | [Casework Representation Schema](applications-representation-defs-representationdocument-properties-redacteditemid.md "applications-representation.schema.json#/$defs/representationDocument/properties/redactedItemId")     |
+| [redactedFileName](#redactedfilename) | `string` | Optional | can be null    | [Casework Representation Schema](applications-representation-defs-representationdocument-properties-redactedfilename.md "applications-representation.schema.json#/$defs/representationDocument/properties/redactedFileName") |
+| [status](#status)                     | `string` | Required | cannot be null | [Casework Representation Schema](applications-representation-defs-representationdocument-properties-status.md "applications-representation.schema.json#/$defs/representationDocument/properties/status")                     |
+
+## id
+
+Source Key for Representation Document
+
+`id`
+
+* is required
+
+* Type: `string`
+
+* cannot be null
+
+* defined in: [Casework Representation Schema](applications-representation-defs-representationdocument-properties-id.md "applications-representation.schema.json#/$defs/representationDocument/properties/id")
+
+### id Type
+
+`string`
+
+## representationId
+
+The representation this relates to
+
+`representationId`
+
+* is required
+
+* Type: `string`
+
+* cannot be null
+
+* defined in: [Casework Representation Schema](applications-representation-defs-representationdocument-properties-representationid.md "applications-representation.schema.json#/$defs/representationDocument/properties/representationId")
+
+### representationId Type
+
+`string`
+
+## itemId
+
+The id of the item in SharePoint
+
+`itemId`
+
+* is required
+
+* Type: `string`
+
+* cannot be null
+
+* defined in: [Casework Representation Schema](applications-representation-defs-representationdocument-properties-itemid.md "applications-representation.schema.json#/$defs/representationDocument/properties/itemId")
+
+### itemId Type
+
+`string`
+
+## fileName
+
+The name of the file
+
+`fileName`
+
+* is required
+
+* Type: `string`
+
+* cannot be null
+
+* defined in: [Casework Representation Schema](applications-representation-defs-representationdocument-properties-filename.md "applications-representation.schema.json#/$defs/representationDocument/properties/fileName")
+
+### fileName Type
+
+`string`
+
+## redactedItemId
+
+The id of the redacted version of the item in sharepoint
+
+`redactedItemId`
+
+* is optional
+
+* Type: `string`
+
+* can be null
+
+* defined in: [Casework Representation Schema](applications-representation-defs-representationdocument-properties-redacteditemid.md "applications-representation.schema.json#/$defs/representationDocument/properties/redactedItemId")
+
+### redactedItemId Type
+
+`string`
+
+## redactedFileName
+
+the name of the redacted file
+
+`redactedFileName`
+
+* is optional
+
+* Type: `string`
+
+* can be null
+
+* defined in: [Casework Representation Schema](applications-representation-defs-representationdocument-properties-redactedfilename.md "applications-representation.schema.json#/$defs/representationDocument/properties/redactedFileName")
+
+### redactedFileName Type
+
+`string`
+
+## status
+
+The status of the document
+
+`status`
+
+* is required
+
+* Type: `string`
+
+* cannot be null
+
+* defined in: [Casework Representation Schema](applications-representation-defs-representationdocument-properties-status.md "applications-representation.schema.json#/$defs/representationDocument/properties/status")
+
+### status Type
+
+`string`
+
+### status Constraints
+
+**enum**: the value of this property must be equal to one of the following values:
+
+| Value               | Explanation |
+| :------------------ | :---------- |
+| `"Awaiting review"` |             |
+| `"Accepted"`        |             |
+| `"Rejected"`        |             |
+| `"Withdrawn"`       |             |

package/docs/applications-representation-defs.md

@@ -0,0 +1,3 @@
+## $defs Type
+
+unknown