@planning-inspectorate/data-model 2.1.0 → 2.3.0

package/.azure/ci.yml

@@ -21,6 +21,7 @@ resources:
 extends:
   template: stages/wrapper_ci.yml@templates
   parameters:
+    gitFetchDepth: 0
     skipAzureAuth: true
     validationJobs:
       - name: Run Checks
@@ -31,6 +32,8 @@ extends:
               script: npm ci
           - template: ../steps/node_script.yml
             parameters:
+              # only run commitlint on branches, not main
+              condition: ne(variables['Build.SourceBranchName'], 'main')
               nodeVersion: 22
               script: npm run commitlint
           - template: ../steps/node_script.yml

package/docs/README.md

@@ -30,6 +30,10 @@
 
 * [NSIP Document](./nsip-document.md "NSIP document schema") – `nsip-document.schema.json`
 
+* [NSIP Invoice](./nsip-invoice.md "NSIP Standalone Invoice Schema for ODW Curated layer") – `nsip-invoice.schema.json`
+
+* [NSIP Meeting](./nsip-meeting.md "NSIP Standalone Meeting Schema for ODW Curated layer") – `nsip-meeting.schema.json`
+
 * [NSIP Project](./nsip-project.md "Subset of Pins Data Model \[Case]") – `nsip-project.schema.json`
 
 * [NSIP Project Update](./nsip-project-update.md "NSIP Project Update (formerly known as Banners)") – `nsip-project-update.schema.json`

package/docs/appeal-has.md

@@ -115,6 +115,7 @@ any of
 | [didAppellantSubmitCompletePhotosAndPlans](#didappellantsubmitcompletephotosandplans)     | `boolean` | Optional | can be null    | [Appeal HAS Case](appeal-has-properties-didappellantsubmitcompletephotosandplans.md "appeal-has.schema.json#/properties/didAppellantSubmitCompletePhotosAndPlans")     |
 | [isSiteInAreaOfSpecialControlAdverts](#issiteinareaofspecialcontroladverts)               | `boolean` | Optional | can be null    | [Appeal HAS Case](appeal-has-properties-issiteinareaofspecialcontroladverts.md "appeal-has.schema.json#/properties/isSiteInAreaOfSpecialControlAdverts")               |
 | [advertDetails](#advertdetails)                                                           | `array`   | Optional | can be null    | [Appeal HAS Case](appeal-has-properties-advertdetails.md "appeal-has.schema.json#/properties/advertDetails")                                                           |
+| [padsSapId](#padssapid)                                                                   | `string`  | Required | can be null    | [Appeal HAS Case](appeal-has-properties-padssapid.md "appeal-has.schema.json#/properties/padsSapId")                                                                   |
 | Additional Properties                                                                     | Any       | Optional | can be null    |                                                                                                                                                                        |
 
 ## caseId
@@ -2623,6 +2624,24 @@ A list of advertisements for the appeal
 
 `object[]` ([Details](appeal-has-properties-advertdetails-items.md))
 
+## padsSapId
+
+padsSapId for PADS inspectors
+
+`padsSapId`
+
+* is required
+
+* Type: `string`
+
+* can be null
+
+* defined in: [Appeal HAS Case](appeal-has-properties-padssapid.md "appeal-has.schema.json#/properties/padsSapId")
+
+### padsSapId Type
+
+`string`
+
 ## Additional Properties
 
 Additional properties are allowed and do not have to follow a specific schema

package/docs/appeal-s78.md

@@ -154,6 +154,7 @@ any of
 | [didAppellantSubmitCompletePhotosAndPlans](#didappellantsubmitcompletephotosandplans)     | `boolean` | Optional | can be null    | [Appeal S78 Case](appeal-s78-properties-didappellantsubmitcompletephotosandplans.md "appeal-s78.schema.json#/properties/didAppellantSubmitCompletePhotosAndPlans")     |
 | [isSiteInAreaOfSpecialControlAdverts](#issiteinareaofspecialcontroladverts)               | `boolean` | Optional | can be null    | [Appeal S78 Case](appeal-s78-properties-issiteinareaofspecialcontroladverts.md "appeal-s78.schema.json#/properties/isSiteInAreaOfSpecialControlAdverts")               |
 | [advertDetails](#advertdetails)                                                           | `array`   | Optional | can be null    | [Appeal S78 Case](appeal-s78-properties-advertdetails.md "appeal-s78.schema.json#/properties/advertDetails")                                                           |
+| [padsSapId](#padssapid)                                                                   | `string`  | Required | can be null    | [Appeal S78 Case](appeal-s78-properties-padssapid.md "appeal-s78.schema.json#/properties/padsSapId")                                                                   |
 | Additional Properties                                                                     | Any       | Optional | can be null    |                                                                                                                                                                        |
 
 ## caseId
@@ -3692,6 +3693,24 @@ A list of advertisements for the appeal
 
 `object[]` ([Details](appeal-s78-properties-advertdetails-items.md))
 
+## padsSapId
+
+padsSapId for PADS inspectors
+
+`padsSapId`
+
+* is required
+
+* Type: `string`
+
+* can be null
+
+* defined in: [Appeal S78 Case](appeal-s78-properties-padssapid.md "appeal-s78.schema.json#/properties/padsSapId")
+
+### padsSapId Type
+
+`string`
+
 ## Additional Properties
 
 Additional properties are allowed and do not have to follow a specific schema

package/docs/nsip-invoice.md

@@ -0,0 +1,317 @@
+## NSIP Invoice Type
+
+`object` ([NSIP Invoice](nsip-invoice.md))
+
+# NSIP Invoice Properties
+
+| Property                                          | Type      | Required | Nullable       | Defined by                                                                                                                      |
+| :------------------------------------------------ | :-------- | :------- | :------------- | :------------------------------------------------------------------------------------------------------------------------------ |
+| [caseId](#caseid)                                 | `integer` | Required | cannot be null | [NSIP Invoice](nsip-invoice-properties-caseid.md "nsip-invoice.schema.json#/properties/caseId")                                 |
+| [caseReference](#casereference)                   | `string`  | Required | can be null    | [NSIP Invoice](nsip-invoice-properties-casereference.md "nsip-invoice.schema.json#/properties/caseReference")                   |
+| [invoiceStage](#invoicestage)                     | `string`  | Required | can be null    | [NSIP Invoice](nsip-invoice-properties-invoicestage.md "nsip-invoice.schema.json#/properties/invoiceStage")                     |
+| [invoiceNumber](#invoicenumber)                   | `string`  | Required | cannot be null | [NSIP Invoice](nsip-invoice-properties-invoicenumber.md "nsip-invoice.schema.json#/properties/invoiceNumber")                   |
+| [amountDue](#amountdue)                           | `number`  | Required | cannot be null | [NSIP Invoice](nsip-invoice-properties-amountdue.md "nsip-invoice.schema.json#/properties/amountDue")                           |
+| [paymentDueDate](#paymentduedate)                 | `string`  | Required | can be null    | [NSIP Invoice](nsip-invoice-properties-paymentduedate.md "nsip-invoice.schema.json#/properties/paymentDueDate")                 |
+| [invoicedDate](#invoiceddate)                     | `string`  | Required | can be null    | [NSIP Invoice](nsip-invoice-properties-invoiceddate.md "nsip-invoice.schema.json#/properties/invoicedDate")                     |
+| [paymentDate](#paymentdate)                       | `string`  | Required | can be null    | [NSIP Invoice](nsip-invoice-properties-paymentdate.md "nsip-invoice.schema.json#/properties/paymentDate")                       |
+| [refundCreditNoteNumber](#refundcreditnotenumber) | `string`  | Required | can be null    | [NSIP Invoice](nsip-invoice-properties-refundcreditnotenumber.md "nsip-invoice.schema.json#/properties/refundCreditNoteNumber") |
+| [refundAmount](#refundamount)                     | `number`  | Required | can be null    | [NSIP Invoice](nsip-invoice-properties-refundamount.md "nsip-invoice.schema.json#/properties/refundAmount")                     |
+| [refundIssueDate](#refundissuedate)               | `string`  | Required | can be null    | [NSIP Invoice](nsip-invoice-properties-refundissuedate.md "nsip-invoice.schema.json#/properties/refundIssueDate")               |
+| Additional Properties                             | Any       | Optional | can be null    |                                                                                                                                 |
+
+## caseId
+
+The unique identifier within the Back Office. This is not the same as the case reference
+
+`caseId`
+
+* is required
+
+* Type: `integer`
+
+* cannot be null
+
+* defined in: [NSIP Invoice](nsip-invoice-properties-caseid.md "nsip-invoice.schema.json#/properties/caseId")
+
+### caseId Type
+
+`integer`
+
+### caseId Examples
+
+```json
+1242
+```
+
+## caseReference
+
+
+
+`caseReference`
+
+* is required
+
+* Type: `string`
+
+* can be null
+
+* defined in: [NSIP Invoice](nsip-invoice-properties-casereference.md "nsip-invoice.schema.json#/properties/caseReference")
+
+### caseReference Type
+
+`string`
+
+### caseReference Examples
+
+```json
+"BC0510001"
+```
+
+## invoiceStage
+
+Invoice stage
+
+`invoiceStage`
+
+* is required
+
+* Type: `string`
+
+* can be null
+
+* defined in: [NSIP Invoice](nsip-invoice-properties-invoicestage.md "nsip-invoice.schema.json#/properties/invoiceStage")
+
+### invoiceStage Type
+
+`string`
+
+### invoiceStage Constraints
+
+**enum**: the value of this property must be equal to one of the following values:
+
+| Value                   | Explanation |
+| :---------------------- | :---------- |
+| `"pre_acceptance"`      |             |
+| `"acceptance"`          |             |
+| `"pre_examination"`     |             |
+| `"initial_examination"` |             |
+| `"final_examination"`   |             |
+| `null`                  |             |
+
+### invoiceStage Examples
+
+```json
+"pre_acceptance"
+```
+
+## invoiceNumber
+
+Invoice number
+
+`invoiceNumber`
+
+* is required
+
+* Type: `string`
+
+* cannot be null
+
+* defined in: [NSIP Invoice](nsip-invoice-properties-invoicenumber.md "nsip-invoice.schema.json#/properties/invoiceNumber")
+
+### invoiceNumber Type
+
+`string`
+
+### invoiceNumber Examples
+
+```json
+"1800004419"
+```
+
+## amountDue
+
+Amount due
+
+`amountDue`
+
+* is required
+
+* Type: `number`
+
+* cannot be null
+
+* defined in: [NSIP Invoice](nsip-invoice-properties-amountdue.md "nsip-invoice.schema.json#/properties/amountDue")
+
+### amountDue Type
+
+`number`
+
+### amountDue Examples
+
+```json
+500
+```
+
+## paymentDueDate
+
+Payment due date
+
+`paymentDueDate`
+
+* is required
+
+* Type: `string`
+
+* can be null
+
+* defined in: [NSIP Invoice](nsip-invoice-properties-paymentduedate.md "nsip-invoice.schema.json#/properties/paymentDueDate")
+
+### paymentDueDate Type
+
+`string`
+
+### paymentDueDate Constraints
+
+**date time**: the string must be a date time string, according to [RFC 3339, section 5.6](https://tools.ietf.org/html/rfc3339 "check the specification")
+
+### paymentDueDate Examples
+
+```json
+"2023-07-27T20:30:00.000Z"
+```
+
+## invoicedDate
+
+Invoiced date
+
+`invoicedDate`
+
+* is required
+
+* Type: `string`
+
+* can be null
+
+* defined in: [NSIP Invoice](nsip-invoice-properties-invoiceddate.md "nsip-invoice.schema.json#/properties/invoicedDate")
+
+### invoicedDate Type
+
+`string`
+
+### invoicedDate Constraints
+
+**date time**: the string must be a date time string, according to [RFC 3339, section 5.6](https://tools.ietf.org/html/rfc3339 "check the specification")
+
+### invoicedDate Examples
+
+```json
+"2023-07-27T20:30:00.000Z"
+```
+
+## paymentDate
+
+Date of payment
+
+`paymentDate`
+
+* is required
+
+* Type: `string`
+
+* can be null
+
+* defined in: [NSIP Invoice](nsip-invoice-properties-paymentdate.md "nsip-invoice.schema.json#/properties/paymentDate")
+
+### paymentDate Type
+
+`string`
+
+### paymentDate Constraints
+
+**date time**: the string must be a date time string, according to [RFC 3339, section 5.6](https://tools.ietf.org/html/rfc3339 "check the specification")
+
+### paymentDate Examples
+
+```json
+"2023-07-27T20:30:00.000Z"
+```
+
+## refundCreditNoteNumber
+
+Refund credit note number
+
+`refundCreditNoteNumber`
+
+* is required
+
+* Type: `string`
+
+* can be null
+
+* defined in: [NSIP Invoice](nsip-invoice-properties-refundcreditnotenumber.md "nsip-invoice.schema.json#/properties/refundCreditNoteNumber")
+
+### refundCreditNoteNumber Type
+
+`string`
+
+### refundCreditNoteNumber Examples
+
+```json
+"1800004419"
+```
+
+## refundAmount
+
+Amount refunded
+
+`refundAmount`
+
+* is required
+
+* Type: `number`
+
+* can be null
+
+* defined in: [NSIP Invoice](nsip-invoice-properties-refundamount.md "nsip-invoice.schema.json#/properties/refundAmount")
+
+### refundAmount Type
+
+`number`
+
+### refundAmount Examples
+
+```json
+200
+```
+
+## refundIssueDate
+
+Refund issue date
+
+`refundIssueDate`
+
+* is required
+
+* Type: `string`
+
+* can be null
+
+* defined in: [NSIP Invoice](nsip-invoice-properties-refundissuedate.md "nsip-invoice.schema.json#/properties/refundIssueDate")
+
+### refundIssueDate Type
+
+`string`
+
+### refundIssueDate Constraints
+
+**date time**: the string must be a date time string, according to [RFC 3339, section 5.6](https://tools.ietf.org/html/rfc3339 "check the specification")
+
+### refundIssueDate Examples
+
+```json
+"2023-07-27T20:30:00.000Z"
+```
+
+## Additional Properties
+
+Additional properties are allowed and do not have to follow a specific schema

package/docs/nsip-meeting.md

@@ -0,0 +1,197 @@
+## NSIP Meeting Type
+
+`object` ([NSIP Meeting](nsip-meeting.md))
+
+# NSIP Meeting Properties
+
+| Property                                              | Type      | Required | Nullable       | Defined by                                                                                                                          |
+| :---------------------------------------------------- | :-------- | :------- | :------------- | :---------------------------------------------------------------------------------------------------------------------------------- |
+| [meetingID](#meetingid)                               | `integer` | Required | cannot be null | [NSIP Meeting](nsip-meeting-properties-meetingid.md "nsip-meeting.schema.json#/properties/meetingID")                               |
+| [caseId](#caseid)                                     | `integer` | Required | cannot be null | [NSIP Meeting](nsip-meeting-properties-caseid.md "nsip-meeting.schema.json#/properties/caseId")                                     |
+| [caseReference](#casereference)                       | `string`  | Required | can be null    | [NSIP Meeting](nsip-meeting-properties-casereference.md "nsip-meeting.schema.json#/properties/caseReference")                       |
+| [meetingAgenda](#meetingagenda)                       | `string`  | Required | can be null    | [NSIP Meeting](nsip-meeting-properties-meetingagenda.md "nsip-meeting.schema.json#/properties/meetingAgenda")                       |
+| [planningInspectorateRole](#planninginspectoraterole) | `string`  | Required | can be null    | [NSIP Meeting](nsip-meeting-properties-planninginspectoraterole.md "nsip-meeting.schema.json#/properties/planningInspectorateRole") |
+| [meetingDate](#meetingdate)                           | `string`  | Required | can be null    | [NSIP Meeting](nsip-meeting-properties-meetingdate.md "nsip-meeting.schema.json#/properties/meetingDate")                           |
+| [meetingType](#meetingtype)                           | `string`  | Required | can be null    | [NSIP Meeting](nsip-meeting-properties-meetingtype.md "nsip-meeting.schema.json#/properties/meetingType")                           |
+| Additional Properties                                 | Any       | Optional | can be null    |                                                                                                                                     |
+
+## meetingID
+
+The unique identifier for an NSIP Meeting.
+
+`meetingID`
+
+* is required
+
+* Type: `integer`
+
+* cannot be null
+
+* defined in: [NSIP Meeting](nsip-meeting-properties-meetingid.md "nsip-meeting.schema.json#/properties/meetingID")
+
+### meetingID Type
+
+`integer`
+
+### meetingID Examples
+
+```json
+1234
+```
+
+## caseId
+
+The unique identifier for the case within the Back Office. This is not the same as the case reference
+
+`caseId`
+
+* is required
+
+* Type: `integer`
+
+* cannot be null
+
+* defined in: [NSIP Meeting](nsip-meeting-properties-caseid.md "nsip-meeting.schema.json#/properties/caseId")
+
+### caseId Type
+
+`integer`
+
+### caseId Examples
+
+```json
+1242
+```
+
+## caseReference
+
+
+
+`caseReference`
+
+* is required
+
+* Type: `string`
+
+* can be null
+
+* defined in: [NSIP Meeting](nsip-meeting-properties-casereference.md "nsip-meeting.schema.json#/properties/caseReference")
+
+### caseReference Type
+
+`string`
+
+### caseReference Examples
+
+```json
+"BC0510001"
+```
+
+## meetingAgenda
+
+Meeting agenda
+
+`meetingAgenda`
+
+* is required
+
+* Type: `string`
+
+* can be null
+
+* defined in: [NSIP Meeting](nsip-meeting-properties-meetingagenda.md "nsip-meeting.schema.json#/properties/meetingAgenda")
+
+### meetingAgenda Type
+
+`string`
+
+### meetingAgenda Examples
+
+```json
+"Flood Risk Assessment (FRA)"
+```
+
+## planningInspectorateRole
+
+Planning Inspectorate role
+
+`planningInspectorateRole`
+
+* is required
+
+* Type: `string`
+
+* can be null
+
+* defined in: [NSIP Meeting](nsip-meeting-properties-planninginspectoraterole.md "nsip-meeting.schema.json#/properties/planningInspectorateRole")
+
+### planningInspectorateRole Type
+
+`string`
+
+### planningInspectorateRole Constraints
+
+**enum**: the value of this property must be equal to one of the following values:
+
+| Value           | Explanation |
+| :-------------- | :---------- |
+| `"facilitator"` |             |
+| `"advisor"`     |             |
+| `"observer"`    |             |
+| `null`          |             |
+
+### planningInspectorateRole Examples
+
+```json
+"facilitator"
+```
+
+## meetingDate
+
+Meeting date
+
+`meetingDate`
+
+* is required
+
+* Type: `string`
+
+* can be null
+
+* defined in: [NSIP Meeting](nsip-meeting-properties-meetingdate.md "nsip-meeting.schema.json#/properties/meetingDate")
+
+### meetingDate Type
+
+`string`
+
+### meetingDate Constraints
+
+**date time**: the string must be a date time string, according to [RFC 3339, section 5.6](https://tools.ietf.org/html/rfc3339 "check the specification")
+
+### meetingDate Examples
+
+```json
+"2023-07-27T20:30:00.000Z"
+```
+
+## meetingType
+
+Type of Meeting
+
+`meetingType`
+
+* is required
+
+* Type: `string`
+
+* can be null
+
+* defined in: [NSIP Meeting](nsip-meeting-properties-meetingtype.md "nsip-meeting.schema.json#/properties/meetingType")
+
+### meetingType Type
+
+`string`
+
+## Additional Properties
+
+Additional properties are allowed and do not have to follow a specific schema

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@planning-inspectorate/data-model",
-  "version": "2.1.0",
+  "version": "2.3.0",
   "description": "JSON Schemas for the Planning Inspectorate's Data Model",
   "main": "src/index.js",
   "type": "module",
@@ -9,7 +9,7 @@
     "require": "./src/index.cjs"
   },
   "scripts": {
-    "commitlint": "commitlint --from=$(git cherry origin/main | head -n 1 | cut -c 3-)",
+    "commitlint": "commitlint --from=$(git rev-parse $(git cherry origin/main | head -n 1 | cut -c 3-)^1)",
     "gen": "npm run gen-docs && npm run gen-enums && npm run gen-types && npm run gen-cjs",
     "gen-docs": "node src/lib/gen-docs.js",
     "gen-enums": "node src/lib/gen-enums.js",

package/pins_data_model/models/model_appeal_document.py

@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  appeal-document.schema.json
-#   timestamp: 2025-11-12T14:58:30+00:00
+#   timestamp: 2025-12-02T17:41:26+00:00
 
 from __future__ import annotations
 

package/pins_data_model/models/model_appeal_event.py

@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  appeal-event.schema.json
-#   timestamp: 2025-11-12T14:58:30+00:00
+#   timestamp: 2025-12-02T17:41:26+00:00
 
 from __future__ import annotations
 

package/pins_data_model/models/model_appeal_event_estimate.py

@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  appeal-event-estimate.schema.json
-#   timestamp: 2025-11-12T14:58:30+00:00
+#   timestamp: 2025-12-02T17:41:26+00:00
 
 from __future__ import annotations
 

package/pins_data_model/models/model_appeal_has.py

@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  appeal-has.schema.json
-#   timestamp: 2025-11-12T14:58:30+00:00
+#   timestamp: 2025-12-02T17:41:26+00:00
 
 from __future__ import annotations
 
@@ -742,6 +742,10 @@ class AppealHasCase1(BaseModel):
     """
     A list of advertisements for the appeal
     """
+    padsSapId: str | None = None
+    """
+    padsSapId for PADS inspectors
+    """
 
 
 class AdvertDetail1(BaseModel):
@@ -1237,6 +1241,10 @@ class AppealHasCase2(BaseModel):
     """
     A list of advertisements for the appeal
     """
+    padsSapId: str | None = None
+    """
+    padsSapId for PADS inspectors
+    """
 
 
 class AppealHasCase(RootModel[AppealHasCase1 | AppealHasCase2]):

package/pins_data_model/models/model_appeal_representation.py

@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  appeal-representation.schema.json
-#   timestamp: 2025-11-12T14:58:30+00:00
+#   timestamp: 2025-12-02T17:41:26+00:00
 
 from __future__ import annotations