@planning-inspectorate/data-model 2.48.1 → 2.50.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 (35) hide show
  1. package/docs/README.md +23 -1
  2. package/docs/address.md +366 -0
  3. package/docs/appeal-has.md +10 -7
  4. package/docs/applications-application-defs-address.md +108 -0
  5. package/docs/applications-application-defs-contact.md +98 -0
  6. package/docs/applications-application-defs-organisation.md +117 -0
  7. package/docs/applications-application-defs.md +3 -0
  8. package/docs/{application-update.md → applications-application-update.md} +22 -22
  9. package/docs/applications-application.md +2250 -0
  10. package/docs/applications-notify-email-defs-contact.md +93 -0
  11. package/docs/applications-notify-email-defs.md +3 -0
  12. package/docs/applications-notify-email.md +458 -0
  13. package/docs/applications-representation-definitions-contact.md +93 -0
  14. package/docs/applications-representation-definitions-representationdocument.md +152 -0
  15. package/docs/applications-representation-definitions.md +3 -0
  16. package/docs/applications-representation.md +834 -0
  17. package/package.json +1 -1
  18. package/pins_data_model/models/model_address.py +69 -0
  19. package/pins_data_model/models/model_appeal_has.py +3 -0
  20. package/pins_data_model/models/model_applications_application.py +518 -0
  21. package/pins_data_model/models/model_applications_application_update.py +55 -0
  22. package/pins_data_model/models/model_applications_notify_email.py +124 -0
  23. package/pins_data_model/models/model_applications_representation.py +207 -0
  24. package/schemas/address.schema.json +87 -0
  25. package/schemas/appeal-has.schema.json +2 -2
  26. package/schemas/{application-update.schema.json → applications-application-update.schema.json} +1 -1
  27. package/schemas/applications-application.schema.json +539 -0
  28. package/schemas/applications-notify-email.schema.json +118 -0
  29. package/schemas/applications-representation.schema.json +202 -0
  30. package/src/enums.cjs +147 -7
  31. package/src/enums.d.ts +131 -6
  32. package/src/enums.js +131 -6
  33. package/src/index.cjs +147 -7
  34. package/src/schemas.d.ts +679 -2
  35. package/tests/appeals/appeal-has.test.js +34 -0
package/docs/applications-representation-definitions-representationdocument.md ADDED
@@ -0,0 +1,152 @@
1
+ ## representationDocument Type
2
+
3
+ `object` ([Details](applications-representation-definitions-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-definitions-representationdocument-properties-id.md "applications-representation.schema.json#/definitions/representationDocument/properties/id") |
10
+ | [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") |
11
+ | [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") |
12
+ | [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") |
13
+ | [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") |
14
+ | [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") |
15
+ | [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") |
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-definitions-representationdocument-properties-id.md "applications-representation.schema.json#/definitions/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-definitions-representationdocument-properties-representationid.md "applications-representation.schema.json#/definitions/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-definitions-representationdocument-properties-itemid.md "applications-representation.schema.json#/definitions/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-definitions-representationdocument-properties-filename.md "applications-representation.schema.json#/definitions/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-definitions-representationdocument-properties-redacteditemid.md "applications-representation.schema.json#/definitions/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-definitions-representationdocument-properties-redactedfilename.md "applications-representation.schema.json#/definitions/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-definitions-representationdocument-properties-status.md "applications-representation.schema.json#/definitions/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-definitions.md ADDED
@@ -0,0 +1,3 @@
1
+ ## definitions Type
2
+
3
+ unknown