@planning-inspectorate/data-model 2.34.0 → 2.36.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/docs/nsip-meeting.md +10 -39
- package/docs/nsip-project-defs-invoice.md +6 -7
- package/docs/nsip-project-defs-meeting.md +8 -37
- package/docs/nsip-project.md +43 -44
- package/package.json +1 -1
- package/pins_data_model/models/model_appeal_document.py +1 -1
- package/pins_data_model/models/model_appeal_event.py +1 -1
- package/pins_data_model/models/model_appeal_event_estimate.py +1 -1
- package/pins_data_model/models/model_appeal_has.py +1 -1
- package/pins_data_model/models/model_appeal_representation.py +1 -1
- package/pins_data_model/models/model_appeal_s78.py +1 -1
- package/pins_data_model/models/model_dart_response.py +1 -1
- package/pins_data_model/models/model_entraid.py +1 -1
- package/pins_data_model/models/model_folder.py +1 -1
- package/pins_data_model/models/model_gettimesheets_response.py +1 -1
- package/pins_data_model/models/model_listed_building.py +1 -1
- package/pins_data_model/models/model_listed_buildings.py +1 -1
- package/pins_data_model/models/model_nsip_document.py +1 -1
- package/pins_data_model/models/model_nsip_exam_timetable.py +1 -1
- package/pins_data_model/models/model_nsip_invoice.py +1 -1
- package/pins_data_model/models/model_nsip_meeting.py +1 -7
- package/pins_data_model/models/model_nsip_project.py +9 -10
- package/pins_data_model/models/model_nsip_project_update.py +1 -1
- package/pins_data_model/models/model_nsip_representation.py +1 -1
- package/pins_data_model/models/model_nsip_subscription.py +1 -1
- package/pins_data_model/models/model_pins_inspector.py +1 -1
- package/pins_data_model/models/model_pins_lpa.py +1 -1
- package/pins_data_model/models/model_s51_advice.py +1 -1
- package/pins_data_model/models/model_service_user.py +1 -1
- package/schemas/nsip-meeting.schema.json +0 -6
- package/schemas/nsip-project.schema.json +10 -10
- package/src/schemas.d.ts +6 -16
package/docs/nsip-meeting.md
CHANGED
|
@@ -4,17 +4,16 @@
|
|
|
4
4
|
|
|
5
5
|
# NSIP Meeting Properties
|
|
6
6
|
|
|
7
|
-
| Property
|
|
8
|
-
|
|
|
9
|
-
| [meetingID](#meetingid)
|
|
10
|
-
| [caseId](#caseid)
|
|
11
|
-
| [caseReference](#casereference)
|
|
12
|
-
| [meetingAgenda](#meetingagenda)
|
|
13
|
-
| [planningInspectorateRole](#planninginspectoraterole)
|
|
14
|
-
| [meetingDate](#meetingdate)
|
|
15
|
-
| [
|
|
16
|
-
|
|
|
17
|
-
| Additional Properties | Any | Optional | can be null | |
|
|
7
|
+
| Property | Type | Required | Nullable | Defined by |
|
|
8
|
+
| :---------------------------------------------------- | :-------- | :------- | :------------- | :---------------------------------------------------------------------------------------------------------------------------------- |
|
|
9
|
+
| [meetingID](#meetingid) | `integer` | Required | cannot be null | [NSIP Meeting](nsip-meeting-properties-meetingid.md "nsip-meeting.schema.json#/properties/meetingID") |
|
|
10
|
+
| [caseId](#caseid) | `integer` | Required | cannot be null | [NSIP Meeting](nsip-meeting-properties-caseid.md "nsip-meeting.schema.json#/properties/caseId") |
|
|
11
|
+
| [caseReference](#casereference) | `string` | Optional | can be null | [NSIP Meeting](nsip-meeting-properties-casereference.md "nsip-meeting.schema.json#/properties/caseReference") |
|
|
12
|
+
| [meetingAgenda](#meetingagenda) | `string` | Optional | can be null | [NSIP Meeting](nsip-meeting-properties-meetingagenda.md "nsip-meeting.schema.json#/properties/meetingAgenda") |
|
|
13
|
+
| [planningInspectorateRole](#planninginspectoraterole) | `string` | Optional | can be null | [NSIP Meeting](nsip-meeting-properties-planninginspectoraterole.md "nsip-meeting.schema.json#/properties/planningInspectorateRole") |
|
|
14
|
+
| [meetingDate](#meetingdate) | `string` | Optional | can be null | [NSIP Meeting](nsip-meeting-properties-meetingdate.md "nsip-meeting.schema.json#/properties/meetingDate") |
|
|
15
|
+
| [meetingType](#meetingtype) | `string` | Optional | can be null | [NSIP Meeting](nsip-meeting-properties-meetingtype.md "nsip-meeting.schema.json#/properties/meetingType") |
|
|
16
|
+
| Additional Properties | Any | Optional | can be null | |
|
|
18
17
|
|
|
19
18
|
## meetingID
|
|
20
19
|
|
|
@@ -175,34 +174,6 @@ Meeting date
|
|
|
175
174
|
"2023-07-27T20:30:00.000Z"
|
|
176
175
|
```
|
|
177
176
|
|
|
178
|
-
## estimatedPrelimMeetingDate
|
|
179
|
-
|
|
180
|
-
Estimated Preliminary Meeting date
|
|
181
|
-
|
|
182
|
-
`estimatedPrelimMeetingDate`
|
|
183
|
-
|
|
184
|
-
* is optional
|
|
185
|
-
|
|
186
|
-
* Type: `string`
|
|
187
|
-
|
|
188
|
-
* can be null
|
|
189
|
-
|
|
190
|
-
* defined in: [NSIP Meeting](nsip-meeting-properties-estimatedprelimmeetingdate.md "nsip-meeting.schema.json#/properties/estimatedPrelimMeetingDate")
|
|
191
|
-
|
|
192
|
-
### estimatedPrelimMeetingDate Type
|
|
193
|
-
|
|
194
|
-
`string`
|
|
195
|
-
|
|
196
|
-
### estimatedPrelimMeetingDate Constraints
|
|
197
|
-
|
|
198
|
-
**date time**: the string must be a date time string, according to [RFC 3339, section 5.6](https://tools.ietf.org/html/rfc3339 "check the specification")
|
|
199
|
-
|
|
200
|
-
### estimatedPrelimMeetingDate Examples
|
|
201
|
-
|
|
202
|
-
```json
|
|
203
|
-
"2023-07-27T20:30:00.000Z"
|
|
204
|
-
```
|
|
205
|
-
|
|
206
177
|
## meetingType
|
|
207
178
|
|
|
208
179
|
Type of Meeting
|
|
@@ -6,9 +6,9 @@
|
|
|
6
6
|
|
|
7
7
|
| Property | Type | Required | Nullable | Defined by |
|
|
8
8
|
| :------------------------------------------------ | :------- | :------- | :------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
9
|
-
| [invoiceStage](#invoicestage) | `string` |
|
|
9
|
+
| [invoiceStage](#invoicestage) | `string` | Required | cannot be null | [NSIP Project](nsip-project-defs-invoice-properties-invoicestage.md "nsip-project.schema.json#/$defs/invoice/properties/invoiceStage") |
|
|
10
10
|
| [invoiceNumber](#invoicenumber) | `string` | Required | cannot be null | [NSIP Project](nsip-project-defs-invoice-properties-invoicenumber.md "nsip-project.schema.json#/$defs/invoice/properties/invoiceNumber") |
|
|
11
|
-
| [amountDue](#amountdue) | `number` |
|
|
11
|
+
| [amountDue](#amountdue) | `number` | Optional | can be null | [NSIP Project](nsip-project-defs-invoice-properties-amountdue.md "nsip-project.schema.json#/$defs/invoice/properties/amountDue") |
|
|
12
12
|
| [paymentDueDate](#paymentduedate) | `string` | Optional | can be null | [NSIP Project](nsip-project-defs-invoice-properties-paymentduedate.md "nsip-project.schema.json#/$defs/invoice/properties/paymentDueDate") |
|
|
13
13
|
| [invoicedDate](#invoiceddate) | `string` | Optional | can be null | [NSIP Project](nsip-project-defs-invoice-properties-invoiceddate.md "nsip-project.schema.json#/$defs/invoice/properties/invoicedDate") |
|
|
14
14
|
| [paymentDate](#paymentdate) | `string` | Optional | can be null | [NSIP Project](nsip-project-defs-invoice-properties-paymentdate.md "nsip-project.schema.json#/$defs/invoice/properties/paymentDate") |
|
|
@@ -23,11 +23,11 @@ Invoice stage
|
|
|
23
23
|
|
|
24
24
|
`invoiceStage`
|
|
25
25
|
|
|
26
|
-
* is
|
|
26
|
+
* is required
|
|
27
27
|
|
|
28
28
|
* Type: `string`
|
|
29
29
|
|
|
30
|
-
*
|
|
30
|
+
* cannot be null
|
|
31
31
|
|
|
32
32
|
* defined in: [NSIP Project](nsip-project-defs-invoice-properties-invoicestage.md "nsip-project.schema.json#/$defs/invoice/properties/invoiceStage")
|
|
33
33
|
|
|
@@ -46,7 +46,6 @@ Invoice stage
|
|
|
46
46
|
| `"pre_examination"` | |
|
|
47
47
|
| `"initial_examination"` | |
|
|
48
48
|
| `"final_examination"` | |
|
|
49
|
-
| `null` | |
|
|
50
49
|
|
|
51
50
|
### invoiceStage Examples
|
|
52
51
|
|
|
@@ -84,11 +83,11 @@ Amount due
|
|
|
84
83
|
|
|
85
84
|
`amountDue`
|
|
86
85
|
|
|
87
|
-
* is
|
|
86
|
+
* is optional
|
|
88
87
|
|
|
89
88
|
* Type: `number`
|
|
90
89
|
|
|
91
|
-
*
|
|
90
|
+
* can be null
|
|
92
91
|
|
|
93
92
|
* defined in: [NSIP Project](nsip-project-defs-invoice-properties-amountdue.md "nsip-project.schema.json#/$defs/invoice/properties/amountDue")
|
|
94
93
|
|
|
@@ -4,15 +4,14 @@
|
|
|
4
4
|
|
|
5
5
|
# meeting Properties
|
|
6
6
|
|
|
7
|
-
| Property
|
|
8
|
-
|
|
|
9
|
-
| [meetingId](#meetingid)
|
|
10
|
-
| [meetingAgenda](#meetingagenda)
|
|
11
|
-
| [planningInspectorateRole](#planninginspectoraterole)
|
|
12
|
-
| [meetingDate](#meetingdate)
|
|
13
|
-
| [
|
|
14
|
-
|
|
|
15
|
-
| Additional Properties | Any | Optional | can be null | |
|
|
7
|
+
| Property | Type | Required | Nullable | Defined by |
|
|
8
|
+
| :---------------------------------------------------- | :-------- | :------- | :------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
9
|
+
| [meetingId](#meetingid) | `integer` | Required | cannot be null | [NSIP Project](nsip-project-defs-meeting-properties-meetingid.md "nsip-project.schema.json#/$defs/meeting/properties/meetingId") |
|
|
10
|
+
| [meetingAgenda](#meetingagenda) | `string` | Optional | can be null | [NSIP Project](nsip-project-defs-meeting-properties-meetingagenda.md "nsip-project.schema.json#/$defs/meeting/properties/meetingAgenda") |
|
|
11
|
+
| [planningInspectorateRole](#planninginspectoraterole) | `string` | Optional | can be null | [NSIP Project](nsip-project-defs-meeting-properties-planninginspectoraterole.md "nsip-project.schema.json#/$defs/meeting/properties/planningInspectorateRole") |
|
|
12
|
+
| [meetingDate](#meetingdate) | `string` | Optional | can be null | [NSIP Project](nsip-project-defs-meeting-properties-meetingdate.md "nsip-project.schema.json#/$defs/meeting/properties/meetingDate") |
|
|
13
|
+
| [meetingType](#meetingtype) | `string` | Optional | can be null | [NSIP Project](nsip-project-defs-meeting-properties-meetingtype.md "nsip-project.schema.json#/$defs/meeting/properties/meetingType") |
|
|
14
|
+
| Additional Properties | Any | Optional | can be null | |
|
|
16
15
|
|
|
17
16
|
## meetingId
|
|
18
17
|
|
|
@@ -125,34 +124,6 @@ Meeting date
|
|
|
125
124
|
"2023-07-27T20:30:00.000Z"
|
|
126
125
|
```
|
|
127
126
|
|
|
128
|
-
## estimatedPrelimMeetingDate
|
|
129
|
-
|
|
130
|
-
Estimated Preliminary Meeting date
|
|
131
|
-
|
|
132
|
-
`estimatedPrelimMeetingDate`
|
|
133
|
-
|
|
134
|
-
* is optional
|
|
135
|
-
|
|
136
|
-
* Type: `string`
|
|
137
|
-
|
|
138
|
-
* can be null
|
|
139
|
-
|
|
140
|
-
* defined in: [NSIP Project](nsip-project-defs-meeting-properties-estimatedprelimmeetingdate.md "nsip-project.schema.json#/$defs/meeting/properties/estimatedPrelimMeetingDate")
|
|
141
|
-
|
|
142
|
-
### estimatedPrelimMeetingDate Type
|
|
143
|
-
|
|
144
|
-
`string`
|
|
145
|
-
|
|
146
|
-
### estimatedPrelimMeetingDate Constraints
|
|
147
|
-
|
|
148
|
-
**date time**: the string must be a date time string, according to [RFC 3339, section 5.6](https://tools.ietf.org/html/rfc3339 "check the specification")
|
|
149
|
-
|
|
150
|
-
### estimatedPrelimMeetingDate Examples
|
|
151
|
-
|
|
152
|
-
```json
|
|
153
|
-
"2023-07-27T20:30:00.000Z"
|
|
154
|
-
```
|
|
155
|
-
|
|
156
127
|
## meetingType
|
|
157
128
|
|
|
158
129
|
Type of Meeting
|
package/docs/nsip-project.md
CHANGED
|
@@ -128,6 +128,7 @@
|
|
|
128
128
|
| [numberBand3Inspectors](#numberband3inspectors) | `number` | Optional | can be null | [NSIP Project](nsip-project-properties-numberband3inspectors.md "nsip-project.schema.json#/properties/numberBand3Inspectors") |
|
|
129
129
|
| [memLastUpdated](#memlastupdated) | `string` | Optional | can be null | [NSIP Project](nsip-project-properties-memlastupdated.md "nsip-project.schema.json#/properties/memLastUpdated") |
|
|
130
130
|
| [additionalComments](#additionalcomments) | `string` | Optional | can be null | [NSIP Project](nsip-project-properties-additionalcomments.md "nsip-project.schema.json#/properties/additionalComments") |
|
|
131
|
+
| [estimatedPrelimMeetingDate](#estimatedprelimmeetingdate) | `string` | Optional | can be null | [NSIP Project](nsip-project-properties-estimatedprelimmeetingdate.md "nsip-project.schema.json#/properties/estimatedPrelimMeetingDate") |
|
|
131
132
|
| [operationsLeadIds](#operationsleadids) | `array` | Optional | cannot be null | [NSIP Project](nsip-project-properties-operationsleadids.md "nsip-project.schema.json#/properties/operationsLeadIds") |
|
|
132
133
|
| [operationsManagerIds](#operationsmanagerids) | `array` | Optional | cannot be null | [NSIP Project](nsip-project-properties-operationsmanagerids.md "nsip-project.schema.json#/properties/operationsManagerIds") |
|
|
133
134
|
| [caseManagerIds](#casemanagerids) | `array` | Optional | cannot be null | [NSIP Project](nsip-project-properties-casemanagerids.md "nsip-project.schema.json#/properties/caseManagerIds") |
|
|
@@ -3380,6 +3381,34 @@ Additional comments
|
|
|
3380
3381
|
"Very likely to change tier from standard to basic after April 2025"
|
|
3381
3382
|
```
|
|
3382
3383
|
|
|
3384
|
+
## estimatedPrelimMeetingDate
|
|
3385
|
+
|
|
3386
|
+
Estimated Preliminary Meeting date
|
|
3387
|
+
|
|
3388
|
+
`estimatedPrelimMeetingDate`
|
|
3389
|
+
|
|
3390
|
+
* is optional
|
|
3391
|
+
|
|
3392
|
+
* Type: `string`
|
|
3393
|
+
|
|
3394
|
+
* can be null
|
|
3395
|
+
|
|
3396
|
+
* defined in: [NSIP Project](nsip-project-properties-estimatedprelimmeetingdate.md "nsip-project.schema.json#/properties/estimatedPrelimMeetingDate")
|
|
3397
|
+
|
|
3398
|
+
### estimatedPrelimMeetingDate Type
|
|
3399
|
+
|
|
3400
|
+
`string`
|
|
3401
|
+
|
|
3402
|
+
### estimatedPrelimMeetingDate Constraints
|
|
3403
|
+
|
|
3404
|
+
**date time**: the string must be a date time string, according to [RFC 3339, section 5.6](https://tools.ietf.org/html/rfc3339 "check the specification")
|
|
3405
|
+
|
|
3406
|
+
### estimatedPrelimMeetingDate Examples
|
|
3407
|
+
|
|
3408
|
+
```json
|
|
3409
|
+
"2023-07-27T20:30:00.000Z"
|
|
3410
|
+
```
|
|
3411
|
+
|
|
3383
3412
|
## operationsLeadIds
|
|
3384
3413
|
|
|
3385
3414
|
Maps to \[Employee].\[EmployeeID].
|
|
@@ -3592,15 +3621,14 @@ Reference this group by using
|
|
|
3592
3621
|
{"$ref":"nsip-project.schema.json#/$defs/meeting"}
|
|
3593
3622
|
```
|
|
3594
3623
|
|
|
3595
|
-
| Property
|
|
3596
|
-
|
|
|
3597
|
-
| [meetingId](#meetingid)
|
|
3598
|
-
| [meetingAgenda](#meetingagenda)
|
|
3599
|
-
| [planningInspectorateRole](#planninginspectoraterole)
|
|
3600
|
-
| [meetingDate](#meetingdate)
|
|
3601
|
-
| [
|
|
3602
|
-
|
|
|
3603
|
-
| Additional Properties | Any | Optional | can be null | |
|
|
3624
|
+
| Property | Type | Required | Nullable | Defined by |
|
|
3625
|
+
| :---------------------------------------------------- | :-------- | :------- | :------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
3626
|
+
| [meetingId](#meetingid) | `integer` | Required | cannot be null | [NSIP Project](nsip-project-defs-meeting-properties-meetingid.md "nsip-project.schema.json#/$defs/meeting/properties/meetingId") |
|
|
3627
|
+
| [meetingAgenda](#meetingagenda) | `string` | Optional | can be null | [NSIP Project](nsip-project-defs-meeting-properties-meetingagenda.md "nsip-project.schema.json#/$defs/meeting/properties/meetingAgenda") |
|
|
3628
|
+
| [planningInspectorateRole](#planninginspectoraterole) | `string` | Optional | can be null | [NSIP Project](nsip-project-defs-meeting-properties-planninginspectoraterole.md "nsip-project.schema.json#/$defs/meeting/properties/planningInspectorateRole") |
|
|
3629
|
+
| [meetingDate](#meetingdate) | `string` | Optional | can be null | [NSIP Project](nsip-project-defs-meeting-properties-meetingdate.md "nsip-project.schema.json#/$defs/meeting/properties/meetingDate") |
|
|
3630
|
+
| [meetingType](#meetingtype) | `string` | Optional | can be null | [NSIP Project](nsip-project-defs-meeting-properties-meetingtype.md "nsip-project.schema.json#/$defs/meeting/properties/meetingType") |
|
|
3631
|
+
| Additional Properties | Any | Optional | can be null | |
|
|
3604
3632
|
|
|
3605
3633
|
### meetingId
|
|
3606
3634
|
|
|
@@ -3713,34 +3741,6 @@ Meeting date
|
|
|
3713
3741
|
"2023-07-27T20:30:00.000Z"
|
|
3714
3742
|
```
|
|
3715
3743
|
|
|
3716
|
-
### estimatedPrelimMeetingDate
|
|
3717
|
-
|
|
3718
|
-
Estimated Preliminary Meeting date
|
|
3719
|
-
|
|
3720
|
-
`estimatedPrelimMeetingDate`
|
|
3721
|
-
|
|
3722
|
-
* is optional
|
|
3723
|
-
|
|
3724
|
-
* Type: `string`
|
|
3725
|
-
|
|
3726
|
-
* can be null
|
|
3727
|
-
|
|
3728
|
-
* defined in: [NSIP Project](nsip-project-defs-meeting-properties-estimatedprelimmeetingdate.md "nsip-project.schema.json#/$defs/meeting/properties/estimatedPrelimMeetingDate")
|
|
3729
|
-
|
|
3730
|
-
#### estimatedPrelimMeetingDate Type
|
|
3731
|
-
|
|
3732
|
-
`string`
|
|
3733
|
-
|
|
3734
|
-
#### estimatedPrelimMeetingDate Constraints
|
|
3735
|
-
|
|
3736
|
-
**date time**: the string must be a date time string, according to [RFC 3339, section 5.6](https://tools.ietf.org/html/rfc3339 "check the specification")
|
|
3737
|
-
|
|
3738
|
-
#### estimatedPrelimMeetingDate Examples
|
|
3739
|
-
|
|
3740
|
-
```json
|
|
3741
|
-
"2023-07-27T20:30:00.000Z"
|
|
3742
|
-
```
|
|
3743
|
-
|
|
3744
3744
|
### meetingType
|
|
3745
3745
|
|
|
3746
3746
|
Type of Meeting
|
|
@@ -3783,9 +3783,9 @@ Reference this group by using
|
|
|
3783
3783
|
|
|
3784
3784
|
| Property | Type | Required | Nullable | Defined by |
|
|
3785
3785
|
| :------------------------------------------------ | :------- | :------- | :------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
3786
|
-
| [invoiceStage](#invoicestage) | `string` |
|
|
3786
|
+
| [invoiceStage](#invoicestage) | `string` | Required | cannot be null | [NSIP Project](nsip-project-defs-invoice-properties-invoicestage.md "nsip-project.schema.json#/$defs/invoice/properties/invoiceStage") |
|
|
3787
3787
|
| [invoiceNumber](#invoicenumber) | `string` | Required | cannot be null | [NSIP Project](nsip-project-defs-invoice-properties-invoicenumber.md "nsip-project.schema.json#/$defs/invoice/properties/invoiceNumber") |
|
|
3788
|
-
| [amountDue](#amountdue) | `number` |
|
|
3788
|
+
| [amountDue](#amountdue) | `number` | Optional | can be null | [NSIP Project](nsip-project-defs-invoice-properties-amountdue.md "nsip-project.schema.json#/$defs/invoice/properties/amountDue") |
|
|
3789
3789
|
| [paymentDueDate](#paymentduedate) | `string` | Optional | can be null | [NSIP Project](nsip-project-defs-invoice-properties-paymentduedate.md "nsip-project.schema.json#/$defs/invoice/properties/paymentDueDate") |
|
|
3790
3790
|
| [invoicedDate](#invoiceddate) | `string` | Optional | can be null | [NSIP Project](nsip-project-defs-invoice-properties-invoiceddate.md "nsip-project.schema.json#/$defs/invoice/properties/invoicedDate") |
|
|
3791
3791
|
| [paymentDate](#paymentdate) | `string` | Optional | can be null | [NSIP Project](nsip-project-defs-invoice-properties-paymentdate.md "nsip-project.schema.json#/$defs/invoice/properties/paymentDate") |
|
|
@@ -3800,11 +3800,11 @@ Invoice stage
|
|
|
3800
3800
|
|
|
3801
3801
|
`invoiceStage`
|
|
3802
3802
|
|
|
3803
|
-
* is
|
|
3803
|
+
* is required
|
|
3804
3804
|
|
|
3805
3805
|
* Type: `string`
|
|
3806
3806
|
|
|
3807
|
-
*
|
|
3807
|
+
* cannot be null
|
|
3808
3808
|
|
|
3809
3809
|
* defined in: [NSIP Project](nsip-project-defs-invoice-properties-invoicestage.md "nsip-project.schema.json#/$defs/invoice/properties/invoiceStage")
|
|
3810
3810
|
|
|
@@ -3823,7 +3823,6 @@ Invoice stage
|
|
|
3823
3823
|
| `"pre_examination"` | |
|
|
3824
3824
|
| `"initial_examination"` | |
|
|
3825
3825
|
| `"final_examination"` | |
|
|
3826
|
-
| `null` | |
|
|
3827
3826
|
|
|
3828
3827
|
#### invoiceStage Examples
|
|
3829
3828
|
|
|
@@ -3861,11 +3860,11 @@ Amount due
|
|
|
3861
3860
|
|
|
3862
3861
|
`amountDue`
|
|
3863
3862
|
|
|
3864
|
-
* is
|
|
3863
|
+
* is optional
|
|
3865
3864
|
|
|
3866
3865
|
* Type: `number`
|
|
3867
3866
|
|
|
3868
|
-
*
|
|
3867
|
+
* can be null
|
|
3869
3868
|
|
|
3870
3869
|
* defined in: [NSIP Project](nsip-project-defs-invoice-properties-amountdue.md "nsip-project.schema.json#/$defs/invoice/properties/amountDue")
|
|
3871
3870
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# generated by datamodel-codegen:
|
|
2
2
|
# filename: nsip-meeting.schema.json
|
|
3
|
-
# timestamp: 2026-04-
|
|
3
|
+
# timestamp: 2026-04-27T11:30:32+00:00
|
|
4
4
|
|
|
5
5
|
from __future__ import annotations
|
|
6
6
|
|
|
@@ -63,12 +63,6 @@ class NsipMeeting(BaseModel):
|
|
|
63
63
|
"""
|
|
64
64
|
Meeting date
|
|
65
65
|
"""
|
|
66
|
-
estimatedPrelimMeetingDate: AwareDatetime | None = Field(
|
|
67
|
-
None, examples=["2023-07-27T20:30:00.000Z"]
|
|
68
|
-
)
|
|
69
|
-
"""
|
|
70
|
-
Estimated Preliminary Meeting date
|
|
71
|
-
"""
|
|
72
66
|
meetingType: MeetingType | None = None
|
|
73
67
|
"""
|
|
74
68
|
Type of Meeting
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# generated by datamodel-codegen:
|
|
2
2
|
# filename: nsip-project.schema.json
|
|
3
|
-
# timestamp: 2026-04-
|
|
3
|
+
# timestamp: 2026-04-27T11:30:32+00:00
|
|
4
4
|
|
|
5
5
|
from __future__ import annotations
|
|
6
6
|
|
|
@@ -330,12 +330,6 @@ class Meeting(BaseModel):
|
|
|
330
330
|
"""
|
|
331
331
|
Meeting date
|
|
332
332
|
"""
|
|
333
|
-
estimatedPrelimMeetingDate: AwareDatetime | None = Field(
|
|
334
|
-
None, examples=["2023-07-27T20:30:00.000Z"]
|
|
335
|
-
)
|
|
336
|
-
"""
|
|
337
|
-
Estimated Preliminary Meeting date
|
|
338
|
-
"""
|
|
339
333
|
meetingType: MeetingType | None = None
|
|
340
334
|
"""
|
|
341
335
|
Type of Meeting
|
|
@@ -352,7 +346,6 @@ class InvoiceStage(Enum):
|
|
|
352
346
|
pre_examination = "pre_examination"
|
|
353
347
|
initial_examination = "initial_examination"
|
|
354
348
|
final_examination = "final_examination"
|
|
355
|
-
NoneType_None = None
|
|
356
349
|
|
|
357
350
|
|
|
358
351
|
class Invoice(BaseModel):
|
|
@@ -363,7 +356,7 @@ class Invoice(BaseModel):
|
|
|
363
356
|
model_config = ConfigDict(
|
|
364
357
|
extra="allow",
|
|
365
358
|
)
|
|
366
|
-
invoiceStage: InvoiceStage
|
|
359
|
+
invoiceStage: InvoiceStage = Field(..., examples=["pre_acceptance"])
|
|
367
360
|
"""
|
|
368
361
|
Invoice stage
|
|
369
362
|
"""
|
|
@@ -371,7 +364,7 @@ class Invoice(BaseModel):
|
|
|
371
364
|
"""
|
|
372
365
|
Invoice number
|
|
373
366
|
"""
|
|
374
|
-
amountDue: float = Field(
|
|
367
|
+
amountDue: float | None = Field(None, examples=[500])
|
|
375
368
|
"""
|
|
376
369
|
Amount due
|
|
377
370
|
"""
|
|
@@ -988,6 +981,12 @@ class NsipProject(BaseModel):
|
|
|
988
981
|
"""
|
|
989
982
|
Additional comments
|
|
990
983
|
"""
|
|
984
|
+
estimatedPrelimMeetingDate: AwareDatetime | None = Field(
|
|
985
|
+
None, examples=["2023-07-27T20:30:00.000Z"]
|
|
986
|
+
)
|
|
987
|
+
"""
|
|
988
|
+
Estimated Preliminary Meeting date
|
|
989
|
+
"""
|
|
991
990
|
operationsLeadIds: list[str] | None = Field(
|
|
992
991
|
None,
|
|
993
992
|
examples=[["9bee96d2-00fe-4269-9d01-8c66", "9bee96d2-00fe-4269-9d01-8c22"]],
|
|
@@ -39,12 +39,6 @@
|
|
|
39
39
|
"format": "date-time",
|
|
40
40
|
"examples": ["2023-07-27T20:30:00.000Z"]
|
|
41
41
|
},
|
|
42
|
-
"estimatedPrelimMeetingDate": {
|
|
43
|
-
"type": ["string", "null"],
|
|
44
|
-
"description": "Estimated Preliminary Meeting date",
|
|
45
|
-
"format": "date-time",
|
|
46
|
-
"examples": ["2023-07-27T20:30:00.000Z"]
|
|
47
|
-
},
|
|
48
42
|
"meetingType": {
|
|
49
43
|
"type": ["string", "null"],
|
|
50
44
|
"description": "Type of Meeting",
|
|
@@ -797,6 +797,12 @@
|
|
|
797
797
|
"description": "Additional comments",
|
|
798
798
|
"examples": ["Very likely to change tier from standard to basic after April 2025"]
|
|
799
799
|
},
|
|
800
|
+
"estimatedPrelimMeetingDate": {
|
|
801
|
+
"type": ["string", "null"],
|
|
802
|
+
"description": "Estimated Preliminary Meeting date",
|
|
803
|
+
"format": "date-time",
|
|
804
|
+
"examples": ["2023-07-27T20:30:00.000Z"]
|
|
805
|
+
},
|
|
800
806
|
"operationsLeadIds": {
|
|
801
807
|
"type": "array",
|
|
802
808
|
"items": {
|
|
@@ -895,12 +901,6 @@
|
|
|
895
901
|
"format": "date-time",
|
|
896
902
|
"examples": ["2023-07-27T20:30:00.000Z"]
|
|
897
903
|
},
|
|
898
|
-
"estimatedPrelimMeetingDate": {
|
|
899
|
-
"type": ["string", "null"],
|
|
900
|
-
"description": "Estimated Preliminary Meeting date",
|
|
901
|
-
"format": "date-time",
|
|
902
|
-
"examples": ["2023-07-27T20:30:00.000Z"]
|
|
903
|
-
},
|
|
904
904
|
"meetingType": {
|
|
905
905
|
"type": ["string", "null"],
|
|
906
906
|
"description": "Type of Meeting",
|
|
@@ -912,12 +912,12 @@
|
|
|
912
912
|
"type": "object",
|
|
913
913
|
"additionalProperties": true,
|
|
914
914
|
"description": "An invoice related to the project",
|
|
915
|
-
"required": ["invoiceNumber", "
|
|
915
|
+
"required": ["invoiceNumber", "invoiceStage"],
|
|
916
916
|
"properties": {
|
|
917
917
|
"invoiceStage": {
|
|
918
|
-
"type":
|
|
918
|
+
"type": "string",
|
|
919
919
|
"description": "Invoice stage",
|
|
920
|
-
"enum": ["pre_acceptance", "acceptance", "pre_examination", "initial_examination", "final_examination"
|
|
920
|
+
"enum": ["pre_acceptance", "acceptance", "pre_examination", "initial_examination", "final_examination"],
|
|
921
921
|
"examples": ["pre_acceptance"]
|
|
922
922
|
},
|
|
923
923
|
"invoiceNumber": {
|
|
@@ -926,7 +926,7 @@
|
|
|
926
926
|
"examples": ["1800004419"]
|
|
927
927
|
},
|
|
928
928
|
"amountDue": {
|
|
929
|
-
"type": "number",
|
|
929
|
+
"type": ["number", "null"],
|
|
930
930
|
"description": "Amount due",
|
|
931
931
|
"examples": [500]
|
|
932
932
|
},
|
package/src/schemas.d.ts
CHANGED
|
@@ -2420,10 +2420,6 @@ export interface NSIPMeeting {
|
|
|
2420
2420
|
* Meeting date
|
|
2421
2421
|
*/
|
|
2422
2422
|
meetingDate?: string | null;
|
|
2423
|
-
/**
|
|
2424
|
-
* Estimated Preliminary Meeting date
|
|
2425
|
-
*/
|
|
2426
|
-
estimatedPrelimMeetingDate?: string | null;
|
|
2427
2423
|
/**
|
|
2428
2424
|
* Type of Meeting
|
|
2429
2425
|
*/
|
|
@@ -2963,6 +2959,10 @@ export interface NSIPProject {
|
|
|
2963
2959
|
* Additional comments
|
|
2964
2960
|
*/
|
|
2965
2961
|
additionalComments?: string | null;
|
|
2962
|
+
/**
|
|
2963
|
+
* Estimated Preliminary Meeting date
|
|
2964
|
+
*/
|
|
2965
|
+
estimatedPrelimMeetingDate?: string | null;
|
|
2966
2966
|
/**
|
|
2967
2967
|
* Maps to [Employee].[EmployeeID].
|
|
2968
2968
|
*/
|
|
@@ -3017,10 +3017,6 @@ export interface Meeting {
|
|
|
3017
3017
|
* Meeting date
|
|
3018
3018
|
*/
|
|
3019
3019
|
meetingDate?: string | null;
|
|
3020
|
-
/**
|
|
3021
|
-
* Estimated Preliminary Meeting date
|
|
3022
|
-
*/
|
|
3023
|
-
estimatedPrelimMeetingDate?: string | null;
|
|
3024
3020
|
/**
|
|
3025
3021
|
* Type of Meeting
|
|
3026
3022
|
*/
|
|
@@ -3034,13 +3030,7 @@ export interface Invoice {
|
|
|
3034
3030
|
/**
|
|
3035
3031
|
* Invoice stage
|
|
3036
3032
|
*/
|
|
3037
|
-
invoiceStage
|
|
3038
|
-
| 'pre_acceptance'
|
|
3039
|
-
| 'acceptance'
|
|
3040
|
-
| 'pre_examination'
|
|
3041
|
-
| 'initial_examination'
|
|
3042
|
-
| 'final_examination'
|
|
3043
|
-
| null;
|
|
3033
|
+
invoiceStage: 'pre_acceptance' | 'acceptance' | 'pre_examination' | 'initial_examination' | 'final_examination';
|
|
3044
3034
|
/**
|
|
3045
3035
|
* Invoice number
|
|
3046
3036
|
*/
|
|
@@ -3048,7 +3038,7 @@ export interface Invoice {
|
|
|
3048
3038
|
/**
|
|
3049
3039
|
* Amount due
|
|
3050
3040
|
*/
|
|
3051
|
-
amountDue
|
|
3041
|
+
amountDue?: number | null;
|
|
3052
3042
|
/**
|
|
3053
3043
|
* Payment due date
|
|
3054
3044
|
*/
|