@planning-inspectorate/data-model 1.11.0

package/docs/employee.md

@@ -0,0 +1,70 @@
+## Employee Type
+
+`object` ([Employee](employee.md))
+
+# Employee Properties
+
+| Property                | Type     | Required | Nullable       | Defined by                                                                                |
+| :---------------------- | :------- | :------- | :------------- | :---------------------------------------------------------------------------------------- |
+| [id](#id)               | `string` | Required | cannot be null | [Employee](employee-properties-id.md "employee.schema.json#/properties/id")               |
+| [firstName](#firstname) | `string` | Required | cannot be null | [Employee](employee-properties-firstname.md "employee.schema.json#/properties/firstName") |
+| [lastName](#lastname)   | `string` | Required | cannot be null | [Employee](employee-properties-lastname.md "employee.schema.json#/properties/lastName")   |
+| Additional Properties   | Any      | Optional | can be null    |                                                                                           |
+
+## id
+
+
+
+`id`
+
+*   is required
+
+*   Type: `string`
+
+*   cannot be null
+
+*   defined in: [Employee](employee-properties-id.md "employee.schema.json#/properties/id")
+
+### id Type
+
+`string`
+
+## firstName
+
+
+
+`firstName`
+
+*   is required
+
+*   Type: `string`
+
+*   cannot be null
+
+*   defined in: [Employee](employee-properties-firstname.md "employee.schema.json#/properties/firstName")
+
+### firstName Type
+
+`string`
+
+## lastName
+
+
+
+`lastName`
+
+*   is required
+
+*   Type: `string`
+
+*   cannot be null
+
+*   defined in: [Employee](employee-properties-lastname.md "employee.schema.json#/properties/lastName")
+
+### lastName Type
+
+`string`
+
+## Additional Properties
+
+Additional properties are allowed and do not have to follow a specific schema

package/docs/entraid.md

@@ -0,0 +1,108 @@
+## Entra ID User Objects Type
+
+`object` ([Entra ID User Objects](entraid.md))
+
+# Entra ID User Objects Properties
+
+| Property                                | Type     | Required | Nullable       | Defined by                                                                                                           |
+| :-------------------------------------- | :------- | :------- | :------------- | :------------------------------------------------------------------------------------------------------------------- |
+| [employeeId](#employeeid)               | `string` | Required | cannot be null | [Entra ID User Objects](entraid-properties-employeeid.md "entraid.schema.json#/properties/employeeId")               |
+| [id](#id)                               | `string` | Required | cannot be null | [Entra ID User Objects](entraid-properties-id.md "entraid.schema.json#/properties/id")                               |
+| [givenName](#givenname)                 | `string` | Required | cannot be null | [Entra ID User Objects](entraid-properties-givenname.md "entraid.schema.json#/properties/givenName")                 |
+| [surname](#surname)                     | `string` | Required | cannot be null | [Entra ID User Objects](entraid-properties-surname.md "entraid.schema.json#/properties/surname")                     |
+| [userPrincipalName](#userprincipalname) | `string` | Required | cannot be null | [Entra ID User Objects](entraid-properties-userprincipalname.md "entraid.schema.json#/properties/userPrincipalName") |
+| Additional Properties                   | Any      | Optional | can be null    |                                                                                                                      |
+
+## employeeId
+
+The employee's unique identifier
+
+`employeeId`
+
+* is required
+
+* Type: `string`
+
+* cannot be null
+
+* defined in: [Entra ID User Objects](entraid-properties-employeeid.md "entraid.schema.json#/properties/employeeId")
+
+### employeeId Type
+
+`string`
+
+## id
+
+The unique identifier within the EntraID
+
+`id`
+
+* is required
+
+* Type: `string`
+
+* cannot be null
+
+* defined in: [Entra ID User Objects](entraid-properties-id.md "entraid.schema.json#/properties/id")
+
+### id Type
+
+`string`
+
+## givenName
+
+The employee's given name
+
+`givenName`
+
+* is required
+
+* Type: `string`
+
+* cannot be null
+
+* defined in: [Entra ID User Objects](entraid-properties-givenname.md "entraid.schema.json#/properties/givenName")
+
+### givenName Type
+
+`string`
+
+## surname
+
+The employee's surname
+
+`surname`
+
+* is required
+
+* Type: `string`
+
+* cannot be null
+
+* defined in: [Entra ID User Objects](entraid-properties-surname.md "entraid.schema.json#/properties/surname")
+
+### surname Type
+
+`string`
+
+## userPrincipalName
+
+The employee's email address
+
+`userPrincipalName`
+
+* is required
+
+* Type: `string`
+
+* cannot be null
+
+* defined in: [Entra ID User Objects](entraid-properties-userprincipalname.md "entraid.schema.json#/properties/userPrincipalName")
+
+### userPrincipalName Type
+
+`string`
+
+## Additional Properties
+
+Additional properties are allowed and do not have to follow a specific schema

package/docs/folder.md

@@ -0,0 +1,147 @@
+## Folder Type
+
+`object` ([Folder](folder.md))
+
+# Folder Properties
+
+| Property                                  | Type      | Required | Nullable       | Defined by                                                                                            |
+| :---------------------------------------- | :-------- | :------- | :------------- | :---------------------------------------------------------------------------------------------------- |
+| [id](#id)                                 | `integer` | Required | cannot be null | [Folder](folder-properties-id.md "folder.schema.json#/properties/id")                                 |
+| [caseReference](#casereference)           | `string`  | Required | cannot be null | [Folder](folder-properties-casereference.md "folder.schema.json#/properties/caseReference")           |
+| [displayNameEnglish](#displaynameenglish) | `string`  | Required | cannot be null | [Folder](folder-properties-displaynameenglish.md "folder.schema.json#/properties/displayNameEnglish") |
+| [displayNameWelsh](#displaynamewelsh)     | `string`  | Required | can be null    | [Folder](folder-properties-displaynamewelsh.md "folder.schema.json#/properties/displayNameWelsh")     |
+| [parentFolderId](#parentfolderid)         | `integer` | Required | can be null    | [Folder](folder-properties-parentfolderid.md "folder.schema.json#/properties/parentFolderId")         |
+| [caseStage](#casestage)                   | `string`  | Required | can be null    | [Folder](folder-properties-casestage.md "folder.schema.json#/properties/caseStage")                   |
+| Additional Properties                     | Any       | Optional | can be null    |                                                                                                       |
+
+## id
+
+The unique identifier within the Back Office.
+
+`id`
+
+* is required
+
+* Type: `integer`
+
+* cannot be null
+
+* defined in: [Folder](folder-properties-id.md "folder.schema.json#/properties/id")
+
+### id Type
+
+`integer`
+
+## caseReference
+
+The case reference this folder belongs to.
+
+`caseReference`
+
+* is required
+
+* Type: `string`
+
+* cannot be null
+
+* defined in: [Folder](folder-properties-casereference.md "folder.schema.json#/properties/caseReference")
+
+### caseReference Type
+
+`string`
+
+## displayNameEnglish
+
+Folder display name in English.
+
+`displayNameEnglish`
+
+* is required
+
+* Type: `string`
+
+* cannot be null
+
+* defined in: [Folder](folder-properties-displaynameenglish.md "folder.schema.json#/properties/displayNameEnglish")
+
+### displayNameEnglish Type
+
+`string`
+
+## displayNameWelsh
+
+Folder display name in Welsh.
+
+`displayNameWelsh`
+
+* is required
+
+* Type: `string`
+
+* can be null
+
+* defined in: [Folder](folder-properties-displaynamewelsh.md "folder.schema.json#/properties/displayNameWelsh")
+
+### displayNameWelsh Type
+
+`string`
+
+## parentFolderId
+
+Optional parent folder ID.
+
+`parentFolderId`
+
+* is required
+
+* Type: `integer`
+
+* can be null
+
+* defined in: [Folder](folder-properties-parentfolderid.md "folder.schema.json#/properties/parentFolderId")
+
+### parentFolderId Type
+
+`integer`
+
+## caseStage
+
+
+
+`caseStage`
+
+* is required
+
+* Type: `string`
+
+* can be null
+
+* defined in: [Folder](folder-properties-casestage.md "folder.schema.json#/properties/caseStage")
+
+### caseStage Type
+
+`string`
+
+### caseStage Constraints
+
+**enum**: the value of this property must be equal to one of the following values:
+
+| Value                      | Explanation |
+| :------------------------- | :---------- |
+| `"draft"`                  |             |
+| `"pre-application"`        |             |
+| `"acceptance"`             |             |
+| `"pre-examination"`        |             |
+| `"examination"`            |             |
+| `"recommendation"`         |             |
+| `"decision"`               |             |
+| `"post_decision"`          |             |
+| `"withdrawn"`              |             |
+| `"developers_application"` |             |
+| `"correspondence"`         |             |
+| `"0"`                      |             |
+| `null`                     |             |
+
+## Additional Properties
+
+Additional properties are allowed and do not have to follow a specific schema

package/docs/gettimesheets-response.md

@@ -0,0 +1,188 @@
+## Get Timesheets API response Type
+
+`object` ([Get Timesheets API response](gettimesheets-response.md))
+
+# Get Timesheets API response Properties
+
+| Property                                      | Type      | Required | Nullable       | Defined by                                                                                                                                                     |
+| :-------------------------------------------- | :-------- | :------- | :------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| [caseReference](#casereference)               | `integer` | Required | cannot be null | [Get Timesheets API response](gettimesheets-response-properties-casereference.md "gettimesheets-response.schema.json#/properties/caseReference")               |
+| [applicationReference](#applicationreference) | `string`  | Required | cannot be null | [Get Timesheets API response](gettimesheets-response-properties-applicationreference.md "gettimesheets-response.schema.json#/properties/applicationReference") |
+| [siteAddressLine1](#siteaddressline1)         | `string`  | Optional | cannot be null | [Get Timesheets API response](gettimesheets-response-properties-siteaddressline1.md "gettimesheets-response.schema.json#/properties/siteAddressLine1")         |
+| [siteAddressLine2](#siteaddressline2)         | `string`  | Optional | cannot be null | [Get Timesheets API response](gettimesheets-response-properties-siteaddressline2.md "gettimesheets-response.schema.json#/properties/siteAddressLine2")         |
+| [siteAddressTown](#siteaddresstown)           | `string`  | Optional | cannot be null | [Get Timesheets API response](gettimesheets-response-properties-siteaddresstown.md "gettimesheets-response.schema.json#/properties/siteAddressTown")           |
+| [siteAddressCounty](#siteaddresscounty)       | `string`  | Optional | cannot be null | [Get Timesheets API response](gettimesheets-response-properties-siteaddresscounty.md "gettimesheets-response.schema.json#/properties/siteAddressCounty")       |
+| [siteAddressPostcode](#siteaddresspostcode)   | `string`  | Optional | cannot be null | [Get Timesheets API response](gettimesheets-response-properties-siteaddresspostcode.md "gettimesheets-response.schema.json#/properties/siteAddressPostcode")   |
+| Additional Properties                         | Any       | Optional | can be null    |                                                                                                                                                                |
+
+## caseReference
+
+External case identifier
+
+`caseReference`
+
+* is required
+
+* Type: `integer`
+
+* cannot be null
+
+* defined in: [Get Timesheets API response](gettimesheets-response-properties-casereference.md "gettimesheets-response.schema.json#/properties/caseReference")
+
+### caseReference Type
+
+`integer`
+
+### caseReference Examples
+
+```json
+"6002744"
+```
+
+## applicationReference
+
+The unique identifier of the application
+
+`applicationReference`
+
+* is required
+
+* Type: `string`
+
+* cannot be null
+
+* defined in: [Get Timesheets API response](gettimesheets-response-properties-applicationreference.md "gettimesheets-response.schema.json#/properties/applicationReference")
+
+### applicationReference Type
+
+`string`
+
+### applicationReference Examples
+
+```json
+"12345"
+```
+
+## siteAddressLine1
+
+First line of case site address
+
+`siteAddressLine1`
+
+* is optional
+
+* Type: `string`
+
+* cannot be null
+
+* defined in: [Get Timesheets API response](gettimesheets-response-properties-siteaddressline1.md "gettimesheets-response.schema.json#/properties/siteAddressLine1")
+
+### siteAddressLine1 Type
+
+`string`
+
+### siteAddressLine1 Examples
+
+```json
+"21 The Pavement"
+```
+
+## siteAddressLine2
+
+Second line of case site address
+
+`siteAddressLine2`
+
+* is optional
+
+* Type: `string`
+
+* cannot be null
+
+* defined in: [Get Timesheets API response](gettimesheets-response-properties-siteaddressline2.md "gettimesheets-response.schema.json#/properties/siteAddressLine2")
+
+### siteAddressLine2 Type
+
+`string`
+
+### siteAddressLine2 Examples
+
+```json
+"Shotesham Road"
+```
+
+## siteAddressTown
+
+Town / City of the site address
+
+`siteAddressTown`
+
+* is optional
+
+* Type: `string`
+
+* cannot be null
+
+* defined in: [Get Timesheets API response](gettimesheets-response-properties-siteaddresstown.md "gettimesheets-response.schema.json#/properties/siteAddressTown")
+
+### siteAddressTown Type
+
+`string`
+
+### siteAddressTown Examples
+
+```json
+"Bristol"
+```
+
+## siteAddressCounty
+
+County of the site address
+
+`siteAddressCounty`
+
+* is optional
+
+* Type: `string`
+
+* cannot be null
+
+* defined in: [Get Timesheets API response](gettimesheets-response-properties-siteaddresscounty.md "gettimesheets-response.schema.json#/properties/siteAddressCounty")
+
+### siteAddressCounty Type
+
+`string`
+
+### siteAddressCounty Examples
+
+```json
+"Wandsworth"
+```
+
+## siteAddressPostcode
+
+Postal code of the site address
+
+`siteAddressPostcode`
+
+* is optional
+
+* Type: `string`
+
+* cannot be null
+
+* defined in: [Get Timesheets API response](gettimesheets-response-properties-siteaddresspostcode.md "gettimesheets-response.schema.json#/properties/siteAddressPostcode")
+
+### siteAddressPostcode Type
+
+`string`
+
+### siteAddressPostcode Examples
+
+```json
+"SW4 0HY"
+```
+
+## Additional Properties
+
+Additional properties are allowed and do not have to follow a specific schema