@planning-inspectorate/data-model 1.11.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (131) hide show
  1. package/.azure/ci.yml +60 -0
  2. package/.azure/release.yml +57 -0
  3. package/.github/dependabot.yml +11 -0
  4. package/.husky/install.mjs +7 -0
  5. package/.husky/pre-commit +1 -0
  6. package/.prettierignore +11 -0
  7. package/.prettierrc +19 -0
  8. package/LICENSE +21 -0
  9. package/README.md +237 -0
  10. package/commitlint.config.js +8 -0
  11. package/docs/README.md +85 -0
  12. package/docs/appeal-document.md +776 -0
  13. package/docs/appeal-event-estimate.md +108 -0
  14. package/docs/appeal-event.md +404 -0
  15. package/docs/appeal-has.md +1960 -0
  16. package/docs/appeal-representation.md +375 -0
  17. package/docs/appeal-s78.md +3607 -0
  18. package/docs/appeal.md +1879 -0
  19. package/docs/case-schedule.md +8 -0
  20. package/docs/dart-response.md +1413 -0
  21. package/docs/employee.md +70 -0
  22. package/docs/entraid.md +108 -0
  23. package/docs/folder.md +147 -0
  24. package/docs/gettimesheets-response.md +188 -0
  25. package/docs/interested-party.md +284 -0
  26. package/docs/listed-building.md +113 -0
  27. package/docs/listed-buildings.md +113 -0
  28. package/docs/nsip-document.md +966 -0
  29. package/docs/nsip-exam-timetable-defs-event.md +223 -0
  30. package/docs/nsip-exam-timetable-defs-line-item.md +51 -0
  31. package/docs/nsip-exam-timetable-defs.md +3 -0
  32. package/docs/nsip-exam-timetable-submission.md +113 -0
  33. package/docs/nsip-exam-timetable.md +352 -0
  34. package/docs/nsip-project-update.md +163 -0
  35. package/docs/nsip-project.md +2098 -0
  36. package/docs/nsip-representation-defs-attachment.md +133 -0
  37. package/docs/nsip-representation-defs.md +3 -0
  38. package/docs/nsip-representation.md +448 -0
  39. package/docs/nsip-subscription.md +193 -0
  40. package/docs/pins-inspector.md +184 -0
  41. package/docs/pins-lpa.md +260 -0
  42. package/docs/s51-advice.md +460 -0
  43. package/docs/service-user.md +575 -0
  44. package/eslint.config.js +21 -0
  45. package/jsconfig.json +12 -0
  46. package/package.json +55 -0
  47. package/pins_data_model/__init__.py +0 -0
  48. package/pins_data_model/gen_models.py +51 -0
  49. package/pins_data_model/load_schemas.py +51 -0
  50. package/pins_data_model/models/__init__.py +0 -0
  51. package/pins_data_model/models/model_appeal_document.py +294 -0
  52. package/pins_data_model/models/model_appeal_event.py +117 -0
  53. package/pins_data_model/models/model_appeal_event_estimate.py +37 -0
  54. package/pins_data_model/models/model_appeal_has.py +585 -0
  55. package/pins_data_model/models/model_appeal_representation.py +132 -0
  56. package/pins_data_model/models/model_appeal_s78.py +864 -0
  57. package/pins_data_model/models/model_case_schedule.py +11 -0
  58. package/pins_data_model/models/model_dart_response.py +292 -0
  59. package/pins_data_model/models/model_entraid.py +37 -0
  60. package/pins_data_model/models/model_folder.py +56 -0
  61. package/pins_data_model/models/model_gettimesheets_response.py +45 -0
  62. package/pins_data_model/models/model_listed_building.py +33 -0
  63. package/pins_data_model/models/model_listed_buildings.py +33 -0
  64. package/pins_data_model/models/model_nsip_document.py +199 -0
  65. package/pins_data_model/models/model_nsip_exam_timetable.py +90 -0
  66. package/pins_data_model/models/model_nsip_project.py +488 -0
  67. package/pins_data_model/models/model_nsip_project_update.py +60 -0
  68. package/pins_data_model/models/model_nsip_representation.py +83 -0
  69. package/pins_data_model/models/model_nsip_subscription.py +60 -0
  70. package/pins_data_model/models/model_pins_inspector.py +53 -0
  71. package/pins_data_model/models/model_pins_lpa.py +69 -0
  72. package/pins_data_model/models/model_s51_advice.py +109 -0
  73. package/pins_data_model/models/model_service_user.py +121 -0
  74. package/requirements.txt +2 -0
  75. package/schemas/__init__.py +0 -0
  76. package/schemas/appeal-document.schema.json +250 -0
  77. package/schemas/appeal-event-estimate.schema.json +31 -0
  78. package/schemas/appeal-event.schema.json +123 -0
  79. package/schemas/appeal-has.schema.json +576 -0
  80. package/schemas/appeal-representation.schema.json +131 -0
  81. package/schemas/appeal-s78.schema.json +1060 -0
  82. package/schemas/commands/__init__.py +0 -0
  83. package/schemas/commands/appeal-common-submission.schema.json +202 -0
  84. package/schemas/commands/appeal-has-submission.schema.json +82 -0
  85. package/schemas/commands/appeal-representation-submission.schema.json +192 -0
  86. package/schemas/commands/appeal-s78-submission.schema.json +100 -0
  87. package/schemas/commands/appellant-submission.schema.json +164 -0
  88. package/schemas/commands/interested-party.schema.json +80 -0
  89. package/schemas/commands/lpa-questionnaire-common.schema.json +110 -0
  90. package/schemas/commands/lpa-questionnaire-has.schema.json +69 -0
  91. package/schemas/commands/lpa-questionnaire-s78.schema.json +218 -0
  92. package/schemas/commands/lpa-questionnaire.schema.json +125 -0
  93. package/schemas/commands/new-deadline-submission.schema.json +59 -0
  94. package/schemas/commands/nsip-exam-timetable-submission.schema.json +27 -0
  95. package/schemas/commands/register-nsip-subscription.schema.json +32 -0
  96. package/schemas/commands/register-representation.schema.json +51 -0
  97. package/schemas/dart-response.schema.json +350 -0
  98. package/schemas/entraid.schema.json +31 -0
  99. package/schemas/folder.schema.json +49 -0
  100. package/schemas/gettimesheets-response.schema.json +46 -0
  101. package/schemas/listed-building.schema.json +31 -0
  102. package/schemas/listed-buildings.schema.json +31 -0
  103. package/schemas/nsip-document.schema.json +235 -0
  104. package/schemas/nsip-exam-timetable.schema.json +101 -0
  105. package/schemas/nsip-project-update.schema.json +49 -0
  106. package/schemas/nsip-project.schema.json +539 -0
  107. package/schemas/nsip-representation.schema.json +110 -0
  108. package/schemas/nsip-subscription.schema.json +52 -0
  109. package/schemas/pins-inspector.schema.json +47 -0
  110. package/schemas/pins-lpa.schema.json +63 -0
  111. package/schemas/s51-advice.schema.json +113 -0
  112. package/schemas/service-user.schema.json +152 -0
  113. package/setup.py +15 -0
  114. package/src/enums.cjs +632 -0
  115. package/src/enums.d.ts +573 -0
  116. package/src/enums.js +573 -0
  117. package/src/gen-docs.js +34 -0
  118. package/src/gen-enums.js +119 -0
  119. package/src/gen-types.js +70 -0
  120. package/src/index.cjs +746 -0
  121. package/src/index.d.ts +18 -0
  122. package/src/index.js +34 -0
  123. package/src/lib/load.js +78 -0
  124. package/src/schemas.d.ts +4570 -0
  125. package/tests/appeals/appeal-event.test.js +62 -0
  126. package/tests/appeals/commands/appeal-representation-submission.test.js +107 -0
  127. package/tests/appeals/commands/has-questionnaire.test.js +92 -0
  128. package/tests/appeals/commands/has-submission.test.js +113 -0
  129. package/tests/appeals/commands/s78-questionnaire.test.js +96 -0
  130. package/tests/appeals/commands/s78-submission.test.js +119 -0
  131. package/tests/schemas.test.js +97 -0
package/docs/nsip-exam-timetable-defs-event.md ADDED
@@ -0,0 +1,223 @@
1
+ ## event Type
2
+
3
+ `object` ([Details](nsip-exam-timetable-defs-event.md))
4
+
5
+ # event Properties
6
+
7
+ | Property | Type | Required | Nullable | Defined by |
8
+ | :------------------------------------------------ | :-------- | :------- | :------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
9
+ | [eventId](#eventid) | `integer` | Required | cannot be null | [Examination Timetable](nsip-exam-timetable-defs-event-properties-eventid.md "nsip-exam-timetable.schema.json#/$defs/event/properties/eventId") |
10
+ | [type](#type) | `string` | Required | cannot be null | [Examination Timetable](nsip-exam-timetable-defs-event-properties-type.md "nsip-exam-timetable.schema.json#/$defs/event/properties/type") |
11
+ | [eventTitle](#eventtitle) | `string` | Required | cannot be null | [Examination Timetable](nsip-exam-timetable-defs-event-properties-eventtitle.md "nsip-exam-timetable.schema.json#/$defs/event/properties/eventTitle") |
12
+ | [eventTitleWelsh](#eventtitlewelsh) | `string` | Optional | can be null | [Examination Timetable](nsip-exam-timetable-defs-event-properties-eventtitlewelsh.md "nsip-exam-timetable.schema.json#/$defs/event/properties/eventTitleWelsh") |
13
+ | [description](#description) | `string` | Required | cannot be null | [Examination Timetable](nsip-exam-timetable-defs-event-properties-description.md "nsip-exam-timetable.schema.json#/$defs/event/properties/description") |
14
+ | [descriptionWelsh](#descriptionwelsh) | `string` | Optional | can be null | [Examination Timetable](nsip-exam-timetable-defs-event-properties-descriptionwelsh.md "nsip-exam-timetable.schema.json#/$defs/event/properties/descriptionWelsh") |
15
+ | [eventDeadlineStartDate](#eventdeadlinestartdate) | `string` | Optional | can be null | [Examination Timetable](nsip-exam-timetable-defs-event-properties-eventdeadlinestartdate.md "nsip-exam-timetable.schema.json#/$defs/event/properties/eventDeadlineStartDate") |
16
+ | [date](#date) | `string` | Required | cannot be null | [Examination Timetable](nsip-exam-timetable-defs-event-properties-date.md "nsip-exam-timetable.schema.json#/$defs/event/properties/date") |
17
+ | [eventLineItems](#eventlineitems) | `array` | Required | cannot be null | [Examination Timetable](nsip-exam-timetable-defs-event-properties-eventlineitems.md "nsip-exam-timetable.schema.json#/$defs/event/properties/eventLineItems") |
18
+ | Additional Properties | Any | Optional | can be null | |
19
+
20
+ ## eventId
21
+
22
+ Event Identifier
23
+
24
+ `eventId`
25
+
26
+ * is required
27
+
28
+ * Type: `integer`
29
+
30
+ * cannot be null
31
+
32
+ * defined in: [Examination Timetable](nsip-exam-timetable-defs-event-properties-eventid.md "nsip-exam-timetable.schema.json#/$defs/event/properties/eventId")
33
+
34
+ ### eventId Type
35
+
36
+ `integer`
37
+
38
+ ## type
39
+
40
+ Compulsory Acquisition Hearing/Deadline/Issue Specific Hearing etc
41
+
42
+ `type`
43
+
44
+ * is required
45
+
46
+ * Type: `string`
47
+
48
+ * cannot be null
49
+
50
+ * defined in: [Examination Timetable](nsip-exam-timetable-defs-event-properties-type.md "nsip-exam-timetable.schema.json#/$defs/event/properties/type")
51
+
52
+ ### type Type
53
+
54
+ `string`
55
+
56
+ ### type Constraints
57
+
58
+ **enum**: the value of this property must be equal to one of the following values:
59
+
60
+ | Value | Explanation |
61
+ | :---------------------------------------- | :---------- |
62
+ | `"Accompanied Site Inspection"` | |
63
+ | `"Compulsory Acquisition Hearing"` | |
64
+ | `"Deadline"` | |
65
+ | `"Deadline For Close Of Examination"` | |
66
+ | `"Issued By"` | |
67
+ | `"Issue Specific Hearing"` | |
68
+ | `"Open Floor Hearing"` | |
69
+ | `"Other Meeting"` | |
70
+ | `"Preliminary Meeting"` | |
71
+ | `"Procedural Deadline (Pre-Examination)"` | |
72
+ | `"Procedural Decision"` | |
73
+ | `"Publication Of"` | |
74
+
75
+ ## eventTitle
76
+
77
+ Title Of Examination Timetable Event
78
+
79
+ `eventTitle`
80
+
81
+ * is required
82
+
83
+ * Type: `string`
84
+
85
+ * cannot be null
86
+
87
+ * defined in: [Examination Timetable](nsip-exam-timetable-defs-event-properties-eventtitle.md "nsip-exam-timetable.schema.json#/$defs/event/properties/eventTitle")
88
+
89
+ ### eventTitle Type
90
+
91
+ `string`
92
+
93
+ ## eventTitleWelsh
94
+
95
+ Title Of Examination Timetable Event In Welsh
96
+
97
+ `eventTitleWelsh`
98
+
99
+ * is optional
100
+
101
+ * Type: `string`
102
+
103
+ * can be null
104
+
105
+ * defined in: [Examination Timetable](nsip-exam-timetable-defs-event-properties-eventtitlewelsh.md "nsip-exam-timetable.schema.json#/$defs/event/properties/eventTitleWelsh")
106
+
107
+ ### eventTitleWelsh Type
108
+
109
+ `string`
110
+
111
+ ## description
112
+
113
+
114
+
115
+ `description`
116
+
117
+ * is required
118
+
119
+ * Type: `string`
120
+
121
+ * cannot be null
122
+
123
+ * defined in: [Examination Timetable](nsip-exam-timetable-defs-event-properties-description.md "nsip-exam-timetable.schema.json#/$defs/event/properties/description")
124
+
125
+ ### description Type
126
+
127
+ `string`
128
+
129
+ ## descriptionWelsh
130
+
131
+
132
+
133
+ `descriptionWelsh`
134
+
135
+ * is optional
136
+
137
+ * Type: `string`
138
+
139
+ * can be null
140
+
141
+ * defined in: [Examination Timetable](nsip-exam-timetable-defs-event-properties-descriptionwelsh.md "nsip-exam-timetable.schema.json#/$defs/event/properties/descriptionWelsh")
142
+
143
+ ### descriptionWelsh Type
144
+
145
+ `string`
146
+
147
+ ## eventDeadlineStartDate
148
+
149
+ Optional start date for event window
150
+
151
+ `eventDeadlineStartDate`
152
+
153
+ * is optional
154
+
155
+ * Type: `string`
156
+
157
+ * can be null
158
+
159
+ * defined in: [Examination Timetable](nsip-exam-timetable-defs-event-properties-eventdeadlinestartdate.md "nsip-exam-timetable.schema.json#/$defs/event/properties/eventDeadlineStartDate")
160
+
161
+ ### eventDeadlineStartDate Type
162
+
163
+ `string`
164
+
165
+ ### eventDeadlineStartDate Constraints
166
+
167
+ **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")
168
+
169
+ ### eventDeadlineStartDate Examples
170
+
171
+ ```json
172
+ "2023-07-27T20:30:00.000Z"
173
+ ```
174
+
175
+ ## date
176
+
177
+ Event Date = effective deadline (end) date
178
+
179
+ `date`
180
+
181
+ * is required
182
+
183
+ * Type: `string`
184
+
185
+ * cannot be null
186
+
187
+ * defined in: [Examination Timetable](nsip-exam-timetable-defs-event-properties-date.md "nsip-exam-timetable.schema.json#/$defs/event/properties/date")
188
+
189
+ ### date Type
190
+
191
+ `string`
192
+
193
+ ### date Constraints
194
+
195
+ **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")
196
+
197
+ ### date Examples
198
+
199
+ ```json
200
+ "2023-07-27T20:30:00.000Z"
201
+ ```
202
+
203
+ ## eventLineItems
204
+
205
+
206
+
207
+ `eventLineItems`
208
+
209
+ * is required
210
+
211
+ * Type: `object[]` ([Details](nsip-exam-timetable-defs-line-item.md))
212
+
213
+ * cannot be null
214
+
215
+ * defined in: [Examination Timetable](nsip-exam-timetable-defs-event-properties-eventlineitems.md "nsip-exam-timetable.schema.json#/$defs/event/properties/eventLineItems")
216
+
217
+ ### eventLineItems Type
218
+
219
+ `object[]` ([Details](nsip-exam-timetable-defs-line-item.md))
220
+
221
+ ## Additional Properties
222
+
223
+ Additional properties are allowed and do not have to follow a specific schema
package/docs/nsip-exam-timetable-defs-line-item.md ADDED
@@ -0,0 +1,51 @@
1
+ ## line-item Type
2
+
3
+ `object` ([Details](nsip-exam-timetable-defs-line-item.md))
4
+
5
+ # line-item Properties
6
+
7
+ | Property | Type | Required | Nullable | Defined by |
8
+ | :------------------------------------ | :------- | :------- | :------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
9
+ | [description](#description) | `string` | Required | cannot be null | [Examination Timetable](nsip-exam-timetable-defs-line-item-properties-description.md "nsip-exam-timetable.schema.json#/$defs/line-item/properties/description") |
10
+ | [descriptionWelsh](#descriptionwelsh) | `string` | Optional | can be null | [Examination Timetable](nsip-exam-timetable-defs-line-item-properties-descriptionwelsh.md "nsip-exam-timetable.schema.json#/$defs/line-item/properties/descriptionWelsh") |
11
+ | Additional Properties | Any | Optional | can be null | |
12
+
13
+ ## description
14
+
15
+
16
+
17
+ `description`
18
+
19
+ * is required
20
+
21
+ * Type: `string`
22
+
23
+ * cannot be null
24
+
25
+ * defined in: [Examination Timetable](nsip-exam-timetable-defs-line-item-properties-description.md "nsip-exam-timetable.schema.json#/$defs/line-item/properties/description")
26
+
27
+ ### description Type
28
+
29
+ `string`
30
+
31
+ ## descriptionWelsh
32
+
33
+
34
+
35
+ `descriptionWelsh`
36
+
37
+ * is optional
38
+
39
+ * Type: `string`
40
+
41
+ * can be null
42
+
43
+ * defined in: [Examination Timetable](nsip-exam-timetable-defs-line-item-properties-descriptionwelsh.md "nsip-exam-timetable.schema.json#/$defs/line-item/properties/descriptionWelsh")
44
+
45
+ ### descriptionWelsh Type
46
+
47
+ `string`
48
+
49
+ ## Additional Properties
50
+
51
+ Additional properties are allowed and do not have to follow a specific schema
package/docs/nsip-exam-timetable-defs.md ADDED
@@ -0,0 +1,3 @@
1
+ ## $defs Type
2
+
3
+ unknown
package/docs/nsip-exam-timetable-submission.md ADDED
@@ -0,0 +1,113 @@
1
+ ## nsip-exam-timetable-submission Type
2
+
3
+ `object` ([nsip-exam-timetable-submission](nsip-exam-timetable-submission.md))
4
+
5
+ # nsip-exam-timetable-submission Properties
6
+
7
+ | Property | Type | Required | Nullable | Defined by |
8
+ | :-------------------------------- | :------- | :------- | :------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
9
+ | [status](#status) | `string` | Required | cannot be null | [nsip-exam-timetable-submission](nsip-exam-timetable-submission-properties-status.md "nsip-exam-timetable-submission.schema.json#/properties/status") |
10
+ | [deadline](#deadline) | `string` | Required | cannot be null | [nsip-exam-timetable-submission](nsip-exam-timetable-submission-properties-deadline.md "nsip-exam-timetable-submission.schema.json#/properties/deadline") |
11
+ | [submissionType](#submissiontype) | `string` | Required | cannot be null | [nsip-exam-timetable-submission](nsip-exam-timetable-submission-properties-submissiontype.md "nsip-exam-timetable-submission.schema.json#/properties/submissionType") |
12
+ | [blobGuid](#blobguid) | `string` | Required | cannot be null | [nsip-exam-timetable-submission](nsip-exam-timetable-submission-properties-blobguid.md "nsip-exam-timetable-submission.schema.json#/properties/blobGuid") |
13
+ | [documentName](#documentname) | `string` | Required | cannot be null | [nsip-exam-timetable-submission](nsip-exam-timetable-submission-properties-documentname.md "nsip-exam-timetable-submission.schema.json#/properties/documentName") |
14
+
15
+ ## status
16
+
17
+
18
+
19
+ `status`
20
+
21
+ * is required
22
+
23
+ * Type: `string`
24
+
25
+ * cannot be null
26
+
27
+ * defined in: [nsip-exam-timetable-submission](nsip-exam-timetable-submission-properties-status.md "nsip-exam-timetable-submission.schema.json#/properties/status")
28
+
29
+ ### status Type
30
+
31
+ `string`
32
+
33
+ ### status Constraints
34
+
35
+ **enum**: the value of this property must be equal to one of the following values:
36
+
37
+ | Value | Explanation |
38
+ | :----------------- | :---------- |
39
+ | `"SUCCESS"` | |
40
+ | `"VIRUS_DETECTED"` | |
41
+ | `"FAILURE"` | |
42
+
43
+ ## deadline
44
+
45
+
46
+
47
+ `deadline`
48
+
49
+ * is required
50
+
51
+ * Type: `string`
52
+
53
+ * cannot be null
54
+
55
+ * defined in: [nsip-exam-timetable-submission](nsip-exam-timetable-submission-properties-deadline.md "nsip-exam-timetable-submission.schema.json#/properties/deadline")
56
+
57
+ ### deadline Type
58
+
59
+ `string`
60
+
61
+ ## submissionType
62
+
63
+
64
+
65
+ `submissionType`
66
+
67
+ * is required
68
+
69
+ * Type: `string`
70
+
71
+ * cannot be null
72
+
73
+ * defined in: [nsip-exam-timetable-submission](nsip-exam-timetable-submission-properties-submissiontype.md "nsip-exam-timetable-submission.schema.json#/properties/submissionType")
74
+
75
+ ### submissionType Type
76
+
77
+ `string`
78
+
79
+ ## blobGuid
80
+
81
+
82
+
83
+ `blobGuid`
84
+
85
+ * is required
86
+
87
+ * Type: `string`
88
+
89
+ * cannot be null
90
+
91
+ * defined in: [nsip-exam-timetable-submission](nsip-exam-timetable-submission-properties-blobguid.md "nsip-exam-timetable-submission.schema.json#/properties/blobGuid")
92
+
93
+ ### blobGuid Type
94
+
95
+ `string`
96
+
97
+ ## documentName
98
+
99
+
100
+
101
+ `documentName`
102
+
103
+ * is required
104
+
105
+ * Type: `string`
106
+
107
+ * cannot be null
108
+
109
+ * defined in: [nsip-exam-timetable-submission](nsip-exam-timetable-submission-properties-documentname.md "nsip-exam-timetable-submission.schema.json#/properties/documentName")
110
+
111
+ ### documentName Type
112
+
113
+ `string`