@vepler/sdk 2.33.0 → 2.38.2

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

@@ -2,11 +2,12 @@ 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";
+import { MatchedSubstring } from "./matchedsubstring.js";
 import { SearchHighlight } from "./searchhighlight.js";
 /**
  * WGS84 coordinate pair
  */
-export type Coordinates = {
+export type SearchResultCoordinates = {
     /**
      * Latitude in decimal degrees
      */
@@ -45,7 +46,7 @@ export type SearchResult = {
      */
     description?: string | undefined;
     /**
-     * Distance from query point in meters
+     * Distance from query point in metres
      */
     distance?: number | undefined;
     /**
@@ -59,7 +60,19 @@ export type SearchResult = {
     /**
      * WGS84 coordinate pair
      */
-    location?: Coordinates | undefined;
+    location?: SearchResultCoordinates | undefined;
+    /**
+     * Primary display text — building + street
+     */
+    mainText?: string | undefined;
+    /**
+     * Query match positions within main_text
+     */
+    mainTextMatchedSubstrings?: Array<MatchedSubstring> | undefined;
+    /**
+     * Query match positions within title
+     */
+    matchedSubstrings?: Array<MatchedSubstring> | undefined;
     /**
      * Additional result-specific metadata (varies by result type)
      */
@@ -70,6 +83,10 @@ export type SearchResult = {
      * URL path to view full details
      */
     path?: string | undefined;
+    /**
+     * Postcode
+     */
+    postcode?: string | undefined;
     /**
      * Normalised relevance score (0-1)
      */
@@ -78,6 +95,10 @@ export type SearchResult = {
      * Raw search score
      */
     score: number;
+    /**
+     * Secondary display text — locality + postcode
+     */
+    secondaryText?: string | undefined;
     /**
      * Data source to search:
      *
@@ -91,13 +112,17 @@ export type SearchResult = {
      */
     title: string;
     /**
-     * Result type (address, postcode, location, etc.)
+     * Result type (address, postcode, street, locality, location)
      */
     type: string;
+    /**
+     * Unique Property Reference Number
+     */
+    uprn?: string | undefined;
 };
 /** @internal */
-export declare const Coordinates$inboundSchema: z.ZodType<Coordinates, z.ZodTypeDef, unknown>;
-export declare function coordinatesFromJSON(jsonString: string): SafeParseResult<Coordinates, SDKValidationError>;
+export declare const SearchResultCoordinates$inboundSchema: z.ZodType<SearchResultCoordinates, z.ZodTypeDef, unknown>;
+export declare function searchResultCoordinatesFromJSON(jsonString: string): SafeParseResult<SearchResultCoordinates, SDKValidationError>;
 /** @internal */
 export declare const Source$inboundSchema: z.ZodType<Source, z.ZodTypeDef, unknown>;
 /** @internal */

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

@@ -1 +1 @@
-{"version":3,"file":"searchresult.d.ts","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/searchresult.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,EACL,eAAe,EAEhB,MAAM,sBAAsB,CAAC;AAE9B;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG;IACxB;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IACZ;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;CACb,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,MAAM;;;CAGT,CAAC;AACX;;;;;;GAMG;AACH,MAAM,MAAM,MAAM,GAAG,QAAQ,CAAC,OAAO,MAAM,CAAC,CAAC;AAE7C,MAAM,MAAM,YAAY,GAAG;IACzB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC7B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACjC;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC9B;;OAEG;IACH,UAAU,CAAC,EAAE,KAAK,CAAC,eAAe,CAAC,GAAG,SAAS,CAAC;IAChD;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IACX;;OAEG;IACH,QAAQ,CAAC,EAAE,WAAW,GAAG,SAAS,CAAC;IACnC;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,CAAC,EAAE,MAAM,GAAG,GAAG,GAAG,IAAI,CAAA;KAAE,GAAG,SAAS,CAAC;IACnD;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC1B;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IACvB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;;;;;OAMG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,yBAAyB,EAAE,CAAC,CAAC,OAAO,CAC/C,WAAW,EACX,CAAC,CAAC,UAAU,EACZ,OAAO,CAIP,CAAC;AAEH,wBAAgB,mBAAmB,CACjC,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,WAAW,EAAE,kBAAkB,CAAC,CAMlD;AAED,gBAAgB;AAChB,eAAO,MAAM,oBAAoB,EAAE,CAAC,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC,UAAU,EAAE,OAAO,CACzC,CAAC;AAElC,gBAAgB;AAChB,eAAO,MAAM,0BAA0B,EAAE,CAAC,CAAC,OAAO,CAChD,YAAY,EACZ,CAAC,CAAC,UAAU,EACZ,OAAO,CAeP,CAAC;AAEH,wBAAgB,oBAAoB,CAClC,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,YAAY,EAAE,kBAAkB,CAAC,CAMnD"}
+{"version":3,"file":"searchresult.d.ts","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/searchresult.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAI5B,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,EACL,gBAAgB,EAEjB,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EACL,eAAe,EAEhB,MAAM,sBAAsB,CAAC;AAE9B;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAAG;IACpC;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IACZ;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;CACb,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,MAAM;;;CAGT,CAAC;AACX;;;;;;GAMG;AACH,MAAM,MAAM,MAAM,GAAG,QAAQ,CAAC,OAAO,MAAM,CAAC,CAAC;AAE7C,MAAM,MAAM,YAAY,GAAG;IACzB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC7B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACjC;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC9B;;OAEG;IACH,UAAU,CAAC,EAAE,KAAK,CAAC,eAAe,CAAC,GAAG,SAAS,CAAC;IAChD;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IACX;;OAEG;IACH,QAAQ,CAAC,EAAE,uBAAuB,GAAG,SAAS,CAAC;IAC/C;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC9B;;OAEG;IACH,yBAAyB,CAAC,EAAE,KAAK,CAAC,gBAAgB,CAAC,GAAG,SAAS,CAAC;IAChE;;OAEG;IACH,iBAAiB,CAAC,EAAE,KAAK,CAAC,gBAAgB,CAAC,GAAG,SAAS,CAAC;IACxD;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,CAAC,EAAE,MAAM,GAAG,GAAG,GAAG,IAAI,CAAA;KAAE,GAAG,SAAS,CAAC;IACnD;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC1B;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC9B;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IACvB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACnC;;;;;;OAMG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAC3B,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,qCAAqC,EAAE,CAAC,CAAC,OAAO,CAC3D,uBAAuB,EACvB,CAAC,CAAC,UAAU,EACZ,OAAO,CAIP,CAAC;AAEH,wBAAgB,+BAA+B,CAC7C,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,uBAAuB,EAAE,kBAAkB,CAAC,CAM9D;AAED,gBAAgB;AAChB,eAAO,MAAM,oBAAoB,EAAE,CAAC,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC,UAAU,EAAE,OAAO,CACzC,CAAC;AAElC,gBAAgB;AAChB,eAAO,MAAM,0BAA0B,EAAE,CAAC,CAAC,OAAO,CAChD,YAAY,EACZ,CAAC,CAAC,UAAU,EACZ,OAAO,CA6BP,CAAC;AAEH,wBAAgB,oBAAoB,CAClC,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,YAAY,EAAE,kBAAkB,CAAC,CAMnD"}

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

@@ -2,8 +2,10 @@
  * 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 { MatchedSubstring$inboundSchema, } from "./matchedsubstring.js";
 import { SearchHighlight$inboundSchema, } from "./searchhighlight.js";
 /**
  * Data source to search:
@@ -17,12 +19,12 @@ export const Source = {
     Location: "location",
 };
 /** @internal */
-export const Coordinates$inboundSchema = z.object({
+export const SearchResultCoordinates$inboundSchema = z.object({
     lat: z.number(),
     lng: z.number(),
 });
-export function coordinatesFromJSON(jsonString) {
-    return safeParse(jsonString, (x) => Coordinates$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'Coordinates' from JSON`);
+export function searchResultCoordinatesFromJSON(jsonString) {
+    return safeParse(jsonString, (x) => SearchResultCoordinates$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'SearchResultCoordinates' from JSON`);
 }
 /** @internal */
 export const Source$inboundSchema = openEnums.inboundSchema(Source);
@@ -33,14 +35,28 @@ export const SearchResult$inboundSchema = z.object({
     distance: z.number().optional(),
     highlights: z.array(SearchHighlight$inboundSchema).optional(),
     id: z.string(),
-    location: z.lazy(() => Coordinates$inboundSchema).optional(),
+    location: z.lazy(() => SearchResultCoordinates$inboundSchema).optional(),
+    main_text: z.string().optional(),
+    main_text_matched_substrings: z.array(MatchedSubstring$inboundSchema)
+        .optional(),
+    matched_substrings: z.array(MatchedSubstring$inboundSchema).optional(),
     metadata: z.record(z.nullable(z.any())).optional(),
     path: z.string().optional(),
+    postcode: z.string().optional(),
     relevanceScore: z.number(),
     score: z.number(),
+    secondary_text: z.string().optional(),
     source: Source$inboundSchema,
     title: z.string(),
     type: z.string(),
+    uprn: z.string().optional(),
+}).transform((v) => {
+    return remap$(v, {
+        "main_text": "mainText",
+        "main_text_matched_substrings": "mainTextMatchedSubstrings",
+        "matched_substrings": "matchedSubstrings",
+        "secondary_text": "secondaryText",
+    });
 });
 export function searchResultFromJSON(jsonString) {
     return safeParse(jsonString, (x) => SearchResult$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'SearchResult' from JSON`);

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

@@ -1 +1 @@
-{"version":3,"file":"searchresult.js","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/searchresult.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,EAEL,6BAA6B,GAC9B,MAAM,sBAAsB,CAAC;AAgB9B;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,MAAM,GAAG;IACpB,OAAO,EAAE,SAAS;IAClB,QAAQ,EAAE,UAAU;CACZ,CAAC;AAqEX,gBAAgB;AAChB,MAAM,CAAC,MAAM,yBAAyB,GAIlC,CAAC,CAAC,MAAM,CAAC;IACX,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE;IACf,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE;CAChB,CAAC,CAAC;AAEH,MAAM,UAAU,mBAAmB,CACjC,UAAkB;IAElB,OAAO,SAAS,CACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,yBAAyB,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EACrD,yCAAyC,CAC1C,CAAC;AACJ,CAAC;AAED,gBAAgB;AAChB,MAAM,CAAC,MAAM,oBAAoB,GAC/B,SAAS,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;AAElC,gBAAgB;AAChB,MAAM,CAAC,MAAM,0BAA0B,GAInC,CAAC,CAAC,MAAM,CAAC;IACX,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC9B,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAClC,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC/B,UAAU,EAAE,CAAC,CAAC,KAAK,CAAC,6BAA6B,CAAC,CAAC,QAAQ,EAAE;IAC7D,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE;IACd,QAAQ,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,yBAAyB,CAAC,CAAC,QAAQ,EAAE;IAC5D,QAAQ,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,QAAQ,EAAE;IAClD,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC3B,cAAc,EAAE,CAAC,CAAC,MAAM,EAAE;IAC1B,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;IACjB,MAAM,EAAE,oBAAoB;IAC5B,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;IACjB,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;CACjB,CAAC,CAAC;AAEH,MAAM,UAAU,oBAAoB,CAClC,UAAkB;IAElB,OAAO,SAAS,CACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,0BAA0B,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EACtD,0CAA0C,CAC3C,CAAC;AACJ,CAAC"}
+{"version":3,"file":"searchresult.js","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/searchresult.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,EAEL,8BAA8B,GAC/B,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAEL,6BAA6B,GAC9B,MAAM,sBAAsB,CAAC;AAgB9B;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,MAAM,GAAG;IACpB,OAAO,EAAE,SAAS;IAClB,QAAQ,EAAE,UAAU;CACZ,CAAC;AA6FX,gBAAgB;AAChB,MAAM,CAAC,MAAM,qCAAqC,GAI9C,CAAC,CAAC,MAAM,CAAC;IACX,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE;IACf,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE;CAChB,CAAC,CAAC;AAEH,MAAM,UAAU,+BAA+B,CAC7C,UAAkB;IAElB,OAAO,SAAS,CACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,qCAAqC,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EACjE,qDAAqD,CACtD,CAAC;AACJ,CAAC;AAED,gBAAgB;AAChB,MAAM,CAAC,MAAM,oBAAoB,GAC/B,SAAS,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;AAElC,gBAAgB;AAChB,MAAM,CAAC,MAAM,0BAA0B,GAInC,CAAC,CAAC,MAAM,CAAC;IACX,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC9B,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAClC,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC/B,UAAU,EAAE,CAAC,CAAC,KAAK,CAAC,6BAA6B,CAAC,CAAC,QAAQ,EAAE;IAC7D,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE;IACd,QAAQ,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,qCAAqC,CAAC,CAAC,QAAQ,EAAE;IACxE,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAChC,4BAA4B,EAAE,CAAC,CAAC,KAAK,CAAC,8BAA8B,CAAC;SAClE,QAAQ,EAAE;IACb,kBAAkB,EAAE,CAAC,CAAC,KAAK,CAAC,8BAA8B,CAAC,CAAC,QAAQ,EAAE;IACtE,QAAQ,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,QAAQ,EAAE;IAClD,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC3B,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC/B,cAAc,EAAE,CAAC,CAAC,MAAM,EAAE;IAC1B,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;IACjB,cAAc,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACrC,MAAM,EAAE,oBAAoB;IAC5B,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;IACjB,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;IAChB,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CAC5B,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE;IACjB,OAAO,MAAM,CAAC,CAAC,EAAE;QACf,WAAW,EAAE,UAAU;QACvB,8BAA8B,EAAE,2BAA2B;QAC3D,oBAAoB,EAAE,mBAAmB;QACzC,gBAAgB,EAAE,eAAe;KAClC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,MAAM,UAAU,oBAAoB,CAClC,UAAkB;IAElB,OAAO,SAAS,CACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,0BAA0B,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EACtD,0CAA0C,CAC3C,CAAC;AACJ,CAAC"}

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

@@ -0,0 +1,20 @@
+import * as z from "zod/v3";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+/**
+ * Standard Industrial Classification (SIC 2007) code identifying a company's business activity
+ */
+export type SicCode = {
+    /**
+     * UK SIC 2007 code -- a 4 or 5-digit numeric code classifying the company's business activity. Published by the ONS. Examples: '62020' (IT consultancy), '68100' (buying/selling own real estate).
+     */
+    code: string;
+    /**
+     * Human-readable description of the SIC code, e.g. 'Information technology consultancy activities'.
+     */
+    description?: string | undefined;
+};
+/** @internal */
+export declare const SicCode$inboundSchema: z.ZodType<SicCode, z.ZodTypeDef, unknown>;
+export declare function sicCodeFromJSON(jsonString: string): SafeParseResult<SicCode, SDKValidationError>;
+//# sourceMappingURL=siccode.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"siccode.d.ts","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/siccode.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAE5B,OAAO,EAAE,MAAM,IAAI,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAC9D,OAAO,EAAE,kBAAkB,EAAE,MAAM,iCAAiC,CAAC;AAErE;;GAEG;AACH,MAAM,MAAM,OAAO,GAAG;IACpB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAClC,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,qBAAqB,EAAE,CAAC,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC,UAAU,EAAE,OAAO,CAIxE,CAAC;AAEL,wBAAgB,eAAe,CAC7B,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,OAAO,EAAE,kBAAkB,CAAC,CAM9C"}

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

@@ -0,0 +1,14 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+import * as z from "zod/v3";
+import { safeParse } from "../../../lib/schemas.js";
+/** @internal */
+export const SicCode$inboundSchema = z.object({
+    code: z.string(),
+    description: z.string().optional(),
+});
+export function sicCodeFromJSON(jsonString) {
+    return safeParse(jsonString, (x) => SicCode$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'SicCode' from JSON`);
+}
+//# sourceMappingURL=siccode.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"siccode.js","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/siccode.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAC5B,OAAO,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAC;AAkBpD,gBAAgB;AAChB,MAAM,CAAC,MAAM,qBAAqB,GAChC,CAAC,CAAC,MAAM,CAAC;IACP,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;IAChB,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CACnC,CAAC,CAAC;AAEL,MAAM,UAAU,eAAe,CAC7B,UAAkB;IAElB,OAAO,SAAS,CACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,qBAAqB,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EACjD,qCAAqC,CACtC,CAAC;AACJ,CAAC"}

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

@@ -0,0 +1,13 @@
+import * as z from "zod/v3";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+export type SingleValueAggregationResult = {
+    /**
+     * Computed value. Null if no documents match.
+     */
+    value: number | null;
+};
+/** @internal */
+export declare const SingleValueAggregationResult$inboundSchema: z.ZodType<SingleValueAggregationResult, z.ZodTypeDef, unknown>;
+export declare function singleValueAggregationResultFromJSON(jsonString: string): SafeParseResult<SingleValueAggregationResult, SDKValidationError>;
+//# sourceMappingURL=singlevalueaggregationresult.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"singlevalueaggregationresult.d.ts","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/singlevalueaggregationresult.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAE5B,OAAO,EAAE,MAAM,IAAI,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAC9D,OAAO,EAAE,kBAAkB,EAAE,MAAM,iCAAiC,CAAC;AAErE,MAAM,MAAM,4BAA4B,GAAG;IACzC;;OAEG;IACH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;CACtB,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,0CAA0C,EAAE,CAAC,CAAC,OAAO,CAChE,4BAA4B,EAC5B,CAAC,CAAC,UAAU,EACZ,OAAO,CAGP,CAAC;AAEH,wBAAgB,oCAAoC,CAClD,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,4BAA4B,EAAE,kBAAkB,CAAC,CAMnE"}

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

@@ -0,0 +1,13 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+import * as z from "zod/v3";
+import { safeParse } from "../../../lib/schemas.js";
+/** @internal */
+export const SingleValueAggregationResult$inboundSchema = z.object({
+    value: z.nullable(z.number()),
+});
+export function singleValueAggregationResultFromJSON(jsonString) {
+    return safeParse(jsonString, (x) => SingleValueAggregationResult$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'SingleValueAggregationResult' from JSON`);
+}
+//# sourceMappingURL=singlevalueaggregationresult.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"singlevalueaggregationresult.js","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/singlevalueaggregationresult.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAC5B,OAAO,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAC;AAWpD,gBAAgB;AAChB,MAAM,CAAC,MAAM,0CAA0C,GAInD,CAAC,CAAC,MAAM,CAAC;IACX,KAAK,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;CAC9B,CAAC,CAAC;AAEH,MAAM,UAAU,oCAAoC,CAClD,UAAkB;IAElB,OAAO,SAAS,CACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,0CAA0C,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EACtE,0DAA0D,CAC3D,CAAC;AACJ,CAAC"}

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

@@ -0,0 +1,200 @@
+import * as z from "zod/v3";
+import { ClosedEnum, OpenEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import { SiteAreaMetrics } from "./siteareametrics.js";
+import { SitePlanningStats } from "./siteplanningstats.js";
+import { SitePropertyStats } from "./sitepropertystats.js";
+import { SiteScores } from "./sitescores.js";
+import { SiteTags } from "./sitetags.js";
+/**
+ * GeoJSON MultiPolygon geometry
+ */
+export type GeoJSONMultiPolygon = {
+    /**
+     * Array of polygon coordinate arrays
+     */
+    coordinates: Array<Array<Array<Array<number>>>>;
+    /**
+     * GeoJSON geometry type
+     */
+    type: "MultiPolygon";
+};
+/**
+ * GeoJSON Polygon geometry
+ */
+export type GeoJSONPolygon = {
+    /**
+     * Array of linear rings
+     */
+    coordinates: Array<Array<Array<number>>>;
+    /**
+     * GeoJSON geometry type
+     */
+    type: "Polygon";
+};
+/**
+ * Site boundary geometry in WGS84 (EPSG:4326). GeoJSON Polygon or MultiPolygon with coordinates in [longitude, latitude] order. Excluded from the default attribute set for performance — request explicitly via `attributes: ["boundary"]`.
+ */
+export type Boundary = GeoJSONPolygon | GeoJSONMultiPolygon;
+/**
+ * WGS84 coordinate pair
+ */
+export type SiteCoordinates = {
+    /**
+     * Latitude in decimal degrees
+     */
+    lat: number;
+    /**
+     * Longitude in decimal degrees
+     */
+    lng: number;
+};
+/**
+ * Object type identifier
+ */
+export declare const SiteObject: {
+    readonly Site: "site";
+};
+/**
+ * Object type identifier
+ */
+export type SiteObject = ClosedEnum<typeof SiteObject>;
+/**
+ * Site record status. "active" — current registered title. "pending" — title awaiting registration or enrichment. "closed" — title no longer active (merged, cancelled, or superseded).
+ */
+export declare const SiteStatus: {
+    readonly Active: "active";
+    readonly Pending: "pending";
+    readonly Closed: "closed";
+};
+/**
+ * Site record status. "active" — current registered title. "pending" — title awaiting registration or enrichment. "closed" — title no longer active (merged, cancelled, or superseded).
+ */
+export type SiteStatus = OpenEnum<typeof SiteStatus>;
+export type Site = {
+    /**
+     * Area-level metrics from the LSOA (Lower Layer Super Output Area) containing the site centroid. Includes crime, deprivation, connectivity, and prosperity indices. Null when the centroid cannot be matched to an LSOA (e.g. sites outside England and Wales).
+     */
+    areaMetrics: SiteAreaMetrics | null;
+    /**
+     * Site area in square metres, calculated from the boundary polygon
+     */
+    areaSqm: number;
+    /**
+     * Site boundary geometry in WGS84 (EPSG:4326). GeoJSON Polygon or MultiPolygon with coordinates in [longitude, latitude] order. Excluded from the default attribute set for performance — request explicitly via `attributes: ["boundary"]`.
+     */
+    boundary: GeoJSONPolygon | GeoJSONMultiPolygon;
+    /**
+     * WGS84 coordinate pair
+     */
+    centroid: SiteCoordinates;
+    /**
+     * HM Land Registry class of title code. Determines title quality and tenure. Freehold codes: AF (Absolute Freehold), QF (Qualified Freehold), PF (Possessory Freehold), SF (Good Leasehold - Freehold). Leasehold codes: AL (Absolute Leasehold), GL (Good Leasehold), QL (Qualified Leasehold), PL (Possessory Leasehold), SL (Scheme Leasehold). Other codes: CF (Caution Freehold), CL (Caution Leasehold), AR, PR, QR (Rentcharge variants), CN (Caution).
+     */
+    classTitleCode: string | null;
+    /**
+     * ISO 3166-1 alpha-2 country code
+     */
+    country: string;
+    /**
+     * HM Land Registry estate interest code. Almost always "EL" (Estate in Land). Does not indicate freehold/leasehold — use `classTitleCode` or `tenureType` instead.
+     */
+    estateInterestCode: string | null;
+    /**
+     * Land use classifications derived from spatial analysis. Examples: residential, commercial, agricultural, mixed_use, industrial, vacant.
+     */
+    landUse: Array<string>;
+    /**
+     * Number of UPRNs linked to this title
+     */
+    locationCount: number;
+    /**
+     * UPRNs (Unique Property Reference Numbers) linked to this title via spatial intersection with the Ordnance Survey AddressBase dataset
+     */
+    locationIds: Array<string>;
+    /**
+     * Object type identifier
+     */
+    object: SiteObject;
+    /**
+     * Spatial overlay keywords derived from area reference data intersecting the site boundary. Examples include flood risk zones, conservation areas, green belt, listed building curtilage, and other planning designations. Values are not from a fixed enum — they depend on available area reference datasets.
+     */
+    overlays: Array<string>;
+    /**
+     * Planning application statistics from applications whose boundary intersects this site. Null when no planning applications intersect or when enrichment has not yet run.
+     */
+    planning: SitePlanningStats | null;
+    /**
+     * Internal polygon identifiers from the source shapefile. Used for provenance tracking; not typically needed by API consumers.
+     */
+    polygonIds: Array<number>;
+    /**
+     * Aggregated statistics for properties linked to this site. Null when no properties are linked (locationCount is 0) or when enrichment has not yet run.
+     */
+    propertyStats: SitePropertyStats | null;
+    /**
+     * UTC date the title was first registered with HM Land Registry, in ISO 8601 format
+     */
+    registeredAt: string | null;
+    /**
+     * Land registry identifier
+     */
+    registry: string;
+    /**
+     * Identifiers of geographic entities that spatially intersect or contain this site. Includes local authority codes, ward codes, parish codes, and other administrative area references.
+     */
+    relationships: Array<string>;
+    /**
+     * Computed scores (0-100) for development potential, environmental risk, and investment attractiveness. Null when insufficient data is available to compute scores.
+     */
+    scores: SiteScores | null;
+    /**
+     * Composite site identifier: {country}:{registry}:{titleRef}
+     */
+    siteId: string;
+    /**
+     * Data sources for this site
+     */
+    sources: Array<string>;
+    /**
+     * Site record status. "active" — current registered title. "pending" — title awaiting registration or enrichment. "closed" — title no longer active (merged, cancelled, or superseded).
+     */
+    status: SiteStatus;
+    /**
+     * Boolean tags derived automatically during enrichment. Useful for quick filtering without complex queries.
+     */
+    tags: SiteTags;
+    /**
+     * Derived tenure type based on classTitleCode. One of: freehold, leasehold, commonhold, rentcharge, caution, other. Null when classTitleCode is unavailable.
+     */
+    tenureType: string | null;
+    /**
+     * Title number from the land registry
+     */
+    titleRef: string;
+    /**
+     * UTC datetime when the site record was last enriched or updated, in ISO 8601 format
+     */
+    updatedAt: string | null;
+};
+/** @internal */
+export declare const GeoJSONMultiPolygon$inboundSchema: z.ZodType<GeoJSONMultiPolygon, z.ZodTypeDef, unknown>;
+export declare function geoJSONMultiPolygonFromJSON(jsonString: string): SafeParseResult<GeoJSONMultiPolygon, SDKValidationError>;
+/** @internal */
+export declare const GeoJSONPolygon$inboundSchema: z.ZodType<GeoJSONPolygon, z.ZodTypeDef, unknown>;
+export declare function geoJSONPolygonFromJSON(jsonString: string): SafeParseResult<GeoJSONPolygon, SDKValidationError>;
+/** @internal */
+export declare const Boundary$inboundSchema: z.ZodType<Boundary, z.ZodTypeDef, unknown>;
+export declare function boundaryFromJSON(jsonString: string): SafeParseResult<Boundary, SDKValidationError>;
+/** @internal */
+export declare const SiteCoordinates$inboundSchema: z.ZodType<SiteCoordinates, z.ZodTypeDef, unknown>;
+export declare function siteCoordinatesFromJSON(jsonString: string): SafeParseResult<SiteCoordinates, SDKValidationError>;
+/** @internal */
+export declare const SiteObject$inboundSchema: z.ZodNativeEnum<typeof SiteObject>;
+/** @internal */
+export declare const SiteStatus$inboundSchema: z.ZodType<SiteStatus, z.ZodTypeDef, unknown>;
+/** @internal */
+export declare const Site$inboundSchema: z.ZodType<Site, z.ZodTypeDef, unknown>;
+export declare function siteFromJSON(jsonString: string): SafeParseResult<Site, SDKValidationError>;
+//# sourceMappingURL=site.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"site.d.ts","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/site.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;AACrE,OAAO,EACL,eAAe,EAEhB,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EACL,iBAAiB,EAElB,MAAM,wBAAwB,CAAC;AAChC,OAAO,EACL,iBAAiB,EAElB,MAAM,wBAAwB,CAAC;AAChC,OAAO,EAAE,UAAU,EAA4B,MAAM,iBAAiB,CAAC;AACvE,OAAO,EAAE,QAAQ,EAA0B,MAAM,eAAe,CAAC;AAEjE;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC;;OAEG;IACH,WAAW,EAAE,KAAK,CAAC,KAAK,CAAC,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;IAChD;;OAEG;IACH,IAAI,EAAE,cAAc,CAAC;CACtB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B;;OAEG;IACH,WAAW,EAAE,KAAK,CAAC,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;IACzC;;OAEG;IACH,IAAI,EAAE,SAAS,CAAC;CACjB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,QAAQ,GAAG,cAAc,GAAG,mBAAmB,CAAC;AAE5D;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IACZ;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;CACb,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,UAAU;;CAEb,CAAC;AACX;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG,UAAU,CAAC,OAAO,UAAU,CAAC,CAAC;AAEvD;;GAEG;AACH,eAAO,MAAM,UAAU;;;;CAIb,CAAC;AACX;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG,QAAQ,CAAC,OAAO,UAAU,CAAC,CAAC;AAErD,MAAM,MAAM,IAAI,GAAG;IACjB;;OAEG;IACH,WAAW,EAAE,eAAe,GAAG,IAAI,CAAC;IACpC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,QAAQ,EAAE,cAAc,GAAG,mBAAmB,CAAC;IAC/C;;OAEG;IACH,QAAQ,EAAE,eAAe,CAAC;IAC1B;;OAEG;IACH,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,kBAAkB,EAAE,MAAM,GAAG,IAAI,CAAC;IAClC;;OAEG;IACH,OAAO,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IACvB;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IACtB;;OAEG;IACH,WAAW,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAC3B;;OAEG;IACH,MAAM,EAAE,UAAU,CAAC;IACnB;;OAEG;IACH,QAAQ,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IACxB;;OAEG;IACH,QAAQ,EAAE,iBAAiB,GAAG,IAAI,CAAC;IACnC;;OAEG;IACH,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAC1B;;OAEG;IACH,aAAa,EAAE,iBAAiB,GAAG,IAAI,CAAC;IACxC;;OAEG;IACH,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,aAAa,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAC7B;;OAEG;IACH,MAAM,EAAE,UAAU,GAAG,IAAI,CAAC;IAC1B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,OAAO,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IACvB;;OAEG;IACH,MAAM,EAAE,UAAU,CAAC;IACnB;;OAEG;IACH,IAAI,EAAE,QAAQ,CAAC;IACf;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;CAC1B,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,iCAAiC,EAAE,CAAC,CAAC,OAAO,CACvD,mBAAmB,EACnB,CAAC,CAAC,UAAU,EACZ,OAAO,CAIP,CAAC;AAEH,wBAAgB,2BAA2B,CACzC,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,mBAAmB,EAAE,kBAAkB,CAAC,CAM1D;AAED,gBAAgB;AAChB,eAAO,MAAM,4BAA4B,EAAE,CAAC,CAAC,OAAO,CAClD,cAAc,EACd,CAAC,CAAC,UAAU,EACZ,OAAO,CAIP,CAAC;AAEH,wBAAgB,sBAAsB,CACpC,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,cAAc,EAAE,kBAAkB,CAAC,CAMrD;AAED,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,6BAA6B,EAAE,CAAC,CAAC,OAAO,CACnD,eAAe,EACf,CAAC,CAAC,UAAU,EACZ,OAAO,CAIP,CAAC;AAEH,wBAAgB,uBAAuB,CACrC,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,eAAe,EAAE,kBAAkB,CAAC,CAMtD;AAED,gBAAgB;AAChB,eAAO,MAAM,wBAAwB,EAAE,CAAC,CAAC,aAAa,CAAC,OAAO,UAAU,CAC/C,CAAC;AAE1B,gBAAgB;AAChB,eAAO,MAAM,wBAAwB,EAAE,CAAC,CAAC,OAAO,CAC9C,UAAU,EACV,CAAC,CAAC,UAAU,EACZ,OAAO,CAC8B,CAAC;AAExC,gBAAgB;AAChB,eAAO,MAAM,kBAAkB,EAAE,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC,UAAU,EAAE,OAAO,CA+BlE,CAAC;AAEL,wBAAgB,YAAY,CAC1B,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,IAAI,EAAE,kBAAkB,CAAC,CAM3C"}

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

@@ -0,0 +1,99 @@
+/*
+ * 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";
+import { SiteAreaMetrics$inboundSchema, } from "./siteareametrics.js";
+import { SitePlanningStats$inboundSchema, } from "./siteplanningstats.js";
+import { SitePropertyStats$inboundSchema, } from "./sitepropertystats.js";
+import { SiteScores$inboundSchema } from "./sitescores.js";
+import { SiteTags$inboundSchema } from "./sitetags.js";
+/**
+ * Object type identifier
+ */
+export const SiteObject = {
+    Site: "site",
+};
+/**
+ * Site record status. "active" — current registered title. "pending" — title awaiting registration or enrichment. "closed" — title no longer active (merged, cancelled, or superseded).
+ */
+export const SiteStatus = {
+    Active: "active",
+    Pending: "pending",
+    Closed: "closed",
+};
+/** @internal */
+export const GeoJSONMultiPolygon$inboundSchema = z.object({
+    coordinates: z.array(z.array(z.array(z.array(z.number())))),
+    type: z.literal("MultiPolygon"),
+});
+export function geoJSONMultiPolygonFromJSON(jsonString) {
+    return safeParse(jsonString, (x) => GeoJSONMultiPolygon$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'GeoJSONMultiPolygon' from JSON`);
+}
+/** @internal */
+export const GeoJSONPolygon$inboundSchema = z.object({
+    coordinates: z.array(z.array(z.array(z.number()))),
+    type: z.literal("Polygon"),
+});
+export function geoJSONPolygonFromJSON(jsonString) {
+    return safeParse(jsonString, (x) => GeoJSONPolygon$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'GeoJSONPolygon' from JSON`);
+}
+/** @internal */
+export const Boundary$inboundSchema = z.union([
+    z.lazy(() => GeoJSONPolygon$inboundSchema),
+    z.lazy(() => GeoJSONMultiPolygon$inboundSchema),
+]);
+export function boundaryFromJSON(jsonString) {
+    return safeParse(jsonString, (x) => Boundary$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'Boundary' from JSON`);
+}
+/** @internal */
+export const SiteCoordinates$inboundSchema = z.object({
+    lat: z.number(),
+    lng: z.number(),
+});
+export function siteCoordinatesFromJSON(jsonString) {
+    return safeParse(jsonString, (x) => SiteCoordinates$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'SiteCoordinates' from JSON`);
+}
+/** @internal */
+export const SiteObject$inboundSchema = z
+    .nativeEnum(SiteObject);
+/** @internal */
+export const SiteStatus$inboundSchema = openEnums.inboundSchema(SiteStatus);
+/** @internal */
+export const Site$inboundSchema = z
+    .object({
+    areaMetrics: z.nullable(SiteAreaMetrics$inboundSchema),
+    areaSqm: z.number(),
+    boundary: z.union([
+        z.lazy(() => GeoJSONPolygon$inboundSchema),
+        z.lazy(() => GeoJSONMultiPolygon$inboundSchema),
+    ]),
+    centroid: z.lazy(() => SiteCoordinates$inboundSchema),
+    classTitleCode: z.nullable(z.string()),
+    country: z.string(),
+    estateInterestCode: z.nullable(z.string()),
+    landUse: z.array(z.string()),
+    locationCount: z.number(),
+    locationIds: z.array(z.string()),
+    object: SiteObject$inboundSchema,
+    overlays: z.array(z.string()),
+    planning: z.nullable(SitePlanningStats$inboundSchema),
+    polygonIds: z.array(z.number()),
+    propertyStats: z.nullable(SitePropertyStats$inboundSchema),
+    registeredAt: z.nullable(z.string()),
+    registry: z.string(),
+    relationships: z.array(z.string()),
+    scores: z.nullable(SiteScores$inboundSchema),
+    siteId: z.string(),
+    sources: z.array(z.string()),
+    status: SiteStatus$inboundSchema,
+    tags: SiteTags$inboundSchema,
+    tenureType: z.nullable(z.string()),
+    titleRef: z.string(),
+    updatedAt: z.nullable(z.string()),
+});
+export function siteFromJSON(jsonString) {
+    return safeParse(jsonString, (x) => Site$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'Site' from JSON`);
+}
+//# sourceMappingURL=site.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"site.js","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/site.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,EAEL,6BAA6B,GAC9B,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAEL,+BAA+B,GAChC,MAAM,wBAAwB,CAAC;AAChC,OAAO,EAEL,+BAA+B,GAChC,MAAM,wBAAwB,CAAC;AAChC,OAAO,EAAc,wBAAwB,EAAE,MAAM,iBAAiB,CAAC;AACvE,OAAO,EAAY,sBAAsB,EAAE,MAAM,eAAe,CAAC;AAiDjE;;GAEG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG;IACxB,IAAI,EAAE,MAAM;CACJ,CAAC;AAMX;;GAEG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG;IACxB,MAAM,EAAE,QAAQ;IAChB,OAAO,EAAE,SAAS;IAClB,MAAM,EAAE,QAAQ;CACR,CAAC;AAiHX,gBAAgB;AAChB,MAAM,CAAC,MAAM,iCAAiC,GAI1C,CAAC,CAAC,MAAM,CAAC;IACX,WAAW,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC;IAC3D,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,cAAc,CAAC;CAChC,CAAC,CAAC;AAEH,MAAM,UAAU,2BAA2B,CACzC,UAAkB;IAElB,OAAO,SAAS,CACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,iCAAiC,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAC7D,iDAAiD,CAClD,CAAC;AACJ,CAAC;AAED,gBAAgB;AAChB,MAAM,CAAC,MAAM,4BAA4B,GAIrC,CAAC,CAAC,MAAM,CAAC;IACX,WAAW,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;IAClD,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC;CAC3B,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;AAED,gBAAgB;AAChB,MAAM,CAAC,MAAM,sBAAsB,GAI/B,CAAC,CAAC,KAAK,CAAC;IACV,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,4BAA4B,CAAC;IAC1C,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,iCAAiC,CAAC;CAChD,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,6BAA6B,GAItC,CAAC,CAAC,MAAM,CAAC;IACX,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE;IACf,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE;CAChB,CAAC,CAAC;AAEH,MAAM,UAAU,uBAAuB,CACrC,UAAkB;IAElB,OAAO,SAAS,CACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,6BAA6B,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EACzD,6CAA6C,CAC9C,CAAC;AACJ,CAAC;AAED,gBAAgB;AAChB,MAAM,CAAC,MAAM,wBAAwB,GAAuC,CAAC;KAC1E,UAAU,CAAC,UAAU,CAAC,CAAC;AAE1B,gBAAgB;AAChB,MAAM,CAAC,MAAM,wBAAwB,GAIjC,SAAS,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC;AAExC,gBAAgB;AAChB,MAAM,CAAC,MAAM,kBAAkB,GAA2C,CAAC;KACxE,MAAM,CAAC;IACN,WAAW,EAAE,CAAC,CAAC,QAAQ,CAAC,6BAA6B,CAAC;IACtD,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE;IACnB,QAAQ,EAAE,CAAC,CAAC,KAAK,CAAC;QAChB,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,4BAA4B,CAAC;QAC1C,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,iCAAiC,CAAC;KAChD,CAAC;IACF,QAAQ,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,6BAA6B,CAAC;IACrD,cAAc,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;IACtC,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE;IACnB,kBAAkB,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;IAC1C,OAAO,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;IAC5B,aAAa,EAAE,CAAC,CAAC,MAAM,EAAE;IACzB,WAAW,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;IAChC,MAAM,EAAE,wBAAwB;IAChC,QAAQ,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;IAC7B,QAAQ,EAAE,CAAC,CAAC,QAAQ,CAAC,+BAA+B,CAAC;IACrD,UAAU,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;IAC/B,aAAa,EAAE,CAAC,CAAC,QAAQ,CAAC,+BAA+B,CAAC;IAC1D,YAAY,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;IACpC,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE;IACpB,aAAa,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;IAClC,MAAM,EAAE,CAAC,CAAC,QAAQ,CAAC,wBAAwB,CAAC;IAC5C,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE;IAClB,OAAO,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;IAC5B,MAAM,EAAE,wBAAwB;IAChC,IAAI,EAAE,sBAAsB;IAC5B,UAAU,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;IAClC,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE;IACpB,SAAS,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;CAClC,CAAC,CAAC;AAEL,MAAM,UAAU,YAAY,CAC1B,UAAkB;IAElB,OAAO,SAAS,CACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,kBAAkB,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAC9C,kCAAkC,CACnC,CAAC;AACJ,CAAC"}

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

@@ -0,0 +1,31 @@
+import * as z from "zod/v3";
+import { SiteAggregationInput, SiteAggregationInput$Outbound } from "./siteaggregationinput.js";
+import { SiteAreaFilter, SiteAreaFilter$Outbound } from "./siteareafilter.js";
+import { SiteFilters, SiteFilters$Outbound } from "./sitefilters.js";
+import { SiteQueryOperator, SiteQueryOperator$Outbound } from "./sitequeryoperator.js";
+export type SiteAggregateRequest = {
+    /**
+     * Aggregation definitions (max 10)
+     */
+    aggregations: Array<SiteAggregationInput>;
+    /**
+     * Geographic area filters (combined with OR logic)
+     */
+    area?: Array<SiteAreaFilter> | undefined;
+    filters?: SiteFilters | undefined;
+    /**
+     * Advanced query operators
+     */
+    query?: Array<SiteQueryOperator> | undefined;
+};
+/** @internal */
+export type SiteAggregateRequest$Outbound = {
+    aggregations: Array<SiteAggregationInput$Outbound>;
+    area?: Array<SiteAreaFilter$Outbound> | undefined;
+    filters?: SiteFilters$Outbound | undefined;
+    query?: Array<SiteQueryOperator$Outbound> | undefined;
+};
+/** @internal */
+export declare const SiteAggregateRequest$outboundSchema: z.ZodType<SiteAggregateRequest$Outbound, z.ZodTypeDef, SiteAggregateRequest>;
+export declare function siteAggregateRequestToJSON(siteAggregateRequest: SiteAggregateRequest): string;
+//# sourceMappingURL=siteaggregaterequest.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"siteaggregaterequest.d.ts","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/siteaggregaterequest.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAC5B,OAAO,EACL,oBAAoB,EACpB,6BAA6B,EAE9B,MAAM,2BAA2B,CAAC;AACnC,OAAO,EACL,cAAc,EACd,uBAAuB,EAExB,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EACL,WAAW,EACX,oBAAoB,EAErB,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EACL,iBAAiB,EACjB,0BAA0B,EAE3B,MAAM,wBAAwB,CAAC;AAEhC,MAAM,MAAM,oBAAoB,GAAG;IACjC;;OAEG;IACH,YAAY,EAAE,KAAK,CAAC,oBAAoB,CAAC,CAAC;IAC1C;;OAEG;IACH,IAAI,CAAC,EAAE,KAAK,CAAC,cAAc,CAAC,GAAG,SAAS,CAAC;IACzC,OAAO,CAAC,EAAE,WAAW,GAAG,SAAS,CAAC;IAClC;;OAEG;IACH,KAAK,CAAC,EAAE,KAAK,CAAC,iBAAiB,CAAC,GAAG,SAAS,CAAC;CAC9C,CAAC;AAEF,gBAAgB;AAChB,MAAM,MAAM,6BAA6B,GAAG;IAC1C,YAAY,EAAE,KAAK,CAAC,6BAA6B,CAAC,CAAC;IACnD,IAAI,CAAC,EAAE,KAAK,CAAC,uBAAuB,CAAC,GAAG,SAAS,CAAC;IAClD,OAAO,CAAC,EAAE,oBAAoB,GAAG,SAAS,CAAC;IAC3C,KAAK,CAAC,EAAE,KAAK,CAAC,0BAA0B,CAAC,GAAG,SAAS,CAAC;CACvD,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,mCAAmC,EAAE,CAAC,CAAC,OAAO,CACzD,6BAA6B,EAC7B,CAAC,CAAC,UAAU,EACZ,oBAAoB,CAMpB,CAAC;AAEH,wBAAgB,0BAA0B,CACxC,oBAAoB,EAAE,oBAAoB,GACzC,MAAM,CAIR"}

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

@@ -0,0 +1,19 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+import * as z from "zod/v3";
+import { SiteAggregationInput$outboundSchema, } from "./siteaggregationinput.js";
+import { SiteAreaFilter$outboundSchema, } from "./siteareafilter.js";
+import { SiteFilters$outboundSchema, } from "./sitefilters.js";
+import { SiteQueryOperator$outboundSchema, } from "./sitequeryoperator.js";
+/** @internal */
+export const SiteAggregateRequest$outboundSchema = z.object({
+    aggregations: z.array(SiteAggregationInput$outboundSchema),
+    area: z.array(SiteAreaFilter$outboundSchema).optional(),
+    filters: SiteFilters$outboundSchema.optional(),
+    query: z.array(SiteQueryOperator$outboundSchema).optional(),
+});
+export function siteAggregateRequestToJSON(siteAggregateRequest) {
+    return JSON.stringify(SiteAggregateRequest$outboundSchema.parse(siteAggregateRequest));
+}
+//# sourceMappingURL=siteaggregaterequest.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"siteaggregaterequest.js","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/siteaggregaterequest.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAC5B,OAAO,EAGL,mCAAmC,GACpC,MAAM,2BAA2B,CAAC;AACnC,OAAO,EAGL,6BAA6B,GAC9B,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAGL,0BAA0B,GAC3B,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EAGL,gCAAgC,GACjC,MAAM,wBAAwB,CAAC;AA0BhC,gBAAgB;AAChB,MAAM,CAAC,MAAM,mCAAmC,GAI5C,CAAC,CAAC,MAAM,CAAC;IACX,YAAY,EAAE,CAAC,CAAC,KAAK,CAAC,mCAAmC,CAAC;IAC1D,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,6BAA6B,CAAC,CAAC,QAAQ,EAAE;IACvD,OAAO,EAAE,0BAA0B,CAAC,QAAQ,EAAE;IAC9C,KAAK,EAAE,CAAC,CAAC,KAAK,CAAC,gCAAgC,CAAC,CAAC,QAAQ,EAAE;CAC5D,CAAC,CAAC;AAEH,MAAM,UAAU,0BAA0B,CACxC,oBAA0C;IAE1C,OAAO,IAAI,CAAC,SAAS,CACnB,mCAAmC,CAAC,KAAK,CAAC,oBAAoB,CAAC,CAChE,CAAC;AACJ,CAAC"}