@planning-inspectorate/data-model 2.0.1 → 2.2.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/README.md +4 -0
- package/docs/nsip-invoice.md +317 -0
- package/docs/nsip-meeting.md +197 -0
- package/docs/nsip-project-defs-meeting.md +32 -7
- package/docs/nsip-project.md +32 -7
- 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 +81 -0
- package/pins_data_model/models/model_nsip_meeting.py +59 -0
- package/pins_data_model/models/model_nsip_project.py +5 -1
- 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-invoice.schema.json +82 -0
- package/schemas/nsip-meeting.schema.json +55 -0
- package/schemas/nsip-project.schema.json +5 -0
- package/src/enums.cjs +16 -0
- package/src/enums.d.ts +14 -0
- package/src/enums.js +14 -0
- package/src/index.cjs +16 -0
- package/src/schemas.d.ts +90 -0
package/src/schemas.d.ts
CHANGED
|
@@ -2088,6 +2088,92 @@ export interface LineItem {
|
|
|
2088
2088
|
[k: string]: unknown;
|
|
2089
2089
|
}
|
|
2090
2090
|
|
|
2091
|
+
/**
|
|
2092
|
+
* NSIP Standalone Invoice Schema for ODW Curated layer
|
|
2093
|
+
*/
|
|
2094
|
+
export interface NSIPInvoice {
|
|
2095
|
+
/**
|
|
2096
|
+
* The unique identifier within the Back Office. This is not the same as the case reference
|
|
2097
|
+
*/
|
|
2098
|
+
caseId: number;
|
|
2099
|
+
caseReference: string | null;
|
|
2100
|
+
/**
|
|
2101
|
+
* Invoice stage
|
|
2102
|
+
*/
|
|
2103
|
+
invoiceStage:
|
|
2104
|
+
| 'pre_acceptance'
|
|
2105
|
+
| 'acceptance'
|
|
2106
|
+
| 'pre_examination'
|
|
2107
|
+
| 'initial_examination'
|
|
2108
|
+
| 'final_examination'
|
|
2109
|
+
| null;
|
|
2110
|
+
/**
|
|
2111
|
+
* Invoice number
|
|
2112
|
+
*/
|
|
2113
|
+
invoiceNumber: string;
|
|
2114
|
+
/**
|
|
2115
|
+
* Amount due
|
|
2116
|
+
*/
|
|
2117
|
+
amountDue: number;
|
|
2118
|
+
/**
|
|
2119
|
+
* Payment due date
|
|
2120
|
+
*/
|
|
2121
|
+
paymentDueDate: string | null;
|
|
2122
|
+
/**
|
|
2123
|
+
* Invoiced date
|
|
2124
|
+
*/
|
|
2125
|
+
invoicedDate: string | null;
|
|
2126
|
+
/**
|
|
2127
|
+
* Date of payment
|
|
2128
|
+
*/
|
|
2129
|
+
paymentDate: string | null;
|
|
2130
|
+
/**
|
|
2131
|
+
* Refund credit note number
|
|
2132
|
+
*/
|
|
2133
|
+
refundCreditNoteNumber: string | null;
|
|
2134
|
+
/**
|
|
2135
|
+
* Amount refunded
|
|
2136
|
+
*/
|
|
2137
|
+
refundAmount: number | null;
|
|
2138
|
+
/**
|
|
2139
|
+
* Refund issue date
|
|
2140
|
+
*/
|
|
2141
|
+
refundIssueDate: string | null;
|
|
2142
|
+
[k: string]: unknown;
|
|
2143
|
+
}
|
|
2144
|
+
|
|
2145
|
+
/**
|
|
2146
|
+
* NSIP Standalone Meeting Schema for ODW Curated layer
|
|
2147
|
+
*/
|
|
2148
|
+
export interface NSIPMeeting {
|
|
2149
|
+
/**
|
|
2150
|
+
* The unique identifier for an NSIP Meeting.
|
|
2151
|
+
*/
|
|
2152
|
+
meetingID: number;
|
|
2153
|
+
/**
|
|
2154
|
+
* The unique identifier for the case within the Back Office. This is not the same as the case reference
|
|
2155
|
+
*/
|
|
2156
|
+
caseId: number;
|
|
2157
|
+
caseReference: string | null;
|
|
2158
|
+
/**
|
|
2159
|
+
* Meeting agenda
|
|
2160
|
+
*/
|
|
2161
|
+
meetingAgenda: string | null;
|
|
2162
|
+
/**
|
|
2163
|
+
* Planning Inspectorate role
|
|
2164
|
+
*/
|
|
2165
|
+
planningInspectorateRole: 'facilitator' | 'advisor' | 'observer' | null;
|
|
2166
|
+
/**
|
|
2167
|
+
* Meeting date
|
|
2168
|
+
*/
|
|
2169
|
+
meetingDate: string | null;
|
|
2170
|
+
/**
|
|
2171
|
+
* Type of Meeting
|
|
2172
|
+
*/
|
|
2173
|
+
meetingType: string | null;
|
|
2174
|
+
[k: string]: unknown;
|
|
2175
|
+
}
|
|
2176
|
+
|
|
2091
2177
|
/**
|
|
2092
2178
|
* NSIP Project Update (formerly known as Banners)
|
|
2093
2179
|
*/
|
|
@@ -2658,6 +2744,10 @@ export interface NSIPProject {
|
|
|
2658
2744
|
* A meeting related to the project
|
|
2659
2745
|
*/
|
|
2660
2746
|
export interface Meeting {
|
|
2747
|
+
/**
|
|
2748
|
+
* Unique identifier for the meeting
|
|
2749
|
+
*/
|
|
2750
|
+
meetingId?: number | null;
|
|
2661
2751
|
/**
|
|
2662
2752
|
* Meeting agenda
|
|
2663
2753
|
*/
|