@vepler/sdk 2.145.1 → 2.151.0

package/src/sdk/models/shared/schoolinspectiongrade.ts

@@ -0,0 +1,39 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type SchoolInspectionGrade = {
+  /**
+   * 1 = Outstanding … 4 = Inadequate
+   */
+  grade: number;
+  /**
+   * Human-readable grade word
+   */
+  label: string;
+};
+
+/** @internal */
+export const SchoolInspectionGrade$inboundSchema: z.ZodType<
+  SchoolInspectionGrade,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  grade: z.number().int(),
+  label: z.string(),
+});
+
+export function schoolInspectionGradeFromJSON(
+  jsonString: string,
+): SafeParseResult<SchoolInspectionGrade, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SchoolInspectionGrade$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SchoolInspectionGrade' from JSON`,
+  );
+}

package/src/sdk/models/shared/schoolinspectionpredecessor.ts

@@ -0,0 +1,37 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type SchoolInspectionPredecessor = {
+  name?: string | null | undefined;
+  relatesToCurrentUrn?: boolean | null | undefined;
+  schoolType?: string | null | undefined;
+  urn?: number | null | undefined;
+};
+
+/** @internal */
+export const SchoolInspectionPredecessor$inboundSchema: z.ZodType<
+  SchoolInspectionPredecessor,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  name: z.nullable(z.string()).optional(),
+  relatesToCurrentUrn: z.nullable(z.boolean()).optional(),
+  schoolType: z.nullable(z.string()).optional(),
+  urn: z.nullable(z.number().int()).optional(),
+});
+
+export function schoolInspectionPredecessorFromJSON(
+  jsonString: string,
+): SafeParseResult<SchoolInspectionPredecessor, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SchoolInspectionPredecessor$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SchoolInspectionPredecessor' from JSON`,
+  );
+}

package/src/sdk/models/shared/schoolinspectorbody.ts

@@ -0,0 +1,29 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import * as openEnums from "../../types/enums.js";
+import { OpenEnum } from "../../types/enums.js";
+
+/**
+ * Inspectorate that issued the rating. ofsted (England), estyn (Wales), education_scotland (Scotland), eti (Northern Ireland), des (Ireland).
+ */
+export const SchoolInspectorBody = {
+  Ofsted: "ofsted",
+  Estyn: "estyn",
+  EducationScotland: "education_scotland",
+  Eti: "eti",
+  Des: "des",
+} as const;
+/**
+ * Inspectorate that issued the rating. ofsted (England), estyn (Wales), education_scotland (Scotland), eti (Northern Ireland), des (Ireland).
+ */
+export type SchoolInspectorBody = OpenEnum<typeof SchoolInspectorBody>;
+
+/** @internal */
+export const SchoolInspectorBody$inboundSchema: z.ZodType<
+  SchoolInspectorBody,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(SchoolInspectorBody);

package/src/sdk/models/shared/schooltrustmembership.ts

@@ -0,0 +1,74 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type SchoolTrustMembership = {
+  /**
+   * Source group id (e.g. GIAS trust id 'TR…').
+   */
+  groupId?: string | null | undefined;
+  /**
+   * Source group-type label.
+   */
+  groupType?: string | null | undefined;
+  /**
+   * Organisation name.
+   */
+  name: string;
+  /**
+   * Internal organisation id.
+   */
+  organisationId: number;
+  /**
+   * This school's role in the organisation, e.g. 'member' | 'lead'.
+   */
+  role: string;
+  /**
+   * Organisation status label.
+   */
+  status?: string | null | undefined;
+  /**
+   * Organisation type, e.g. 'mat' | 'sat' | 'federation' | 'diocese'.
+   */
+  type: string;
+  /**
+   * Stable organisation UID (e.g. GIAS group UID).
+   */
+  uid: string;
+  /**
+   * Organisation UKPRN.
+   */
+  ukprn?: string | null | undefined;
+};
+
+/** @internal */
+export const SchoolTrustMembership$inboundSchema: z.ZodType<
+  SchoolTrustMembership,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  groupId: z.nullable(z.string()).optional(),
+  groupType: z.nullable(z.string()).optional(),
+  name: z.string(),
+  organisationId: z.number().int(),
+  role: z.string(),
+  status: z.nullable(z.string()).optional(),
+  type: z.string(),
+  uid: z.string(),
+  ukprn: z.nullable(z.string()).optional(),
+});
+
+export function schoolTrustMembershipFromJSON(
+  jsonString: string,
+): SafeParseResult<SchoolTrustMembership, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SchoolTrustMembership$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SchoolTrustMembership' from JSON`,
+  );
+}

package/src/sdk/models/shared/searchresult.ts

@@ -70,7 +70,7 @@ export type SearchResult = {
    */
   location?: SearchResultCoordinates | undefined;
   /**
-   * Primary display text — building + street
+   * Primary display text: building + street
    */
   mainText?: string | undefined;
   /**
@@ -102,7 +102,7 @@ export type SearchResult = {
    */
   score: number;
   /**
-   * Secondary display text — locality + postcode
+   * Secondary display text: locality + postcode
    */
   secondaryText?: string | undefined;
   /**

package/src/sdk/models/shared/sitepropertystats.ts

@@ -12,11 +12,11 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
  */
 export type SitePropertyStats = {
   /**
-   * Average monthly rent in pence
+   * Average monthly rent in GBP (whole pounds)
    */
   avgRent?: number | undefined;
   /**
-   * Average estimated property value in pence
+   * Average estimated property value in GBP (whole pounds)
    */
   avgValue?: number | undefined;
   /**

package/src/sdk/planning.ts

@@ -15,7 +15,7 @@ export class Planning extends ClientSDK {
    * Get planning applications by application IDs
    *
    * @remarks
-   * Retrieve one or more planning applications by their internal UUIDs. Provide up to 100 comma-separated application IDs in the path. Returns the matching applications in a paginated list response. If you have council reference numbers rather than UUIDs, use the GET /sources/{sourceIds} endpoint instead. Pass ?include=extractions to attach structured, citation-backed extractions to each application.
+   * Retrieve one or more planning applications by their internal UUIDs. Provide up to 100 comma-separated application IDs in the path. Returns the matching applications in a paginated list response. If you have council reference numbers rather than UUIDs, use the GET /sources/{sourceIds} endpoint instead. Use ?include= to attach optional expansions (comma-separated): 'extractions' (structured, citation-backed extractions), 'images' (a renderable image gallery), 'content' (fileUrl + ocrUrl on each document), 'enrichment' (AI classification reasoning and document summaries).
    */
   async getPlanningApplications(
     request: operations.GetPlanningApplicationsRequest,
@@ -32,7 +32,7 @@ export class Planning extends ClientSDK {
    * Get planning applications by source IDs
    *
    * @remarks
-   * Retrieve one or more planning applications by their source identifiers. Each source ID uses the format 'provider::key' where provider is the council slug and key is the council's reference number (e.g. 'lambeth::24/00123/FUL'). Provide up to 100 comma-separated source IDs in the path. This is the recommended lookup method when you know the council and application reference number. Pass ?include=extractions to attach structured, citation-backed extractions to each application.
+   * Retrieve one or more planning applications by their source identifiers. Each source ID uses the format 'provider::key' where provider is the council slug and key is the council's reference number (e.g. 'lambeth::24/00123/FUL'). Provide up to 100 comma-separated source IDs in the path. This is the recommended lookup method when you know the council and application reference number. Use ?include= to attach optional expansions (comma-separated): 'extractions' (structured, citation-backed extractions), 'images' (a renderable image gallery), 'content' (fileUrl + ocrUrl on each document), 'enrichment' (AI classification reasoning and document summaries).
    */
   async getPlanningApplicationsBySource(
     request: operations.GetPlanningApplicationsBySourceRequest,
@@ -49,7 +49,7 @@ export class Planning extends ClientSDK {
    * Query planning applications with advanced filters
    *
    * @remarks
-   * Search for planning applications using a combination of filters including council, status, type, development category, and date ranges. Use the `near` filter ({ lat, lng, radiusM }) to retrieve applications around a point — the primary way to find a property's planning context; results come back closest-first with `distance` (metres) populated. Pass `include: ["extractions"]` to attach structured, citation-backed extractions. Filters within the query object are combined with AND logic, whilst array values within a single filter use OR logic. Results are paginated and can be sorted by any date field (the `near` filter overrides sort with closest-first). Supports up to 100 results per page.
+   * Search for planning applications using a combination of filters including council, status, type, development category, and date ranges. Use the `near` filter ({ lat, lng, radiusM }) to retrieve applications around a point — the primary way to find a property's planning context; results come back closest-first with `distance` (metres) populated. Pass `include` (any of `["extractions", "images", "content", "enrichment"]`) to attach structured citation-backed extractions, a renderable image gallery, document fileUrl/ocrUrl, and/or AI classification reasoning. Filters within the query object are combined with AND logic, whilst array values within a single filter use OR logic. Results are paginated and can be sorted by any date field (the `near` filter overrides sort with closest-first). Supports up to 100 results per page.
    */
   async searchPlanningApplications(
     request?: shared.PlanningQueryRequest | undefined,

package/src/sdk/search.ts

@@ -14,6 +14,12 @@ export class Search extends ClientSDK {
    *
    * @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.
    */
   async searchSuggest(
     request: operations.SearchSuggestRequest,