@vepler/sdk 2.149.0 → 2.151.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 (139) hide show
  1. package/dist/commonjs/funcs/schoolsGetSchoolById.js +4 -0
  2. package/dist/commonjs/funcs/schoolsGetSchoolById.js.map +1 -1
  3. package/dist/commonjs/funcs/schoolsGetSchoolBySource.js +4 -0
  4. package/dist/commonjs/funcs/schoolsGetSchoolBySource.js.map +1 -1
  5. package/dist/commonjs/lib/config.d.ts +2 -2
  6. package/dist/commonjs/lib/config.js +2 -2
  7. package/dist/commonjs/sdk/models/operations/getschoolbyid.d.ts +69 -0
  8. package/dist/commonjs/sdk/models/operations/getschoolbyid.d.ts.map +1 -1
  9. package/dist/commonjs/sdk/models/operations/getschoolbyid.js +35 -1
  10. package/dist/commonjs/sdk/models/operations/getschoolbyid.js.map +1 -1
  11. package/dist/commonjs/sdk/models/operations/getschoolbysource.d.ts +69 -0
  12. package/dist/commonjs/sdk/models/operations/getschoolbysource.d.ts.map +1 -1
  13. package/dist/commonjs/sdk/models/operations/getschoolbysource.js +35 -1
  14. package/dist/commonjs/sdk/models/operations/getschoolbysource.js.map +1 -1
  15. package/dist/commonjs/sdk/models/operations/queryschools.d.ts +78 -0
  16. package/dist/commonjs/sdk/models/operations/queryschools.d.ts.map +1 -1
  17. package/dist/commonjs/sdk/models/operations/queryschools.js +42 -1
  18. package/dist/commonjs/sdk/models/operations/queryschools.js.map +1 -1
  19. package/dist/commonjs/sdk/models/operations/queryschoolsbysource.d.ts +78 -0
  20. package/dist/commonjs/sdk/models/operations/queryschoolsbysource.d.ts.map +1 -1
  21. package/dist/commonjs/sdk/models/operations/queryschoolsbysource.js +41 -1
  22. package/dist/commonjs/sdk/models/operations/queryschoolsbysource.js.map +1 -1
  23. package/dist/commonjs/sdk/models/shared/chargeentry.d.ts +1 -1
  24. package/dist/commonjs/sdk/models/shared/chargehistory.d.ts +1 -1
  25. package/dist/commonjs/sdk/models/shared/index.d.ts +6 -0
  26. package/dist/commonjs/sdk/models/shared/index.d.ts.map +1 -1
  27. package/dist/commonjs/sdk/models/shared/index.js +6 -0
  28. package/dist/commonjs/sdk/models/shared/index.js.map +1 -1
  29. package/dist/commonjs/sdk/models/shared/listing.d.ts +2 -2
  30. package/dist/commonjs/sdk/models/shared/listingpricechange.d.ts +2 -2
  31. package/dist/commonjs/sdk/models/shared/pricechange.d.ts +2 -2
  32. package/dist/commonjs/sdk/models/shared/pricingdata.d.ts +4 -4
  33. package/dist/commonjs/sdk/models/shared/salerecord.d.ts +1 -1
  34. package/dist/commonjs/sdk/models/shared/schoolinspectionevaluationarea.d.ts +17 -0
  35. package/dist/commonjs/sdk/models/shared/schoolinspectionevaluationarea.d.ts.map +1 -0
  36. package/dist/commonjs/sdk/models/shared/schoolinspectionevaluationarea.js +51 -0
  37. package/dist/commonjs/sdk/models/shared/schoolinspectionevaluationarea.js.map +1 -0
  38. package/dist/commonjs/sdk/models/shared/schoolinspectionevent.d.ts +103 -0
  39. package/dist/commonjs/sdk/models/shared/schoolinspectionevent.d.ts.map +1 -0
  40. package/dist/commonjs/sdk/models/shared/schoolinspectionevent.js +112 -0
  41. package/dist/commonjs/sdk/models/shared/schoolinspectionevent.js.map +1 -0
  42. package/dist/commonjs/sdk/models/shared/schoolinspectiongrade.d.ts +17 -0
  43. package/dist/commonjs/sdk/models/shared/schoolinspectiongrade.d.ts.map +1 -0
  44. package/dist/commonjs/sdk/models/shared/schoolinspectiongrade.js +51 -0
  45. package/dist/commonjs/sdk/models/shared/schoolinspectiongrade.js.map +1 -0
  46. package/dist/commonjs/sdk/models/shared/schoolinspectionpredecessor.d.ts +13 -0
  47. package/dist/commonjs/sdk/models/shared/schoolinspectionpredecessor.d.ts.map +1 -0
  48. package/dist/commonjs/sdk/models/shared/schoolinspectionpredecessor.js +53 -0
  49. package/dist/commonjs/sdk/models/shared/schoolinspectionpredecessor.js.map +1 -0
  50. package/dist/commonjs/sdk/models/shared/schoolinspectorbody.d.ts +19 -0
  51. package/dist/commonjs/sdk/models/shared/schoolinspectorbody.d.ts.map +1 -0
  52. package/dist/commonjs/sdk/models/shared/schoolinspectorbody.js +53 -0
  53. package/dist/commonjs/sdk/models/shared/schoolinspectorbody.js.map +1 -0
  54. package/dist/commonjs/sdk/models/shared/schooltrustmembership.d.ts +45 -0
  55. package/dist/commonjs/sdk/models/shared/schooltrustmembership.d.ts.map +1 -0
  56. package/dist/commonjs/sdk/models/shared/schooltrustmembership.js +58 -0
  57. package/dist/commonjs/sdk/models/shared/schooltrustmembership.js.map +1 -0
  58. package/dist/commonjs/sdk/models/shared/sitepropertystats.d.ts +2 -2
  59. package/dist/esm/funcs/schoolsGetSchoolById.js +5 -1
  60. package/dist/esm/funcs/schoolsGetSchoolById.js.map +1 -1
  61. package/dist/esm/funcs/schoolsGetSchoolBySource.js +5 -1
  62. package/dist/esm/funcs/schoolsGetSchoolBySource.js.map +1 -1
  63. package/dist/esm/lib/config.d.ts +2 -2
  64. package/dist/esm/lib/config.js +2 -2
  65. package/dist/esm/sdk/models/operations/getschoolbyid.d.ts +69 -0
  66. package/dist/esm/sdk/models/operations/getschoolbyid.d.ts.map +1 -1
  67. package/dist/esm/sdk/models/operations/getschoolbyid.js +31 -0
  68. package/dist/esm/sdk/models/operations/getschoolbyid.js.map +1 -1
  69. package/dist/esm/sdk/models/operations/getschoolbysource.d.ts +69 -0
  70. package/dist/esm/sdk/models/operations/getschoolbysource.d.ts.map +1 -1
  71. package/dist/esm/sdk/models/operations/getschoolbysource.js +31 -0
  72. package/dist/esm/sdk/models/operations/getschoolbysource.js.map +1 -1
  73. package/dist/esm/sdk/models/operations/queryschools.d.ts +78 -0
  74. package/dist/esm/sdk/models/operations/queryschools.d.ts.map +1 -1
  75. package/dist/esm/sdk/models/operations/queryschools.js +37 -0
  76. package/dist/esm/sdk/models/operations/queryschools.js.map +1 -1
  77. package/dist/esm/sdk/models/operations/queryschoolsbysource.d.ts +78 -0
  78. package/dist/esm/sdk/models/operations/queryschoolsbysource.d.ts.map +1 -1
  79. package/dist/esm/sdk/models/operations/queryschoolsbysource.js +36 -0
  80. package/dist/esm/sdk/models/operations/queryschoolsbysource.js.map +1 -1
  81. package/dist/esm/sdk/models/shared/chargeentry.d.ts +1 -1
  82. package/dist/esm/sdk/models/shared/chargehistory.d.ts +1 -1
  83. package/dist/esm/sdk/models/shared/index.d.ts +6 -0
  84. package/dist/esm/sdk/models/shared/index.d.ts.map +1 -1
  85. package/dist/esm/sdk/models/shared/index.js +6 -0
  86. package/dist/esm/sdk/models/shared/index.js.map +1 -1
  87. package/dist/esm/sdk/models/shared/listing.d.ts +2 -2
  88. package/dist/esm/sdk/models/shared/listingpricechange.d.ts +2 -2
  89. package/dist/esm/sdk/models/shared/pricechange.d.ts +2 -2
  90. package/dist/esm/sdk/models/shared/pricingdata.d.ts +4 -4
  91. package/dist/esm/sdk/models/shared/salerecord.d.ts +1 -1
  92. package/dist/esm/sdk/models/shared/schoolinspectionevaluationarea.d.ts +17 -0
  93. package/dist/esm/sdk/models/shared/schoolinspectionevaluationarea.d.ts.map +1 -0
  94. package/dist/esm/sdk/models/shared/schoolinspectionevaluationarea.js +14 -0
  95. package/dist/esm/sdk/models/shared/schoolinspectionevaluationarea.js.map +1 -0
  96. package/dist/esm/sdk/models/shared/schoolinspectionevent.d.ts +103 -0
  97. package/dist/esm/sdk/models/shared/schoolinspectionevent.d.ts.map +1 -0
  98. package/dist/esm/sdk/models/shared/schoolinspectionevent.js +74 -0
  99. package/dist/esm/sdk/models/shared/schoolinspectionevent.js.map +1 -0
  100. package/dist/esm/sdk/models/shared/schoolinspectiongrade.d.ts +17 -0
  101. package/dist/esm/sdk/models/shared/schoolinspectiongrade.d.ts.map +1 -0
  102. package/dist/esm/sdk/models/shared/schoolinspectiongrade.js +14 -0
  103. package/dist/esm/sdk/models/shared/schoolinspectiongrade.js.map +1 -0
  104. package/dist/esm/sdk/models/shared/schoolinspectionpredecessor.d.ts +13 -0
  105. package/dist/esm/sdk/models/shared/schoolinspectionpredecessor.d.ts.map +1 -0
  106. package/dist/esm/sdk/models/shared/schoolinspectionpredecessor.js +16 -0
  107. package/dist/esm/sdk/models/shared/schoolinspectionpredecessor.js.map +1 -0
  108. package/dist/esm/sdk/models/shared/schoolinspectorbody.d.ts +19 -0
  109. package/dist/esm/sdk/models/shared/schoolinspectorbody.d.ts.map +1 -0
  110. package/dist/esm/sdk/models/shared/schoolinspectorbody.js +17 -0
  111. package/dist/esm/sdk/models/shared/schoolinspectorbody.js.map +1 -0
  112. package/dist/esm/sdk/models/shared/schooltrustmembership.d.ts +45 -0
  113. package/dist/esm/sdk/models/shared/schooltrustmembership.d.ts.map +1 -0
  114. package/dist/esm/sdk/models/shared/schooltrustmembership.js +21 -0
  115. package/dist/esm/sdk/models/shared/schooltrustmembership.js.map +1 -0
  116. package/dist/esm/sdk/models/shared/sitepropertystats.d.ts +2 -2
  117. package/package.json +1 -1
  118. package/src/funcs/schoolsGetSchoolById.ts +6 -1
  119. package/src/funcs/schoolsGetSchoolBySource.ts +6 -1
  120. package/src/lib/config.ts +2 -2
  121. package/src/sdk/models/operations/getschoolbyid.ts +126 -0
  122. package/src/sdk/models/operations/getschoolbysource.ts +134 -0
  123. package/src/sdk/models/operations/queryschools.ts +154 -0
  124. package/src/sdk/models/operations/queryschoolsbysource.ts +153 -0
  125. package/src/sdk/models/shared/chargeentry.ts +1 -1
  126. package/src/sdk/models/shared/chargehistory.ts +1 -1
  127. package/src/sdk/models/shared/index.ts +6 -0
  128. package/src/sdk/models/shared/listing.ts +2 -2
  129. package/src/sdk/models/shared/listingpricechange.ts +2 -2
  130. package/src/sdk/models/shared/pricechange.ts +2 -2
  131. package/src/sdk/models/shared/pricingdata.ts +4 -4
  132. package/src/sdk/models/shared/salerecord.ts +1 -1
  133. package/src/sdk/models/shared/schoolinspectionevaluationarea.ts +39 -0
  134. package/src/sdk/models/shared/schoolinspectionevent.ts +184 -0
  135. package/src/sdk/models/shared/schoolinspectiongrade.ts +39 -0
  136. package/src/sdk/models/shared/schoolinspectionpredecessor.ts +37 -0
  137. package/src/sdk/models/shared/schoolinspectorbody.ts +29 -0
  138. package/src/sdk/models/shared/schooltrustmembership.ts +74 -0
  139. package/src/sdk/models/shared/sitepropertystats.ts +2 -2
@@ -11,6 +11,11 @@ import { Result as SafeParseResult } from "../../types/fp.js";
11
11
  import { SDKValidationError } from "../errors/sdkvalidationerror.js";
12
12
  import * as shared from "../shared/index.js";
13
13
 
14
+ /**
15
+ * Fields/blocks to return per school. Default: the full flat record with no aggregate blocks. Aggregate blocks are opt-in: `inspections`.
16
+ */
17
+ export type Attributes = string | Array<string>;
18
+
14
19
  /**
15
20
  * Source register identifier. 'dfe': UK DfE GIAS (England + cross-border Welsh URNs). 'welshgov': Welsh Government School Number. 'seed': Scottish SEED code. 'deni': NI DE Reference. 'dept_edu_ie': Irish Roll Number.
16
21
  */
@@ -30,6 +35,10 @@ export type Provider = ClosedEnum<typeof Provider>;
30
35
  * Batch lookup by provider keys. Keys that do not match are silently omitted from the response.
31
36
  */
32
37
  export type QuerySchoolsBySourceRequestBody = {
38
+ /**
39
+ * Fields/blocks to return per school. Default: the full flat record with no aggregate blocks. Aggregate blocks are opt-in: `inspections`.
40
+ */
41
+ attributes?: string | Array<string> | undefined;
33
42
  /**
34
43
  * Array of provider-scoped identifiers (URNs / SEED codes / etc). Maximum 500 per request.
35
44
  */
@@ -97,6 +106,42 @@ export type QuerySchoolsBySourceCurrentRating = OpenEnum<
97
106
  typeof QuerySchoolsBySourceCurrentRating
98
107
  >;
99
108
 
109
+ /**
110
+ * Cross-register identifiers. Present only when requested via `attributes=identifiers`.
111
+ */
112
+ export type QuerySchoolsBySourceIdentifiers = {
113
+ /**
114
+ * Estyn provider id (Wales).
115
+ */
116
+ estynId?: string | null | undefined;
117
+ /**
118
+ * Ofsted provider id (England).
119
+ */
120
+ ofstedProviderId?: string | null | undefined;
121
+ /**
122
+ * Predecessor URNs this school was previously known by (re-identification lineage).
123
+ */
124
+ oldUrns?: Array<string> | undefined;
125
+ /**
126
+ * UK Provider Reference Number (UKPRN).
127
+ */
128
+ ukprn?: string | null | undefined;
129
+ };
130
+
131
+ /**
132
+ * Inspection history. Present only when requested via `attributes=inspections`.
133
+ */
134
+ export type QuerySchoolsBySourceInspections = {
135
+ /**
136
+ * Most recent inspection event, or null if never inspected.
137
+ */
138
+ current: shared.SchoolInspectionEvent | null;
139
+ /**
140
+ * Every inspection event, newest first (includes `current`).
141
+ */
142
+ history?: Array<shared.SchoolInspectionEvent | null> | undefined;
143
+ };
144
+
100
145
  /**
101
146
  * Geographic coordinates of the school
102
147
  */
@@ -156,6 +201,16 @@ export type QuerySchoolsBySourceStatus = OpenEnum<
156
201
  typeof QuerySchoolsBySourceStatus
157
202
  >;
158
203
 
204
+ /**
205
+ * Trust / organisation memberships. Present only when requested via `attributes=trust`.
206
+ */
207
+ export type QuerySchoolsBySourceTrust = {
208
+ /**
209
+ * Active organisation memberships, lead/trust roles first.
210
+ */
211
+ memberships?: Array<shared.SchoolTrustMembership> | undefined;
212
+ };
213
+
159
214
  /**
160
215
  * Educational institution type. 'nursery': early years. 'primary': key stages 1-2 / ISCED 1. 'secondary': key stages 3-4 / ISCED 2-3. 'all-through': combined primary + secondary. 'sixth-form': post-16. 'special': special educational needs. 'independent': fee-paying. 'academy': state-funded, independently run. 'other': alternative provision / pupil referral / unclassified.
161
216
  */
@@ -215,6 +270,14 @@ export type QuerySchoolsBySourceData = {
215
270
  * System-generated identifier. Stable across updates.
216
271
  */
217
272
  id: number;
273
+ /**
274
+ * Cross-register identifiers. Present only when requested via `attributes=identifiers`.
275
+ */
276
+ identifiers?: QuerySchoolsBySourceIdentifiers | null | undefined;
277
+ /**
278
+ * Inspection history. Present only when requested via `attributes=inspections`.
279
+ */
280
+ inspections?: QuerySchoolsBySourceInspections | null | undefined;
218
281
  /**
219
282
  * Provider-scoped identifier. URN for `dfe`, SEED for `seed`, etc. Combined with `provider` this is a globally unique alternate key for the school.
220
283
  */
@@ -271,6 +334,10 @@ export type QuerySchoolsBySourceData = {
271
334
  */
272
335
  subType?: string | undefined;
273
336
  telephone?: string | undefined;
337
+ /**
338
+ * Trust / organisation memberships. Present only when requested via `attributes=trust`.
339
+ */
340
+ trust?: QuerySchoolsBySourceTrust | null | undefined;
274
341
  trustId?: string | undefined;
275
342
  trustName?: string | undefined;
276
343
  /**
@@ -323,12 +390,27 @@ export type QuerySchoolsBySourceResponseBody = {
323
390
  url: string;
324
391
  };
325
392
 
393
+ /** @internal */
394
+ export type Attributes$Outbound = string | Array<string>;
395
+
396
+ /** @internal */
397
+ export const Attributes$outboundSchema: z.ZodType<
398
+ Attributes$Outbound,
399
+ z.ZodTypeDef,
400
+ Attributes
401
+ > = z.union([z.string(), z.array(z.string())]);
402
+
403
+ export function attributesToJSON(attributes: Attributes): string {
404
+ return JSON.stringify(Attributes$outboundSchema.parse(attributes));
405
+ }
406
+
326
407
  /** @internal */
327
408
  export const Provider$outboundSchema: z.ZodNativeEnum<typeof Provider> = z
328
409
  .nativeEnum(Provider);
329
410
 
330
411
  /** @internal */
331
412
  export type QuerySchoolsBySourceRequestBody$Outbound = {
413
+ attributes?: string | Array<string> | undefined;
332
414
  keys: Array<string>;
333
415
  provider: string;
334
416
  };
@@ -339,6 +421,7 @@ export const QuerySchoolsBySourceRequestBody$outboundSchema: z.ZodType<
339
421
  z.ZodTypeDef,
340
422
  QuerySchoolsBySourceRequestBody
341
423
  > = z.object({
424
+ attributes: z.union([z.string(), z.array(z.string())]).optional(),
342
425
  keys: z.array(z.string()),
343
426
  provider: Provider$outboundSchema,
344
427
  });
@@ -383,6 +466,49 @@ export const QuerySchoolsBySourceCurrentRating$inboundSchema: z.ZodType<
383
466
  unknown
384
467
  > = openEnums.inboundSchema(QuerySchoolsBySourceCurrentRating);
385
468
 
469
+ /** @internal */
470
+ export const QuerySchoolsBySourceIdentifiers$inboundSchema: z.ZodType<
471
+ QuerySchoolsBySourceIdentifiers,
472
+ z.ZodTypeDef,
473
+ unknown
474
+ > = z.object({
475
+ estynId: z.nullable(z.string()).optional(),
476
+ ofstedProviderId: z.nullable(z.string()).optional(),
477
+ oldUrns: z.array(z.string()).optional(),
478
+ ukprn: z.nullable(z.string()).optional(),
479
+ });
480
+
481
+ export function querySchoolsBySourceIdentifiersFromJSON(
482
+ jsonString: string,
483
+ ): SafeParseResult<QuerySchoolsBySourceIdentifiers, SDKValidationError> {
484
+ return safeParse(
485
+ jsonString,
486
+ (x) => QuerySchoolsBySourceIdentifiers$inboundSchema.parse(JSON.parse(x)),
487
+ `Failed to parse 'QuerySchoolsBySourceIdentifiers' from JSON`,
488
+ );
489
+ }
490
+
491
+ /** @internal */
492
+ export const QuerySchoolsBySourceInspections$inboundSchema: z.ZodType<
493
+ QuerySchoolsBySourceInspections,
494
+ z.ZodTypeDef,
495
+ unknown
496
+ > = z.object({
497
+ current: z.nullable(shared.SchoolInspectionEvent$inboundSchema),
498
+ history: z.array(z.nullable(shared.SchoolInspectionEvent$inboundSchema))
499
+ .optional(),
500
+ });
501
+
502
+ export function querySchoolsBySourceInspectionsFromJSON(
503
+ jsonString: string,
504
+ ): SafeParseResult<QuerySchoolsBySourceInspections, SDKValidationError> {
505
+ return safeParse(
506
+ jsonString,
507
+ (x) => QuerySchoolsBySourceInspections$inboundSchema.parse(JSON.parse(x)),
508
+ `Failed to parse 'QuerySchoolsBySourceInspections' from JSON`,
509
+ );
510
+ }
511
+
386
512
  /** @internal */
387
513
  export const QuerySchoolsBySourceLocation$inboundSchema: z.ZodType<
388
514
  QuerySchoolsBySourceLocation,
@@ -422,6 +548,25 @@ export const QuerySchoolsBySourceStatus$inboundSchema: z.ZodType<
422
548
  unknown
423
549
  > = openEnums.inboundSchema(QuerySchoolsBySourceStatus);
424
550
 
551
+ /** @internal */
552
+ export const QuerySchoolsBySourceTrust$inboundSchema: z.ZodType<
553
+ QuerySchoolsBySourceTrust,
554
+ z.ZodTypeDef,
555
+ unknown
556
+ > = z.object({
557
+ memberships: z.array(shared.SchoolTrustMembership$inboundSchema).optional(),
558
+ });
559
+
560
+ export function querySchoolsBySourceTrustFromJSON(
561
+ jsonString: string,
562
+ ): SafeParseResult<QuerySchoolsBySourceTrust, SDKValidationError> {
563
+ return safeParse(
564
+ jsonString,
565
+ (x) => QuerySchoolsBySourceTrust$inboundSchema.parse(JSON.parse(x)),
566
+ `Failed to parse 'QuerySchoolsBySourceTrust' from JSON`,
567
+ );
568
+ }
569
+
425
570
  /** @internal */
426
571
  export const QuerySchoolsBySourceType$inboundSchema: z.ZodType<
427
572
  QuerySchoolsBySourceType,
@@ -449,6 +594,12 @@ export const QuerySchoolsBySourceData$inboundSchema: z.ZodType<
449
594
  gender: z.string().optional(),
450
595
  headteacher: z.string().optional(),
451
596
  id: z.number().int(),
597
+ identifiers: z.nullable(
598
+ z.lazy(() => QuerySchoolsBySourceIdentifiers$inboundSchema),
599
+ ).optional(),
600
+ inspections: z.nullable(
601
+ z.lazy(() => QuerySchoolsBySourceInspections$inboundSchema),
602
+ ).optional(),
452
603
  key: z.string(),
453
604
  laCode: z.string().optional(),
454
605
  laName: z.string().optional(),
@@ -470,6 +621,8 @@ export const QuerySchoolsBySourceData$inboundSchema: z.ZodType<
470
621
  status: QuerySchoolsBySourceStatus$inboundSchema,
471
622
  subType: z.string().optional(),
472
623
  telephone: z.string().optional(),
624
+ trust: z.nullable(z.lazy(() => QuerySchoolsBySourceTrust$inboundSchema))
625
+ .optional(),
473
626
  trustId: z.string().optional(),
474
627
  trustName: z.string().optional(),
475
628
  type: QuerySchoolsBySourceType$inboundSchema,
@@ -33,7 +33,7 @@ export type ChargeEntry = {
33
33
  */
34
34
  sourceProvider: string;
35
35
  /**
36
- * Charge amount in pence
36
+ * Charge amount in GBP (whole pounds)
37
37
  */
38
38
  value: number;
39
39
  };
@@ -18,7 +18,7 @@ export type ChargeHistory = {
18
18
  */
19
19
  currency?: string | null | undefined;
20
20
  /**
21
- * Current best estimate (annual) in pence
21
+ * Current best estimate (annual) in GBP (whole pounds)
22
22
  */
23
23
  current?: number | null | undefined;
24
24
  /**
@@ -296,7 +296,13 @@ export * from "./salerecord.js";
296
296
  export * from "./scale.js";
297
297
  export * from "./schoolcatchmentblock.js";
298
298
  export * from "./schoolframeworkcode.js";
299
+ export * from "./schoolinspectionevaluationarea.js";
300
+ export * from "./schoolinspectionevent.js";
301
+ export * from "./schoolinspectiongrade.js";
302
+ export * from "./schoolinspectionpredecessor.js";
303
+ export * from "./schoolinspectorbody.js";
299
304
  export * from "./schoolmatchbasis.js";
305
+ export * from "./schooltrustmembership.js";
300
306
  export * from "./searchhighlight.js";
301
307
  export * from "./searchresponse.js";
302
308
  export * from "./searchresult.js";
@@ -55,11 +55,11 @@ export type Pricing = {
55
55
  */
56
56
  currency?: string | null | undefined;
57
57
  /**
58
- * Estimated price in pence
58
+ * Estimated price in GBP (whole pounds)
59
59
  */
60
60
  estimated?: number | null | undefined;
61
61
  /**
62
- * Listed price in pence
62
+ * Listed price in GBP (whole pounds)
63
63
  */
64
64
  price?: number | null | undefined;
65
65
  };
@@ -24,7 +24,7 @@ export type Direction = OpenEnum<typeof Direction>;
24
24
 
25
25
  export type ListingPriceChange = {
26
26
  /**
27
- * Amount of change in pence
27
+ * Amount of change in GBP (whole pounds)
28
28
  */
29
29
  amount?: number | null | undefined;
30
30
  /**
@@ -40,7 +40,7 @@ export type ListingPriceChange = {
40
40
  */
41
41
  percent?: number | null | undefined;
42
42
  /**
43
- * New price after change in pence
43
+ * New price after change in GBP (whole pounds)
44
44
  */
45
45
  price?: number | null | undefined;
46
46
  };
@@ -24,7 +24,7 @@ export type PriceChangeDirection = OpenEnum<typeof PriceChangeDirection>;
24
24
 
25
25
  export type PriceChange = {
26
26
  /**
27
- * Amount of change in pence
27
+ * Amount of change in GBP (whole pounds)
28
28
  */
29
29
  amount?: number | null | undefined;
30
30
  /**
@@ -40,7 +40,7 @@ export type PriceChange = {
40
40
  */
41
41
  percent?: number | null | undefined;
42
42
  /**
43
- * New price after change in pence
43
+ * New price after change in GBP (whole pounds)
44
44
  */
45
45
  price?: number | null | undefined;
46
46
  };
@@ -13,19 +13,19 @@ export type PricingData = {
13
13
  */
14
14
  currency?: string | null | undefined;
15
15
  /**
16
- * Current rental price per month in pence
16
+ * Current rental price per month in GBP (whole pounds)
17
17
  */
18
18
  currentRent?: number | null | undefined;
19
19
  /**
20
- * Current sale price in pence
20
+ * Current sale price in GBP (whole pounds)
21
21
  */
22
22
  currentSale?: number | null | undefined;
23
23
  /**
24
- * Estimated rental value per month in pence
24
+ * Estimated monthly rental value in GBP (whole pounds)
25
25
  */
26
26
  estimatedRent?: number | null | undefined;
27
27
  /**
28
- * Estimated sale value in pence
28
+ * Estimated sale value in GBP (whole pounds)
29
29
  */
30
30
  estimatedSale?: number | null | undefined;
31
31
  };
@@ -9,7 +9,7 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
9
9
 
10
10
  export type SaleRecord = {
11
11
  /**
12
- * Sale price in pence
12
+ * Sale price in GBP (whole pounds)
13
13
  */
14
14
  amount: number;
15
15
  /**
@@ -0,0 +1,39 @@
1
+ /*
2
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
+ */
4
+
5
+ import * as z from "zod/v3";
6
+ import { safeParse } from "../../../lib/schemas.js";
7
+ import { Result as SafeParseResult } from "../../types/fp.js";
8
+ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
9
+
10
+ export type SchoolInspectionEvaluationArea = {
11
+ /**
12
+ * Evaluation area key, e.g. 'leadership_governance'
13
+ */
14
+ area: string;
15
+ /**
16
+ * Category grade, e.g. 'Strong standard', or 'Met'/'Not met' for safeguarding
17
+ */
18
+ grade: string;
19
+ };
20
+
21
+ /** @internal */
22
+ export const SchoolInspectionEvaluationArea$inboundSchema: z.ZodType<
23
+ SchoolInspectionEvaluationArea,
24
+ z.ZodTypeDef,
25
+ unknown
26
+ > = z.object({
27
+ area: z.string(),
28
+ grade: z.string(),
29
+ });
30
+
31
+ export function schoolInspectionEvaluationAreaFromJSON(
32
+ jsonString: string,
33
+ ): SafeParseResult<SchoolInspectionEvaluationArea, SDKValidationError> {
34
+ return safeParse(
35
+ jsonString,
36
+ (x) => SchoolInspectionEvaluationArea$inboundSchema.parse(JSON.parse(x)),
37
+ `Failed to parse 'SchoolInspectionEvaluationArea' from JSON`,
38
+ );
39
+ }
@@ -0,0 +1,184 @@
1
+ /*
2
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
+ */
4
+
5
+ import * as z from "zod/v3";
6
+ import { safeParse } from "../../../lib/schemas.js";
7
+ import * as openEnums from "../../types/enums.js";
8
+ import { OpenEnum } from "../../types/enums.js";
9
+ import { Result as SafeParseResult } from "../../types/fp.js";
10
+ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
11
+ import {
12
+ SchoolInspectionEvaluationArea,
13
+ SchoolInspectionEvaluationArea$inboundSchema,
14
+ } from "./schoolinspectionevaluationarea.js";
15
+ import {
16
+ SchoolInspectionGrade,
17
+ SchoolInspectionGrade$inboundSchema,
18
+ } from "./schoolinspectiongrade.js";
19
+ import {
20
+ SchoolInspectionPredecessor,
21
+ SchoolInspectionPredecessor$inboundSchema,
22
+ } from "./schoolinspectionpredecessor.js";
23
+ import {
24
+ SchoolInspectorBody,
25
+ SchoolInspectorBody$inboundSchema,
26
+ } from "./schoolinspectorbody.js";
27
+
28
+ /**
29
+ * The inspectorate's own native overall grade. Not cross-body comparable.
30
+ */
31
+ export const SchoolInspectionEventRating = {
32
+ Outstanding: "outstanding",
33
+ Good: "good",
34
+ Satisfactory: "satisfactory",
35
+ Inadequate: "inadequate",
36
+ Exceptional: "exceptional",
37
+ StrongStandard: "strong_standard",
38
+ ExpectedStandard: "expected_standard",
39
+ NeedsAttention: "needs_attention",
40
+ UrgentImprovement: "urgent_improvement",
41
+ RequiresImprovement: "requires_improvement",
42
+ NotYetInspected: "not_yet_inspected",
43
+ Excellent: "excellent",
44
+ Adequate: "adequate",
45
+ Unsatisfactory: "unsatisfactory",
46
+ VeryGood: "very_good",
47
+ Weak: "weak",
48
+ ImportantAreaForImprovement: "important_area_for_improvement",
49
+ RequiresSignificantImprovement: "requires_significant_improvement",
50
+ Fair: "fair",
51
+ } as const;
52
+ /**
53
+ * The inspectorate's own native overall grade. Not cross-body comparable.
54
+ */
55
+ export type SchoolInspectionEventRating = OpenEnum<
56
+ typeof SchoolInspectionEventRating
57
+ >;
58
+
59
+ /**
60
+ * OEIF 1-4 sub-judgements (graded pre-2025 inspections).
61
+ */
62
+ export type Ratings = {
63
+ behaviourAndAttitudes?: SchoolInspectionGrade | null | undefined;
64
+ earlyYearsProvision?: SchoolInspectionGrade | null | undefined;
65
+ leadershipAndManagement?: SchoolInspectionGrade | null | undefined;
66
+ overallEffectiveness?: SchoolInspectionGrade | null | undefined;
67
+ personalDevelopment?: SchoolInspectionGrade | null | undefined;
68
+ qualityOfEducation?: SchoolInspectionGrade | null | undefined;
69
+ sixthFormProvision?: SchoolInspectionGrade | null | undefined;
70
+ };
71
+
72
+ /**
73
+ * Most recent inspection event, or null if never inspected.
74
+ */
75
+ export type SchoolInspectionEvent = {
76
+ /**
77
+ * Statutory category of concern (e.g. 'Special measures'), where applicable.
78
+ */
79
+ categoryOfConcern?: string | null | undefined;
80
+ /**
81
+ * Post-2025 Ofsted evaluation-area grades.
82
+ */
83
+ evaluationAreas?: Array<SchoolInspectionEvaluationArea> | null | undefined;
84
+ /**
85
+ * Framework variant, e.g. 'post_2025' | 'oeif' | 'ungraded_only'.
86
+ */
87
+ framework?: string | null | undefined;
88
+ /**
89
+ * ISO date of the inspection.
90
+ */
91
+ inspectionDate: string;
92
+ /**
93
+ * Inspection type as published by the inspectorate.
94
+ */
95
+ inspectionType?: string | null | undefined;
96
+ /**
97
+ * Inspectorate that issued the rating. ofsted (England), estyn (Wales), education_scotland (Scotland), eti (Northern Ireland), des (Ireland).
98
+ */
99
+ inspectorBody: SchoolInspectorBody;
100
+ predecessor?: SchoolInspectionPredecessor | null | undefined;
101
+ /**
102
+ * ISO date the report was published, where known.
103
+ */
104
+ publicationDate?: string | null | undefined;
105
+ /**
106
+ * The inspectorate's own native overall grade. Not cross-body comparable.
107
+ */
108
+ rating: SchoolInspectionEventRating;
109
+ /**
110
+ * OEIF 1-4 sub-judgements (graded pre-2025 inspections).
111
+ */
112
+ ratings?: Ratings | null | undefined;
113
+ /**
114
+ * Canonical link to the published inspection report on the inspectorate's site.
115
+ */
116
+ reportUrl?: string | null | undefined;
117
+ };
118
+
119
+ /** @internal */
120
+ export const SchoolInspectionEventRating$inboundSchema: z.ZodType<
121
+ SchoolInspectionEventRating,
122
+ z.ZodTypeDef,
123
+ unknown
124
+ > = openEnums.inboundSchema(SchoolInspectionEventRating);
125
+
126
+ /** @internal */
127
+ export const Ratings$inboundSchema: z.ZodType<Ratings, z.ZodTypeDef, unknown> =
128
+ z.object({
129
+ behaviourAndAttitudes: z.nullable(SchoolInspectionGrade$inboundSchema)
130
+ .optional(),
131
+ earlyYearsProvision: z.nullable(SchoolInspectionGrade$inboundSchema)
132
+ .optional(),
133
+ leadershipAndManagement: z.nullable(SchoolInspectionGrade$inboundSchema)
134
+ .optional(),
135
+ overallEffectiveness: z.nullable(SchoolInspectionGrade$inboundSchema)
136
+ .optional(),
137
+ personalDevelopment: z.nullable(SchoolInspectionGrade$inboundSchema)
138
+ .optional(),
139
+ qualityOfEducation: z.nullable(SchoolInspectionGrade$inboundSchema)
140
+ .optional(),
141
+ sixthFormProvision: z.nullable(SchoolInspectionGrade$inboundSchema)
142
+ .optional(),
143
+ });
144
+
145
+ export function ratingsFromJSON(
146
+ jsonString: string,
147
+ ): SafeParseResult<Ratings, SDKValidationError> {
148
+ return safeParse(
149
+ jsonString,
150
+ (x) => Ratings$inboundSchema.parse(JSON.parse(x)),
151
+ `Failed to parse 'Ratings' from JSON`,
152
+ );
153
+ }
154
+
155
+ /** @internal */
156
+ export const SchoolInspectionEvent$inboundSchema: z.ZodType<
157
+ SchoolInspectionEvent,
158
+ z.ZodTypeDef,
159
+ unknown
160
+ > = z.object({
161
+ categoryOfConcern: z.nullable(z.string()).optional(),
162
+ evaluationAreas: z.nullable(
163
+ z.array(SchoolInspectionEvaluationArea$inboundSchema),
164
+ ).optional(),
165
+ framework: z.nullable(z.string()).optional(),
166
+ inspectionDate: z.string(),
167
+ inspectionType: z.nullable(z.string()).optional(),
168
+ inspectorBody: SchoolInspectorBody$inboundSchema,
169
+ predecessor: z.nullable(SchoolInspectionPredecessor$inboundSchema).optional(),
170
+ publicationDate: z.nullable(z.string()).optional(),
171
+ rating: SchoolInspectionEventRating$inboundSchema,
172
+ ratings: z.nullable(z.lazy(() => Ratings$inboundSchema)).optional(),
173
+ reportUrl: z.nullable(z.string()).optional(),
174
+ });
175
+
176
+ export function schoolInspectionEventFromJSON(
177
+ jsonString: string,
178
+ ): SafeParseResult<SchoolInspectionEvent, SDKValidationError> {
179
+ return safeParse(
180
+ jsonString,
181
+ (x) => SchoolInspectionEvent$inboundSchema.parse(JSON.parse(x)),
182
+ `Failed to parse 'SchoolInspectionEvent' from JSON`,
183
+ );
184
+ }
@@ -0,0 +1,39 @@
1
+ /*
2
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
+ */
4
+
5
+ import * as z from "zod/v3";
6
+ import { safeParse } from "../../../lib/schemas.js";
7
+ import { Result as SafeParseResult } from "../../types/fp.js";
8
+ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
9
+
10
+ export type SchoolInspectionGrade = {
11
+ /**
12
+ * 1 = Outstanding … 4 = Inadequate
13
+ */
14
+ grade: number;
15
+ /**
16
+ * Human-readable grade word
17
+ */
18
+ label: string;
19
+ };
20
+
21
+ /** @internal */
22
+ export const SchoolInspectionGrade$inboundSchema: z.ZodType<
23
+ SchoolInspectionGrade,
24
+ z.ZodTypeDef,
25
+ unknown
26
+ > = z.object({
27
+ grade: z.number().int(),
28
+ label: z.string(),
29
+ });
30
+
31
+ export function schoolInspectionGradeFromJSON(
32
+ jsonString: string,
33
+ ): SafeParseResult<SchoolInspectionGrade, SDKValidationError> {
34
+ return safeParse(
35
+ jsonString,
36
+ (x) => SchoolInspectionGrade$inboundSchema.parse(JSON.parse(x)),
37
+ `Failed to parse 'SchoolInspectionGrade' from JSON`,
38
+ );
39
+ }
@@ -0,0 +1,37 @@
1
+ /*
2
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
+ */
4
+
5
+ import * as z from "zod/v3";
6
+ import { safeParse } from "../../../lib/schemas.js";
7
+ import { Result as SafeParseResult } from "../../types/fp.js";
8
+ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
9
+
10
+ export type SchoolInspectionPredecessor = {
11
+ name?: string | null | undefined;
12
+ relatesToCurrentUrn?: boolean | null | undefined;
13
+ schoolType?: string | null | undefined;
14
+ urn?: number | null | undefined;
15
+ };
16
+
17
+ /** @internal */
18
+ export const SchoolInspectionPredecessor$inboundSchema: z.ZodType<
19
+ SchoolInspectionPredecessor,
20
+ z.ZodTypeDef,
21
+ unknown
22
+ > = z.object({
23
+ name: z.nullable(z.string()).optional(),
24
+ relatesToCurrentUrn: z.nullable(z.boolean()).optional(),
25
+ schoolType: z.nullable(z.string()).optional(),
26
+ urn: z.nullable(z.number().int()).optional(),
27
+ });
28
+
29
+ export function schoolInspectionPredecessorFromJSON(
30
+ jsonString: string,
31
+ ): SafeParseResult<SchoolInspectionPredecessor, SDKValidationError> {
32
+ return safeParse(
33
+ jsonString,
34
+ (x) => SchoolInspectionPredecessor$inboundSchema.parse(JSON.parse(x)),
35
+ `Failed to parse 'SchoolInspectionPredecessor' from JSON`,
36
+ );
37
+ }
@@ -0,0 +1,29 @@
1
+ /*
2
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
+ */
4
+
5
+ import * as z from "zod/v3";
6
+ import * as openEnums from "../../types/enums.js";
7
+ import { OpenEnum } from "../../types/enums.js";
8
+
9
+ /**
10
+ * Inspectorate that issued the rating. ofsted (England), estyn (Wales), education_scotland (Scotland), eti (Northern Ireland), des (Ireland).
11
+ */
12
+ export const SchoolInspectorBody = {
13
+ Ofsted: "ofsted",
14
+ Estyn: "estyn",
15
+ EducationScotland: "education_scotland",
16
+ Eti: "eti",
17
+ Des: "des",
18
+ } as const;
19
+ /**
20
+ * Inspectorate that issued the rating. ofsted (England), estyn (Wales), education_scotland (Scotland), eti (Northern Ireland), des (Ireland).
21
+ */
22
+ export type SchoolInspectorBody = OpenEnum<typeof SchoolInspectorBody>;
23
+
24
+ /** @internal */
25
+ export const SchoolInspectorBody$inboundSchema: z.ZodType<
26
+ SchoolInspectorBody,
27
+ z.ZodTypeDef,
28
+ unknown
29
+ > = openEnums.inboundSchema(SchoolInspectorBody);