@planning-inspectorate/data-model 2.51.1 → 2.53.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/.azure/ci.yml +6 -6
- package/.azure/release.yml +2 -2
- package/docs/README.md +6 -2
- package/docs/appeal-document.md +1 -0
- package/docs/appeal-has.md +17 -15
- package/docs/appeal-s78.md +63 -19
- package/docs/applications-notify-email.md +2 -2
- package/docs/applications-representation-defs-contact.md +93 -0
- package/docs/applications-representation-defs-representationdocument.md +152 -0
- package/docs/applications-representation-defs.md +3 -0
- package/docs/applications-representation.md +41 -41
- package/package.json +1 -1
- package/pins_data_model/models/model_appeal_document.py +1 -0
- package/pins_data_model/models/model_appeal_has.py +2 -0
- package/pins_data_model/models/model_appeal_s78.py +118 -4
- package/pins_data_model/models/model_applications_notify_email.py +1 -1
- package/pins_data_model/models/model_applications_representation.py +2 -2
- package/schemas/appeal-document.schema.json +1 -0
- package/schemas/appeal-has.schema.json +3 -1
- package/schemas/appeal-s78.schema.json +43 -1
- package/schemas/applications-notify-email.schema.json +1 -1
- package/schemas/applications-representation.schema.json +6 -6
- package/src/enums.cjs +5 -0
- package/src/enums.d.ts +5 -0
- package/src/enums.js +5 -0
- package/src/index.cjs +5 -0
- package/src/schemas.d.ts +30 -5
- package/tests/appeals/appeal-has.test.js +41 -0
- package/tests/appeals/appeal-s78.test.js +41 -0
|
@@ -11,10 +11,10 @@
|
|
|
11
11
|
| [caseReference](#casereference) | `string` | Required | cannot be null | [Casework Representation Schema](applications-representation-properties-casereference.md "applications-representation.schema.json#/properties/caseReference") |
|
|
12
12
|
| [caseId](#caseid) | `string` | Required | cannot be null | [Casework Representation Schema](applications-representation-properties-caseid.md "applications-representation.schema.json#/properties/caseId") |
|
|
13
13
|
| [caseType](#casetype) | `string` | Required | cannot be null | [Casework Representation Schema](applications-representation-properties-casetype.md "applications-representation.schema.json#/properties/caseType") |
|
|
14
|
-
| [representationStatus](#representationstatus) | `string` |
|
|
14
|
+
| [representationStatus](#representationstatus) | `string` | Required | cannot be null | [Casework Representation Schema](applications-representation-properties-representationstatus.md "applications-representation.schema.json#/properties/representationStatus") |
|
|
15
15
|
| [submittedFor](#submittedfor) | `string` | Required | cannot be null | [Casework Representation Schema](applications-representation-properties-submittedfor.md "applications-representation.schema.json#/properties/submittedFor") |
|
|
16
16
|
| [submittedByContact](#submittedbycontact) | `array` | Optional | can be null | [Casework Representation Schema](applications-representation-properties-submittedbycontact.md "applications-representation.schema.json#/properties/submittedByContact") |
|
|
17
|
-
| [
|
|
17
|
+
| [submittedByAgent](#submittedbyagent) | `boolean` | Optional | can be null | [Casework Representation Schema](applications-representation-properties-submittedbyagent.md "applications-representation.schema.json#/properties/submittedByAgent") |
|
|
18
18
|
| [submittedByAgentOrgName](#submittedbyagentorgname) | `string` | Optional | can be null | [Casework Representation Schema](applications-representation-properties-submittedbyagentorgname.md "applications-representation.schema.json#/properties/submittedByAgentOrgName") |
|
|
19
19
|
| [submittedDate](#submitteddate) | `string` | Required | cannot be null | [Casework Representation Schema](applications-representation-properties-submitteddate.md "applications-representation.schema.json#/properties/submittedDate") |
|
|
20
20
|
| [submittedReceivedMethod](#submittedreceivedmethod) | `string` | Optional | can be null | [Casework Representation Schema](applications-representation-properties-submittedreceivedmethod.md "applications-representation.schema.json#/properties/submittedReceivedMethod") |
|
|
@@ -130,7 +130,7 @@ The type of case this representation is for.
|
|
|
130
130
|
|
|
131
131
|
`representationStatus`
|
|
132
132
|
|
|
133
|
-
* is
|
|
133
|
+
* is required
|
|
134
134
|
|
|
135
135
|
* Type: `string`
|
|
136
136
|
|
|
@@ -188,7 +188,7 @@ The type of case this representation is for.
|
|
|
188
188
|
|
|
189
189
|
* is optional
|
|
190
190
|
|
|
191
|
-
* Type: `object[]` ([Details](applications-representation-
|
|
191
|
+
* Type: `object[]` ([Details](applications-representation-defs-contact.md))
|
|
192
192
|
|
|
193
193
|
* can be null
|
|
194
194
|
|
|
@@ -196,13 +196,13 @@ The type of case this representation is for.
|
|
|
196
196
|
|
|
197
197
|
### submittedByContact Type
|
|
198
198
|
|
|
199
|
-
`object[]` ([Details](applications-representation-
|
|
199
|
+
`object[]` ([Details](applications-representation-defs-contact.md))
|
|
200
200
|
|
|
201
|
-
##
|
|
201
|
+
## submittedByAgent
|
|
202
202
|
|
|
203
203
|
|
|
204
204
|
|
|
205
|
-
`
|
|
205
|
+
`submittedByAgent`
|
|
206
206
|
|
|
207
207
|
* is optional
|
|
208
208
|
|
|
@@ -210,9 +210,9 @@ The type of case this representation is for.
|
|
|
210
210
|
|
|
211
211
|
* can be null
|
|
212
212
|
|
|
213
|
-
* defined in: [Casework Representation Schema](applications-representation-properties-
|
|
213
|
+
* defined in: [Casework Representation Schema](applications-representation-properties-submittedbyagent.md "applications-representation.schema.json#/properties/submittedByAgent")
|
|
214
214
|
|
|
215
|
-
###
|
|
215
|
+
### submittedByAgent Type
|
|
216
216
|
|
|
217
217
|
`boolean`
|
|
218
218
|
|
|
@@ -376,7 +376,7 @@ When representation is on behalf of a person/org/group
|
|
|
376
376
|
|
|
377
377
|
* is optional
|
|
378
378
|
|
|
379
|
-
* Type: `object[]` ([Details](applications-representation-
|
|
379
|
+
* Type: `object[]` ([Details](applications-representation-defs-contact.md))
|
|
380
380
|
|
|
381
381
|
* can be null
|
|
382
382
|
|
|
@@ -384,7 +384,7 @@ When representation is on behalf of a person/org/group
|
|
|
384
384
|
|
|
385
385
|
### representedContact Type
|
|
386
386
|
|
|
387
|
-
`object[]` ([Details](applications-representation-
|
|
387
|
+
`object[]` ([Details](applications-representation-defs-contact.md))
|
|
388
388
|
|
|
389
389
|
## representedCategory
|
|
390
390
|
|
|
@@ -566,7 +566,7 @@ Date the representation was withdrawn
|
|
|
566
566
|
|
|
567
567
|
* is optional
|
|
568
568
|
|
|
569
|
-
* Type: `object[]` ([Details](applications-representation-
|
|
569
|
+
* Type: `object[]` ([Details](applications-representation-defs-representationdocument.md))
|
|
570
570
|
|
|
571
571
|
* can be null
|
|
572
572
|
|
|
@@ -574,7 +574,7 @@ Date the representation was withdrawn
|
|
|
574
574
|
|
|
575
575
|
### representationDocuments Type
|
|
576
576
|
|
|
577
|
-
`object[]` ([Details](applications-representation-
|
|
577
|
+
`object[]` ([Details](applications-representation-defs-representationdocument.md))
|
|
578
578
|
|
|
579
579
|
## Additional Properties
|
|
580
580
|
|
|
@@ -587,15 +587,15 @@ Additional properties are allowed and do not have to follow a specific schema
|
|
|
587
587
|
Reference this group by using
|
|
588
588
|
|
|
589
589
|
```json
|
|
590
|
-
{"$ref":"applications-representation.schema.json
|
|
590
|
+
{"$ref":"applications-representation.schema.json#/$defs/contact"}
|
|
591
591
|
```
|
|
592
592
|
|
|
593
|
-
| Property | Type | Required | Nullable | Defined by
|
|
594
|
-
| :---------------------------------------------------- | :------- | :------- | :------------- |
|
|
595
|
-
| [contactId](#contactid) | `string` | Required | cannot be null | [Casework Representation Schema](applications-representation-
|
|
596
|
-
| [contactPreference](#contactpreference) | `string` | Optional | can be null | [Casework Representation Schema](applications-representation-
|
|
597
|
-
| [writtenRepOrgName](#writtenreporgname) | `string` | Optional | can be null | [Casework Representation Schema](applications-representation-
|
|
598
|
-
| [writtenRepJobTitleorRole](#writtenrepjobtitleorrole) | `string` | Optional | can be null | [Casework Representation Schema](applications-representation-
|
|
593
|
+
| Property | Type | Required | Nullable | Defined by |
|
|
594
|
+
| :---------------------------------------------------- | :------- | :------- | :------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
595
|
+
| [contactId](#contactid) | `string` | Required | cannot be null | [Casework Representation Schema](applications-representation-defs-contact-properties-contactid.md "applications-representation.schema.json#/$defs/contact/properties/contactId") |
|
|
596
|
+
| [contactPreference](#contactpreference) | `string` | Optional | can be null | [Casework Representation Schema](applications-representation-defs-contact-properties-contactpreference.md "applications-representation.schema.json#/$defs/contact/properties/contactPreference") |
|
|
597
|
+
| [writtenRepOrgName](#writtenreporgname) | `string` | Optional | can be null | [Casework Representation Schema](applications-representation-defs-contact-properties-writtenreporgname.md "applications-representation.schema.json#/$defs/contact/properties/writtenRepOrgName") |
|
|
598
|
+
| [writtenRepJobTitleorRole](#writtenrepjobtitleorrole) | `string` | Optional | can be null | [Casework Representation Schema](applications-representation-defs-contact-properties-writtenrepjobtitleorrole.md "applications-representation.schema.json#/$defs/contact/properties/writtenRepJobTitleorRole") |
|
|
599
599
|
|
|
600
600
|
### contactId
|
|
601
601
|
|
|
@@ -609,7 +609,7 @@ Source PK for Contact
|
|
|
609
609
|
|
|
610
610
|
* cannot be null
|
|
611
611
|
|
|
612
|
-
* defined in: [Casework Representation Schema](applications-representation-
|
|
612
|
+
* defined in: [Casework Representation Schema](applications-representation-defs-contact-properties-contactid.md "applications-representation.schema.json#/$defs/contact/properties/contactId")
|
|
613
613
|
|
|
614
614
|
#### contactId Type
|
|
615
615
|
|
|
@@ -627,7 +627,7 @@ Source PK for Contact
|
|
|
627
627
|
|
|
628
628
|
* can be null
|
|
629
629
|
|
|
630
|
-
* defined in: [Casework Representation Schema](applications-representation-
|
|
630
|
+
* defined in: [Casework Representation Schema](applications-representation-defs-contact-properties-contactpreference.md "applications-representation.schema.json#/$defs/contact/properties/contactPreference")
|
|
631
631
|
|
|
632
632
|
#### contactPreference Type
|
|
633
633
|
|
|
@@ -654,7 +654,7 @@ Source PK for Contact
|
|
|
654
654
|
|
|
655
655
|
* can be null
|
|
656
656
|
|
|
657
|
-
* defined in: [Casework Representation Schema](applications-representation-
|
|
657
|
+
* defined in: [Casework Representation Schema](applications-representation-defs-contact-properties-writtenreporgname.md "applications-representation.schema.json#/$defs/contact/properties/writtenRepOrgName")
|
|
658
658
|
|
|
659
659
|
#### writtenRepOrgName Type
|
|
660
660
|
|
|
@@ -672,7 +672,7 @@ Source PK for Contact
|
|
|
672
672
|
|
|
673
673
|
* can be null
|
|
674
674
|
|
|
675
|
-
* defined in: [Casework Representation Schema](applications-representation-
|
|
675
|
+
* defined in: [Casework Representation Schema](applications-representation-defs-contact-properties-writtenrepjobtitleorrole.md "applications-representation.schema.json#/$defs/contact/properties/writtenRepJobTitleorRole")
|
|
676
676
|
|
|
677
677
|
#### writtenRepJobTitleorRole Type
|
|
678
678
|
|
|
@@ -683,18 +683,18 @@ Source PK for Contact
|
|
|
683
683
|
Reference this group by using
|
|
684
684
|
|
|
685
685
|
```json
|
|
686
|
-
{"$ref":"applications-representation.schema.json
|
|
686
|
+
{"$ref":"applications-representation.schema.json#/$defs/representationDocument"}
|
|
687
687
|
```
|
|
688
688
|
|
|
689
|
-
| Property | Type | Required | Nullable | Defined by
|
|
690
|
-
| :------------------------------------ | :------- | :------- | :------------- |
|
|
691
|
-
| [id](#id-1) | `string` | Required | cannot be null | [Casework Representation Schema](applications-representation-
|
|
692
|
-
| [representationId](#representationid) | `string` | Required | cannot be null | [Casework Representation Schema](applications-representation-
|
|
693
|
-
| [itemId](#itemid) | `string` | Required | cannot be null | [Casework Representation Schema](applications-representation-
|
|
694
|
-
| [fileName](#filename) | `string` | Required | cannot be null | [Casework Representation Schema](applications-representation-
|
|
695
|
-
| [redactedItemId](#redacteditemid) | `string` | Optional | can be null | [Casework Representation Schema](applications-representation-
|
|
696
|
-
| [redactedFileName](#redactedfilename) | `string` | Optional | can be null | [Casework Representation Schema](applications-representation-
|
|
697
|
-
| [status](#status) | `string` | Required | cannot be null | [Casework Representation Schema](applications-representation-
|
|
689
|
+
| Property | Type | Required | Nullable | Defined by |
|
|
690
|
+
| :------------------------------------ | :------- | :------- | :------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
691
|
+
| [id](#id-1) | `string` | Required | cannot be null | [Casework Representation Schema](applications-representation-defs-representationdocument-properties-id.md "applications-representation.schema.json#/$defs/representationDocument/properties/id") |
|
|
692
|
+
| [representationId](#representationid) | `string` | Required | cannot be null | [Casework Representation Schema](applications-representation-defs-representationdocument-properties-representationid.md "applications-representation.schema.json#/$defs/representationDocument/properties/representationId") |
|
|
693
|
+
| [itemId](#itemid) | `string` | Required | cannot be null | [Casework Representation Schema](applications-representation-defs-representationdocument-properties-itemid.md "applications-representation.schema.json#/$defs/representationDocument/properties/itemId") |
|
|
694
|
+
| [fileName](#filename) | `string` | Required | cannot be null | [Casework Representation Schema](applications-representation-defs-representationdocument-properties-filename.md "applications-representation.schema.json#/$defs/representationDocument/properties/fileName") |
|
|
695
|
+
| [redactedItemId](#redacteditemid) | `string` | Optional | can be null | [Casework Representation Schema](applications-representation-defs-representationdocument-properties-redacteditemid.md "applications-representation.schema.json#/$defs/representationDocument/properties/redactedItemId") |
|
|
696
|
+
| [redactedFileName](#redactedfilename) | `string` | Optional | can be null | [Casework Representation Schema](applications-representation-defs-representationdocument-properties-redactedfilename.md "applications-representation.schema.json#/$defs/representationDocument/properties/redactedFileName") |
|
|
697
|
+
| [status](#status) | `string` | Required | cannot be null | [Casework Representation Schema](applications-representation-defs-representationdocument-properties-status.md "applications-representation.schema.json#/$defs/representationDocument/properties/status") |
|
|
698
698
|
|
|
699
699
|
### id
|
|
700
700
|
|
|
@@ -708,7 +708,7 @@ Source Key for Representation Document
|
|
|
708
708
|
|
|
709
709
|
* cannot be null
|
|
710
710
|
|
|
711
|
-
* defined in: [Casework Representation Schema](applications-representation-
|
|
711
|
+
* defined in: [Casework Representation Schema](applications-representation-defs-representationdocument-properties-id.md "applications-representation.schema.json#/$defs/representationDocument/properties/id")
|
|
712
712
|
|
|
713
713
|
#### id Type
|
|
714
714
|
|
|
@@ -726,7 +726,7 @@ The representation this relates to
|
|
|
726
726
|
|
|
727
727
|
* cannot be null
|
|
728
728
|
|
|
729
|
-
* defined in: [Casework Representation Schema](applications-representation-
|
|
729
|
+
* defined in: [Casework Representation Schema](applications-representation-defs-representationdocument-properties-representationid.md "applications-representation.schema.json#/$defs/representationDocument/properties/representationId")
|
|
730
730
|
|
|
731
731
|
#### representationId Type
|
|
732
732
|
|
|
@@ -744,7 +744,7 @@ The id of the item in SharePoint
|
|
|
744
744
|
|
|
745
745
|
* cannot be null
|
|
746
746
|
|
|
747
|
-
* defined in: [Casework Representation Schema](applications-representation-
|
|
747
|
+
* defined in: [Casework Representation Schema](applications-representation-defs-representationdocument-properties-itemid.md "applications-representation.schema.json#/$defs/representationDocument/properties/itemId")
|
|
748
748
|
|
|
749
749
|
#### itemId Type
|
|
750
750
|
|
|
@@ -762,7 +762,7 @@ The name of the file
|
|
|
762
762
|
|
|
763
763
|
* cannot be null
|
|
764
764
|
|
|
765
|
-
* defined in: [Casework Representation Schema](applications-representation-
|
|
765
|
+
* defined in: [Casework Representation Schema](applications-representation-defs-representationdocument-properties-filename.md "applications-representation.schema.json#/$defs/representationDocument/properties/fileName")
|
|
766
766
|
|
|
767
767
|
#### fileName Type
|
|
768
768
|
|
|
@@ -780,7 +780,7 @@ The id of the redacted version of the item in sharepoint
|
|
|
780
780
|
|
|
781
781
|
* can be null
|
|
782
782
|
|
|
783
|
-
* defined in: [Casework Representation Schema](applications-representation-
|
|
783
|
+
* defined in: [Casework Representation Schema](applications-representation-defs-representationdocument-properties-redacteditemid.md "applications-representation.schema.json#/$defs/representationDocument/properties/redactedItemId")
|
|
784
784
|
|
|
785
785
|
#### redactedItemId Type
|
|
786
786
|
|
|
@@ -798,7 +798,7 @@ the name of the redacted file
|
|
|
798
798
|
|
|
799
799
|
* can be null
|
|
800
800
|
|
|
801
|
-
* defined in: [Casework Representation Schema](applications-representation-
|
|
801
|
+
* defined in: [Casework Representation Schema](applications-representation-defs-representationdocument-properties-redactedfilename.md "applications-representation.schema.json#/$defs/representationDocument/properties/redactedFileName")
|
|
802
802
|
|
|
803
803
|
#### redactedFileName Type
|
|
804
804
|
|
|
@@ -816,7 +816,7 @@ The status of the document
|
|
|
816
816
|
|
|
817
817
|
* cannot be null
|
|
818
818
|
|
|
819
|
-
* defined in: [Casework Representation Schema](applications-representation-
|
|
819
|
+
* defined in: [Casework Representation Schema](applications-representation-defs-representationdocument-properties-status.md "applications-representation.schema.json#/$defs/representationDocument/properties/status")
|
|
820
820
|
|
|
821
821
|
#### status Type
|
|
822
822
|
|
package/package.json
CHANGED
|
@@ -31,6 +31,8 @@ class CaseStatus(StrEnum):
|
|
|
31
31
|
transferred = "transferred"
|
|
32
32
|
event = "event"
|
|
33
33
|
awaiting_event = "awaiting_event"
|
|
34
|
+
notice_withdrawn = "notice_withdrawn"
|
|
35
|
+
closed_opened_in_error = "closed_opened_in_error"
|
|
34
36
|
|
|
35
37
|
|
|
36
38
|
class CaseType(StrEnum):
|
|
@@ -394,6 +396,52 @@ class ApplicationElbAppealGroundsDetail(BaseModel):
|
|
|
394
396
|
"""
|
|
395
397
|
|
|
396
398
|
|
|
399
|
+
class AppealGroundLetter2(Enum):
|
|
400
|
+
a = "a"
|
|
401
|
+
b = "b"
|
|
402
|
+
c = "c"
|
|
403
|
+
d = "d"
|
|
404
|
+
e = "e"
|
|
405
|
+
f = "f"
|
|
406
|
+
g = "g"
|
|
407
|
+
NoneType_None = None
|
|
408
|
+
|
|
409
|
+
|
|
410
|
+
class EnforcementCaseGroundsOfAppealItem(BaseModel):
|
|
411
|
+
model_config = ConfigDict(
|
|
412
|
+
extra="allow",
|
|
413
|
+
)
|
|
414
|
+
appealGroundLetter: AppealGroundLetter2 | None = None
|
|
415
|
+
groundForAppealStartDate: AwareDatetime | None = Field(
|
|
416
|
+
None, examples=["2023-07-27T20:30:00.000Z"]
|
|
417
|
+
)
|
|
418
|
+
|
|
419
|
+
|
|
420
|
+
class AppealGroundLetter3(Enum):
|
|
421
|
+
a = "a"
|
|
422
|
+
b = "b"
|
|
423
|
+
c = "c"
|
|
424
|
+
d = "d"
|
|
425
|
+
e = "e"
|
|
426
|
+
f = "f"
|
|
427
|
+
g = "g"
|
|
428
|
+
h = "h"
|
|
429
|
+
i = "i"
|
|
430
|
+
j = "j"
|
|
431
|
+
k = "k"
|
|
432
|
+
NoneType_None = None
|
|
433
|
+
|
|
434
|
+
|
|
435
|
+
class ElbCaseGroundsOfAppealItem(BaseModel):
|
|
436
|
+
model_config = ConfigDict(
|
|
437
|
+
extra="allow",
|
|
438
|
+
)
|
|
439
|
+
appealGroundLetter: AppealGroundLetter3 | None = None
|
|
440
|
+
groundForAppealStartDate: AwareDatetime | None = Field(
|
|
441
|
+
None, examples=["2023-07-27T20:30:00.000Z"]
|
|
442
|
+
)
|
|
443
|
+
|
|
444
|
+
|
|
397
445
|
class ApplicationPartOrWholeDevelopment(Enum):
|
|
398
446
|
"""
|
|
399
447
|
Did the application relate to all or part of the development
|
|
@@ -1099,6 +1147,16 @@ class AppealS78Case1(BaseModel):
|
|
|
1099
1147
|
"""
|
|
1100
1148
|
A list of grounds for the appeal, supporting facts & start dates. Enforcement cases (C) can have grounds (a) to (g)
|
|
1101
1149
|
"""
|
|
1150
|
+
enforcementCaseGroundsOfAppeal: list[EnforcementCaseGroundsOfAppealItem] | None = (
|
|
1151
|
+
None
|
|
1152
|
+
)
|
|
1153
|
+
"""
|
|
1154
|
+
Case Officer list of grounds for the appeal & start dates. Enforcement cases (C) can have grounds (a) to (g)
|
|
1155
|
+
"""
|
|
1156
|
+
elbCaseGroundsOfAppeal: list[ElbCaseGroundsOfAppealItem] | None = None
|
|
1157
|
+
"""
|
|
1158
|
+
Case Officer list of grounds for the appeal & start dates. Enforcement cases (C) can have grounds (a) to (g)
|
|
1159
|
+
"""
|
|
1102
1160
|
applicationMadeAndFeePaid: bool | None = None
|
|
1103
1161
|
"""
|
|
1104
1162
|
Was an application made and paid for
|
|
@@ -1223,7 +1281,7 @@ class AdvertDetail1(BaseModel):
|
|
|
1223
1281
|
"""
|
|
1224
1282
|
|
|
1225
1283
|
|
|
1226
|
-
class
|
|
1284
|
+
class AppealGroundLetter4(Enum):
|
|
1227
1285
|
a = "a"
|
|
1228
1286
|
b = "b"
|
|
1229
1287
|
c = "c"
|
|
@@ -1238,7 +1296,7 @@ class EnforcementAppealGroundsDetail1(BaseModel):
|
|
|
1238
1296
|
model_config = ConfigDict(
|
|
1239
1297
|
extra="allow",
|
|
1240
1298
|
)
|
|
1241
|
-
appealGroundLetter:
|
|
1299
|
+
appealGroundLetter: AppealGroundLetter4 | None = None
|
|
1242
1300
|
groundForAppealStartDate: AwareDatetime | None = Field(
|
|
1243
1301
|
None, examples=["2023-07-27T20:30:00.000Z"]
|
|
1244
1302
|
)
|
|
@@ -1248,7 +1306,7 @@ class EnforcementAppealGroundsDetail1(BaseModel):
|
|
|
1248
1306
|
"""
|
|
1249
1307
|
|
|
1250
1308
|
|
|
1251
|
-
class
|
|
1309
|
+
class AppealGroundLetter5(Enum):
|
|
1252
1310
|
a = "a"
|
|
1253
1311
|
b = "b"
|
|
1254
1312
|
c = "c"
|
|
@@ -1267,7 +1325,7 @@ class ApplicationElbAppealGroundsDetail1(BaseModel):
|
|
|
1267
1325
|
model_config = ConfigDict(
|
|
1268
1326
|
extra="allow",
|
|
1269
1327
|
)
|
|
1270
|
-
appealGroundLetter:
|
|
1328
|
+
appealGroundLetter: AppealGroundLetter5 | None = None
|
|
1271
1329
|
groundForAppealStartDate: AwareDatetime | None = Field(
|
|
1272
1330
|
None, examples=["2023-07-27T20:30:00.000Z"]
|
|
1273
1331
|
)
|
|
@@ -1277,6 +1335,52 @@ class ApplicationElbAppealGroundsDetail1(BaseModel):
|
|
|
1277
1335
|
"""
|
|
1278
1336
|
|
|
1279
1337
|
|
|
1338
|
+
class AppealGroundLetter6(Enum):
|
|
1339
|
+
a = "a"
|
|
1340
|
+
b = "b"
|
|
1341
|
+
c = "c"
|
|
1342
|
+
d = "d"
|
|
1343
|
+
e = "e"
|
|
1344
|
+
f = "f"
|
|
1345
|
+
g = "g"
|
|
1346
|
+
NoneType_None = None
|
|
1347
|
+
|
|
1348
|
+
|
|
1349
|
+
class EnforcementCaseGroundsOfAppealItem1(BaseModel):
|
|
1350
|
+
model_config = ConfigDict(
|
|
1351
|
+
extra="allow",
|
|
1352
|
+
)
|
|
1353
|
+
appealGroundLetter: AppealGroundLetter6 | None = None
|
|
1354
|
+
groundForAppealStartDate: AwareDatetime | None = Field(
|
|
1355
|
+
None, examples=["2023-07-27T20:30:00.000Z"]
|
|
1356
|
+
)
|
|
1357
|
+
|
|
1358
|
+
|
|
1359
|
+
class AppealGroundLetter7(Enum):
|
|
1360
|
+
a = "a"
|
|
1361
|
+
b = "b"
|
|
1362
|
+
c = "c"
|
|
1363
|
+
d = "d"
|
|
1364
|
+
e = "e"
|
|
1365
|
+
f = "f"
|
|
1366
|
+
g = "g"
|
|
1367
|
+
h = "h"
|
|
1368
|
+
i = "i"
|
|
1369
|
+
j = "j"
|
|
1370
|
+
k = "k"
|
|
1371
|
+
NoneType_None = None
|
|
1372
|
+
|
|
1373
|
+
|
|
1374
|
+
class ElbCaseGroundsOfAppealItem1(BaseModel):
|
|
1375
|
+
model_config = ConfigDict(
|
|
1376
|
+
extra="allow",
|
|
1377
|
+
)
|
|
1378
|
+
appealGroundLetter: AppealGroundLetter7 | None = None
|
|
1379
|
+
groundForAppealStartDate: AwareDatetime | None = Field(
|
|
1380
|
+
None, examples=["2023-07-27T20:30:00.000Z"]
|
|
1381
|
+
)
|
|
1382
|
+
|
|
1383
|
+
|
|
1280
1384
|
class SignificantChangesAffectingApplicationAppellantItem1(BaseModel):
|
|
1281
1385
|
value: Value | None
|
|
1282
1386
|
comment: str | None = None
|
|
@@ -1941,6 +2045,16 @@ class AppealS78Case2(BaseModel):
|
|
|
1941
2045
|
"""
|
|
1942
2046
|
A list of grounds for the appeal, supporting facts & start dates. Enforcement cases (C) can have grounds (a) to (g)
|
|
1943
2047
|
"""
|
|
2048
|
+
enforcementCaseGroundsOfAppeal: list[EnforcementCaseGroundsOfAppealItem1] | None = (
|
|
2049
|
+
None
|
|
2050
|
+
)
|
|
2051
|
+
"""
|
|
2052
|
+
Case Officer list of grounds for the appeal & start dates. Enforcement cases (C) can have grounds (a) to (g)
|
|
2053
|
+
"""
|
|
2054
|
+
elbCaseGroundsOfAppeal: list[ElbCaseGroundsOfAppealItem1] | None = None
|
|
2055
|
+
"""
|
|
2056
|
+
Case Officer list of grounds for the appeal & start dates. Enforcement cases (C) can have grounds (a) to (g)
|
|
2057
|
+
"""
|
|
1944
2058
|
applicationMadeAndFeePaid: bool | None = None
|
|
1945
2059
|
"""
|
|
1946
2060
|
Was an application made and paid for
|
|
@@ -102,7 +102,7 @@ class EmailNotificationRecordSchema(BaseModel):
|
|
|
102
102
|
"""
|
|
103
103
|
Planning Body code
|
|
104
104
|
"""
|
|
105
|
-
emailStatus: EmailStatus
|
|
105
|
+
emailStatus: EmailStatus = Field(..., examples=["Delivered"])
|
|
106
106
|
"""
|
|
107
107
|
Outcome of the email (status)
|
|
108
108
|
"""
|
|
@@ -151,10 +151,10 @@ class CaseworkRepresentationSchema(BaseModel):
|
|
|
151
151
|
"""
|
|
152
152
|
The type of case this representation is for.
|
|
153
153
|
"""
|
|
154
|
-
representationStatus: RepresentationStatus
|
|
154
|
+
representationStatus: RepresentationStatus
|
|
155
155
|
submittedFor: SubmittedFor
|
|
156
156
|
submittedByContact: list[Contact] | None = None
|
|
157
|
-
|
|
157
|
+
submittedByAgent: bool | None = None
|
|
158
158
|
submittedByAgentOrgName: str | None = None
|
|
159
159
|
submittedDate: AwareDatetime
|
|
160
160
|
submittedReceivedMethod: SubmittedReceivedMethod | None = None
|
|
@@ -196,7 +196,9 @@
|
|
|
196
196
|
"awaiting_transfer",
|
|
197
197
|
"transferred",
|
|
198
198
|
"event",
|
|
199
|
-
"awaiting_event"
|
|
199
|
+
"awaiting_event",
|
|
200
|
+
"notice_withdrawn",
|
|
201
|
+
"closed_opened_in_error"
|
|
200
202
|
],
|
|
201
203
|
"description": "The processing status for the appeal",
|
|
202
204
|
"$comment": "Also available on HAS cases"
|
|
@@ -1214,6 +1216,46 @@
|
|
|
1214
1216
|
"description": "A list of grounds for the appeal, supporting facts & start dates. Enforcement cases (C) can have grounds (a) to (g)",
|
|
1215
1217
|
"$comment": "Enforcement Listed Building cases (F) have a separate list of grounds (a) to (k)"
|
|
1216
1218
|
},
|
|
1219
|
+
"enforcementCaseGroundsOfAppeal": {
|
|
1220
|
+
"type": ["array", "null"],
|
|
1221
|
+
"items": {
|
|
1222
|
+
"type": "object",
|
|
1223
|
+
"additionalProperties": true,
|
|
1224
|
+
"properties": {
|
|
1225
|
+
"appealGroundLetter": {
|
|
1226
|
+
"type": ["string", "null"],
|
|
1227
|
+
"enum": ["a", "b", "c", "d", "e", "f", "g", null]
|
|
1228
|
+
},
|
|
1229
|
+
"groundForAppealStartDate": {
|
|
1230
|
+
"type": ["string", "null"],
|
|
1231
|
+
"format": "date-time",
|
|
1232
|
+
"examples": ["2023-07-27T20:30:00.000Z"]
|
|
1233
|
+
}
|
|
1234
|
+
}
|
|
1235
|
+
},
|
|
1236
|
+
"description": "Case Officer list of grounds for the appeal & start dates. Enforcement cases (C) can have grounds (a) to (g)",
|
|
1237
|
+
"$comment": "Enforcement Listed Building cases (F) have a separate list of grounds (a) to (k)"
|
|
1238
|
+
},
|
|
1239
|
+
"elbCaseGroundsOfAppeal": {
|
|
1240
|
+
"type": ["array", "null"],
|
|
1241
|
+
"items": {
|
|
1242
|
+
"type": "object",
|
|
1243
|
+
"additionalProperties": true,
|
|
1244
|
+
"properties": {
|
|
1245
|
+
"appealGroundLetter": {
|
|
1246
|
+
"type": ["string", "null"],
|
|
1247
|
+
"enum": ["a", "b", "c", "d", "e", "f", "g", "h", "i", "j", "k", null]
|
|
1248
|
+
},
|
|
1249
|
+
"groundForAppealStartDate": {
|
|
1250
|
+
"type": ["string", "null"],
|
|
1251
|
+
"format": "date-time",
|
|
1252
|
+
"examples": ["2023-07-27T20:30:00.000Z"]
|
|
1253
|
+
}
|
|
1254
|
+
}
|
|
1255
|
+
},
|
|
1256
|
+
"description": "Case Officer list of grounds for the appeal & start dates. Enforcement cases (C) can have grounds (a) to (g)",
|
|
1257
|
+
"$comment": "Enforcement Listed Building cases (F) have a separate list of grounds (a) to (k)"
|
|
1258
|
+
},
|
|
1217
1259
|
"applicationMadeAndFeePaid": {
|
|
1218
1260
|
"type": ["boolean", "null"],
|
|
1219
1261
|
"description": "Was an application made and paid for"
|
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
"description": "Email Notifications for Casework Projects",
|
|
6
6
|
"type": "object",
|
|
7
7
|
"additionalProperties": true,
|
|
8
|
-
"required": ["id", "caseReference", "caseId", "caseType", "
|
|
8
|
+
"required": ["id", "caseReference", "caseId", "caseType", "emailStatus", "lpaCode"],
|
|
9
9
|
"properties": {
|
|
10
10
|
"id": {
|
|
11
11
|
"type": "string",
|
|
@@ -11,7 +11,7 @@
|
|
|
11
11
|
"caseReference",
|
|
12
12
|
"caseId",
|
|
13
13
|
"caseType",
|
|
14
|
-
"
|
|
14
|
+
"representationStatus",
|
|
15
15
|
"submittedFor",
|
|
16
16
|
"submittedDate",
|
|
17
17
|
"comment"
|
|
@@ -52,10 +52,10 @@
|
|
|
52
52
|
"submittedByContact": {
|
|
53
53
|
"type": ["array", "null"],
|
|
54
54
|
"items": {
|
|
55
|
-
"$ref": "
|
|
55
|
+
"$ref": "#/$defs/contact"
|
|
56
56
|
}
|
|
57
57
|
},
|
|
58
|
-
"
|
|
58
|
+
"submittedByAgent": {
|
|
59
59
|
"type": ["boolean", "null"]
|
|
60
60
|
},
|
|
61
61
|
"submittedByAgentOrgName": {
|
|
@@ -92,7 +92,7 @@
|
|
|
92
92
|
"representedContact": {
|
|
93
93
|
"type": ["array", "null"],
|
|
94
94
|
"items": {
|
|
95
|
-
"$ref": "
|
|
95
|
+
"$ref": "#/$defs/contact"
|
|
96
96
|
},
|
|
97
97
|
"description": "When representation is on behalf of a person/org/group"
|
|
98
98
|
},
|
|
@@ -134,11 +134,11 @@
|
|
|
134
134
|
"representationDocuments": {
|
|
135
135
|
"type": ["array", "null"],
|
|
136
136
|
"items": {
|
|
137
|
-
"$ref": "
|
|
137
|
+
"$ref": "#/$defs/representationDocument"
|
|
138
138
|
}
|
|
139
139
|
}
|
|
140
140
|
},
|
|
141
|
-
"
|
|
141
|
+
"$defs": {
|
|
142
142
|
"contact": {
|
|
143
143
|
"type": "object",
|
|
144
144
|
"required": ["contactId"],
|