@planning-inspectorate/data-model 2.49.0 → 2.51.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 (55) hide show
  1. package/docs/README.md +23 -1
  2. package/docs/address.md +366 -0
  3. package/docs/applications-application-defs-address.md +108 -0
  4. package/docs/applications-application-defs-contact.md +98 -0
  5. package/docs/applications-application-defs-organisation.md +117 -0
  6. package/docs/applications-application-defs.md +3 -0
  7. package/docs/{application-update.md → applications-application-update.md} +22 -22
  8. package/docs/applications-application.md +2250 -0
  9. package/docs/applications-notify-email-defs-contact.md +93 -0
  10. package/docs/applications-notify-email-defs.md +3 -0
  11. package/docs/applications-notify-email.md +458 -0
  12. package/docs/applications-representation-definitions-contact.md +93 -0
  13. package/docs/applications-representation-definitions-representationdocument.md +152 -0
  14. package/docs/applications-representation-definitions.md +3 -0
  15. package/docs/applications-representation.md +834 -0
  16. package/docs/nsip-exam-timetable-defs-event.md +1 -0
  17. package/docs/nsip-exam-timetable.md +1 -0
  18. package/package.json +1 -1
  19. package/pins_data_model/gen_models.py +2 -1
  20. package/pins_data_model/models/model_address.py +69 -0
  21. package/pins_data_model/models/model_appeal_document.py +11 -11
  22. package/pins_data_model/models/model_appeal_event.py +4 -4
  23. package/pins_data_model/models/model_appeal_event_estimate.py +3 -3
  24. package/pins_data_model/models/model_appeal_has.py +111 -93
  25. package/pins_data_model/models/model_appeal_representation.py +12 -12
  26. package/pins_data_model/models/model_appeal_s78.py +246 -228
  27. package/pins_data_model/models/model_application_update.py +2 -2
  28. package/pins_data_model/models/model_applications_application.py +518 -0
  29. package/pins_data_model/models/model_applications_application_update.py +55 -0
  30. package/pins_data_model/models/model_applications_notify_email.py +124 -0
  31. package/pins_data_model/models/model_applications_representation.py +207 -0
  32. package/pins_data_model/models/model_dart_response.py +1 -1
  33. package/pins_data_model/models/model_folder.py +3 -3
  34. package/pins_data_model/models/model_nsip_document.py +12 -12
  35. package/pins_data_model/models/model_nsip_exam_timetable.py +3 -2
  36. package/pins_data_model/models/model_nsip_invoice.py +2 -2
  37. package/pins_data_model/models/model_nsip_project.py +19 -19
  38. package/pins_data_model/models/model_nsip_project_update.py +5 -5
  39. package/pins_data_model/models/model_nsip_representation.py +7 -7
  40. package/pins_data_model/models/model_nsip_subscription.py +6 -6
  41. package/pins_data_model/models/model_pins_inspector.py +5 -5
  42. package/pins_data_model/models/model_s51_advice.py +7 -7
  43. package/pins_data_model/models/model_service_user.py +2 -2
  44. package/requirements.txt +1 -1
  45. package/schemas/address.schema.json +87 -0
  46. package/schemas/{application-update.schema.json → applications-application-update.schema.json} +1 -1
  47. package/schemas/applications-application.schema.json +539 -0
  48. package/schemas/applications-notify-email.schema.json +118 -0
  49. package/schemas/applications-representation.schema.json +202 -0
  50. package/schemas/nsip-exam-timetable.schema.json +2 -1
  51. package/src/enums.cjs +147 -0
  52. package/src/enums.d.ts +131 -0
  53. package/src/enums.js +131 -0
  54. package/src/index.cjs +147 -0
  55. package/src/schemas.d.ts +680 -2
package/docs/applications-application-defs-organisation.md ADDED
@@ -0,0 +1,117 @@
1
+ ## organisation Type
2
+
3
+ `object` ([Details](applications-application-defs-organisation.md))
4
+
5
+ # organisation Properties
6
+
7
+ | Property | Type | Required | Nullable | Defined by |
8
+ | :------------------------------------------ | :------- | :------- | :------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
9
+ | [roleType](#roletype) | `string` | Optional | cannot be null | [Crown Development Application](applications-application-defs-organisation-properties-roletype.md "applications-application.schema.json#/$defs/organisation/properties/roleType") |
10
+ | [organisationId](#organisationid) | `string` | Required | cannot be null | [Crown Development Application](applications-application-defs-organisation-properties-organisationid.md "applications-application.schema.json#/$defs/organisation/properties/organisationId") |
11
+ | [organisationName](#organisationname) | `string` | Optional | can be null | [Crown Development Application](applications-application-defs-organisation-properties-organisationname.md "applications-application.schema.json#/$defs/organisation/properties/organisationName") |
12
+ | [organisationAddress](#organisationaddress) | `array` | Optional | can be null | [Crown Development Application](applications-application-defs-organisation-properties-organisationaddress.md "applications-application.schema.json#/$defs/organisation/properties/organisationAddress") |
13
+ | [contacts](#contacts) | `array` | Optional | can be null | [Crown Development Application](applications-application-defs-organisation-properties-contacts.md "applications-application.schema.json#/$defs/organisation/properties/contacts") |
14
+ | Additional Properties | Any | Optional | can be null | |
15
+
16
+ ## roleType
17
+
18
+ Agent or Applicant details
19
+
20
+ `roleType`
21
+
22
+ * is optional
23
+
24
+ * Type: `string`
25
+
26
+ * cannot be null
27
+
28
+ * defined in: [Crown Development Application](applications-application-defs-organisation-properties-roletype.md "applications-application.schema.json#/$defs/organisation/properties/roleType")
29
+
30
+ ### roleType Type
31
+
32
+ `string`
33
+
34
+ ### roleType Constraints
35
+
36
+ **enum**: the value of this property must be equal to one of the following values:
37
+
38
+ | Value | Explanation |
39
+ | :------------ | :---------- |
40
+ | `"agent"` | |
41
+ | `"applicant"` | |
42
+
43
+ ## organisationId
44
+
45
+ Source PK for Organisation
46
+
47
+ `organisationId`
48
+
49
+ * is required
50
+
51
+ * Type: `string`
52
+
53
+ * cannot be null
54
+
55
+ * defined in: [Crown Development Application](applications-application-defs-organisation-properties-organisationid.md "applications-application.schema.json#/$defs/organisation/properties/organisationId")
56
+
57
+ ### organisationId Type
58
+
59
+ `string`
60
+
61
+ ## organisationName
62
+
63
+
64
+
65
+ `organisationName`
66
+
67
+ * is optional
68
+
69
+ * Type: `string`
70
+
71
+ * can be null
72
+
73
+ * defined in: [Crown Development Application](applications-application-defs-organisation-properties-organisationname.md "applications-application.schema.json#/$defs/organisation/properties/organisationName")
74
+
75
+ ### organisationName Type
76
+
77
+ `string`
78
+
79
+ ## organisationAddress
80
+
81
+
82
+
83
+ `organisationAddress`
84
+
85
+ * is optional
86
+
87
+ * Type: `object[]` ([Details](applications-application-defs-address.md))
88
+
89
+ * can be null
90
+
91
+ * defined in: [Crown Development Application](applications-application-defs-organisation-properties-organisationaddress.md "applications-application.schema.json#/$defs/organisation/properties/organisationAddress")
92
+
93
+ ### organisationAddress Type
94
+
95
+ `object[]` ([Details](applications-application-defs-address.md))
96
+
97
+ ## contacts
98
+
99
+ An Organisation may be linked to one or more Contacts
100
+
101
+ `contacts`
102
+
103
+ * is optional
104
+
105
+ * Type: `object[]` ([Details](applications-application-defs-contact.md))
106
+
107
+ * can be null
108
+
109
+ * defined in: [Crown Development Application](applications-application-defs-organisation-properties-contacts.md "applications-application.schema.json#/$defs/organisation/properties/contacts")
110
+
111
+ ### contacts Type
112
+
113
+ `object[]` ([Details](applications-application-defs-contact.md))
114
+
115
+ ## Additional Properties
116
+
117
+ Additional properties are allowed and do not have to follow a specific schema
package/docs/applications-application-defs.md ADDED
@@ -0,0 +1,3 @@
1
+ ## $defs Type
2
+
3
+ unknown
package/docs/{application-update.md → applications-application-update.md} RENAMED
@@ -1,21 +1,21 @@
1
1
  ## Application Update Schema Type
2
2
 
3
- `object` ([Application Update Schema](application-update.md))
3
+ `object` ([Application Update Schema](applications-application-update.md))
4
4
 
5
5
  # Application Update Schema Properties
6
6
 
7
- | Property | Type | Required | Nullable | Defined by |
8
- | :-------------------------------------------------- | :------- | :------- | :------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------- |
9
- | [id](#id) | `string` | Required | cannot be null | [Application Update Schema](application-update-properties-id.md "application-update.schema.json#/properties/id") |
10
- | [caseReference](#casereference) | `string` | Required | cannot be null | [Application Update Schema](application-update-properties-casereference.md "application-update.schema.json#/properties/caseReference") |
11
- | [caseId](#caseid) | `string` | Required | cannot be null | [Application Update Schema](application-update-properties-caseid.md "application-update.schema.json#/properties/caseId") |
12
- | [caseType](#casetype) | `string` | Required | cannot be null | [Application Update Schema](application-update-properties-casetype.md "application-update.schema.json#/properties/caseType") |
13
- | [applicationUpdateStatus](#applicationupdatestatus) | `string` | Required | cannot be null | [Application Update Schema](application-update-properties-applicationupdatestatus.md "application-update.schema.json#/properties/applicationUpdateStatus") |
14
- | [details](#details) | `string` | Required | cannot be null | [Application Update Schema](application-update-properties-details.md "application-update.schema.json#/properties/details") |
15
- | [firstPublished](#firstpublished) | `string` | Optional | can be null | [Application Update Schema](application-update-properties-firstpublished.md "application-update.schema.json#/properties/firstPublished") |
16
- | [unpublishedDate](#unpublisheddate) | `string` | Optional | can be null | [Application Update Schema](application-update-properties-unpublisheddate.md "application-update.schema.json#/properties/unpublishedDate") |
17
- | [lastEdited](#lastedited) | `string` | Optional | can be null | [Application Update Schema](application-update-properties-lastedited.md "application-update.schema.json#/properties/lastEdited") |
18
- | Additional Properties | Any | Optional | can be null | |
7
+ | Property | Type | Required | Nullable | Defined by |
8
+ | :-------------------------------------------------- | :------- | :------- | :------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
9
+ | [id](#id) | `string` | Required | cannot be null | [Application Update Schema](applications-application-update-properties-id.md "applications-application-update.schema.json#/properties/id") |
10
+ | [caseReference](#casereference) | `string` | Required | cannot be null | [Application Update Schema](applications-application-update-properties-casereference.md "applications-application-update.schema.json#/properties/caseReference") |
11
+ | [caseId](#caseid) | `string` | Required | cannot be null | [Application Update Schema](applications-application-update-properties-caseid.md "applications-application-update.schema.json#/properties/caseId") |
12
+ | [caseType](#casetype) | `string` | Required | cannot be null | [Application Update Schema](applications-application-update-properties-casetype.md "applications-application-update.schema.json#/properties/caseType") |
13
+ | [applicationUpdateStatus](#applicationupdatestatus) | `string` | Required | cannot be null | [Application Update Schema](applications-application-update-properties-applicationupdatestatus.md "applications-application-update.schema.json#/properties/applicationUpdateStatus") |
14
+ | [details](#details) | `string` | Required | cannot be null | [Application Update Schema](applications-application-update-properties-details.md "applications-application-update.schema.json#/properties/details") |
15
+ | [firstPublished](#firstpublished) | `string` | Optional | can be null | [Application Update Schema](applications-application-update-properties-firstpublished.md "applications-application-update.schema.json#/properties/firstPublished") |
16
+ | [unpublishedDate](#unpublisheddate) | `string` | Optional | can be null | [Application Update Schema](applications-application-update-properties-unpublisheddate.md "applications-application-update.schema.json#/properties/unpublishedDate") |
17
+ | [lastEdited](#lastedited) | `string` | Optional | can be null | [Application Update Schema](applications-application-update-properties-lastedited.md "applications-application-update.schema.json#/properties/lastEdited") |
18
+ | Additional Properties | Any | Optional | can be null | |
19
19
 
20
20
  ## id
21
21
 
@@ -29,7 +29,7 @@ Primary key
29
29
 
30
30
  * cannot be null
31
31
 
32
- * defined in: [Application Update Schema](application-update-properties-id.md "application-update.schema.json#/properties/id")
32
+ * defined in: [Application Update Schema](applications-application-update-properties-id.md "applications-application-update.schema.json#/properties/id")
33
33
 
34
34
  ### id Type
35
35
 
@@ -47,7 +47,7 @@ Business Key for the related case
47
47
 
48
48
  * cannot be null
49
49
 
50
- * defined in: [Application Update Schema](application-update-properties-casereference.md "application-update.schema.json#/properties/caseReference")
50
+ * defined in: [Application Update Schema](applications-application-update-properties-casereference.md "applications-application-update.schema.json#/properties/caseReference")
51
51
 
52
52
  ### caseReference Type
53
53
 
@@ -65,7 +65,7 @@ The unique ID for the case this Application Update belongs to.
65
65
 
66
66
  * cannot be null
67
67
 
68
- * defined in: [Application Update Schema](application-update-properties-caseid.md "application-update.schema.json#/properties/caseId")
68
+ * defined in: [Application Update Schema](applications-application-update-properties-caseid.md "applications-application-update.schema.json#/properties/caseId")
69
69
 
70
70
  ### caseId Type
71
71
 
@@ -83,7 +83,7 @@ The type of case this Application Update is for.
83
83
 
84
84
  * cannot be null
85
85
 
86
- * defined in: [Application Update Schema](application-update-properties-casetype.md "application-update.schema.json#/properties/caseType")
86
+ * defined in: [Application Update Schema](applications-application-update-properties-casetype.md "applications-application-update.schema.json#/properties/caseType")
87
87
 
88
88
  ### caseType Type
89
89
 
@@ -101,7 +101,7 @@ Application Update Status. Name displayed to users, e.g. Draft
101
101
 
102
102
  * cannot be null
103
103
 
104
- * defined in: [Application Update Schema](application-update-properties-applicationupdatestatus.md "application-update.schema.json#/properties/applicationUpdateStatus")
104
+ * defined in: [Application Update Schema](applications-application-update-properties-applicationupdatestatus.md "applications-application-update.schema.json#/properties/applicationUpdateStatus")
105
105
 
106
106
  ### applicationUpdateStatus Type
107
107
 
@@ -129,7 +129,7 @@ Application Update text description.
129
129
 
130
130
  * cannot be null
131
131
 
132
- * defined in: [Application Update Schema](application-update-properties-details.md "application-update.schema.json#/properties/details")
132
+ * defined in: [Application Update Schema](applications-application-update-properties-details.md "applications-application-update.schema.json#/properties/details")
133
133
 
134
134
  ### details Type
135
135
 
@@ -147,7 +147,7 @@ Application Update text description.
147
147
 
148
148
  * can be null
149
149
 
150
- * defined in: [Application Update Schema](application-update-properties-firstpublished.md "application-update.schema.json#/properties/firstPublished")
150
+ * defined in: [Application Update Schema](applications-application-update-properties-firstpublished.md "applications-application-update.schema.json#/properties/firstPublished")
151
151
 
152
152
  ### firstPublished Type
153
153
 
@@ -169,7 +169,7 @@ Application Update text description.
169
169
 
170
170
  * can be null
171
171
 
172
- * defined in: [Application Update Schema](application-update-properties-unpublisheddate.md "application-update.schema.json#/properties/unpublishedDate")
172
+ * defined in: [Application Update Schema](applications-application-update-properties-unpublisheddate.md "applications-application-update.schema.json#/properties/unpublishedDate")
173
173
 
174
174
  ### unpublishedDate Type
175
175
 
@@ -191,7 +191,7 @@ Application Update text description.
191
191
 
192
192
  * can be null
193
193
 
194
- * defined in: [Application Update Schema](application-update-properties-lastedited.md "application-update.schema.json#/properties/lastEdited")
194
+ * defined in: [Application Update Schema](applications-application-update-properties-lastedited.md "applications-application-update.schema.json#/properties/lastEdited")
195
195
 
196
196
  ### lastEdited Type
197
197