@planning-inspectorate/data-model 2.51.1 → 2.52.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 (12) hide show
  1. package/docs/README.md +2 -2
  2. package/docs/applications-notify-email.md +2 -2
  3. package/docs/applications-representation-defs-contact.md +93 -0
  4. package/docs/applications-representation-defs-representationdocument.md +152 -0
  5. package/docs/applications-representation-defs.md +3 -0
  6. package/docs/applications-representation.md +41 -41
  7. package/package.json +1 -1
  8. package/pins_data_model/models/model_applications_notify_email.py +1 -1
  9. package/pins_data_model/models/model_applications_representation.py +2 -2
  10. package/schemas/applications-notify-email.schema.json +1 -1
  11. package/schemas/applications-representation.schema.json +6 -6
  12. package/src/schemas.d.ts +3 -3
package/docs/README.md CHANGED
@@ -84,9 +84,9 @@
84
84
 
85
85
  * [Untitled object in Appeal S78 Case](./appeal-s78-properties-significantchangesaffectingapplicationlpa-items.md) – `appeal-s78.schema.json#/properties/significantChangesAffectingApplicationLpa/items`
86
86
 
87
- * [Untitled object in Casework Representation Schema](./applications-representation-definitions-contact.md) – `applications-representation.schema.json#/definitions/contact`
87
+ * [Untitled object in Casework Representation Schema](./applications-representation-defs-contact.md) – `applications-representation.schema.json#/$defs/contact`
88
88
 
89
- * [Untitled object in Casework Representation Schema](./applications-representation-definitions-representationdocument.md) – `applications-representation.schema.json#/definitions/representationDocument`
89
+ * [Untitled object in Casework Representation Schema](./applications-representation-defs-representationdocument.md) – `applications-representation.schema.json#/$defs/representationDocument`
90
90
 
91
91
  * [Untitled object in Crown Development Application](./applications-application-defs-organisation.md) – `applications-application.schema.json#/$defs/organisation`
92
92
 
package/docs/applications-notify-email.md CHANGED
@@ -18,7 +18,7 @@
18
18
  | [email](#email) | `string` | Optional | can be null | [Email Notification Record Schema](applications-notify-email-properties-email.md "applications-notify-email.schema.json#/properties/email") |
19
19
  | [contact](#contact) | `array` | Optional | can be null | [Email Notification Record Schema](applications-notify-email-properties-contact.md "applications-notify-email.schema.json#/properties/contact") |
20
20
  | [lpaCode](#lpacode) | `string` | Required | cannot be null | [Email Notification Record Schema](applications-notify-email-properties-lpacode.md "applications-notify-email.schema.json#/properties/lpaCode") |
21
- | [emailStatus](#emailstatus) | `string` | Optional | cannot be null | [Email Notification Record Schema](applications-notify-email-properties-emailstatus.md "applications-notify-email.schema.json#/properties/emailStatus") |
21
+ | [emailStatus](#emailstatus) | `string` | Required | cannot be null | [Email Notification Record Schema](applications-notify-email-properties-emailstatus.md "applications-notify-email.schema.json#/properties/emailStatus") |
22
22
  | [templateId](#templateid) | `string` | Optional | can be null | [Email Notification Record Schema](applications-notify-email-properties-templateid.md "applications-notify-email.schema.json#/properties/templateId") |
23
23
  | [templateVersion](#templateversion) | `integer` | Optional | can be null | [Email Notification Record Schema](applications-notify-email-properties-templateversion.md "applications-notify-email.schema.json#/properties/templateVersion") |
24
24
  | [body](#body) | `string` | Optional | can be null | [Email Notification Record Schema](applications-notify-email-properties-body.md "applications-notify-email.schema.json#/properties/body") |
@@ -259,7 +259,7 @@ Outcome of the email (status)
259
259
 
260
260
  `emailStatus`
261
261
 
262
- * is optional
262
+ * is required
263
263
 
264
264
  * Type: `string`
265
265
 
package/docs/applications-representation-defs-contact.md ADDED
@@ -0,0 +1,93 @@
1
+ ## contact Type
2
+
3
+ `object` ([Details](applications-representation-defs-contact.md))
4
+
5
+ # contact Properties
6
+
7
+ | Property | Type | Required | Nullable | Defined by |
8
+ | :---------------------------------------------------- | :------- | :------- | :------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
9
+ | [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") |
10
+ | [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") |
11
+ | [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") |
12
+ | [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") |
13
+
14
+ ## contactId
15
+
16
+ Source PK for Contact
17
+
18
+ `contactId`
19
+
20
+ * is required
21
+
22
+ * Type: `string`
23
+
24
+ * cannot be null
25
+
26
+ * defined in: [Casework Representation Schema](applications-representation-defs-contact-properties-contactid.md "applications-representation.schema.json#/$defs/contact/properties/contactId")
27
+
28
+ ### contactId Type
29
+
30
+ `string`
31
+
32
+ ## contactPreference
33
+
34
+
35
+
36
+ `contactPreference`
37
+
38
+ * is optional
39
+
40
+ * Type: `string`
41
+
42
+ * can be null
43
+
44
+ * defined in: [Casework Representation Schema](applications-representation-defs-contact-properties-contactpreference.md "applications-representation.schema.json#/$defs/contact/properties/contactPreference")
45
+
46
+ ### contactPreference Type
47
+
48
+ `string`
49
+
50
+ ### contactPreference Constraints
51
+
52
+ **enum**: the value of this property must be equal to one of the following values:
53
+
54
+ | Value | Explanation |
55
+ | :-------- | :---------- |
56
+ | `"email"` | |
57
+ | `"post"` | |
58
+
59
+ ## writtenRepOrgName
60
+
61
+
62
+
63
+ `writtenRepOrgName`
64
+
65
+ * is optional
66
+
67
+ * Type: `string`
68
+
69
+ * can be null
70
+
71
+ * defined in: [Casework Representation Schema](applications-representation-defs-contact-properties-writtenreporgname.md "applications-representation.schema.json#/$defs/contact/properties/writtenRepOrgName")
72
+
73
+ ### writtenRepOrgName Type
74
+
75
+ `string`
76
+
77
+ ## writtenRepJobTitleorRole
78
+
79
+
80
+
81
+ `writtenRepJobTitleorRole`
82
+
83
+ * is optional
84
+
85
+ * Type: `string`
86
+
87
+ * can be null
88
+
89
+ * defined in: [Casework Representation Schema](applications-representation-defs-contact-properties-writtenrepjobtitleorrole.md "applications-representation.schema.json#/$defs/contact/properties/writtenRepJobTitleorRole")
90
+
91
+ ### writtenRepJobTitleorRole Type
92
+
93
+ `string`
package/docs/applications-representation-defs-representationdocument.md ADDED
@@ -0,0 +1,152 @@
1
+ ## representationDocument Type
2
+
3
+ `object` ([Details](applications-representation-defs-representationdocument.md))
4
+
5
+ # representationDocument Properties
6
+
7
+ | Property | Type | Required | Nullable | Defined by |
8
+ | :------------------------------------ | :------- | :------- | :------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
9
+ | [id](#id) | `string` | Required | cannot be null | [Casework Representation Schema](applications-representation-defs-representationdocument-properties-id.md "applications-representation.schema.json#/$defs/representationDocument/properties/id") |
10
+ | [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") |
11
+ | [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") |
12
+ | [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") |
13
+ | [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") |
14
+ | [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") |
15
+ | [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") |
16
+
17
+ ## id
18
+
19
+ Source Key for Representation Document
20
+
21
+ `id`
22
+
23
+ * is required
24
+
25
+ * Type: `string`
26
+
27
+ * cannot be null
28
+
29
+ * defined in: [Casework Representation Schema](applications-representation-defs-representationdocument-properties-id.md "applications-representation.schema.json#/$defs/representationDocument/properties/id")
30
+
31
+ ### id Type
32
+
33
+ `string`
34
+
35
+ ## representationId
36
+
37
+ The representation this relates to
38
+
39
+ `representationId`
40
+
41
+ * is required
42
+
43
+ * Type: `string`
44
+
45
+ * cannot be null
46
+
47
+ * defined in: [Casework Representation Schema](applications-representation-defs-representationdocument-properties-representationid.md "applications-representation.schema.json#/$defs/representationDocument/properties/representationId")
48
+
49
+ ### representationId Type
50
+
51
+ `string`
52
+
53
+ ## itemId
54
+
55
+ The id of the item in SharePoint
56
+
57
+ `itemId`
58
+
59
+ * is required
60
+
61
+ * Type: `string`
62
+
63
+ * cannot be null
64
+
65
+ * defined in: [Casework Representation Schema](applications-representation-defs-representationdocument-properties-itemid.md "applications-representation.schema.json#/$defs/representationDocument/properties/itemId")
66
+
67
+ ### itemId Type
68
+
69
+ `string`
70
+
71
+ ## fileName
72
+
73
+ The name of the file
74
+
75
+ `fileName`
76
+
77
+ * is required
78
+
79
+ * Type: `string`
80
+
81
+ * cannot be null
82
+
83
+ * defined in: [Casework Representation Schema](applications-representation-defs-representationdocument-properties-filename.md "applications-representation.schema.json#/$defs/representationDocument/properties/fileName")
84
+
85
+ ### fileName Type
86
+
87
+ `string`
88
+
89
+ ## redactedItemId
90
+
91
+ The id of the redacted version of the item in sharepoint
92
+
93
+ `redactedItemId`
94
+
95
+ * is optional
96
+
97
+ * Type: `string`
98
+
99
+ * can be null
100
+
101
+ * defined in: [Casework Representation Schema](applications-representation-defs-representationdocument-properties-redacteditemid.md "applications-representation.schema.json#/$defs/representationDocument/properties/redactedItemId")
102
+
103
+ ### redactedItemId Type
104
+
105
+ `string`
106
+
107
+ ## redactedFileName
108
+
109
+ the name of the redacted file
110
+
111
+ `redactedFileName`
112
+
113
+ * is optional
114
+
115
+ * Type: `string`
116
+
117
+ * can be null
118
+
119
+ * defined in: [Casework Representation Schema](applications-representation-defs-representationdocument-properties-redactedfilename.md "applications-representation.schema.json#/$defs/representationDocument/properties/redactedFileName")
120
+
121
+ ### redactedFileName Type
122
+
123
+ `string`
124
+
125
+ ## status
126
+
127
+ The status of the document
128
+
129
+ `status`
130
+
131
+ * is required
132
+
133
+ * Type: `string`
134
+
135
+ * cannot be null
136
+
137
+ * defined in: [Casework Representation Schema](applications-representation-defs-representationdocument-properties-status.md "applications-representation.schema.json#/$defs/representationDocument/properties/status")
138
+
139
+ ### status Type
140
+
141
+ `string`
142
+
143
+ ### status Constraints
144
+
145
+ **enum**: the value of this property must be equal to one of the following values:
146
+
147
+ | Value | Explanation |
148
+ | :------------------ | :---------- |
149
+ | `"Awaiting review"` | |
150
+ | `"Accepted"` | |
151
+ | `"Rejected"` | |
152
+ | `"Withdrawn"` | |
package/docs/applications-representation-defs.md ADDED
@@ -0,0 +1,3 @@
1
+ ## $defs Type
2
+
3
+ unknown
package/docs/applications-representation.md CHANGED
@@ -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` | Optional | cannot be null | [Casework Representation Schema](applications-representation-properties-representationstatus.md "applications-representation.schema.json#/properties/representationStatus") |
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
- | [submittedByAgentFlag](#submittedbyagentflag) | `boolean` | Optional | can be null | [Casework Representation Schema](applications-representation-properties-submittedbyagentflag.md "applications-representation.schema.json#/properties/submittedByAgentFlag") |
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 optional
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-definitions-contact.md))
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-definitions-contact.md))
199
+ `object[]` ([Details](applications-representation-defs-contact.md))
200
200
 
201
- ## submittedByAgentFlag
201
+ ## submittedByAgent
202
202
 
203
203
 
204
204
 
205
- `submittedByAgentFlag`
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-submittedbyagentflag.md "applications-representation.schema.json#/properties/submittedByAgentFlag")
213
+ * defined in: [Casework Representation Schema](applications-representation-properties-submittedbyagent.md "applications-representation.schema.json#/properties/submittedByAgent")
214
214
 
215
- ### submittedByAgentFlag Type
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-definitions-contact.md))
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-definitions-contact.md))
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-definitions-representationdocument.md))
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-definitions-representationdocument.md))
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#/definitions/contact"}
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-definitions-contact-properties-contactid.md "applications-representation.schema.json#/definitions/contact/properties/contactId") |
596
- | [contactPreference](#contactpreference) | `string` | Optional | can be null | [Casework Representation Schema](applications-representation-definitions-contact-properties-contactpreference.md "applications-representation.schema.json#/definitions/contact/properties/contactPreference") |
597
- | [writtenRepOrgName](#writtenreporgname) | `string` | Optional | can be null | [Casework Representation Schema](applications-representation-definitions-contact-properties-writtenreporgname.md "applications-representation.schema.json#/definitions/contact/properties/writtenRepOrgName") |
598
- | [writtenRepJobTitleorRole](#writtenrepjobtitleorrole) | `string` | Optional | can be null | [Casework Representation Schema](applications-representation-definitions-contact-properties-writtenrepjobtitleorrole.md "applications-representation.schema.json#/definitions/contact/properties/writtenRepJobTitleorRole") |
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-definitions-contact-properties-contactid.md "applications-representation.schema.json#/definitions/contact/properties/contactId")
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-definitions-contact-properties-contactpreference.md "applications-representation.schema.json#/definitions/contact/properties/contactPreference")
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-definitions-contact-properties-writtenreporgname.md "applications-representation.schema.json#/definitions/contact/properties/writtenRepOrgName")
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-definitions-contact-properties-writtenrepjobtitleorrole.md "applications-representation.schema.json#/definitions/contact/properties/writtenRepJobTitleorRole")
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#/definitions/representationDocument"}
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-definitions-representationdocument-properties-id.md "applications-representation.schema.json#/definitions/representationDocument/properties/id") |
692
- | [representationId](#representationid) | `string` | Required | cannot be null | [Casework Representation Schema](applications-representation-definitions-representationdocument-properties-representationid.md "applications-representation.schema.json#/definitions/representationDocument/properties/representationId") |
693
- | [itemId](#itemid) | `string` | Required | cannot be null | [Casework Representation Schema](applications-representation-definitions-representationdocument-properties-itemid.md "applications-representation.schema.json#/definitions/representationDocument/properties/itemId") |
694
- | [fileName](#filename) | `string` | Required | cannot be null | [Casework Representation Schema](applications-representation-definitions-representationdocument-properties-filename.md "applications-representation.schema.json#/definitions/representationDocument/properties/fileName") |
695
- | [redactedItemId](#redacteditemid) | `string` | Optional | can be null | [Casework Representation Schema](applications-representation-definitions-representationdocument-properties-redacteditemid.md "applications-representation.schema.json#/definitions/representationDocument/properties/redactedItemId") |
696
- | [redactedFileName](#redactedfilename) | `string` | Optional | can be null | [Casework Representation Schema](applications-representation-definitions-representationdocument-properties-redactedfilename.md "applications-representation.schema.json#/definitions/representationDocument/properties/redactedFileName") |
697
- | [status](#status) | `string` | Required | cannot be null | [Casework Representation Schema](applications-representation-definitions-representationdocument-properties-status.md "applications-representation.schema.json#/definitions/representationDocument/properties/status") |
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-definitions-representationdocument-properties-id.md "applications-representation.schema.json#/definitions/representationDocument/properties/id")
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-definitions-representationdocument-properties-representationid.md "applications-representation.schema.json#/definitions/representationDocument/properties/representationId")
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-definitions-representationdocument-properties-itemid.md "applications-representation.schema.json#/definitions/representationDocument/properties/itemId")
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-definitions-representationdocument-properties-filename.md "applications-representation.schema.json#/definitions/representationDocument/properties/fileName")
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-definitions-representationdocument-properties-redacteditemid.md "applications-representation.schema.json#/definitions/representationDocument/properties/redactedItemId")
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-definitions-representationdocument-properties-redactedfilename.md "applications-representation.schema.json#/definitions/representationDocument/properties/redactedFileName")
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-definitions-representationdocument-properties-status.md "applications-representation.schema.json#/definitions/representationDocument/properties/status")
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
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@planning-inspectorate/data-model",
3
- "version": "2.51.1",
3
+ "version": "2.52.0",
4
4
  "description": "JSON Schemas for the Planning Inspectorate's Data Model",
5
5
  "main": "src/index.js",
6
6
  "type": "module",
package/pins_data_model/models/model_applications_notify_email.py CHANGED
@@ -102,7 +102,7 @@ class EmailNotificationRecordSchema(BaseModel):
102
102
  """
103
103
  Planning Body code
104
104
  """
105
- emailStatus: EmailStatus | None = Field(None, examples=["Delivered"])
105
+ emailStatus: EmailStatus = Field(..., examples=["Delivered"])
106
106
  """
107
107
  Outcome of the email (status)
108
108
  """
package/pins_data_model/models/model_applications_representation.py CHANGED
@@ -151,10 +151,10 @@ class CaseworkRepresentationSchema(BaseModel):
151
151
  """
152
152
  The type of case this representation is for.
153
153
  """
154
- representationStatus: RepresentationStatus | None = None
154
+ representationStatus: RepresentationStatus
155
155
  submittedFor: SubmittedFor
156
156
  submittedByContact: list[Contact] | None = None
157
- submittedByAgentFlag: bool | None = None
157
+ submittedByAgent: bool | None = None
158
158
  submittedByAgentOrgName: str | None = None
159
159
  submittedDate: AwareDatetime
160
160
  submittedReceivedMethod: SubmittedReceivedMethod | None = None
package/schemas/applications-notify-email.schema.json CHANGED
@@ -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", "status", "lpaCode"],
8
+ "required": ["id", "caseReference", "caseId", "caseType", "emailStatus", "lpaCode"],
9
9
  "properties": {
10
10
  "id": {
11
11
  "type": "string",
package/schemas/applications-representation.schema.json CHANGED
@@ -11,7 +11,7 @@
11
11
  "caseReference",
12
12
  "caseId",
13
13
  "caseType",
14
- "status",
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": "#/definitions/contact"
55
+ "$ref": "#/$defs/contact"
56
56
  }
57
57
  },
58
- "submittedByAgentFlag": {
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": "#/definitions/contact"
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": "#/definitions/representationDocument"
137
+ "$ref": "#/$defs/representationDocument"
138
138
  }
139
139
  }
140
140
  },
141
- "definitions": {
141
+ "$defs": {
142
142
  "contact": {
143
143
  "type": "object",
144
144
  "required": ["contactId"],
package/src/schemas.d.ts CHANGED
@@ -2320,7 +2320,7 @@ export interface EmailNotificationRecordSchema {
2320
2320
  /**
2321
2321
  * Outcome of the email (status)
2322
2322
  */
2323
- emailStatus?: 'Sending' | 'Delivered' | 'Permanent failure' | 'Temporary failure' | 'Technical failure';
2323
+ emailStatus: 'Sending' | 'Delivered' | 'Permanent failure' | 'Temporary failure' | 'Technical failure';
2324
2324
  /**
2325
2325
  * The id of the template sent in Notify
2326
2326
  */
@@ -2379,10 +2379,10 @@ export interface CaseworkRepresentationSchema {
2379
2379
  * The type of case this representation is for.
2380
2380
  */
2381
2381
  caseType: string;
2382
- representationStatus?: 'Awaiting review' | 'Accepted' | 'Rejected' | 'Withdrawn';
2382
+ representationStatus: 'Awaiting review' | 'Accepted' | 'Rejected' | 'Withdrawn';
2383
2383
  submittedFor: 'Myself' | 'On behalf of another person or an organisation';
2384
2384
  submittedByContact?: Contact[] | null;
2385
- submittedByAgentFlag?: boolean | null;
2385
+ submittedByAgent?: boolean | null;
2386
2386
  submittedByAgentOrgName?: string | null;
2387
2387
  submittedDate: string;
2388
2388
  /**