@planning-inspectorate/data-model 1.18.1 → 1.20.0

package/.github/dependabot.yml

@@ -9,3 +9,8 @@ updates:
     directory: '/' # Location of package manifests
     schedule:
       interval: 'weekly'
+    groups:
+      devDeps: # group all dev dependencies
+        patterns:
+          - '*'
+        dependency-type: 'development'

package/docs/README.md

@@ -60,6 +60,10 @@
 
 * [Untitled object in Examination Timetable](./nsip-exam-timetable-defs-line-item.md) – `nsip-exam-timetable.schema.json#/$defs/line-item`
 
+* [Untitled object in NSIP Project](./nsip-project-defs-meeting.md "A meeting related to the project") – `nsip-project.schema.json#/$defs/meeting`
+
+* [Untitled object in NSIP Project](./nsip-project-defs-invoice.md "An invoice related to the project") – `nsip-project.schema.json#/$defs/invoice`
+
 ### Arrays
 
 * [Untitled array in Appeal Representation](./appeal-representation-properties-documentids.md "An array of documentIds") – `appeal-representation.schema.json#/properties/documentIds`
@@ -76,6 +80,22 @@
 
 * [Untitled array in NSIP Project](./nsip-project-properties-inspectorids.md) – `nsip-project.schema.json#/properties/inspectorIds`
 
+* [Untitled array in NSIP Project](./nsip-project-properties-operationsleadids.md "Maps to \[Employee]") – `nsip-project.schema.json#/properties/operationsLeadIds`
+
+* [Untitled array in NSIP Project](./nsip-project-properties-operationsmanagerids.md "New NSIP role, Maps to \[Employee]") – `nsip-project.schema.json#/properties/operationsManagerIds`
+
+* [Untitled array in NSIP Project](./nsip-project-properties-casemanagerids.md "Maps to \[Employee]") – `nsip-project.schema.json#/properties/caseManagerIds`
+
+* [Untitled array in NSIP Project](./nsip-project-properties-leadinspectorids.md "Maps to \[Employee]") – `nsip-project.schema.json#/properties/leadInspectorIds`
+
+* [Untitled array in NSIP Project](./nsip-project-properties-environmentalservicesofficerids.md "Maps to \[Employee]") – `nsip-project.schema.json#/properties/environmentalServicesOfficerIds`
+
+* [Untitled array in NSIP Project](./nsip-project-properties-legalofficerids.md "Maps to \[Employee]") – `nsip-project.schema.json#/properties/legalOfficerIds`
+
+* [Untitled array in NSIP Project](./nsip-project-properties-meetings.md "Collection of meetings associated with this project") – `nsip-project.schema.json#/properties/meetings`
+
+* [Untitled array in NSIP Project](./nsip-project-properties-invoices.md "Collection of invoices associated with this project") – `nsip-project.schema.json#/properties/invoices`
+
 * [Untitled array in Representation](./nsip-representation-properties-attachmentids.md) – `nsip-representation.schema.json#/properties/attachmentIds`
 
 * [Untitled array in S51 Advice](./s51-advice-properties-attachmentids.md) – `s51-advice.schema.json#/properties/attachmentIds`

package/docs/nsip-project-defs-invoice.md

@@ -0,0 +1,267 @@
+## invoice Type
+
+`object` ([Details](nsip-project-defs-invoice.md))
+
+# invoice Properties
+
+| Property                                          | Type     | Required | Nullable       | Defined by                                                                                                                                                 |
+| :------------------------------------------------ | :------- | :------- | :------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| [invoiceStage](#invoicestage)                     | `string` | Optional | can be null    | [NSIP Project](nsip-project-defs-invoice-properties-invoicestage.md "nsip-project.schema.json#/$defs/invoice/properties/invoiceStage")                     |
+| [invoiceNumber](#invoicenumber)                   | `string` | Required | cannot be null | [NSIP Project](nsip-project-defs-invoice-properties-invoicenumber.md "nsip-project.schema.json#/$defs/invoice/properties/invoiceNumber")                   |
+| [amountDue](#amountdue)                           | `number` | Required | cannot be null | [NSIP Project](nsip-project-defs-invoice-properties-amountdue.md "nsip-project.schema.json#/$defs/invoice/properties/amountDue")                           |
+| [paymentDueDate](#paymentduedate)                 | `string` | Optional | can be null    | [NSIP Project](nsip-project-defs-invoice-properties-paymentduedate.md "nsip-project.schema.json#/$defs/invoice/properties/paymentDueDate")                 |
+| [invoicedDate](#invoiceddate)                     | `string` | Optional | can be null    | [NSIP Project](nsip-project-defs-invoice-properties-invoiceddate.md "nsip-project.schema.json#/$defs/invoice/properties/invoicedDate")                     |
+| [paymentDate](#paymentdate)                       | `string` | Optional | can be null    | [NSIP Project](nsip-project-defs-invoice-properties-paymentdate.md "nsip-project.schema.json#/$defs/invoice/properties/paymentDate")                       |
+| [refundCreditNoteNumber](#refundcreditnotenumber) | `string` | Optional | can be null    | [NSIP Project](nsip-project-defs-invoice-properties-refundcreditnotenumber.md "nsip-project.schema.json#/$defs/invoice/properties/refundCreditNoteNumber") |
+| [refundAmount](#refundamount)                     | `number` | Optional | can be null    | [NSIP Project](nsip-project-defs-invoice-properties-refundamount.md "nsip-project.schema.json#/$defs/invoice/properties/refundAmount")                     |
+| [refundIssueDate](#refundissuedate)               | `string` | Optional | can be null    | [NSIP Project](nsip-project-defs-invoice-properties-refundissuedate.md "nsip-project.schema.json#/$defs/invoice/properties/refundIssueDate")               |
+| Additional Properties                             | Any      | Optional | can be null    |                                                                                                                                                            |
+
+## invoiceStage
+
+Invoice stage
+
+`invoiceStage`
+
+* is optional
+
+* Type: `string`
+
+* can be null
+
+* defined in: [NSIP Project](nsip-project-defs-invoice-properties-invoicestage.md "nsip-project.schema.json#/$defs/invoice/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 Project](nsip-project-defs-invoice-properties-invoicenumber.md "nsip-project.schema.json#/$defs/invoice/properties/invoiceNumber")
+
+### invoiceNumber Type
+
+`string`
+
+### invoiceNumber Examples
+
+```json
+"1800004419"
+```
+
+## amountDue
+
+Amount due
+
+`amountDue`
+
+* is required
+
+* Type: `number`
+
+* cannot be null
+
+* defined in: [NSIP Project](nsip-project-defs-invoice-properties-amountdue.md "nsip-project.schema.json#/$defs/invoice/properties/amountDue")
+
+### amountDue Type
+
+`number`
+
+### amountDue Examples
+
+```json
+500
+```
+
+## paymentDueDate
+
+Payment due date
+
+`paymentDueDate`
+
+* is optional
+
+* Type: `string`
+
+* can be null
+
+* defined in: [NSIP Project](nsip-project-defs-invoice-properties-paymentduedate.md "nsip-project.schema.json#/$defs/invoice/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 optional
+
+* Type: `string`
+
+* can be null
+
+* defined in: [NSIP Project](nsip-project-defs-invoice-properties-invoiceddate.md "nsip-project.schema.json#/$defs/invoice/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 optional
+
+* Type: `string`
+
+* can be null
+
+* defined in: [NSIP Project](nsip-project-defs-invoice-properties-paymentdate.md "nsip-project.schema.json#/$defs/invoice/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 optional
+
+* Type: `string`
+
+* can be null
+
+* defined in: [NSIP Project](nsip-project-defs-invoice-properties-refundcreditnotenumber.md "nsip-project.schema.json#/$defs/invoice/properties/refundCreditNoteNumber")
+
+### refundCreditNoteNumber Type
+
+`string`
+
+### refundCreditNoteNumber Examples
+
+```json
+"1800004419"
+```
+
+## refundAmount
+
+Amount refunded
+
+`refundAmount`
+
+* is optional
+
+* Type: `number`
+
+* can be null
+
+* defined in: [NSIP Project](nsip-project-defs-invoice-properties-refundamount.md "nsip-project.schema.json#/$defs/invoice/properties/refundAmount")
+
+### refundAmount Type
+
+`number`
+
+### refundAmount Examples
+
+```json
+200
+```
+
+## refundIssueDate
+
+Refund issue date
+
+`refundIssueDate`
+
+* is optional
+
+* Type: `string`
+
+* can be null
+
+* defined in: [NSIP Project](nsip-project-defs-invoice-properties-refundissuedate.md "nsip-project.schema.json#/$defs/invoice/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-project-defs-meeting.md

@@ -0,0 +1,122 @@
+## meeting Type
+
+`object` ([Details](nsip-project-defs-meeting.md))
+
+# meeting Properties
+
+| Property                                              | Type     | Required | Nullable    | Defined by                                                                                                                                                     |
+| :---------------------------------------------------- | :------- | :------- | :---------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| [meetingAgenda](#meetingagenda)                       | `string` | Optional | can be null | [NSIP Project](nsip-project-defs-meeting-properties-meetingagenda.md "nsip-project.schema.json#/$defs/meeting/properties/meetingAgenda")                       |
+| [planningInspectorateRole](#planninginspectoraterole) | `string` | Optional | can be null | [NSIP Project](nsip-project-defs-meeting-properties-planninginspectoraterole.md "nsip-project.schema.json#/$defs/meeting/properties/planningInspectorateRole") |
+| [meetingDate](#meetingdate)                           | `string` | Optional | can be null | [NSIP Project](nsip-project-defs-meeting-properties-meetingdate.md "nsip-project.schema.json#/$defs/meeting/properties/meetingDate")                           |
+| [meetingType](#meetingtype)                           | `string` | Optional | can be null | [NSIP Project](nsip-project-defs-meeting-properties-meetingtype.md "nsip-project.schema.json#/$defs/meeting/properties/meetingType")                           |
+| Additional Properties                                 | Any      | Optional | can be null |                                                                                                                                                                |
+
+## meetingAgenda
+
+Meeting agenda
+
+`meetingAgenda`
+
+* is optional
+
+* Type: `string`
+
+* can be null
+
+* defined in: [NSIP Project](nsip-project-defs-meeting-properties-meetingagenda.md "nsip-project.schema.json#/$defs/meeting/properties/meetingAgenda")
+
+### meetingAgenda Type
+
+`string`
+
+### meetingAgenda Examples
+
+```json
+"Flood Risk Assessment (FRA)"
+```
+
+## planningInspectorateRole
+
+Planning Inspectorate role
+
+`planningInspectorateRole`
+
+* is optional
+
+* Type: `string`
+
+* can be null
+
+* defined in: [NSIP Project](nsip-project-defs-meeting-properties-planninginspectoraterole.md "nsip-project.schema.json#/$defs/meeting/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 optional
+
+* Type: `string`
+
+* can be null
+
+* defined in: [NSIP Project](nsip-project-defs-meeting-properties-meetingdate.md "nsip-project.schema.json#/$defs/meeting/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 optional
+
+* Type: `string`
+
+* can be null
+
+* defined in: [NSIP Project](nsip-project-defs-meeting-properties-meetingtype.md "nsip-project.schema.json#/$defs/meeting/properties/meetingType")
+
+### meetingType Type
+
+`string`
+
+## Additional Properties
+
+Additional properties are allowed and do not have to follow a specific schema

package/docs/nsip-project-defs.md

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