@vepler/sdk 2.33.0 → 2.38.2

package/dist/esm/sdk/models/shared/pscsummary.d.ts

@@ -0,0 +1,72 @@
+import * as z from "zod/v3";
+import { OpenEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+/**
+ * The type of entity that holds significant control. 'individual-person-with-significant-control' for natural persons, 'corporate-entity-person-with-significant-control' for companies, 'legal-person-person-with-significant-control' for non-company legal entities, 'super-secure-person-with-significant-control' for court-protected identities. Beneficial owner variants (e.g. 'individual-beneficial-owner') apply to Registered Overseas Entities under the Economic Crime (Transparency and Enforcement) Act 2022.
+ */
+export declare const PscSummaryKind: {
+    readonly IndividualPersonWithSignificantControl: "individual-person-with-significant-control";
+    readonly CorporateEntityPersonWithSignificantControl: "corporate-entity-person-with-significant-control";
+    readonly LegalPersonPersonWithSignificantControl: "legal-person-person-with-significant-control";
+    readonly SuperSecurePersonWithSignificantControl: "super-secure-person-with-significant-control";
+    readonly IndividualBeneficialOwner: "individual-beneficial-owner";
+    readonly CorporateEntityBeneficialOwner: "corporate-entity-beneficial-owner";
+    readonly LegalPersonBeneficialOwner: "legal-person-beneficial-owner";
+    readonly SuperSecureBeneficialOwner: "super-secure-beneficial-owner";
+};
+/**
+ * The type of entity that holds significant control. 'individual-person-with-significant-control' for natural persons, 'corporate-entity-person-with-significant-control' for companies, 'legal-person-person-with-significant-control' for non-company legal entities, 'super-secure-person-with-significant-control' for court-protected identities. Beneficial owner variants (e.g. 'individual-beneficial-owner') apply to Registered Overseas Entities under the Economic Crime (Transparency and Enforcement) Act 2022.
+ */
+export type PscSummaryKind = OpenEnum<typeof PscSummaryKind>;
+/**
+ * Lightweight PSC summary for list responses and nested inclusions.
+ */
+export type PscSummary = {
+    /**
+     * Date the PSC ceased. Null if still active. ISO 8601 format.
+     */
+    ceasedOn?: Date | null | undefined;
+    /**
+     * The 8-character registration number of the company.
+     */
+    companyNumber: string;
+    /**
+     * Unique identifier for this PSC notification record (UUID v4).
+     */
+    id: string;
+    /**
+     * Whether the PSC is subject to financial sanctions.
+     */
+    isSanctioned: boolean;
+    /**
+     * Whether the PSC's identity is court-protected.
+     */
+    isSuperSecure: boolean;
+    /**
+     * The type of entity that holds significant control. 'individual-person-with-significant-control' for natural persons, 'corporate-entity-person-with-significant-control' for companies, 'legal-person-person-with-significant-control' for non-company legal entities, 'super-secure-person-with-significant-control' for court-protected identities. Beneficial owner variants (e.g. 'individual-beneficial-owner') apply to Registered Overseas Entities under the Economic Crime (Transparency and Enforcement) Act 2022.
+     */
+    kind: PscSummaryKind;
+    /**
+     * Name of the PSC as recorded.
+     */
+    name: string;
+    /**
+     * Array of control types held by this PSC.
+     */
+    naturesOfControl: Array<string>;
+    /**
+     * Date the PSC notification became effective. ISO 8601 format.
+     */
+    notifiedOn?: Date | null | undefined;
+    /**
+     * Link to the deduplicated person record (for individual PSCs). Use with the /persons endpoint.
+     */
+    personId?: string | null | undefined;
+};
+/** @internal */
+export declare const PscSummaryKind$inboundSchema: z.ZodType<PscSummaryKind, z.ZodTypeDef, unknown>;
+/** @internal */
+export declare const PscSummary$inboundSchema: z.ZodType<PscSummary, z.ZodTypeDef, unknown>;
+export declare function pscSummaryFromJSON(jsonString: string): SafeParseResult<PscSummary, SDKValidationError>;
+//# sourceMappingURL=pscsummary.d.ts.map

package/dist/esm/sdk/models/shared/pscsummary.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"pscsummary.d.ts","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/pscsummary.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAG5B,OAAO,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAChD,OAAO,EAAE,MAAM,IAAI,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAC9D,OAAO,EAAE,kBAAkB,EAAE,MAAM,iCAAiC,CAAC;AAErE;;GAEG;AACH,eAAO,MAAM,cAAc;;;;;;;;;CAajB,CAAC;AACX;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG,QAAQ,CAAC,OAAO,cAAc,CAAC,CAAC;AAE7D;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG;IACvB;;OAEG;IACH,QAAQ,CAAC,EAAE,IAAI,GAAG,IAAI,GAAG,SAAS,CAAC;IACnC;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IACtB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IACX;;OAEG;IACH,YAAY,EAAE,OAAO,CAAC;IACtB;;OAEG;IACH,aAAa,EAAE,OAAO,CAAC;IACvB;;OAEG;IACH,IAAI,EAAE,cAAc,CAAC;IACrB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,gBAAgB,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAChC;;OAEG;IACH,UAAU,CAAC,EAAE,IAAI,GAAG,IAAI,GAAG,SAAS,CAAC;IACrC;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;CACtC,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,4BAA4B,EAAE,CAAC,CAAC,OAAO,CAClD,cAAc,EACd,CAAC,CAAC,UAAU,EACZ,OAAO,CACkC,CAAC;AAE5C,gBAAgB;AAChB,eAAO,MAAM,wBAAwB,EAAE,CAAC,CAAC,OAAO,CAC9C,UAAU,EACV,CAAC,CAAC,UAAU,EACZ,OAAO,CAgBP,CAAC;AAEH,wBAAgB,kBAAkB,CAChC,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,UAAU,EAAE,kBAAkB,CAAC,CAMjD"}

package/dist/esm/sdk/models/shared/pscsummary.js

@@ -0,0 +1,38 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+import * as z from "zod/v3";
+import { safeParse } from "../../../lib/schemas.js";
+import * as openEnums from "../../types/enums.js";
+/**
+ * The type of entity that holds significant control. 'individual-person-with-significant-control' for natural persons, 'corporate-entity-person-with-significant-control' for companies, 'legal-person-person-with-significant-control' for non-company legal entities, 'super-secure-person-with-significant-control' for court-protected identities. Beneficial owner variants (e.g. 'individual-beneficial-owner') apply to Registered Overseas Entities under the Economic Crime (Transparency and Enforcement) Act 2022.
+ */
+export const PscSummaryKind = {
+    IndividualPersonWithSignificantControl: "individual-person-with-significant-control",
+    CorporateEntityPersonWithSignificantControl: "corporate-entity-person-with-significant-control",
+    LegalPersonPersonWithSignificantControl: "legal-person-person-with-significant-control",
+    SuperSecurePersonWithSignificantControl: "super-secure-person-with-significant-control",
+    IndividualBeneficialOwner: "individual-beneficial-owner",
+    CorporateEntityBeneficialOwner: "corporate-entity-beneficial-owner",
+    LegalPersonBeneficialOwner: "legal-person-beneficial-owner",
+    SuperSecureBeneficialOwner: "super-secure-beneficial-owner",
+};
+/** @internal */
+export const PscSummaryKind$inboundSchema = openEnums.inboundSchema(PscSummaryKind);
+/** @internal */
+export const PscSummary$inboundSchema = z.object({
+    ceasedOn: z.nullable(z.string().datetime({ offset: true }).transform(v => new Date(v))).optional(),
+    companyNumber: z.string(),
+    id: z.string(),
+    isSanctioned: z.boolean(),
+    isSuperSecure: z.boolean(),
+    kind: PscSummaryKind$inboundSchema,
+    name: z.string(),
+    naturesOfControl: z.array(z.string()),
+    notifiedOn: z.nullable(z.string().datetime({ offset: true }).transform(v => new Date(v))).optional(),
+    personId: z.nullable(z.string()).optional(),
+});
+export function pscSummaryFromJSON(jsonString) {
+    return safeParse(jsonString, (x) => PscSummary$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'PscSummary' from JSON`);
+}
+//# sourceMappingURL=pscsummary.js.map

package/dist/esm/sdk/models/shared/pscsummary.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"pscsummary.js","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/pscsummary.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAC5B,OAAO,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAC;AACpD,OAAO,KAAK,SAAS,MAAM,sBAAsB,CAAC;AAKlD;;GAEG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG;IAC5B,sCAAsC,EACpC,4CAA4C;IAC9C,2CAA2C,EACzC,kDAAkD;IACpD,uCAAuC,EACrC,8CAA8C;IAChD,uCAAuC,EACrC,8CAA8C;IAChD,yBAAyB,EAAE,6BAA6B;IACxD,8BAA8B,EAAE,mCAAmC;IACnE,0BAA0B,EAAE,+BAA+B;IAC3D,0BAA0B,EAAE,+BAA+B;CACnD,CAAC;AAoDX,gBAAgB;AAChB,MAAM,CAAC,MAAM,4BAA4B,GAIrC,SAAS,CAAC,aAAa,CAAC,cAAc,CAAC,CAAC;AAE5C,gBAAgB;AAChB,MAAM,CAAC,MAAM,wBAAwB,GAIjC,CAAC,CAAC,MAAM,CAAC;IACX,QAAQ,EAAE,CAAC,CAAC,QAAQ,CAClB,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,CAAC,CAClE,CAAC,QAAQ,EAAE;IACZ,aAAa,EAAE,CAAC,CAAC,MAAM,EAAE;IACzB,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE;IACd,YAAY,EAAE,CAAC,CAAC,OAAO,EAAE;IACzB,aAAa,EAAE,CAAC,CAAC,OAAO,EAAE;IAC1B,IAAI,EAAE,4BAA4B;IAClC,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;IAChB,gBAAgB,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;IACrC,UAAU,EAAE,CAAC,CAAC,QAAQ,CACpB,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,CAAC,CAClE,CAAC,QAAQ,EAAE;IACZ,QAAQ,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;CAC5C,CAAC,CAAC;AAEH,MAAM,UAAU,kBAAkB,CAChC,UAAkB;IAElB,OAAO,SAAS,CACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,wBAAwB,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EACpD,wCAAwC,CACzC,CAAC;AACJ,CAAC"}

package/dist/esm/sdk/models/shared/reversegeocoderesponse.d.ts

@@ -0,0 +1,52 @@
+import * as z from "zod/v3";
+import { ClosedEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import { PostcodeAddress } from "./postcodeaddress.js";
+/**
+ * WGS84 coordinate pair
+ */
+export type ReverseGeocodeResponseCoordinates = {
+    /**
+     * Latitude in decimal degrees
+     */
+    lat: number;
+    /**
+     * Longitude in decimal degrees
+     */
+    lng: number;
+};
+export declare const ReverseGeocodeResponseObject: {
+    readonly List: "list";
+};
+export type ReverseGeocodeResponseObject = ClosedEnum<typeof ReverseGeocodeResponseObject>;
+export type ReverseGeocodeResponse = {
+    /**
+     * WGS84 coordinate pair
+     */
+    coordinates: ReverseGeocodeResponseCoordinates;
+    /**
+     * Addresses near the specified coordinates
+     */
+    data: Array<PostcodeAddress>;
+    hasMore: boolean;
+    object: ReverseGeocodeResponseObject;
+    /**
+     * Search radius in metres
+     */
+    radius: number;
+    totalCount?: number | undefined;
+    /**
+     * Request URL
+     */
+    url: string;
+};
+/** @internal */
+export declare const ReverseGeocodeResponseCoordinates$inboundSchema: z.ZodType<ReverseGeocodeResponseCoordinates, z.ZodTypeDef, unknown>;
+export declare function reverseGeocodeResponseCoordinatesFromJSON(jsonString: string): SafeParseResult<ReverseGeocodeResponseCoordinates, SDKValidationError>;
+/** @internal */
+export declare const ReverseGeocodeResponseObject$inboundSchema: z.ZodNativeEnum<typeof ReverseGeocodeResponseObject>;
+/** @internal */
+export declare const ReverseGeocodeResponse$inboundSchema: z.ZodType<ReverseGeocodeResponse, z.ZodTypeDef, unknown>;
+export declare function reverseGeocodeResponseFromJSON(jsonString: string): SafeParseResult<ReverseGeocodeResponse, SDKValidationError>;
+//# sourceMappingURL=reversegeocoderesponse.d.ts.map

package/dist/esm/sdk/models/shared/reversegeocoderesponse.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"reversegeocoderesponse.d.ts","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/reversegeocoderesponse.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAG5B,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAClD,OAAO,EAAE,MAAM,IAAI,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAC9D,OAAO,EAAE,kBAAkB,EAAE,MAAM,iCAAiC,CAAC;AACrE,OAAO,EACL,eAAe,EAEhB,MAAM,sBAAsB,CAAC;AAE9B;;GAEG;AACH,MAAM,MAAM,iCAAiC,GAAG;IAC9C;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IACZ;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;CACb,CAAC;AAEF,eAAO,MAAM,4BAA4B;;CAE/B,CAAC;AACX,MAAM,MAAM,4BAA4B,GAAG,UAAU,CACnD,OAAO,4BAA4B,CACpC,CAAC;AAEF,MAAM,MAAM,sBAAsB,GAAG;IACnC;;OAEG;IACH,WAAW,EAAE,iCAAiC,CAAC;IAC/C;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,eAAe,CAAC,CAAC;IAC7B,OAAO,EAAE,OAAO,CAAC;IACjB,MAAM,EAAE,4BAA4B,CAAC;IACrC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IACf,UAAU,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAChC;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;CACb,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,+CAA+C,EAAE,CAAC,CAAC,OAAO,CACrE,iCAAiC,EACjC,CAAC,CAAC,UAAU,EACZ,OAAO,CAIP,CAAC;AAEH,wBAAgB,yCAAyC,CACvD,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,iCAAiC,EAAE,kBAAkB,CAAC,CAMxE;AAED,gBAAgB;AAChB,eAAO,MAAM,0CAA0C,EAAE,CAAC,CAAC,aAAa,CACtE,OAAO,4BAA4B,CACS,CAAC;AAE/C,gBAAgB;AAChB,eAAO,MAAM,oCAAoC,EAAE,CAAC,CAAC,OAAO,CAC1D,sBAAsB,EACtB,CAAC,CAAC,UAAU,EACZ,OAAO,CAcP,CAAC;AAEH,wBAAgB,8BAA8B,CAC5C,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,sBAAsB,EAAE,kBAAkB,CAAC,CAM7D"}

package/dist/esm/sdk/models/shared/reversegeocoderesponse.js

@@ -0,0 +1,39 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../../lib/primitives.js";
+import { safeParse } from "../../../lib/schemas.js";
+import { PostcodeAddress$inboundSchema, } from "./postcodeaddress.js";
+export const ReverseGeocodeResponseObject = {
+    List: "list",
+};
+/** @internal */
+export const ReverseGeocodeResponseCoordinates$inboundSchema = z.object({
+    lat: z.number(),
+    lng: z.number(),
+});
+export function reverseGeocodeResponseCoordinatesFromJSON(jsonString) {
+    return safeParse(jsonString, (x) => ReverseGeocodeResponseCoordinates$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ReverseGeocodeResponseCoordinates' from JSON`);
+}
+/** @internal */
+export const ReverseGeocodeResponseObject$inboundSchema = z.nativeEnum(ReverseGeocodeResponseObject);
+/** @internal */
+export const ReverseGeocodeResponse$inboundSchema = z.object({
+    coordinates: z.lazy(() => ReverseGeocodeResponseCoordinates$inboundSchema),
+    data: z.array(PostcodeAddress$inboundSchema),
+    has_more: z.boolean(),
+    object: ReverseGeocodeResponseObject$inboundSchema,
+    radius: z.number(),
+    total_count: z.number().int().optional(),
+    url: z.string(),
+}).transform((v) => {
+    return remap$(v, {
+        "has_more": "hasMore",
+        "total_count": "totalCount",
+    });
+});
+export function reverseGeocodeResponseFromJSON(jsonString) {
+    return safeParse(jsonString, (x) => ReverseGeocodeResponse$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ReverseGeocodeResponse' from JSON`);
+}
+//# sourceMappingURL=reversegeocoderesponse.js.map

package/dist/esm/sdk/models/shared/reversegeocoderesponse.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"reversegeocoderesponse.js","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/reversegeocoderesponse.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAC5B,OAAO,EAAE,KAAK,IAAI,MAAM,EAAE,MAAM,4BAA4B,CAAC;AAC7D,OAAO,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAC;AAIpD,OAAO,EAEL,6BAA6B,GAC9B,MAAM,sBAAsB,CAAC;AAgB9B,MAAM,CAAC,MAAM,4BAA4B,GAAG;IAC1C,IAAI,EAAE,MAAM;CACJ,CAAC;AA2BX,gBAAgB;AAChB,MAAM,CAAC,MAAM,+CAA+C,GAIxD,CAAC,CAAC,MAAM,CAAC;IACX,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE;IACf,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE;CAChB,CAAC,CAAC;AAEH,MAAM,UAAU,yCAAyC,CACvD,UAAkB;IAElB,OAAO,SAAS,CACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,+CAA+C,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAC3E,+DAA+D,CAChE,CAAC;AACJ,CAAC;AAED,gBAAgB;AAChB,MAAM,CAAC,MAAM,0CAA0C,GAEnD,CAAC,CAAC,UAAU,CAAC,4BAA4B,CAAC,CAAC;AAE/C,gBAAgB;AAChB,MAAM,CAAC,MAAM,oCAAoC,GAI7C,CAAC,CAAC,MAAM,CAAC;IACX,WAAW,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,+CAA+C,CAAC;IAC1E,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,6BAA6B,CAAC;IAC5C,QAAQ,EAAE,CAAC,CAAC,OAAO,EAAE;IACrB,MAAM,EAAE,0CAA0C;IAClD,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE;IAClB,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;IACxC,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE;CAChB,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE;IACjB,OAAO,MAAM,CAAC,CAAC,EAAE;QACf,UAAU,EAAE,SAAS;QACrB,aAAa,EAAE,YAAY;KAC5B,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,MAAM,UAAU,8BAA8B,CAC5C,UAAkB;IAElB,OAAO,SAAS,CACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,oCAAoC,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAChE,oDAAoD,CACrD,CAAC;AACJ,CAAC"}

package/dist/esm/sdk/models/shared/school.d.ts

@@ -28,7 +28,7 @@ export type SchoolAddress = {
     town?: string | undefined;
 };
 /**
- * Current Ofsted rating
+ * Current Ofsted inspection rating. outstanding: highest grade — exceptional quality of education. good: meets all expectations — effective teaching and outcomes. satisfactory: (pre-2012 framework) or 'requires improvement' — adequate but needs enhancement. inadequate: serious weaknesses or special measures — urgent improvement required. Null if the school has not yet been inspected by Ofsted.
  */
 export declare const CurrentRating: {
     readonly Outstanding: "outstanding";
@@ -37,7 +37,7 @@ export declare const CurrentRating: {
     readonly Inadequate: "inadequate";
 };
 /**
- * Current Ofsted rating
+ * Current Ofsted inspection rating. outstanding: highest grade — exceptional quality of education. good: meets all expectations — effective teaching and outcomes. satisfactory: (pre-2012 framework) or 'requires improvement' — adequate but needs enhancement. inadequate: serious weaknesses or special measures — urgent improvement required. Null if the school has not yet been inspected by Ofsted.
  */
 export type CurrentRating = OpenEnum<typeof CurrentRating>;
 /**
@@ -64,7 +64,7 @@ export declare const SchoolObject: {
  */
 export type SchoolObject = ClosedEnum<typeof SchoolObject>;
 /**
- * Current operational status
+ * Current operational status of the school (sourced from DfE GIAS). open: actively operating and accepting pupils. closed: permanently closed, no longer operational. pending_closure: scheduled to close — still operational but may not be accepting new admissions. Note: treat 'pending_closure' as a forward-looking indicator; the school may revert to 'open' if closure plans change. For most use cases, filter on status='open' to show only active schools.
  */
 export declare const SchoolStatus: {
     readonly Open: "open";
@@ -72,11 +72,11 @@ export declare const SchoolStatus: {
     readonly PendingClosure: "pending_closure";
 };
 /**
- * Current operational status
+ * Current operational status of the school (sourced from DfE GIAS). open: actively operating and accepting pupils. closed: permanently closed, no longer operational. pending_closure: scheduled to close — still operational but may not be accepting new admissions. Note: treat 'pending_closure' as a forward-looking indicator; the school may revert to 'open' if closure plans change. For most use cases, filter on status='open' to show only active schools.
  */
 export type SchoolStatus = OpenEnum<typeof SchoolStatus>;
 /**
- * Type of educational institution
+ * Type of educational institution. nursery: early years (ages 0-5). primary: key stages 1-2 (ages 4-11). secondary: key stages 3-4 (ages 11-16). all-through: combined primary and secondary (ages 4-16 or 4-18). sixth-form: post-16 education (ages 16-18). special: schools for pupils with special educational needs. independent: fee-paying schools not maintained by local authority. academy: state-funded but independently run, outside local authority control. other: alternative provision, pupil referral units, or unclassified.
  */
 export declare const SchoolType: {
     readonly Nursery: "nursery";
@@ -90,7 +90,7 @@ export declare const SchoolType: {
     readonly Other: "other";
 };
 /**
- * Type of educational institution
+ * Type of educational institution. nursery: early years (ages 0-5). primary: key stages 1-2 (ages 4-11). secondary: key stages 3-4 (ages 11-16). all-through: combined primary and secondary (ages 4-16 or 4-18). sixth-form: post-16 education (ages 16-18). special: schools for pupils with special educational needs. independent: fee-paying schools not maintained by local authority. academy: state-funded but independently run, outside local authority control. other: alternative provision, pupil referral units, or unclassified.
  */
 export type SchoolType = OpenEnum<typeof SchoolType>;
 export type School = {
@@ -115,7 +115,7 @@ export type School = {
      */
     createdAt: string;
     /**
-     * Current Ofsted rating
+     * Current Ofsted inspection rating. outstanding: highest grade — exceptional quality of education. good: meets all expectations — effective teaching and outcomes. satisfactory: (pre-2012 framework) or 'requires improvement' — adequate but needs enhancement. inadequate: serious weaknesses or special measures — urgent improvement required. Null if the school has not yet been inspected by Ofsted.
      */
     currentRating?: CurrentRating | undefined;
     /**
@@ -135,7 +135,7 @@ export type School = {
      */
     gender?: string | undefined;
     /**
-     * Name of the headteacher or principal
+     * Name of the headteacher or principal, sourced from DfE Get Information About Schools (GIAS). This is publicly available data. Null if not published by the school.
      */
     headteacher?: string | undefined;
     /**
@@ -163,9 +163,9 @@ export type School = {
      */
     location?: Location | undefined;
     /**
-     * Lower level geography code (LSOA)
+     * Lower Layer Super Output Area (LSOA) code for the school's location (ONS Census 2021 vintage). LSOAs are statistical areas containing ~1,500 people, used as the base geography for deprivation indices (IMD), crime statistics, and prosperity scores. Use this to join schools with the Area Reference or Safety APIs. Null if the school's postcode could not be mapped to an LSOA.
      */
-    lowerLevelGeographyCode: string | null;
+    lsoaCode: string | null;
     /**
      * Official name of the school
      */
@@ -199,7 +199,7 @@ export type School = {
      */
     specialistResource?: string | undefined;
     /**
-     * Current operational status
+     * Current operational status of the school (sourced from DfE GIAS). open: actively operating and accepting pupils. closed: permanently closed, no longer operational. pending_closure: scheduled to close — still operational but may not be accepting new admissions. Note: treat 'pending_closure' as a forward-looking indicator; the school may revert to 'open' if closure plans change. For most use cases, filter on status='open' to show only active schools.
      */
     status: SchoolStatus;
     /**
@@ -219,7 +219,7 @@ export type School = {
      */
     trustName?: string | undefined;
     /**
-     * Type of educational institution
+     * Type of educational institution. nursery: early years (ages 0-5). primary: key stages 1-2 (ages 4-11). secondary: key stages 3-4 (ages 11-16). all-through: combined primary and secondary (ages 4-16 or 4-18). sixth-form: post-16 education (ages 16-18). special: schools for pupils with special educational needs. independent: fee-paying schools not maintained by local authority. academy: state-funded but independently run, outside local authority control. other: alternative provision, pupil referral units, or unclassified.
      */
     type: SchoolType;
     /**

package/dist/esm/sdk/models/shared/school.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"school.d.ts","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/school.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAG5B,OAAO,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAC5D,OAAO,EAAE,MAAM,IAAI,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAC9D,OAAO,EAAE,kBAAkB,EAAE,MAAM,iCAAiC,CAAC;AAErE;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG;IAC1B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC5B;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC9B;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC9B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC5B;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAC3B,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,aAAa;;;;;CAKhB,CAAC;AACX;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG,QAAQ,CAAC,OAAO,aAAa,CAAC,CAAC;AAE3D;;GAEG;AACH,MAAM,MAAM,QAAQ,GAAG;IACrB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,YAAY;;CAEf,CAAC;AACX;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,UAAU,CAAC,OAAO,YAAY,CAAC,CAAC;AAE3D;;GAEG;AACH,eAAO,MAAM,YAAY;;;;CAIf,CAAC;AACX;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,QAAQ,CAAC,OAAO,YAAY,CAAC,CAAC;AAEzD;;GAEG;AACH,eAAO,MAAM,UAAU;;;;;;;;;;CAUb,CAAC;AACX;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG,QAAQ,CAAC,OAAO,UAAU,CAAC,CAAC;AAErD,MAAM,MAAM,MAAM,GAAG;IACnB;;OAEG;IACH,OAAO,CAAC,EAAE,aAAa,GAAG,SAAS,CAAC;IACpC;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACtC;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC9B;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC9B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,aAAa,CAAC,EAAE,aAAa,GAAG,SAAS,CAAC;IAC1C;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACxC;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC9B;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACzC;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC5B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACjC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IACX;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC5B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC5B;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACxC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,QAAQ,CAAC,EAAE,QAAQ,GAAG,SAAS,CAAC;IAChC;;OAEG;IACH,uBAAuB,EAAE,MAAM,GAAG,IAAI,CAAC;IACvC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACpC;;OAEG;IACH,MAAM,EAAE,YAAY,CAAC;IACrB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC3B;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACxC;;OAEG;IACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IACpB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACpC;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACxC;;OAEG;IACH,MAAM,EAAE,YAAY,CAAC;IACrB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC/B;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC7B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC/B;;OAEG;IACH,IAAI,EAAE,UAAU,CAAC;IACjB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IACZ;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAC9B,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,2BAA2B,EAAE,CAAC,CAAC,OAAO,CACjD,aAAa,EACb,CAAC,CAAC,UAAU,EACZ,OAAO,CAOP,CAAC;AAEH,wBAAgB,qBAAqB,CACnC,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,aAAa,EAAE,kBAAkB,CAAC,CAMpD;AAED,gBAAgB;AAChB,eAAO,MAAM,2BAA2B,EAAE,CAAC,CAAC,OAAO,CACjD,aAAa,EACb,CAAC,CAAC,UAAU,EACZ,OAAO,CACiC,CAAC;AAE3C,gBAAgB;AAChB,eAAO,MAAM,sBAAsB,EAAE,CAAC,CAAC,OAAO,CAC5C,QAAQ,EACR,CAAC,CAAC,UAAU,EACZ,OAAO,CAIP,CAAC;AAEH,wBAAgB,gBAAgB,CAC9B,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,QAAQ,EAAE,kBAAkB,CAAC,CAM/C;AAED,gBAAgB;AAChB,eAAO,MAAM,0BAA0B,EAAE,CAAC,CAAC,aAAa,CAAC,OAAO,YAAY,CAChD,CAAC;AAE7B,gBAAgB;AAChB,eAAO,MAAM,0BAA0B,EAAE,CAAC,CAAC,OAAO,CAChD,YAAY,EACZ,CAAC,CAAC,UAAU,EACZ,OAAO,CACgC,CAAC;AAE1C,gBAAgB;AAChB,eAAO,MAAM,wBAAwB,EAAE,CAAC,CAAC,OAAO,CAC9C,UAAU,EACV,CAAC,CAAC,UAAU,EACZ,OAAO,CAC8B,CAAC;AAExC,gBAAgB;AAChB,eAAO,MAAM,oBAAoB,EAAE,CAAC,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC,UAAU,EAAE,OAAO,CAqCtE,CAAC;AAEL,wBAAgB,cAAc,CAC5B,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,MAAM,EAAE,kBAAkB,CAAC,CAM7C"}
+{"version":3,"file":"school.d.ts","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/school.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAG5B,OAAO,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAC5D,OAAO,EAAE,MAAM,IAAI,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAC9D,OAAO,EAAE,kBAAkB,EAAE,MAAM,iCAAiC,CAAC;AAErE;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG;IAC1B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC5B;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC9B;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC9B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC5B;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAC3B,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,aAAa;;;;;CAKhB,CAAC;AACX;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG,QAAQ,CAAC,OAAO,aAAa,CAAC,CAAC;AAE3D;;GAEG;AACH,MAAM,MAAM,QAAQ,GAAG;IACrB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,YAAY;;CAEf,CAAC;AACX;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,UAAU,CAAC,OAAO,YAAY,CAAC,CAAC;AAE3D;;GAEG;AACH,eAAO,MAAM,YAAY;;;;CAIf,CAAC;AACX;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,QAAQ,CAAC,OAAO,YAAY,CAAC,CAAC;AAEzD;;GAEG;AACH,eAAO,MAAM,UAAU;;;;;;;;;;CAUb,CAAC;AACX;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG,QAAQ,CAAC,OAAO,UAAU,CAAC,CAAC;AAErD,MAAM,MAAM,MAAM,GAAG;IACnB;;OAEG;IACH,OAAO,CAAC,EAAE,aAAa,GAAG,SAAS,CAAC;IACpC;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACtC;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC9B;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC9B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,aAAa,CAAC,EAAE,aAAa,GAAG,SAAS,CAAC;IAC1C;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACxC;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC9B;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACzC;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC5B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACjC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IACX;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC5B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC5B;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACxC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,QAAQ,CAAC,EAAE,QAAQ,GAAG,SAAS,CAAC;IAChC;;OAEG;IACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACpC;;OAEG;IACH,MAAM,EAAE,YAAY,CAAC;IACrB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC3B;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACxC;;OAEG;IACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IACpB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACpC;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACxC;;OAEG;IACH,MAAM,EAAE,YAAY,CAAC;IACrB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC/B;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC7B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC/B;;OAEG;IACH,IAAI,EAAE,UAAU,CAAC;IACjB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IACZ;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAC9B,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,2BAA2B,EAAE,CAAC,CAAC,OAAO,CACjD,aAAa,EACb,CAAC,CAAC,UAAU,EACZ,OAAO,CAOP,CAAC;AAEH,wBAAgB,qBAAqB,CACnC,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,aAAa,EAAE,kBAAkB,CAAC,CAMpD;AAED,gBAAgB;AAChB,eAAO,MAAM,2BAA2B,EAAE,CAAC,CAAC,OAAO,CACjD,aAAa,EACb,CAAC,CAAC,UAAU,EACZ,OAAO,CACiC,CAAC;AAE3C,gBAAgB;AAChB,eAAO,MAAM,sBAAsB,EAAE,CAAC,CAAC,OAAO,CAC5C,QAAQ,EACR,CAAC,CAAC,UAAU,EACZ,OAAO,CAIP,CAAC;AAEH,wBAAgB,gBAAgB,CAC9B,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,QAAQ,EAAE,kBAAkB,CAAC,CAM/C;AAED,gBAAgB;AAChB,eAAO,MAAM,0BAA0B,EAAE,CAAC,CAAC,aAAa,CAAC,OAAO,YAAY,CAChD,CAAC;AAE7B,gBAAgB;AAChB,eAAO,MAAM,0BAA0B,EAAE,CAAC,CAAC,OAAO,CAChD,YAAY,EACZ,CAAC,CAAC,UAAU,EACZ,OAAO,CACgC,CAAC;AAE1C,gBAAgB;AAChB,eAAO,MAAM,wBAAwB,EAAE,CAAC,CAAC,OAAO,CAC9C,UAAU,EACV,CAAC,CAAC,UAAU,EACZ,OAAO,CAC8B,CAAC;AAExC,gBAAgB;AAChB,eAAO,MAAM,oBAAoB,EAAE,CAAC,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC,UAAU,EAAE,OAAO,CAqCtE,CAAC;AAEL,wBAAgB,cAAc,CAC5B,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,MAAM,EAAE,kBAAkB,CAAC,CAM7C"}

package/dist/esm/sdk/models/shared/school.js

@@ -5,7 +5,7 @@ import * as z from "zod/v3";
 import { safeParse } from "../../../lib/schemas.js";
 import * as openEnums from "../../types/enums.js";
 /**
- * Current Ofsted rating
+ * Current Ofsted inspection rating. outstanding: highest grade — exceptional quality of education. good: meets all expectations — effective teaching and outcomes. satisfactory: (pre-2012 framework) or 'requires improvement' — adequate but needs enhancement. inadequate: serious weaknesses or special measures — urgent improvement required. Null if the school has not yet been inspected by Ofsted.
  */
 export const CurrentRating = {
     Outstanding: "outstanding",
@@ -20,7 +20,7 @@ export const SchoolObject = {
     School: "school",
 };
 /**
- * Current operational status
+ * Current operational status of the school (sourced from DfE GIAS). open: actively operating and accepting pupils. closed: permanently closed, no longer operational. pending_closure: scheduled to close — still operational but may not be accepting new admissions. Note: treat 'pending_closure' as a forward-looking indicator; the school may revert to 'open' if closure plans change. For most use cases, filter on status='open' to show only active schools.
  */
 export const SchoolStatus = {
     Open: "open",
@@ -28,7 +28,7 @@ export const SchoolStatus = {
     PendingClosure: "pending_closure",
 };
 /**
- * Type of educational institution
+ * Type of educational institution. nursery: early years (ages 0-5). primary: key stages 1-2 (ages 4-11). secondary: key stages 3-4 (ages 11-16). all-through: combined primary and secondary (ages 4-16 or 4-18). sixth-form: post-16 education (ages 16-18). special: schools for pupils with special educational needs. independent: fee-paying schools not maintained by local authority. academy: state-funded but independently run, outside local authority control. other: alternative provision, pupil referral units, or unclassified.
  */
 export const SchoolType = {
     Nursery: "nursery",
@@ -88,7 +88,7 @@ export const School$inboundSchema = z
     lastInspectionDate: z.string().optional(),
     lastUpdated: z.string(),
     location: z.lazy(() => Location$inboundSchema).optional(),
-    lowerLevelGeographyCode: z.nullable(z.string()),
+    lsoaCode: z.nullable(z.string()),
     name: z.string(),
     numberOfPupils: z.number().optional(),
     object: SchoolObject$inboundSchema,

package/dist/esm/sdk/models/shared/school.js.map

@@ -1 +1 @@
-{"version":3,"file":"school.js","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/school.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAC5B,OAAO,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAC;AACpD,OAAO,KAAK,SAAS,MAAM,sBAAsB,CAAC;AA+BlD;;GAEG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG;IAC3B,WAAW,EAAE,aAAa;IAC1B,IAAI,EAAE,MAAM;IACZ,YAAY,EAAE,cAAc;IAC5B,UAAU,EAAE,YAAY;CAChB,CAAC;AAoBX;;GAEG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG;IAC1B,MAAM,EAAE,QAAQ;CACR,CAAC;AAMX;;GAEG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG;IAC1B,IAAI,EAAE,MAAM;IACZ,MAAM,EAAE,QAAQ;IAChB,cAAc,EAAE,iBAAiB;CACzB,CAAC;AAMX;;GAEG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG;IACxB,OAAO,EAAE,SAAS;IAClB,OAAO,EAAE,SAAS;IAClB,SAAS,EAAE,WAAW;IACtB,UAAU,EAAE,aAAa;IACzB,SAAS,EAAE,YAAY;IACvB,OAAO,EAAE,SAAS;IAClB,WAAW,EAAE,aAAa;IAC1B,OAAO,EAAE,SAAS;IAClB,KAAK,EAAE,OAAO;CACN,CAAC;AAqJX,gBAAgB;AAChB,MAAM,CAAC,MAAM,2BAA2B,GAIpC,CAAC,CAAC,MAAM,CAAC;IACX,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC7B,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC/B,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC/B,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC7B,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CAC5B,CAAC,CAAC;AAEH,MAAM,UAAU,qBAAqB,CACnC,UAAkB;IAElB,OAAO,SAAS,CACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,2BAA2B,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EACvD,2CAA2C,CAC5C,CAAC;AACJ,CAAC;AAED,gBAAgB;AAChB,MAAM,CAAC,MAAM,2BAA2B,GAIpC,SAAS,CAAC,aAAa,CAAC,aAAa,CAAC,CAAC;AAE3C,gBAAgB;AAChB,MAAM,CAAC,MAAM,sBAAsB,GAI/B,CAAC,CAAC,MAAM,CAAC;IACX,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE;IACpB,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE;CACtB,CAAC,CAAC;AAEH,MAAM,UAAU,gBAAgB,CAC9B,UAAkB;IAElB,OAAO,SAAS,CACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,sBAAsB,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAClD,sCAAsC,CACvC,CAAC;AACJ,CAAC;AAED,gBAAgB;AAChB,MAAM,CAAC,MAAM,0BAA0B,GACrC,CAAC,CAAC,UAAU,CAAC,YAAY,CAAC,CAAC;AAE7B,gBAAgB;AAChB,MAAM,CAAC,MAAM,0BAA0B,GAInC,SAAS,CAAC,aAAa,CAAC,YAAY,CAAC,CAAC;AAE1C,gBAAgB;AAChB,MAAM,CAAC,MAAM,wBAAwB,GAIjC,SAAS,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC;AAExC,gBAAgB;AAChB,MAAM,CAAC,MAAM,oBAAoB,GAA6C,CAAC;KAC5E,MAAM,CAAC;IACN,OAAO,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,2BAA2B,CAAC,CAAC,QAAQ,EAAE;IAC7D,gBAAgB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACvC,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC/B,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC/B,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE;IACrB,aAAa,EAAE,2BAA2B,CAAC,QAAQ,EAAE;IACrD,kBAAkB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACzC,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC/B,mBAAmB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC1C,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC7B,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAClC,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE;IACd,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC7B,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC7B,kBAAkB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACzC,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE;IACvB,QAAQ,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,sBAAsB,CAAC,CAAC,QAAQ,EAAE;IACzD,uBAAuB,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;IAC/C,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;IAChB,cAAc,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACrC,MAAM,EAAE,0BAA0B;IAClC,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC5B,kBAAkB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACzC,IAAI,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;IAC5B,cAAc,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACrC,kBAAkB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACzC,MAAM,EAAE,0BAA0B;IAClC,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE;IACnB,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAChC,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC9B,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAChC,IAAI,EAAE,wBAAwB;IAC9B,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE;IACrB,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE;IACf,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CAC/B,CAAC,CAAC;AAEL,MAAM,UAAU,cAAc,CAC5B,UAAkB;IAElB,OAAO,SAAS,CACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,oBAAoB,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAChD,oCAAoC,CACrC,CAAC;AACJ,CAAC"}
+{"version":3,"file":"school.js","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/school.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAC5B,OAAO,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAC;AACpD,OAAO,KAAK,SAAS,MAAM,sBAAsB,CAAC;AA+BlD;;GAEG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG;IAC3B,WAAW,EAAE,aAAa;IAC1B,IAAI,EAAE,MAAM;IACZ,YAAY,EAAE,cAAc;IAC5B,UAAU,EAAE,YAAY;CAChB,CAAC;AAoBX;;GAEG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG;IAC1B,MAAM,EAAE,QAAQ;CACR,CAAC;AAMX;;GAEG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG;IAC1B,IAAI,EAAE,MAAM;IACZ,MAAM,EAAE,QAAQ;IAChB,cAAc,EAAE,iBAAiB;CACzB,CAAC;AAMX;;GAEG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG;IACxB,OAAO,EAAE,SAAS;IAClB,OAAO,EAAE,SAAS;IAClB,SAAS,EAAE,WAAW;IACtB,UAAU,EAAE,aAAa;IACzB,SAAS,EAAE,YAAY;IACvB,OAAO,EAAE,SAAS;IAClB,WAAW,EAAE,aAAa;IAC1B,OAAO,EAAE,SAAS;IAClB,KAAK,EAAE,OAAO;CACN,CAAC;AAqJX,gBAAgB;AAChB,MAAM,CAAC,MAAM,2BAA2B,GAIpC,CAAC,CAAC,MAAM,CAAC;IACX,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC7B,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC/B,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC/B,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC7B,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CAC5B,CAAC,CAAC;AAEH,MAAM,UAAU,qBAAqB,CACnC,UAAkB;IAElB,OAAO,SAAS,CACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,2BAA2B,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EACvD,2CAA2C,CAC5C,CAAC;AACJ,CAAC;AAED,gBAAgB;AAChB,MAAM,CAAC,MAAM,2BAA2B,GAIpC,SAAS,CAAC,aAAa,CAAC,aAAa,CAAC,CAAC;AAE3C,gBAAgB;AAChB,MAAM,CAAC,MAAM,sBAAsB,GAI/B,CAAC,CAAC,MAAM,CAAC;IACX,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE;IACpB,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE;CACtB,CAAC,CAAC;AAEH,MAAM,UAAU,gBAAgB,CAC9B,UAAkB;IAElB,OAAO,SAAS,CACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,sBAAsB,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAClD,sCAAsC,CACvC,CAAC;AACJ,CAAC;AAED,gBAAgB;AAChB,MAAM,CAAC,MAAM,0BAA0B,GACrC,CAAC,CAAC,UAAU,CAAC,YAAY,CAAC,CAAC;AAE7B,gBAAgB;AAChB,MAAM,CAAC,MAAM,0BAA0B,GAInC,SAAS,CAAC,aAAa,CAAC,YAAY,CAAC,CAAC;AAE1C,gBAAgB;AAChB,MAAM,CAAC,MAAM,wBAAwB,GAIjC,SAAS,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC;AAExC,gBAAgB;AAChB,MAAM,CAAC,MAAM,oBAAoB,GAA6C,CAAC;KAC5E,MAAM,CAAC;IACN,OAAO,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,2BAA2B,CAAC,CAAC,QAAQ,EAAE;IAC7D,gBAAgB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACvC,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC/B,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC/B,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE;IACrB,aAAa,EAAE,2BAA2B,CAAC,QAAQ,EAAE;IACrD,kBAAkB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACzC,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC/B,mBAAmB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC1C,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC7B,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAClC,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE;IACd,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC7B,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC7B,kBAAkB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACzC,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE;IACvB,QAAQ,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,sBAAsB,CAAC,CAAC,QAAQ,EAAE;IACzD,QAAQ,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;IAChC,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;IAChB,cAAc,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACrC,MAAM,EAAE,0BAA0B;IAClC,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC5B,kBAAkB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACzC,IAAI,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;IAC5B,cAAc,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACrC,kBAAkB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACzC,MAAM,EAAE,0BAA0B;IAClC,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE;IACnB,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAChC,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC9B,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAChC,IAAI,EAAE,wBAAwB;IAC9B,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE;IACrB,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE;IACf,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CAC/B,CAAC,CAAC;AAEL,MAAM,UAAU,cAAc,CAC5B,UAAkB;IAElB,OAAO,SAAS,CACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,oBAAoB,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAChD,oCAAoC,CACrC,CAAC;AACJ,CAAC"}

package/dist/esm/sdk/models/shared/searchresponse.d.ts

@@ -1,5 +1,5 @@
 import * as z from "zod/v3";
-import { OpenEnum } from "../../types/enums.js";
+import { ClosedEnum, OpenEnum } from "../../types/enums.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 import { SearchResult } from "./searchresult.js";
@@ -66,35 +66,44 @@ export type Metadata = {
      */
     sources?: Array<Sources> | undefined;
 };
+/**
+ * Object type identifier
+ */
+export declare const SearchResponseObject: {
+    readonly List: "list";
+};
+/**
+ * Object type identifier
+ */
+export type SearchResponseObject = ClosedEnum<typeof SearchResponseObject>;
+/**
+ * Paginated list response
+ */
 export type SearchResponse = {
     /**
-     * Whether more results are available
+     * Array of items
      */
-    hasMore?: boolean | undefined;
+    data: Array<SearchResult>;
     /**
-     * Search metadata
-     */
-    metadata?: Metadata | undefined;
-    /**
-     * Offset for next page of results
+     * Whether more items exist
      */
-    nextOffset?: number | undefined;
+    hasMore: boolean;
     /**
-     * Array of search results
+     * Search metadata
      */
-    results: Array<SearchResult>;
+    metadata?: Metadata | undefined;
     /**
-     * Number of results returned in this response
+     * Object type identifier
      */
-    size: number;
+    object: SearchResponseObject;
     /**
-     * Whether the search was successful
+     * Total number of items available
      */
-    success: boolean;
+    totalCount?: number | undefined;
     /**
-     * Total number of results found
+     * URL of the request
      */
-    totalResults: number;
+    url: string;
 };
 /** @internal */
 export declare const QueryPattern$inboundSchema: z.ZodType<QueryPattern, z.ZodTypeDef, unknown>;
@@ -104,6 +113,8 @@ export declare const Sources$inboundSchema: z.ZodType<Sources, z.ZodTypeDef, unk
 export declare const Metadata$inboundSchema: z.ZodType<Metadata, z.ZodTypeDef, unknown>;
 export declare function metadataFromJSON(jsonString: string): SafeParseResult<Metadata, SDKValidationError>;
 /** @internal */
+export declare const SearchResponseObject$inboundSchema: z.ZodNativeEnum<typeof SearchResponseObject>;
+/** @internal */
 export declare const SearchResponse$inboundSchema: z.ZodType<SearchResponse, z.ZodTypeDef, unknown>;
 export declare function searchResponseFromJSON(jsonString: string): SafeParseResult<SearchResponse, SDKValidationError>;
 //# sourceMappingURL=searchresponse.d.ts.map

package/dist/esm/sdk/models/shared/searchresponse.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"searchresponse.d.ts","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/searchresponse.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAG5B,OAAO,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAChD,OAAO,EAAE,MAAM,IAAI,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAC9D,OAAO,EAAE,kBAAkB,EAAE,MAAM,iCAAiC,CAAC;AACrE,OAAO,EAAE,YAAY,EAA8B,MAAM,mBAAmB,CAAC;AAE7E;;;;;;;GAOG;AACH,eAAO,MAAM,YAAY;;;;CAIf,CAAC;AACX;;;;;;;GAOG;AACH,MAAM,MAAM,YAAY,GAAG,QAAQ,CAAC,OAAO,YAAY,CAAC,CAAC;AAEzD;;;;;;GAMG;AACH,eAAO,MAAM,OAAO;;;CAGV,CAAC;AACX;;;;;;GAMG;AACH,MAAM,MAAM,OAAO,GAAG,QAAQ,CAAC,OAAO,OAAO,CAAC,CAAC;AAE/C;;GAEG;AACH,MAAM,MAAM,QAAQ,GAAG;IACrB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACpC;;;;;;;OAOG;IACH,YAAY,CAAC,EAAE,YAAY,GAAG,SAAS,CAAC;IACxC;;OAEG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,OAAO,CAAC,GAAG,SAAS,CAAC;CACtC,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG;IAC3B;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAC9B;;OAEG;IACH,QAAQ,CAAC,EAAE,QAAQ,GAAG,SAAS,CAAC;IAChC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAChC;;OAEG;IACH,OAAO,EAAE,KAAK,CAAC,YAAY,CAAC,CAAC;IAC7B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IACjB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;CACtB,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,0BAA0B,EAAE,CAAC,CAAC,OAAO,CAChD,YAAY,EACZ,CAAC,CAAC,UAAU,EACZ,OAAO,CACgC,CAAC;AAE1C,gBAAgB;AAChB,eAAO,MAAM,qBAAqB,EAAE,CAAC,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC,UAAU,EAAE,OAAO,CAC1C,CAAC;AAEnC,gBAAgB;AAChB,eAAO,MAAM,sBAAsB,EAAE,CAAC,CAAC,OAAO,CAC5C,QAAQ,EACR,CAAC,CAAC,UAAU,EACZ,OAAO,CAKP,CAAC;AAEH,wBAAgB,gBAAgB,CAC9B,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,QAAQ,EAAE,kBAAkB,CAAC,CAM/C;AAED,gBAAgB;AAChB,eAAO,MAAM,4BAA4B,EAAE,CAAC,CAAC,OAAO,CAClD,cAAc,EACd,CAAC,CAAC,UAAU,EACZ,OAAO,CASP,CAAC;AAEH,wBAAgB,sBAAsB,CACpC,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,cAAc,EAAE,kBAAkB,CAAC,CAMrD"}
+{"version":3,"file":"searchresponse.d.ts","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/searchresponse.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAI5B,OAAO,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAC5D,OAAO,EAAE,MAAM,IAAI,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAC9D,OAAO,EAAE,kBAAkB,EAAE,MAAM,iCAAiC,CAAC;AACrE,OAAO,EAAE,YAAY,EAA8B,MAAM,mBAAmB,CAAC;AAE7E;;;;;;;GAOG;AACH,eAAO,MAAM,YAAY;;;;CAIf,CAAC;AACX;;;;;;;GAOG;AACH,MAAM,MAAM,YAAY,GAAG,QAAQ,CAAC,OAAO,YAAY,CAAC,CAAC;AAEzD;;;;;;GAMG;AACH,eAAO,MAAM,OAAO;;;CAGV,CAAC;AACX;;;;;;GAMG;AACH,MAAM,MAAM,OAAO,GAAG,QAAQ,CAAC,OAAO,OAAO,CAAC,CAAC;AAE/C;;GAEG;AACH,MAAM,MAAM,QAAQ,GAAG;IACrB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACpC;;;;;;;OAOG;IACH,YAAY,CAAC,EAAE,YAAY,GAAG,SAAS,CAAC;IACxC;;OAEG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,OAAO,CAAC,GAAG,SAAS,CAAC;CACtC,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,oBAAoB;;CAEvB,CAAC;AACX;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG,UAAU,CAAC,OAAO,oBAAoB,CAAC,CAAC;AAE3E;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,YAAY,CAAC,CAAC;IAC1B;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IACjB;;OAEG;IACH,QAAQ,CAAC,EAAE,QAAQ,GAAG,SAAS,CAAC;IAChC;;OAEG;IACH,MAAM,EAAE,oBAAoB,CAAC;IAC7B;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAChC;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;CACb,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,0BAA0B,EAAE,CAAC,CAAC,OAAO,CAChD,YAAY,EACZ,CAAC,CAAC,UAAU,EACZ,OAAO,CACgC,CAAC;AAE1C,gBAAgB;AAChB,eAAO,MAAM,qBAAqB,EAAE,CAAC,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC,UAAU,EAAE,OAAO,CAC1C,CAAC;AAEnC,gBAAgB;AAChB,eAAO,MAAM,sBAAsB,EAAE,CAAC,CAAC,OAAO,CAC5C,QAAQ,EACR,CAAC,CAAC,UAAU,EACZ,OAAO,CAKP,CAAC;AAEH,wBAAgB,gBAAgB,CAC9B,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,QAAQ,EAAE,kBAAkB,CAAC,CAM/C;AAED,gBAAgB;AAChB,eAAO,MAAM,kCAAkC,EAAE,CAAC,CAAC,aAAa,CAC9D,OAAO,oBAAoB,CACS,CAAC;AAEvC,gBAAgB;AAChB,eAAO,MAAM,4BAA4B,EAAE,CAAC,CAAC,OAAO,CAClD,cAAc,EACd,CAAC,CAAC,UAAU,EACZ,OAAO,CAaP,CAAC;AAEH,wBAAgB,sBAAsB,CACpC,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,cAAc,EAAE,kBAAkB,CAAC,CAMrD"}

package/dist/esm/sdk/models/shared/searchresponse.js

@@ -2,6 +2,7 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 import * as z from "zod/v3";
+import { remap as remap$ } from "../../../lib/primitives.js";
 import { safeParse } from "../../../lib/schemas.js";
 import * as openEnums from "../../types/enums.js";
 import { SearchResult$inboundSchema } from "./searchresult.js";
@@ -29,6 +30,12 @@ export const Sources = {
     Address: "address",
     Location: "location",
 };
+/**
+ * Object type identifier
+ */
+export const SearchResponseObject = {
+    List: "list",
+};
 /** @internal */
 export const QueryPattern$inboundSchema = openEnums.inboundSchema(QueryPattern);
 /** @internal */
@@ -43,14 +50,20 @@ export function metadataFromJSON(jsonString) {
     return safeParse(jsonString, (x) => Metadata$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'Metadata' from JSON`);
 }
 /** @internal */
+export const SearchResponseObject$inboundSchema = z.nativeEnum(SearchResponseObject);
+/** @internal */
 export const SearchResponse$inboundSchema = z.object({
-    hasMore: z.boolean().optional(),
+    data: z.array(SearchResult$inboundSchema),
+    has_more: z.boolean(),
     metadata: z.lazy(() => Metadata$inboundSchema).optional(),
-    nextOffset: z.number().optional(),
-    results: z.array(SearchResult$inboundSchema),
-    size: z.number(),
-    success: z.boolean(),
-    totalResults: z.number(),
+    object: SearchResponseObject$inboundSchema,
+    total_count: z.number().optional(),
+    url: z.string(),
+}).transform((v) => {
+    return remap$(v, {
+        "has_more": "hasMore",
+        "total_count": "totalCount",
+    });
 });
 export function searchResponseFromJSON(jsonString) {
     return safeParse(jsonString, (x) => SearchResponse$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'SearchResponse' from JSON`);

package/dist/esm/sdk/models/shared/searchresponse.js.map

@@ -1 +1 @@
-{"version":3,"file":"searchresponse.js","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/searchresponse.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAC5B,OAAO,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAC;AACpD,OAAO,KAAK,SAAS,MAAM,sBAAsB,CAAC;AAIlD,OAAO,EAAgB,0BAA0B,EAAE,MAAM,mBAAmB,CAAC;AAE7E;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG;IAC1B,QAAQ,EAAE,UAAU;IACpB,OAAO,EAAE,SAAS;IAClB,OAAO,EAAE,SAAS;CACV,CAAC;AAWX;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,OAAO,GAAG;IACrB,OAAO,EAAE,SAAS;IAClB,QAAQ,EAAE,UAAU;CACZ,CAAC;AAgEX,gBAAgB;AAChB,MAAM,CAAC,MAAM,0BAA0B,GAInC,SAAS,CAAC,aAAa,CAAC,YAAY,CAAC,CAAC;AAE1C,gBAAgB;AAChB,MAAM,CAAC,MAAM,qBAAqB,GAChC,SAAS,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;AAEnC,gBAAgB;AAChB,MAAM,CAAC,MAAM,sBAAsB,GAI/B,CAAC,CAAC,MAAM,CAAC;IACX,cAAc,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACrC,YAAY,EAAE,0BAA0B,CAAC,QAAQ,EAAE;IACnD,OAAO,EAAE,CAAC,CAAC,KAAK,CAAC,qBAAqB,CAAC,CAAC,QAAQ,EAAE;CACnD,CAAC,CAAC;AAEH,MAAM,UAAU,gBAAgB,CAC9B,UAAkB;IAElB,OAAO,SAAS,CACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,sBAAsB,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAClD,sCAAsC,CACvC,CAAC;AACJ,CAAC;AAED,gBAAgB;AAChB,MAAM,CAAC,MAAM,4BAA4B,GAIrC,CAAC,CAAC,MAAM,CAAC;IACX,OAAO,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IAC/B,QAAQ,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,sBAAsB,CAAC,CAAC,QAAQ,EAAE;IACzD,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACjC,OAAO,EAAE,CAAC,CAAC,KAAK,CAAC,0BAA0B,CAAC;IAC5C,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;IAChB,OAAO,EAAE,CAAC,CAAC,OAAO,EAAE;IACpB,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE;CACzB,CAAC,CAAC;AAEH,MAAM,UAAU,sBAAsB,CACpC,UAAkB;IAElB,OAAO,SAAS,CACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,4BAA4B,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EACxD,4CAA4C,CAC7C,CAAC;AACJ,CAAC"}
+{"version":3,"file":"searchresponse.js","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/searchresponse.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAC5B,OAAO,EAAE,KAAK,IAAI,MAAM,EAAE,MAAM,4BAA4B,CAAC;AAC7D,OAAO,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAC;AACpD,OAAO,KAAK,SAAS,MAAM,sBAAsB,CAAC;AAIlD,OAAO,EAAgB,0BAA0B,EAAE,MAAM,mBAAmB,CAAC;AAE7E;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG;IAC1B,QAAQ,EAAE,UAAU;IACpB,OAAO,EAAE,SAAS;IAClB,OAAO,EAAE,SAAS;CACV,CAAC;AAWX;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,OAAO,GAAG;IACrB,OAAO,EAAE,SAAS;IAClB,QAAQ,EAAE,UAAU;CACZ,CAAC;AAiCX;;GAEG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAG;IAClC,IAAI,EAAE,MAAM;CACJ,CAAC;AAoCX,gBAAgB;AAChB,MAAM,CAAC,MAAM,0BAA0B,GAInC,SAAS,CAAC,aAAa,CAAC,YAAY,CAAC,CAAC;AAE1C,gBAAgB;AAChB,MAAM,CAAC,MAAM,qBAAqB,GAChC,SAAS,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;AAEnC,gBAAgB;AAChB,MAAM,CAAC,MAAM,sBAAsB,GAI/B,CAAC,CAAC,MAAM,CAAC;IACX,cAAc,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACrC,YAAY,EAAE,0BAA0B,CAAC,QAAQ,EAAE;IACnD,OAAO,EAAE,CAAC,CAAC,KAAK,CAAC,qBAAqB,CAAC,CAAC,QAAQ,EAAE;CACnD,CAAC,CAAC;AAEH,MAAM,UAAU,gBAAgB,CAC9B,UAAkB;IAElB,OAAO,SAAS,CACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,sBAAsB,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAClD,sCAAsC,CACvC,CAAC;AACJ,CAAC;AAED,gBAAgB;AAChB,MAAM,CAAC,MAAM,kCAAkC,GAE3C,CAAC,CAAC,UAAU,CAAC,oBAAoB,CAAC,CAAC;AAEvC,gBAAgB;AAChB,MAAM,CAAC,MAAM,4BAA4B,GAIrC,CAAC,CAAC,MAAM,CAAC;IACX,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,0BAA0B,CAAC;IACzC,QAAQ,EAAE,CAAC,CAAC,OAAO,EAAE;IACrB,QAAQ,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,sBAAsB,CAAC,CAAC,QAAQ,EAAE;IACzD,MAAM,EAAE,kCAAkC;IAC1C,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAClC,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE;CAChB,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE;IACjB,OAAO,MAAM,CAAC,CAAC,EAAE;QACf,UAAU,EAAE,SAAS;QACrB,aAAa,EAAE,YAAY;KAC5B,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,MAAM,UAAU,sBAAsB,CACpC,UAAkB;IAElB,OAAO,SAAS,CACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,4BAA4B,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EACxD,4CAA4C,CAC7C,CAAC;AACJ,CAAC"}