@vepler/sdk 2.145.1 → 2.151.0

package/src/funcs/schoolsGetSchoolById.ts

@@ -3,7 +3,7 @@
  */
 
 import { SDKCore } from "../core.js";
-import { encodeSimple } from "../lib/encodings.js";
+import { encodeFormQuery, encodeSimple } from "../lib/encodings.js";
 import { matchStatusCode } from "../lib/http.js";
 import * as M from "../lib/matchers.js";
 import { compactMap } from "../lib/primitives.js";
@@ -101,6 +101,10 @@ async function $do(
   };
   const path = pathToFunc("/v1/schools/{id}")(pathParams);
 
+  const query = encodeFormQuery({
+    "attributes": payload.attributes,
+  });
+
   const headers = new Headers(compactMap({
     Accept: "application/json",
   }));
@@ -130,6 +134,7 @@ async function $do(
     baseURL: options?.serverURL,
     path: path,
     headers: headers,
+    query: query,
     body: body,
     userAgent: client._options.userAgent,
     timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,

package/src/funcs/schoolsGetSchoolBySource.ts

@@ -3,7 +3,7 @@
  */
 
 import { SDKCore } from "../core.js";
-import { encodeSimple } from "../lib/encodings.js";
+import { encodeFormQuery, encodeSimple } from "../lib/encodings.js";
 import { matchStatusCode } from "../lib/http.js";
 import * as M from "../lib/matchers.js";
 import { compactMap } from "../lib/primitives.js";
@@ -105,6 +105,10 @@ async function $do(
   };
   const path = pathToFunc("/v1/schools/source/{provider}/{key}")(pathParams);
 
+  const query = encodeFormQuery({
+    "attributes": payload.attributes,
+  });
+
   const headers = new Headers(compactMap({
     Accept: "application/json",
   }));
@@ -134,6 +138,7 @@ async function $do(
     baseURL: options?.serverURL,
     path: path,
     headers: headers,
+    query: query,
     body: body,
     userAgent: client._options.userAgent,
     timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,

package/src/funcs/searchSearchSuggest.ts

@@ -32,6 +32,12 @@ import { Result } from "../sdk/types/fp.js";
  *
  * @remarks
  * Simple autocomplete for UK properties and locations. Searches across Address and Location sources with fuzzy matching. Automatically detects query type (postcode, address, place name) and returns suggestions.
+ *
+ * Optionally accepts a geographic centre point (`lat`, `lng`) to make results proximity-aware:
+ * - `geo_mode=bias` (default): soft preference. The best textual matches near the point rank higher, but distant matches are still returned.
+ * - `geo_mode=restrict`: hard cutoff. Only address results within `radius_meters` of the point are returned.
+ *
+ * When a centre point is supplied, address results include a `distance` (metres from the point). Geographic ranking applies to the address source, so pair it with `source=address` for the most predictable proximity results.
  */
 export function searchSearchSuggest(
   client: SDKCore,
@@ -96,9 +102,13 @@ async function $do(
 
   const query = encodeFormQuery({
     "classification": payload.classification,
+    "geo_mode": payload.geo_mode,
+    "lat": payload.lat,
     "limit": payload.limit,
+    "lng": payload.lng,
     "offset": payload.offset,
     "q": payload.q,
+    "radius_meters": payload.radius_meters,
     "source": payload.source,
   });
 

package/src/lib/config.ts

@@ -60,8 +60,8 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
 
 export const SDK_METADATA = {
   language: "typescript",
-  openapiDocVersion: "2.145.1",
+  openapiDocVersion: "2.151.0",
   sdkVersion: "0.10.0",
   genVersion: "2.893.0",
-  userAgent: "speakeasy-sdk/typescript 0.10.0 2.893.0 2.145.1 @vepler/sdk",
+  userAgent: "speakeasy-sdk/typescript 0.10.0 2.893.0 2.151.0 @vepler/sdk",
 } as const;

package/src/sdk/models/operations/getplanningapplications.ts

@@ -10,7 +10,7 @@ export type GetPlanningApplicationsRequest = {
    */
   applicationIds: string;
   /**
-   * Comma-separated list of optional expansions to attach to each application. Currently supported: 'extractions' (structured, citation-backed extractions — decision, development, s106, officer assessment, consultee responses). Omitted by default; extractions are large, so request them only when you need the detail.
+   * Comma-separated list of optional expansions to attach to each application. Supported: 'extractions' (structured, citation-backed extractions — decision, development, s106, officer assessment, consultee responses); 'images' (a deduplicated image gallery with directly-renderable CDN URLs); 'content' (adds fileUrl + ocrUrl to each document so it can be rendered/searched in-browser); 'enrichment' (AI classification reasoning and document segmentation summaries). Omitted by default; these expansions can be large, so request only what you need. Example: 'extractions,images,content'.
    */
   include?: string | undefined;
 };

package/src/sdk/models/operations/getplanningapplicationsbysource.ts

@@ -6,7 +6,7 @@ import * as z from "zod/v3";
 
 export type GetPlanningApplicationsBySourceRequest = {
   /**
-   * Comma-separated list of optional expansions to attach to each application. Currently supported: 'extractions' (structured, citation-backed extractions — decision, development, s106, officer assessment, consultee responses). Omitted by default; extractions are large, so request them only when you need the detail.
+   * Comma-separated list of optional expansions to attach to each application. Supported: 'extractions' (structured, citation-backed extractions — decision, development, s106, officer assessment, consultee responses); 'images' (a deduplicated image gallery with directly-renderable CDN URLs); 'content' (adds fileUrl + ocrUrl to each document so it can be rendered/searched in-browser); 'enrichment' (AI classification reasoning and document segmentation summaries). Omitted by default; these expansions can be large, so request only what you need. Example: 'extractions,images,content'.
    */
   include?: string | undefined;
   /**

package/src/sdk/models/operations/getschoolbyid.ts

@@ -11,6 +11,10 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 import * as shared from "../shared/index.js";
 
 export type GetSchoolByIdRequest = {
+  /**
+   * Comma-separated fields/blocks to return. Default: the full flat record with no aggregate blocks. Aggregate blocks are opt-in: `inspections`. Performance/census/finance live on `/v1/schools/metrics`.
+   */
+  attributes?: string | undefined;
   /**
    * Internal school identifier
    */
@@ -72,6 +76,42 @@ export const CurrentRating = {
  */
 export type CurrentRating = OpenEnum<typeof CurrentRating>;
 
+/**
+ * Cross-register identifiers. Present only when requested via `attributes=identifiers`.
+ */
+export type Identifiers = {
+  /**
+   * Estyn provider id (Wales).
+   */
+  estynId?: string | null | undefined;
+  /**
+   * Ofsted provider id (England).
+   */
+  ofstedProviderId?: string | null | undefined;
+  /**
+   * Predecessor URNs this school was previously known by (re-identification lineage).
+   */
+  oldUrns?: Array<string> | undefined;
+  /**
+   * UK Provider Reference Number (UKPRN).
+   */
+  ukprn?: string | null | undefined;
+};
+
+/**
+ * Inspection history. Present only when requested via `attributes=inspections`.
+ */
+export type Inspections = {
+  /**
+   * Most recent inspection event, or null if never inspected.
+   */
+  current: shared.SchoolInspectionEvent | null;
+  /**
+   * Every inspection event, newest first (includes `current`).
+   */
+  history?: Array<shared.SchoolInspectionEvent | null> | undefined;
+};
+
 /**
  * Geographic coordinates of the school
  */
@@ -125,6 +165,16 @@ export const GetSchoolByIdStatus = {
  */
 export type GetSchoolByIdStatus = OpenEnum<typeof GetSchoolByIdStatus>;
 
+/**
+ * Trust / organisation memberships. Present only when requested via `attributes=trust`.
+ */
+export type Trust = {
+  /**
+   * Active organisation memberships, lead/trust roles first.
+   */
+  memberships?: Array<shared.SchoolTrustMembership> | undefined;
+};
+
 /**
  * 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.
  */
@@ -182,6 +232,14 @@ export type GetSchoolByIdResponseBody = {
    * System-generated identifier. Stable across updates.
    */
   id: number;
+  /**
+   * Cross-register identifiers. Present only when requested via `attributes=identifiers`.
+   */
+  identifiers?: Identifiers | null | undefined;
+  /**
+   * Inspection history. Present only when requested via `attributes=inspections`.
+   */
+  inspections?: Inspections | null | undefined;
   /**
    * Provider-scoped identifier. URN for `dfe`, SEED for `seed`, etc. Combined with `provider` this is a globally unique alternate key for the school.
    */
@@ -238,6 +296,10 @@ export type GetSchoolByIdResponseBody = {
    */
   subType?: string | undefined;
   telephone?: string | undefined;
+  /**
+   * Trust / organisation memberships. Present only when requested via `attributes=trust`.
+   */
+  trust?: Trust | null | undefined;
   trustId?: string | undefined;
   trustName?: string | undefined;
   /**
@@ -253,6 +315,7 @@ export type GetSchoolByIdResponseBody = {
 
 /** @internal */
 export type GetSchoolByIdRequest$Outbound = {
+  attributes?: string | undefined;
   id: string;
 };
 
@@ -262,6 +325,7 @@ export const GetSchoolByIdRequest$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   GetSchoolByIdRequest
 > = z.object({
+  attributes: z.string().optional(),
   id: z.string(),
 });
 
@@ -303,6 +367,49 @@ export const CurrentRating$inboundSchema: z.ZodType<
   unknown
 > = openEnums.inboundSchema(CurrentRating);
 
+/** @internal */
+export const Identifiers$inboundSchema: z.ZodType<
+  Identifiers,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  estynId: z.nullable(z.string()).optional(),
+  ofstedProviderId: z.nullable(z.string()).optional(),
+  oldUrns: z.array(z.string()).optional(),
+  ukprn: z.nullable(z.string()).optional(),
+});
+
+export function identifiersFromJSON(
+  jsonString: string,
+): SafeParseResult<Identifiers, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Identifiers$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Identifiers' from JSON`,
+  );
+}
+
+/** @internal */
+export const Inspections$inboundSchema: z.ZodType<
+  Inspections,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  current: z.nullable(shared.SchoolInspectionEvent$inboundSchema),
+  history: z.array(z.nullable(shared.SchoolInspectionEvent$inboundSchema))
+    .optional(),
+});
+
+export function inspectionsFromJSON(
+  jsonString: string,
+): SafeParseResult<Inspections, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Inspections$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Inspections' from JSON`,
+  );
+}
+
 /** @internal */
 export const Location$inboundSchema: z.ZodType<
   Location,
@@ -342,6 +449,22 @@ export const GetSchoolByIdStatus$inboundSchema: z.ZodType<
   unknown
 > = openEnums.inboundSchema(GetSchoolByIdStatus);
 
+/** @internal */
+export const Trust$inboundSchema: z.ZodType<Trust, z.ZodTypeDef, unknown> = z
+  .object({
+    memberships: z.array(shared.SchoolTrustMembership$inboundSchema).optional(),
+  });
+
+export function trustFromJSON(
+  jsonString: string,
+): SafeParseResult<Trust, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Trust$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Trust' from JSON`,
+  );
+}
+
 /** @internal */
 export const GetSchoolByIdType$inboundSchema: z.ZodType<
   GetSchoolByIdType,
@@ -368,6 +491,8 @@ export const GetSchoolByIdResponseBody$inboundSchema: z.ZodType<
   gender: z.string().optional(),
   headteacher: z.string().optional(),
   id: z.number().int(),
+  identifiers: z.nullable(z.lazy(() => Identifiers$inboundSchema)).optional(),
+  inspections: z.nullable(z.lazy(() => Inspections$inboundSchema)).optional(),
   key: z.string(),
   laCode: z.string().optional(),
   laName: z.string().optional(),
@@ -388,6 +513,7 @@ export const GetSchoolByIdResponseBody$inboundSchema: z.ZodType<
   status: GetSchoolByIdStatus$inboundSchema,
   subType: z.string().optional(),
   telephone: z.string().optional(),
+  trust: z.nullable(z.lazy(() => Trust$inboundSchema)).optional(),
   trustId: z.string().optional(),
   trustName: z.string().optional(),
   type: GetSchoolByIdType$inboundSchema,

package/src/sdk/models/operations/getschoolbysource.ts

@@ -26,6 +26,10 @@ export const PathParamProvider = {
 export type PathParamProvider = ClosedEnum<typeof PathParamProvider>;
 
 export type GetSchoolBySourceRequest = {
+  /**
+   * Comma-separated fields/blocks to return. Default: the full flat record with no aggregate blocks. Aggregate blocks are opt-in: `inspections`. Performance/census/finance live on `/v1/schools/metrics`.
+   */
+  attributes?: string | undefined;
   /**
    * Provider-scoped identifier (URN for dfe, SEED for seed, …)
    */
@@ -93,6 +97,42 @@ export type GetSchoolBySourceCurrentRating = OpenEnum<
   typeof GetSchoolBySourceCurrentRating
 >;
 
+/**
+ * Cross-register identifiers. Present only when requested via `attributes=identifiers`.
+ */
+export type GetSchoolBySourceIdentifiers = {
+  /**
+   * Estyn provider id (Wales).
+   */
+  estynId?: string | null | undefined;
+  /**
+   * Ofsted provider id (England).
+   */
+  ofstedProviderId?: string | null | undefined;
+  /**
+   * Predecessor URNs this school was previously known by (re-identification lineage).
+   */
+  oldUrns?: Array<string> | undefined;
+  /**
+   * UK Provider Reference Number (UKPRN).
+   */
+  ukprn?: string | null | undefined;
+};
+
+/**
+ * Inspection history. Present only when requested via `attributes=inspections`.
+ */
+export type GetSchoolBySourceInspections = {
+  /**
+   * Most recent inspection event, or null if never inspected.
+   */
+  current: shared.SchoolInspectionEvent | null;
+  /**
+   * Every inspection event, newest first (includes `current`).
+   */
+  history?: Array<shared.SchoolInspectionEvent | null> | undefined;
+};
+
 /**
  * Geographic coordinates of the school
  */
@@ -150,6 +190,16 @@ export const GetSchoolBySourceStatus = {
  */
 export type GetSchoolBySourceStatus = OpenEnum<typeof GetSchoolBySourceStatus>;
 
+/**
+ * Trust / organisation memberships. Present only when requested via `attributes=trust`.
+ */
+export type GetSchoolBySourceTrust = {
+  /**
+   * Active organisation memberships, lead/trust roles first.
+   */
+  memberships?: Array<shared.SchoolTrustMembership> | undefined;
+};
+
 /**
  * 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.
  */
@@ -207,6 +257,14 @@ export type GetSchoolBySourceResponseBody = {
    * System-generated identifier. Stable across updates.
    */
   id: number;
+  /**
+   * Cross-register identifiers. Present only when requested via `attributes=identifiers`.
+   */
+  identifiers?: GetSchoolBySourceIdentifiers | null | undefined;
+  /**
+   * Inspection history. Present only when requested via `attributes=inspections`.
+   */
+  inspections?: GetSchoolBySourceInspections | null | undefined;
   /**
    * Provider-scoped identifier. URN for `dfe`, SEED for `seed`, etc. Combined with `provider` this is a globally unique alternate key for the school.
    */
@@ -263,6 +321,10 @@ export type GetSchoolBySourceResponseBody = {
    */
   subType?: string | undefined;
   telephone?: string | undefined;
+  /**
+   * Trust / organisation memberships. Present only when requested via `attributes=trust`.
+   */
+  trust?: GetSchoolBySourceTrust | null | undefined;
   trustId?: string | undefined;
   trustName?: string | undefined;
   /**
@@ -283,6 +345,7 @@ export const PathParamProvider$outboundSchema: z.ZodNativeEnum<
 
 /** @internal */
 export type GetSchoolBySourceRequest$Outbound = {
+  attributes?: string | undefined;
   key: string;
   provider: string;
 };
@@ -293,6 +356,7 @@ export const GetSchoolBySourceRequest$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   GetSchoolBySourceRequest
 > = z.object({
+  attributes: z.string().optional(),
   key: z.string(),
   provider: PathParamProvider$outboundSchema,
 });
@@ -335,6 +399,49 @@ export const GetSchoolBySourceCurrentRating$inboundSchema: z.ZodType<
   unknown
 > = openEnums.inboundSchema(GetSchoolBySourceCurrentRating);
 
+/** @internal */
+export const GetSchoolBySourceIdentifiers$inboundSchema: z.ZodType<
+  GetSchoolBySourceIdentifiers,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  estynId: z.nullable(z.string()).optional(),
+  ofstedProviderId: z.nullable(z.string()).optional(),
+  oldUrns: z.array(z.string()).optional(),
+  ukprn: z.nullable(z.string()).optional(),
+});
+
+export function getSchoolBySourceIdentifiersFromJSON(
+  jsonString: string,
+): SafeParseResult<GetSchoolBySourceIdentifiers, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetSchoolBySourceIdentifiers$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetSchoolBySourceIdentifiers' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetSchoolBySourceInspections$inboundSchema: z.ZodType<
+  GetSchoolBySourceInspections,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  current: z.nullable(shared.SchoolInspectionEvent$inboundSchema),
+  history: z.array(z.nullable(shared.SchoolInspectionEvent$inboundSchema))
+    .optional(),
+});
+
+export function getSchoolBySourceInspectionsFromJSON(
+  jsonString: string,
+): SafeParseResult<GetSchoolBySourceInspections, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetSchoolBySourceInspections$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetSchoolBySourceInspections' from JSON`,
+  );
+}
+
 /** @internal */
 export const GetSchoolBySourceLocation$inboundSchema: z.ZodType<
   GetSchoolBySourceLocation,
@@ -374,6 +481,25 @@ export const GetSchoolBySourceStatus$inboundSchema: z.ZodType<
   unknown
 > = openEnums.inboundSchema(GetSchoolBySourceStatus);
 
+/** @internal */
+export const GetSchoolBySourceTrust$inboundSchema: z.ZodType<
+  GetSchoolBySourceTrust,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  memberships: z.array(shared.SchoolTrustMembership$inboundSchema).optional(),
+});
+
+export function getSchoolBySourceTrustFromJSON(
+  jsonString: string,
+): SafeParseResult<GetSchoolBySourceTrust, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetSchoolBySourceTrust$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetSchoolBySourceTrust' from JSON`,
+  );
+}
+
 /** @internal */
 export const GetSchoolBySourceType$inboundSchema: z.ZodType<
   GetSchoolBySourceType,
@@ -401,6 +527,12 @@ export const GetSchoolBySourceResponseBody$inboundSchema: z.ZodType<
   gender: z.string().optional(),
   headteacher: z.string().optional(),
   id: z.number().int(),
+  identifiers: z.nullable(
+    z.lazy(() => GetSchoolBySourceIdentifiers$inboundSchema),
+  ).optional(),
+  inspections: z.nullable(
+    z.lazy(() => GetSchoolBySourceInspections$inboundSchema),
+  ).optional(),
   key: z.string(),
   laCode: z.string().optional(),
   laName: z.string().optional(),
@@ -422,6 +554,8 @@ export const GetSchoolBySourceResponseBody$inboundSchema: z.ZodType<
   status: GetSchoolBySourceStatus$inboundSchema,
   subType: z.string().optional(),
   telephone: z.string().optional(),
+  trust: z.nullable(z.lazy(() => GetSchoolBySourceTrust$inboundSchema))
+    .optional(),
   trustId: z.string().optional(),
   trustName: z.string().optional(),
   type: GetSchoolBySourceType$inboundSchema,