@planning-inspectorate/data-model 2.1.0 → 2.3.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 (42) hide show
  1. package/.azure/ci.yml +3 -0
  2. package/docs/README.md +4 -0
  3. package/docs/appeal-has.md +19 -0
  4. package/docs/appeal-s78.md +19 -0
  5. package/docs/nsip-invoice.md +317 -0
  6. package/docs/nsip-meeting.md +197 -0
  7. package/package.json +2 -2
  8. package/pins_data_model/models/model_appeal_document.py +1 -1
  9. package/pins_data_model/models/model_appeal_event.py +1 -1
  10. package/pins_data_model/models/model_appeal_event_estimate.py +1 -1
  11. package/pins_data_model/models/model_appeal_has.py +9 -1
  12. package/pins_data_model/models/model_appeal_representation.py +1 -1
  13. package/pins_data_model/models/model_appeal_s78.py +9 -1
  14. package/pins_data_model/models/model_dart_response.py +1 -1
  15. package/pins_data_model/models/model_entraid.py +1 -1
  16. package/pins_data_model/models/model_folder.py +1 -1
  17. package/pins_data_model/models/model_gettimesheets_response.py +1 -1
  18. package/pins_data_model/models/model_listed_building.py +1 -1
  19. package/pins_data_model/models/model_listed_buildings.py +1 -1
  20. package/pins_data_model/models/model_nsip_document.py +1 -1
  21. package/pins_data_model/models/model_nsip_exam_timetable.py +1 -1
  22. package/pins_data_model/models/model_nsip_invoice.py +81 -0
  23. package/pins_data_model/models/model_nsip_meeting.py +59 -0
  24. package/pins_data_model/models/model_nsip_project.py +1 -1
  25. package/pins_data_model/models/model_nsip_project_update.py +1 -1
  26. package/pins_data_model/models/model_nsip_representation.py +1 -1
  27. package/pins_data_model/models/model_nsip_subscription.py +1 -1
  28. package/pins_data_model/models/model_pins_inspector.py +1 -1
  29. package/pins_data_model/models/model_pins_lpa.py +1 -1
  30. package/pins_data_model/models/model_s51_advice.py +1 -1
  31. package/pins_data_model/models/model_service_user.py +1 -1
  32. package/schemas/appeal-has.schema.json +6 -1
  33. package/schemas/appeal-s78.schema.json +6 -1
  34. package/schemas/nsip-invoice.schema.json +82 -0
  35. package/schemas/nsip-meeting.schema.json +55 -0
  36. package/src/enums.cjs +16 -0
  37. package/src/enums.d.ts +14 -0
  38. package/src/enums.js +14 -0
  39. package/src/index.cjs +16 -0
  40. package/src/schemas.d.ts +94 -0
  41. package/tests/appeals/appeal-has.test.js +2 -1
  42. package/tests/appeals/appeal-s78.test.js +2 -1
package/src/schemas.d.ts CHANGED
@@ -799,6 +799,10 @@ export type AppealHASCase = (
799
799
  [k: string]: unknown;
800
800
  }[]
801
801
  | null;
802
+ /**
803
+ * padsSapId for PADS inspectors
804
+ */
805
+ padsSapId: string | null;
802
806
  [k: string]: unknown;
803
807
  };
804
808
 
@@ -1505,6 +1509,10 @@ export type AppealS78Case = (
1505
1509
  [k: string]: unknown;
1506
1510
  }[]
1507
1511
  | null;
1512
+ /**
1513
+ * padsSapId for PADS inspectors
1514
+ */
1515
+ padsSapId: string | null;
1508
1516
  [k: string]: unknown;
1509
1517
  };
1510
1518
 
@@ -2088,6 +2096,92 @@ export interface LineItem {
2088
2096
  [k: string]: unknown;
2089
2097
  }
2090
2098
 
2099
+ /**
2100
+ * NSIP Standalone Invoice Schema for ODW Curated layer
2101
+ */
2102
+ export interface NSIPInvoice {
2103
+ /**
2104
+ * The unique identifier within the Back Office. This is not the same as the case reference
2105
+ */
2106
+ caseId: number;
2107
+ caseReference: string | null;
2108
+ /**
2109
+ * Invoice stage
2110
+ */
2111
+ invoiceStage:
2112
+ | 'pre_acceptance'
2113
+ | 'acceptance'
2114
+ | 'pre_examination'
2115
+ | 'initial_examination'
2116
+ | 'final_examination'
2117
+ | null;
2118
+ /**
2119
+ * Invoice number
2120
+ */
2121
+ invoiceNumber: string;
2122
+ /**
2123
+ * Amount due
2124
+ */
2125
+ amountDue: number;
2126
+ /**
2127
+ * Payment due date
2128
+ */
2129
+ paymentDueDate: string | null;
2130
+ /**
2131
+ * Invoiced date
2132
+ */
2133
+ invoicedDate: string | null;
2134
+ /**
2135
+ * Date of payment
2136
+ */
2137
+ paymentDate: string | null;
2138
+ /**
2139
+ * Refund credit note number
2140
+ */
2141
+ refundCreditNoteNumber: string | null;
2142
+ /**
2143
+ * Amount refunded
2144
+ */
2145
+ refundAmount: number | null;
2146
+ /**
2147
+ * Refund issue date
2148
+ */
2149
+ refundIssueDate: string | null;
2150
+ [k: string]: unknown;
2151
+ }
2152
+
2153
+ /**
2154
+ * NSIP Standalone Meeting Schema for ODW Curated layer
2155
+ */
2156
+ export interface NSIPMeeting {
2157
+ /**
2158
+ * The unique identifier for an NSIP Meeting.
2159
+ */
2160
+ meetingID: number;
2161
+ /**
2162
+ * The unique identifier for the case within the Back Office. This is not the same as the case reference
2163
+ */
2164
+ caseId: number;
2165
+ caseReference: string | null;
2166
+ /**
2167
+ * Meeting agenda
2168
+ */
2169
+ meetingAgenda: string | null;
2170
+ /**
2171
+ * Planning Inspectorate role
2172
+ */
2173
+ planningInspectorateRole: 'facilitator' | 'advisor' | 'observer' | null;
2174
+ /**
2175
+ * Meeting date
2176
+ */
2177
+ meetingDate: string | null;
2178
+ /**
2179
+ * Type of Meeting
2180
+ */
2181
+ meetingType: string | null;
2182
+ [k: string]: unknown;
2183
+ }
2184
+
2091
2185
  /**
2092
2186
  * NSIP Project Update (formerly known as Banners)
2093
2187
  */
@@ -172,7 +172,8 @@ const appealHas = {
172
172
  isSiteOnHighwayLand: false,
173
173
  advertType: 'Other'
174
174
  }
175
- ]
175
+ ],
176
+ padsSapId: null
176
177
  };
177
178
 
178
179
  describe(schema, () => {
@@ -160,7 +160,8 @@ const appealS78 = {
160
160
  isSiteOnHighwayLand: false,
161
161
  advertType: 'Other'
162
162
  }
163
- ]
163
+ ],
164
+ padsSapId: null
164
165
  };
165
166
 
166
167
  describe(schema, () => {