@planning-inspectorate/data-model 1.14.0 → 1.16.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.
- package/docs/appeal-has.md +1 -0
- package/docs/appeal-s78.md +63 -0
- package/package.json +1 -1
- package/pins_data_model/models/model_appeal_document.py +1 -1
- package/pins_data_model/models/model_appeal_event.py +1 -1
- package/pins_data_model/models/model_appeal_event_estimate.py +1 -1
- package/pins_data_model/models/model_appeal_has.py +2 -1
- package/pins_data_model/models/model_appeal_representation.py +1 -1
- package/pins_data_model/models/model_appeal_s78.py +8 -1
- package/pins_data_model/models/model_dart_response.py +1 -1
- package/pins_data_model/models/model_entraid.py +1 -1
- package/pins_data_model/models/model_folder.py +1 -1
- package/pins_data_model/models/model_gettimesheets_response.py +1 -1
- package/pins_data_model/models/model_listed_building.py +1 -1
- package/pins_data_model/models/model_listed_buildings.py +1 -1
- package/pins_data_model/models/model_nsip_document.py +1 -1
- package/pins_data_model/models/model_nsip_exam_timetable.py +1 -1
- package/pins_data_model/models/model_nsip_project.py +1 -1
- package/pins_data_model/models/model_nsip_project_update.py +1 -1
- package/pins_data_model/models/model_nsip_representation.py +1 -1
- package/pins_data_model/models/model_nsip_subscription.py +1 -1
- package/pins_data_model/models/model_pins_inspector.py +1 -1
- package/pins_data_model/models/model_pins_lpa.py +1 -1
- package/pins_data_model/models/model_s51_advice.py +1 -1
- package/pins_data_model/models/model_service_user.py +1 -1
- package/schemas/appeal-has.schema.json +1 -0
- package/schemas/appeal-s78.schema.json +13 -0
- package/schemas/commands/appeal-common-submission.schema.json +1 -0
- package/src/enums.cjs +1 -0
- package/src/enums.d.ts +1 -0
- package/src/enums.js +1 -0
- package/src/index.cjs +1 -0
- package/src/schemas.d.ts +8 -0
package/docs/appeal-has.md
CHANGED
|
@@ -1953,6 +1953,7 @@ Indicates if the appellant has applied for costs
|
|
|
1953
1953
|
| `"removal-or-variation-of-conditions"` | |
|
|
1954
1954
|
| `"listed-building"` | |
|
|
1955
1955
|
| `"minor-commercial-development"` | |
|
|
1956
|
+
| `"advertisement"` | |
|
|
1956
1957
|
| `null` | |
|
|
1957
1958
|
|
|
1958
1959
|
## Additional Properties
|
package/docs/appeal-s78.md
CHANGED
|
@@ -141,6 +141,8 @@
|
|
|
141
141
|
| [siteWithinSSSI](#sitewithinsssi) | `boolean` | Required | can be null | [Appeal S78 Case](appeal-s78-properties-sitewithinsssi.md "appeal-s78.schema.json#/properties/siteWithinSSSI") |
|
|
142
142
|
| [typeOfPlanningApplication](#typeofplanningapplication) | `string` | Required | can be null | [Appeal S78 Case](appeal-s78-properties-typeofplanningapplication.md "appeal-s78.schema.json#/properties/typeOfPlanningApplication") |
|
|
143
143
|
| [developmentType](#developmenttype) | `string` | Required | can be null | [Appeal S78 Case](appeal-s78-properties-developmenttype.md "appeal-s78.schema.json#/properties/developmentType") |
|
|
144
|
+
| [statementOfCommonGroundDueDate](#statementofcommongroundduedate) | `string` | Optional | can be null | [Appeal S78 Case](appeal-s78-properties-statementofcommongroundduedate.md "appeal-s78.schema.json#/properties/statementOfCommonGroundDueDate") |
|
|
145
|
+
| [planningObligationDueDate](#planningobligationduedate) | `string` | Optional | can be null | [Appeal S78 Case](appeal-s78-properties-planningobligationduedate.md "appeal-s78.schema.json#/properties/planningObligationDueDate") |
|
|
144
146
|
| Additional Properties | Any | Optional | can be null | |
|
|
145
147
|
|
|
146
148
|
## caseId
|
|
@@ -3559,6 +3561,7 @@ The net gain in residences of the proposed development
|
|
|
3559
3561
|
| `"removal-or-variation-of-conditions"` | |
|
|
3560
3562
|
| `"listed-building"` | |
|
|
3561
3563
|
| `"minor-commercial-development"` | |
|
|
3564
|
+
| `"advertisement"` | |
|
|
3562
3565
|
| `null` | |
|
|
3563
3566
|
|
|
3564
3567
|
## developmentType
|
|
@@ -3602,6 +3605,66 @@ The net gain in residences of the proposed development
|
|
|
3602
3605
|
| `"other-minor"` | |
|
|
3603
3606
|
| `null` | |
|
|
3604
3607
|
|
|
3608
|
+
## statementOfCommonGroundDueDate
|
|
3609
|
+
|
|
3610
|
+
|
|
3611
|
+
|
|
3612
|
+
> Only available in S78 cases
|
|
3613
|
+
|
|
3614
|
+
`statementOfCommonGroundDueDate`
|
|
3615
|
+
|
|
3616
|
+
* is optional
|
|
3617
|
+
|
|
3618
|
+
* Type: `string`
|
|
3619
|
+
|
|
3620
|
+
* can be null
|
|
3621
|
+
|
|
3622
|
+
* defined in: [Appeal S78 Case](appeal-s78-properties-statementofcommongroundduedate.md "appeal-s78.schema.json#/properties/statementOfCommonGroundDueDate")
|
|
3623
|
+
|
|
3624
|
+
### statementOfCommonGroundDueDate Type
|
|
3625
|
+
|
|
3626
|
+
`string`
|
|
3627
|
+
|
|
3628
|
+
### statementOfCommonGroundDueDate Constraints
|
|
3629
|
+
|
|
3630
|
+
**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")
|
|
3631
|
+
|
|
3632
|
+
### statementOfCommonGroundDueDate Examples
|
|
3633
|
+
|
|
3634
|
+
```json
|
|
3635
|
+
"2023-07-27T20:30:00.000Z"
|
|
3636
|
+
```
|
|
3637
|
+
|
|
3638
|
+
## planningObligationDueDate
|
|
3639
|
+
|
|
3640
|
+
|
|
3641
|
+
|
|
3642
|
+
> Only available in S78 cases
|
|
3643
|
+
|
|
3644
|
+
`planningObligationDueDate`
|
|
3645
|
+
|
|
3646
|
+
* is optional
|
|
3647
|
+
|
|
3648
|
+
* Type: `string`
|
|
3649
|
+
|
|
3650
|
+
* can be null
|
|
3651
|
+
|
|
3652
|
+
* defined in: [Appeal S78 Case](appeal-s78-properties-planningobligationduedate.md "appeal-s78.schema.json#/properties/planningObligationDueDate")
|
|
3653
|
+
|
|
3654
|
+
### planningObligationDueDate Type
|
|
3655
|
+
|
|
3656
|
+
`string`
|
|
3657
|
+
|
|
3658
|
+
### planningObligationDueDate Constraints
|
|
3659
|
+
|
|
3660
|
+
**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")
|
|
3661
|
+
|
|
3662
|
+
### planningObligationDueDate Examples
|
|
3663
|
+
|
|
3664
|
+
```json
|
|
3665
|
+
"2023-07-27T20:30:00.000Z"
|
|
3666
|
+
```
|
|
3667
|
+
|
|
3605
3668
|
## Additional Properties
|
|
3606
3669
|
|
|
3607
3670
|
Additional properties are allowed and do not have to follow a specific schema
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# generated by datamodel-codegen:
|
|
2
2
|
# filename: appeal-has.schema.json
|
|
3
|
-
# timestamp: 2025-
|
|
3
|
+
# timestamp: 2025-08-29T10:40:44+00:00
|
|
4
4
|
|
|
5
5
|
from __future__ import annotations
|
|
6
6
|
|
|
@@ -221,6 +221,7 @@ class TypeOfPlanningApplication(Enum):
|
|
|
221
221
|
removal_or_variation_of_conditions = "removal-or-variation-of-conditions"
|
|
222
222
|
listed_building = "listed-building"
|
|
223
223
|
minor_commercial_development = "minor-commercial-development"
|
|
224
|
+
advertisement = "advertisement"
|
|
224
225
|
NoneType_None = None
|
|
225
226
|
|
|
226
227
|
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# generated by datamodel-codegen:
|
|
2
2
|
# filename: appeal-s78.schema.json
|
|
3
|
-
# timestamp: 2025-
|
|
3
|
+
# timestamp: 2025-08-29T10:40:44+00:00
|
|
4
4
|
|
|
5
5
|
from __future__ import annotations
|
|
6
6
|
|
|
@@ -279,6 +279,7 @@ class TypeOfPlanningApplication(Enum):
|
|
|
279
279
|
removal_or_variation_of_conditions = "removal-or-variation-of-conditions"
|
|
280
280
|
listed_building = "listed-building"
|
|
281
281
|
minor_commercial_development = "minor-commercial-development"
|
|
282
|
+
advertisement = "advertisement"
|
|
282
283
|
NoneType_None = None
|
|
283
284
|
|
|
284
285
|
|
|
@@ -862,3 +863,9 @@ class AppealS78Case(BaseModel):
|
|
|
862
863
|
siteWithinSSSI: bool | None = None
|
|
863
864
|
typeOfPlanningApplication: TypeOfPlanningApplication
|
|
864
865
|
developmentType: DevelopmentType
|
|
866
|
+
statementOfCommonGroundDueDate: AwareDatetime | None = Field(
|
|
867
|
+
None, examples=["2023-07-27T20:30:00.000Z"]
|
|
868
|
+
)
|
|
869
|
+
planningObligationDueDate: AwareDatetime | None = Field(
|
|
870
|
+
None, examples=["2023-07-27T20:30:00.000Z"]
|
|
871
|
+
)
|
|
@@ -1032,6 +1032,7 @@
|
|
|
1032
1032
|
"removal-or-variation-of-conditions",
|
|
1033
1033
|
"listed-building",
|
|
1034
1034
|
"minor-commercial-development",
|
|
1035
|
+
"advertisement",
|
|
1035
1036
|
null
|
|
1036
1037
|
]
|
|
1037
1038
|
},
|
|
@@ -1055,6 +1056,18 @@
|
|
|
1055
1056
|
"other-minor",
|
|
1056
1057
|
null
|
|
1057
1058
|
]
|
|
1059
|
+
},
|
|
1060
|
+
"statementOfCommonGroundDueDate": {
|
|
1061
|
+
"type": ["string", "null"],
|
|
1062
|
+
"format": "date-time",
|
|
1063
|
+
"examples": ["2023-07-27T20:30:00.000Z"],
|
|
1064
|
+
"$comment": "Only available in S78 cases"
|
|
1065
|
+
},
|
|
1066
|
+
"planningObligationDueDate": {
|
|
1067
|
+
"type": ["string", "null"],
|
|
1068
|
+
"format": "date-time",
|
|
1069
|
+
"examples": ["2023-07-27T20:30:00.000Z"],
|
|
1070
|
+
"$comment": "Only available in S78 cases"
|
|
1058
1071
|
}
|
|
1059
1072
|
}
|
|
1060
1073
|
}
|
package/src/enums.cjs
CHANGED
|
@@ -309,6 +309,7 @@ const APPEAL_SOURCE_SYSTEM = Object.freeze({
|
|
|
309
309
|
});
|
|
310
310
|
|
|
311
311
|
const APPEAL_TYPE_OF_PLANNING_APPLICATION = Object.freeze({
|
|
312
|
+
ADVERTISEMENT: 'advertisement',
|
|
312
313
|
FULL_APPEAL: 'full-appeal',
|
|
313
314
|
HOUSEHOLDER_PLANNING: 'householder-planning',
|
|
314
315
|
LISTED_BUILDING: 'listed-building',
|
package/src/enums.d.ts
CHANGED
|
@@ -307,6 +307,7 @@ export const APPEAL_SOURCE_SYSTEM = {
|
|
|
307
307
|
};
|
|
308
308
|
|
|
309
309
|
export const APPEAL_TYPE_OF_PLANNING_APPLICATION = {
|
|
310
|
+
ADVERTISEMENT: 'advertisement',
|
|
310
311
|
FULL_APPEAL: 'full-appeal',
|
|
311
312
|
HOUSEHOLDER_PLANNING: 'householder-planning',
|
|
312
313
|
LISTED_BUILDING: 'listed-building',
|
package/src/enums.js
CHANGED
|
@@ -307,6 +307,7 @@ export const APPEAL_SOURCE_SYSTEM = Object.freeze({
|
|
|
307
307
|
});
|
|
308
308
|
|
|
309
309
|
export const APPEAL_TYPE_OF_PLANNING_APPLICATION = Object.freeze({
|
|
310
|
+
ADVERTISEMENT: 'advertisement',
|
|
310
311
|
FULL_APPEAL: 'full-appeal',
|
|
311
312
|
HOUSEHOLDER_PLANNING: 'householder-planning',
|
|
312
313
|
LISTED_BUILDING: 'listed-building',
|
package/src/index.cjs
CHANGED
|
@@ -390,6 +390,7 @@ const APPEAL_SOURCE_SYSTEM = Object.freeze({
|
|
|
390
390
|
});
|
|
391
391
|
|
|
392
392
|
const APPEAL_TYPE_OF_PLANNING_APPLICATION = Object.freeze({
|
|
393
|
+
ADVERTISEMENT: 'advertisement',
|
|
393
394
|
FULL_APPEAL: 'full-appeal',
|
|
394
395
|
HOUSEHOLDER_PLANNING: 'householder-planning',
|
|
395
396
|
LISTED_BUILDING: 'listed-building',
|
package/src/schemas.d.ts
CHANGED
|
@@ -654,6 +654,7 @@ export interface AppealHASCase {
|
|
|
654
654
|
| 'removal-or-variation-of-conditions'
|
|
655
655
|
| 'listed-building'
|
|
656
656
|
| 'minor-commercial-development'
|
|
657
|
+
| 'advertisement'
|
|
657
658
|
| null;
|
|
658
659
|
[k: string]: unknown;
|
|
659
660
|
}
|
|
@@ -1283,6 +1284,7 @@ export interface AppealS78Case {
|
|
|
1283
1284
|
| 'removal-or-variation-of-conditions'
|
|
1284
1285
|
| 'listed-building'
|
|
1285
1286
|
| 'minor-commercial-development'
|
|
1287
|
+
| 'advertisement'
|
|
1286
1288
|
| null;
|
|
1287
1289
|
developmentType:
|
|
1288
1290
|
| 'householder'
|
|
@@ -1301,6 +1303,8 @@ export interface AppealS78Case {
|
|
|
1301
1303
|
| 'other-major'
|
|
1302
1304
|
| 'other-minor'
|
|
1303
1305
|
| null;
|
|
1306
|
+
statementOfCommonGroundDueDate?: string | null;
|
|
1307
|
+
planningObligationDueDate?: string | null;
|
|
1304
1308
|
[k: string]: unknown;
|
|
1305
1309
|
}
|
|
1306
1310
|
|
|
@@ -2702,6 +2706,7 @@ export interface AppellantCommonSubmissionProperties {
|
|
|
2702
2706
|
| 'removal-or-variation-of-conditions'
|
|
2703
2707
|
| 'listed-building'
|
|
2704
2708
|
| 'minor-commercial-development'
|
|
2709
|
+
| 'advertisement'
|
|
2705
2710
|
| null;
|
|
2706
2711
|
[k: string]: unknown;
|
|
2707
2712
|
}
|
|
@@ -2881,6 +2886,7 @@ export interface AppellantCommonSubmissionProperties {
|
|
|
2881
2886
|
| 'removal-or-variation-of-conditions'
|
|
2882
2887
|
| 'listed-building'
|
|
2883
2888
|
| 'minor-commercial-development'
|
|
2889
|
+
| 'advertisement'
|
|
2884
2890
|
| null;
|
|
2885
2891
|
[k: string]: unknown;
|
|
2886
2892
|
}
|
|
@@ -3253,6 +3259,7 @@ export interface AppellantCommonSubmissionProperties {
|
|
|
3253
3259
|
| 'removal-or-variation-of-conditions'
|
|
3254
3260
|
| 'listed-building'
|
|
3255
3261
|
| 'minor-commercial-development'
|
|
3262
|
+
| 'advertisement'
|
|
3256
3263
|
| null;
|
|
3257
3264
|
[k: string]: unknown;
|
|
3258
3265
|
}
|
|
@@ -3633,6 +3640,7 @@ export interface AppellantCommonSubmissionProperties {
|
|
|
3633
3640
|
| 'removal-or-variation-of-conditions'
|
|
3634
3641
|
| 'listed-building'
|
|
3635
3642
|
| 'minor-commercial-development'
|
|
3643
|
+
| 'advertisement'
|
|
3636
3644
|
| null;
|
|
3637
3645
|
[k: string]: unknown;
|
|
3638
3646
|
}
|