@vepler/sdk 6.1.0 → 6.36.0

package/dist/commonjs/sdk/models/shared/streetproperties.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";
+/**
+ * The properties on the street, paged by `propertyOptions`.
+ */
+export type StreetProperties = {
+    /**
+     * True when the street has further properties beyond this list.
+     */
+    hasMore: boolean;
+    /**
+     * Unique Property Reference Numbers (UPRNs) of properties on the street, in ascending order.
+     */
+    uprns: Array<number>;
+};
+/** @internal */
+export declare const StreetProperties$inboundSchema: z.ZodType<StreetProperties, z.ZodTypeDef, unknown>;
+export declare function streetPropertiesFromJSON(jsonString: string): SafeParseResult<StreetProperties, SDKValidationError>;
+//# sourceMappingURL=streetproperties.d.ts.map

package/dist/commonjs/sdk/models/shared/streetproperties.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"streetproperties.d.ts","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/streetproperties.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,gBAAgB,GAAG;IAC7B;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IACjB;;OAEG;IACH,KAAK,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACtB,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,8BAA8B,EAAE,CAAC,CAAC,OAAO,CACpD,gBAAgB,EAChB,CAAC,CAAC,UAAU,EACZ,OAAO,CAIP,CAAC;AAEH,wBAAgB,wBAAwB,CACtC,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,gBAAgB,EAAE,kBAAkB,CAAC,CAMvD"}

package/dist/commonjs/sdk/models/shared/{streetstatistics.js → streetproperties.js}

@@ -36,16 +36,16 @@ var __importStar = (this && this.__importStar) || (function () {
     };
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.StreetStatistics$inboundSchema = void 0;
-exports.streetStatisticsFromJSON = streetStatisticsFromJSON;
+exports.StreetProperties$inboundSchema = void 0;
+exports.streetPropertiesFromJSON = streetPropertiesFromJSON;
 const z = __importStar(require("zod/v3"));
 const schemas_js_1 = require("../../../lib/schemas.js");
 /** @internal */
-exports.StreetStatistics$inboundSchema = z.object({
-    classifications: z.record(z.number()),
-    propertyCount: z.number(),
+exports.StreetProperties$inboundSchema = z.object({
+    hasMore: z.boolean(),
+    uprns: z.array(z.number()),
 });
-function streetStatisticsFromJSON(jsonString) {
-    return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.StreetStatistics$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'StreetStatistics' from JSON`);
+function streetPropertiesFromJSON(jsonString) {
+    return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.StreetProperties$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'StreetProperties' from JSON`);
 }
-//# sourceMappingURL=streetstatistics.js.map
+//# sourceMappingURL=streetproperties.js.map

package/dist/commonjs/sdk/models/shared/streetproperties.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"streetproperties.js","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/streetproperties.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA+BH,4DAQC;AArCD,0CAA4B;AAC5B,wDAAoD;AAkBpD,gBAAgB;AACH,QAAA,8BAA8B,GAIvC,CAAC,CAAC,MAAM,CAAC;IACX,OAAO,EAAE,CAAC,CAAC,OAAO,EAAE;IACpB,KAAK,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;CAC3B,CAAC,CAAC;AAEH,SAAgB,wBAAwB,CACtC,UAAkB;IAElB,OAAO,IAAA,sBAAS,EACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,sCAA8B,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAC1D,8CAA8C,CAC/C,CAAC;AACJ,CAAC"}

package/dist/commonjs/sdk/models/shared/streetpropertyoptions.d.ts

@@ -0,0 +1,28 @@
+import * as z from "zod/v3";
+/**
+ * How to page and filter each street's property list. Accepted only when `includeProperties` is true.
+ */
+export type StreetPropertyOptions = {
+    /**
+     * Include retired address records alongside the current ones. Defaults to false, which returns only approved and alternative addresses. Available only with `dataset` set to `ngd`.
+     */
+    includeHistoric?: boolean | undefined;
+    /**
+     * Maximum number of properties to return per street. Defaults to 100. Minimum 1, maximum 500.
+     */
+    limit?: number | undefined;
+    /**
+     * Number of properties to skip on each street before the first one returned. Defaults to 0.
+     */
+    offset?: number | undefined;
+};
+/** @internal */
+export type StreetPropertyOptions$Outbound = {
+    includeHistoric: boolean;
+    limit: number;
+    offset: number;
+};
+/** @internal */
+export declare const StreetPropertyOptions$outboundSchema: z.ZodType<StreetPropertyOptions$Outbound, z.ZodTypeDef, StreetPropertyOptions>;
+export declare function streetPropertyOptionsToJSON(streetPropertyOptions: StreetPropertyOptions): string;
+//# sourceMappingURL=streetpropertyoptions.d.ts.map

package/dist/commonjs/sdk/models/shared/streetpropertyoptions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"streetpropertyoptions.d.ts","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/streetpropertyoptions.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAE5B;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG;IAClC;;OAEG;IACH,eAAe,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IACtC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC3B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAC7B,CAAC;AAEF,gBAAgB;AAChB,MAAM,MAAM,8BAA8B,GAAG;IAC3C,eAAe,EAAE,OAAO,CAAC;IACzB,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,oCAAoC,EAAE,CAAC,CAAC,OAAO,CAC1D,8BAA8B,EAC9B,CAAC,CAAC,UAAU,EACZ,qBAAqB,CAKrB,CAAC;AAEH,wBAAgB,2BAA2B,CACzC,qBAAqB,EAAE,qBAAqB,GAC3C,MAAM,CAIR"}

package/dist/commonjs/sdk/models/shared/streetpropertyoptions.js

@@ -0,0 +1,51 @@
+"use strict";
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StreetPropertyOptions$outboundSchema = void 0;
+exports.streetPropertyOptionsToJSON = streetPropertyOptionsToJSON;
+const z = __importStar(require("zod/v3"));
+/** @internal */
+exports.StreetPropertyOptions$outboundSchema = z.object({
+    includeHistoric: z.boolean().default(false),
+    limit: z.number().int().default(100),
+    offset: z.number().int().default(0),
+});
+function streetPropertyOptionsToJSON(streetPropertyOptions) {
+    return JSON.stringify(exports.StreetPropertyOptions$outboundSchema.parse(streetPropertyOptions));
+}
+//# sourceMappingURL=streetpropertyoptions.js.map

package/dist/commonjs/sdk/models/shared/streetpropertyoptions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"streetpropertyoptions.js","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/streetpropertyoptions.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAwCH,kEAMC;AA5CD,0CAA4B;AA2B5B,gBAAgB;AACH,QAAA,oCAAoC,GAI7C,CAAC,CAAC,MAAM,CAAC;IACX,eAAe,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC;IAC3C,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC;IACpC,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC;CACpC,CAAC,CAAC;AAEH,SAAgB,2BAA2B,CACzC,qBAA4C;IAE5C,OAAO,IAAI,CAAC,SAAS,CACnB,4CAAoC,CAAC,KAAK,CAAC,qBAAqB,CAAC,CAClE,CAAC;AACJ,CAAC"}

package/dist/commonjs/sdk/models/shared/streetprovenance.d.ts

@@ -0,0 +1,45 @@
+import * as z from "zod/v3";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import { StreetSource } from "./streetsource.js";
+/**
+ * Which dataset supplied each returned field. Present only when a street's fields came from more than one dataset.
+ */
+export type StreetProvenance = {
+    /**
+     * The dataset that supplied the street record: 'open' for Ordnance Survey open data, 'ngd' for the Ordnance Survey National Geographic Database.
+     */
+    county?: StreetSource | undefined;
+    /**
+     * The dataset that supplied the street record: 'open' for Ordnance Survey open data, 'ngd' for the Ordnance Survey National Geographic Database.
+     */
+    district?: StreetSource | undefined;
+    /**
+     * The dataset that supplied the street record: 'open' for Ordnance Survey open data, 'ngd' for the Ordnance Survey National Geographic Database.
+     */
+    locality?: StreetSource | undefined;
+    /**
+     * The dataset that supplied the street record: 'open' for Ordnance Survey open data, 'ngd' for the Ordnance Survey National Geographic Database.
+     */
+    location?: StreetSource | undefined;
+    /**
+     * The dataset that supplied the street record: 'open' for Ordnance Survey open data, 'ngd' for the Ordnance Survey National Geographic Database.
+     */
+    name?: StreetSource | undefined;
+    /**
+     * The dataset that supplied the street record: 'open' for Ordnance Survey open data, 'ngd' for the Ordnance Survey National Geographic Database.
+     */
+    postcodeDistrict?: StreetSource | undefined;
+    /**
+     * The dataset that supplied the street record: 'open' for Ordnance Survey open data, 'ngd' for the Ordnance Survey National Geographic Database.
+     */
+    streetType?: StreetSource | undefined;
+    /**
+     * The dataset that supplied the street record: 'open' for Ordnance Survey open data, 'ngd' for the Ordnance Survey National Geographic Database.
+     */
+    town?: StreetSource | undefined;
+};
+/** @internal */
+export declare const StreetProvenance$inboundSchema: z.ZodType<StreetProvenance, z.ZodTypeDef, unknown>;
+export declare function streetProvenanceFromJSON(jsonString: string): SafeParseResult<StreetProvenance, SDKValidationError>;
+//# sourceMappingURL=streetprovenance.d.ts.map

package/dist/commonjs/sdk/models/shared/streetprovenance.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"streetprovenance.d.ts","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/streetprovenance.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;AACrE,OAAO,EAAE,YAAY,EAA8B,MAAM,mBAAmB,CAAC;AAE7E;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B;;OAEG;IACH,MAAM,CAAC,EAAE,YAAY,GAAG,SAAS,CAAC;IAClC;;OAEG;IACH,QAAQ,CAAC,EAAE,YAAY,GAAG,SAAS,CAAC;IACpC;;OAEG;IACH,QAAQ,CAAC,EAAE,YAAY,GAAG,SAAS,CAAC;IACpC;;OAEG;IACH,QAAQ,CAAC,EAAE,YAAY,GAAG,SAAS,CAAC;IACpC;;OAEG;IACH,IAAI,CAAC,EAAE,YAAY,GAAG,SAAS,CAAC;IAChC;;OAEG;IACH,gBAAgB,CAAC,EAAE,YAAY,GAAG,SAAS,CAAC;IAC5C;;OAEG;IACH,UAAU,CAAC,EAAE,YAAY,GAAG,SAAS,CAAC;IACtC;;OAEG;IACH,IAAI,CAAC,EAAE,YAAY,GAAG,SAAS,CAAC;CACjC,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,8BAA8B,EAAE,CAAC,CAAC,OAAO,CACpD,gBAAgB,EAChB,CAAC,CAAC,UAAU,EACZ,OAAO,CAUP,CAAC;AAEH,wBAAgB,wBAAwB,CACtC,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,gBAAgB,EAAE,kBAAkB,CAAC,CAMvD"}

package/dist/commonjs/sdk/models/shared/streetprovenance.js

@@ -0,0 +1,58 @@
+"use strict";
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StreetProvenance$inboundSchema = void 0;
+exports.streetProvenanceFromJSON = streetProvenanceFromJSON;
+const z = __importStar(require("zod/v3"));
+const schemas_js_1 = require("../../../lib/schemas.js");
+const streetsource_js_1 = require("./streetsource.js");
+/** @internal */
+exports.StreetProvenance$inboundSchema = z.object({
+    county: streetsource_js_1.StreetSource$inboundSchema.optional(),
+    district: streetsource_js_1.StreetSource$inboundSchema.optional(),
+    locality: streetsource_js_1.StreetSource$inboundSchema.optional(),
+    location: streetsource_js_1.StreetSource$inboundSchema.optional(),
+    name: streetsource_js_1.StreetSource$inboundSchema.optional(),
+    postcodeDistrict: streetsource_js_1.StreetSource$inboundSchema.optional(),
+    streetType: streetsource_js_1.StreetSource$inboundSchema.optional(),
+    town: streetsource_js_1.StreetSource$inboundSchema.optional(),
+});
+function streetProvenanceFromJSON(jsonString) {
+    return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.StreetProvenance$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'StreetProvenance' from JSON`);
+}
+//# sourceMappingURL=streetprovenance.js.map

package/dist/commonjs/sdk/models/shared/streetprovenance.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"streetprovenance.js","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/streetprovenance.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA8DH,4DAQC;AApED,0CAA4B;AAC5B,wDAAoD;AAGpD,uDAA6E;AAwC7E,gBAAgB;AACH,QAAA,8BAA8B,GAIvC,CAAC,CAAC,MAAM,CAAC;IACX,MAAM,EAAE,4CAA0B,CAAC,QAAQ,EAAE;IAC7C,QAAQ,EAAE,4CAA0B,CAAC,QAAQ,EAAE;IAC/C,QAAQ,EAAE,4CAA0B,CAAC,QAAQ,EAAE;IAC/C,QAAQ,EAAE,4CAA0B,CAAC,QAAQ,EAAE;IAC/C,IAAI,EAAE,4CAA0B,CAAC,QAAQ,EAAE;IAC3C,gBAAgB,EAAE,4CAA0B,CAAC,QAAQ,EAAE;IACvD,UAAU,EAAE,4CAA0B,CAAC,QAAQ,EAAE;IACjD,IAAI,EAAE,4CAA0B,CAAC,QAAQ,EAAE;CAC5C,CAAC,CAAC;AAEH,SAAgB,wBAAwB,CACtC,UAAkB;IAElB,OAAO,IAAA,sBAAS,EACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,sCAA8B,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAC1D,8CAA8C,CAC/C,CAAC;AACJ,CAAC"}

package/dist/commonjs/sdk/models/shared/streetquerybycoordinates.d.ts

@@ -4,12 +4,16 @@ export type StreetQueryByCoordinates = {
      * Latitude in WGS84 decimal degrees.
      */
     lat: number;
+    /**
+     * Maximum number of streets to return on this page. Defaults to 10. Minimum 1, maximum 50.
+     */
+    limit?: number | undefined;
     /**
      * Longitude in WGS84 decimal degrees.
      */
     lng: number;
     /**
-     * How far from the point to search, in metres. Defaults to 50. Minimum 1, maximum 1000.
+     * How far from the point to search, in metres, measured to each street's centre in the dataset searched. Under `open_then_ngd` that is the open data unless the open data has no street in the radius, so a street the NGD supplies whole can have its `location` outside the radius. Defaults to 50. Minimum 1, maximum 1000.
      */
     radius?: number | undefined;
     type: "coordinates";
@@ -17,6 +21,7 @@ export type StreetQueryByCoordinates = {
 /** @internal */
 export type StreetQueryByCoordinates$Outbound = {
     lat: number;
+    limit: number;
     lng: number;
     radius: number;
     type: "coordinates";

package/dist/commonjs/sdk/models/shared/streetquerybycoordinates.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"streetquerybycoordinates.d.ts","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/streetquerybycoordinates.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAE5B,MAAM,MAAM,wBAAwB,GAAG;IACrC;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IACZ;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IACZ;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC5B,IAAI,EAAE,aAAa,CAAC;CACrB,CAAC;AAEF,gBAAgB;AAChB,MAAM,MAAM,iCAAiC,GAAG;IAC9C,GAAG,EAAE,MAAM,CAAC;IACZ,GAAG,EAAE,MAAM,CAAC;IACZ,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,aAAa,CAAC;CACrB,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,uCAAuC,EAAE,CAAC,CAAC,OAAO,CAC7D,iCAAiC,EACjC,CAAC,CAAC,UAAU,EACZ,wBAAwB,CAMxB,CAAC;AAEH,wBAAgB,8BAA8B,CAC5C,wBAAwB,EAAE,wBAAwB,GACjD,MAAM,CAIR"}
+{"version":3,"file":"streetquerybycoordinates.d.ts","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/streetquerybycoordinates.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAE5B,MAAM,MAAM,wBAAwB,GAAG;IACrC;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IACZ;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC3B;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IACZ;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC5B,IAAI,EAAE,aAAa,CAAC;CACrB,CAAC;AAEF,gBAAgB;AAChB,MAAM,MAAM,iCAAiC,GAAG;IAC9C,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,MAAM,CAAC;IACd,GAAG,EAAE,MAAM,CAAC;IACZ,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,aAAa,CAAC;CACrB,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,uCAAuC,EAAE,CAAC,CAAC,OAAO,CAC7D,iCAAiC,EACjC,CAAC,CAAC,UAAU,EACZ,wBAAwB,CAOxB,CAAC;AAEH,wBAAgB,8BAA8B,CAC5C,wBAAwB,EAAE,wBAAwB,GACjD,MAAM,CAIR"}

package/dist/commonjs/sdk/models/shared/streetquerybycoordinates.js

@@ -42,6 +42,7 @@ const z = __importStar(require("zod/v3"));
 /** @internal */
 exports.StreetQueryByCoordinates$outboundSchema = z.object({
     lat: z.number(),
+    limit: z.number().int().default(10),
     lng: z.number(),
     radius: z.number().default(50),
     type: z.literal("coordinates"),

package/dist/commonjs/sdk/models/shared/streetquerybycoordinates.js.map

@@ -1 +1 @@
-{"version":3,"file":"streetquerybycoordinates.js","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/streetquerybycoordinates.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAwCH,wEAMC;AA5CD,0CAA4B;AA0B5B,gBAAgB;AACH,QAAA,uCAAuC,GAIhD,CAAC,CAAC,MAAM,CAAC;IACX,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE;IACf,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE;IACf,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,OAAO,CAAC,EAAE,CAAC;IAC9B,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,aAAa,CAAC;CAC/B,CAAC,CAAC;AAEH,SAAgB,8BAA8B,CAC5C,wBAAkD;IAElD,OAAO,IAAI,CAAC,SAAS,CACnB,+CAAuC,CAAC,KAAK,CAAC,wBAAwB,CAAC,CACxE,CAAC;AACJ,CAAC"}
+{"version":3,"file":"streetquerybycoordinates.js","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/streetquerybycoordinates.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA8CH,wEAMC;AAlDD,0CAA4B;AA+B5B,gBAAgB;AACH,QAAA,uCAAuC,GAIhD,CAAC,CAAC,MAAM,CAAC;IACX,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE;IACf,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,EAAE,CAAC;IACnC,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE;IACf,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,OAAO,CAAC,EAAE,CAAC;IAC9B,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,aAAa,CAAC;CAC/B,CAAC,CAAC;AAEH,SAAgB,8BAA8B,CAC5C,wBAAkD;IAElD,OAAO,IAAI,CAAC,SAAS,CACnB,+CAAuC,CAAC,KAAK,CAAC,wBAAwB,CAAC,CACxE,CAAC;AACJ,CAAC"}

package/dist/commonjs/sdk/models/shared/streetquerybyname.d.ts

@@ -1,11 +1,11 @@
 import * as z from "zod/v3";
 export type StreetQueryByName = {
     /**
-     * Maximum number of streets to return. Defaults to 10. Minimum 1, maximum 50.
+     * Maximum number of streets to return on this page. Defaults to 10. Minimum 1, maximum 50.
      */
     limit?: number | undefined;
     /**
-     * Street name to search for. Matched anywhere in the name. Minimum 2 characters.
+     * Street name to search for, optionally followed by its locality or town. Case is not significant and small misspellings are tolerated; every word must match. Minimum 2 characters.
      */
     searchTerm: string;
     type: "name";

package/dist/commonjs/sdk/models/shared/streetquerybyname.js

@@ -41,7 +41,7 @@ exports.streetQueryByNameToJSON = streetQueryByNameToJSON;
 const z = __importStar(require("zod/v3"));
 /** @internal */
 exports.StreetQueryByName$outboundSchema = z.object({
-    limit: z.number().default(10),
+    limit: z.number().int().default(10),
     searchTerm: z.string(),
     type: z.literal("name"),
 });

package/dist/commonjs/sdk/models/shared/streetquerybyname.js.map

@@ -1 +1 @@
-{"version":3,"file":"streetquerybyname.js","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/streetquerybyname.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAkCH,0DAMC;AAtCD,0CAA4B;AAqB5B,gBAAgB;AACH,QAAA,gCAAgC,GAIzC,CAAC,CAAC,MAAM,CAAC;IACX,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,OAAO,CAAC,EAAE,CAAC;IAC7B,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE;IACtB,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC;CACxB,CAAC,CAAC;AAEH,SAAgB,uBAAuB,CACrC,iBAAoC;IAEpC,OAAO,IAAI,CAAC,SAAS,CACnB,wCAAgC,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAC1D,CAAC;AACJ,CAAC"}
+{"version":3,"file":"streetquerybyname.js","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/streetquerybyname.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAkCH,0DAMC;AAtCD,0CAA4B;AAqB5B,gBAAgB;AACH,QAAA,gCAAgC,GAIzC,CAAC,CAAC,MAAM,CAAC;IACX,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,EAAE,CAAC;IACnC,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE;IACtB,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC;CACxB,CAAC,CAAC;AAEH,SAAgB,uBAAuB,CACrC,iBAAoC;IAEpC,OAAO,IAAI,CAAC,SAAS,CACnB,wCAAgC,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAC1D,CAAC;AACJ,CAAC"}

package/dist/commonjs/sdk/models/shared/streetquerybypostcode.d.ts

@@ -1,5 +1,9 @@
 import * as z from "zod/v3";
 export type StreetQueryByPostcode = {
+    /**
+     * Maximum number of streets to return on this page. Defaults to 10. Minimum 1, maximum 50.
+     */
+    limit?: number | undefined;
     /**
      * A full UK postcode. The space is optional and case is not significant; the value is returned upper-cased.
      */
@@ -8,6 +12,7 @@ export type StreetQueryByPostcode = {
 };
 /** @internal */
 export type StreetQueryByPostcode$Outbound = {
+    limit: number;
     postcode: string;
     type: "postcode";
 };

package/dist/commonjs/sdk/models/shared/streetquerybypostcode.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"streetquerybypostcode.d.ts","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/streetquerybypostcode.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAE5B,MAAM,MAAM,qBAAqB,GAAG;IAClC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,UAAU,CAAC;CAClB,CAAC;AAEF,gBAAgB;AAChB,MAAM,MAAM,8BAA8B,GAAG;IAC3C,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,UAAU,CAAC;CAClB,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,oCAAoC,EAAE,CAAC,CAAC,OAAO,CAC1D,8BAA8B,EAC9B,CAAC,CAAC,UAAU,EACZ,qBAAqB,CAIrB,CAAC;AAEH,wBAAgB,2BAA2B,CACzC,qBAAqB,EAAE,qBAAqB,GAC3C,MAAM,CAIR"}
+{"version":3,"file":"streetquerybypostcode.d.ts","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/streetquerybypostcode.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAE5B,MAAM,MAAM,qBAAqB,GAAG;IAClC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC3B;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,UAAU,CAAC;CAClB,CAAC;AAEF,gBAAgB;AAChB,MAAM,MAAM,8BAA8B,GAAG;IAC3C,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,UAAU,CAAC;CAClB,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,oCAAoC,EAAE,CAAC,CAAC,OAAO,CAC1D,8BAA8B,EAC9B,CAAC,CAAC,UAAU,EACZ,qBAAqB,CAKrB,CAAC;AAEH,wBAAgB,2BAA2B,CACzC,qBAAqB,EAAE,qBAAqB,GAC3C,MAAM,CAIR"}

package/dist/commonjs/sdk/models/shared/streetquerybypostcode.js

@@ -41,6 +41,7 @@ exports.streetQueryByPostcodeToJSON = streetQueryByPostcodeToJSON;
 const z = __importStar(require("zod/v3"));
 /** @internal */
 exports.StreetQueryByPostcode$outboundSchema = z.object({
+    limit: z.number().int().default(10),
     postcode: z.string(),
     type: z.literal("postcode"),
 });

package/dist/commonjs/sdk/models/shared/streetquerybypostcode.js.map

@@ -1 +1 @@
-{"version":3,"file":"streetquerybypostcode.js","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/streetquerybypostcode.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA4BH,kEAMC;AAhCD,0CAA4B;AAgB5B,gBAAgB;AACH,QAAA,oCAAoC,GAI7C,CAAC,CAAC,MAAM,CAAC;IACX,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE;IACpB,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,UAAU,CAAC;CAC5B,CAAC,CAAC;AAEH,SAAgB,2BAA2B,CACzC,qBAA4C;IAE5C,OAAO,IAAI,CAAC,SAAS,CACnB,4CAAoC,CAAC,KAAK,CAAC,qBAAqB,CAAC,CAClE,CAAC;AACJ,CAAC"}
+{"version":3,"file":"streetquerybypostcode.js","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/streetquerybypostcode.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAkCH,kEAMC;AAtCD,0CAA4B;AAqB5B,gBAAgB;AACH,QAAA,oCAAoC,GAI7C,CAAC,CAAC,MAAM,CAAC;IACX,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,EAAE,CAAC;IACnC,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE;IACpB,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,UAAU,CAAC;CAC5B,CAAC,CAAC;AAEH,SAAgB,2BAA2B,CACzC,qBAA4C;IAE5C,OAAO,IAAI,CAAC,SAAS,CACnB,4CAAoC,CAAC,KAAK,CAAC,qBAAqB,CAAC,CAClE,CAAC;AACJ,CAAC"}

package/dist/commonjs/sdk/models/shared/streetqueryrequest.d.ts

@@ -1,4 +1,7 @@
 import * as z from "zod/v3";
+import { StreetDataset } from "./streetdataset.js";
+import { StreetField } from "./streetfield.js";
+import { StreetPropertyOptions, StreetPropertyOptions$Outbound } from "./streetpropertyoptions.js";
 import { StreetQueryByCoordinates, StreetQueryByCoordinates$Outbound } from "./streetquerybycoordinates.js";
 import { StreetQueryByName, StreetQueryByName$Outbound } from "./streetquerybyname.js";
 import { StreetQueryByPostcode, StreetQueryByPostcode$Outbound } from "./streetquerybypostcode.js";
@@ -8,40 +11,35 @@ import { StreetQueryByUsrn, StreetQueryByUsrn$Outbound } from "./streetquerybyus
  * Which streets to return, given as one of five identifier types. Set `type` to `usrn`, `uprn`, `coordinates`, `name` or `postcode` and supply that type's own fields.
  */
 export type Identifier = StreetQueryByCoordinates | StreetQueryByName | StreetQueryByPostcode | StreetQueryByUprn | StreetQueryByUsrn;
-/**
- * How to page and filter the property list, when `includeProperties` is set.
- */
-export type PropertyOptions = {
-    /**
-     * Include retired address records alongside the current ones. Defaults to false, which returns only approved and alternative addresses.
-     */
-    includeHistoric?: boolean | undefined;
+export type StreetQueryRequest = {
     /**
-     * Maximum number of properties to return. Defaults to 100. Minimum 1, maximum 500.
+     * Which street dataset to read. 'open' reads Ordnance Survey open data published under the Open Government Licence. 'ngd' reads the Ordnance Survey National Geographic Database (NGD). 'open_then_ngd' reads the open data first and turns to the NGD only when the open data has no record or no name for the street, or when a search finds nothing in it. Postcode lookups are answered from the NGD only, so they are rejected under 'open'. Defaults to 'open_then_ngd'.
      */
-    limit?: number | undefined;
+    dataset?: StreetDataset | undefined;
     /**
-     * Number of properties to skip before the first one returned. Defaults to 0.
+     * The street fields to return. When omitted, every field the answering dataset holds is returned. Under `open_then_ngd`, a field named here that the open data lacks for a street is taken from the NGD, and `provenance` then shows which dataset supplied each field. A name is always taken whole from one dataset.
      */
-    offset?: number | undefined;
-};
-export type StreetQueryRequest = {
+    fields?: Array<StreetField> | undefined;
     /**
      * Which streets to return, given as one of five identifier types. Set `type` to `usrn`, `uprn`, `coordinates`, `name` or `postcode` and supply that type's own fields.
      */
     identifier: StreetQueryByCoordinates | StreetQueryByName | StreetQueryByPostcode | StreetQueryByUprn | StreetQueryByUsrn;
     /**
-     * Ask for the addressable properties on each matched street. Defaults to false.
+     * Return the properties on each street under `properties`, as UPRNs. Defaults to false. Paged by `propertyOptions`.
      */
     includeProperties?: boolean | undefined;
     /**
-     * Ask for the property counts and classification breakdown for each matched street. Defaults to false.
+     * Return the number of properties on each street as `propertyCount`. Defaults to false.
      */
     includeStatistics?: boolean | undefined;
     /**
-     * How to page and filter the property list, when `includeProperties` is set.
+     * How to page and filter each street's property list. Accepted only when `includeProperties` is true.
+     */
+    propertyOptions?: StreetPropertyOptions | undefined;
+    /**
+     * Cursor for the next page: the `id` of the last street on the current page. Applies to name, coordinate and postcode lookups.
      */
-    propertyOptions?: PropertyOptions | undefined;
+    startingAfter?: string | undefined;
 };
 /** @internal */
 export type Identifier$Outbound = StreetQueryByCoordinates$Outbound | StreetQueryByName$Outbound | StreetQueryByPostcode$Outbound | StreetQueryByUprn$Outbound | StreetQueryByUsrn$Outbound;
@@ -49,20 +47,14 @@ export type Identifier$Outbound = StreetQueryByCoordinates$Outbound | StreetQuer
 export declare const Identifier$outboundSchema: z.ZodType<Identifier$Outbound, z.ZodTypeDef, Identifier>;
 export declare function identifierToJSON(identifier: Identifier): string;
 /** @internal */
-export type PropertyOptions$Outbound = {
-    includeHistoric: boolean;
-    limit: number;
-    offset: number;
-};
-/** @internal */
-export declare const PropertyOptions$outboundSchema: z.ZodType<PropertyOptions$Outbound, z.ZodTypeDef, PropertyOptions>;
-export declare function propertyOptionsToJSON(propertyOptions: PropertyOptions): string;
-/** @internal */
 export type StreetQueryRequest$Outbound = {
+    dataset: string;
+    fields?: Array<string> | undefined;
     identifier: StreetQueryByCoordinates$Outbound | StreetQueryByName$Outbound | StreetQueryByPostcode$Outbound | StreetQueryByUprn$Outbound | StreetQueryByUsrn$Outbound;
     includeProperties: boolean;
     includeStatistics: boolean;
-    propertyOptions?: PropertyOptions$Outbound | undefined;
+    propertyOptions?: StreetPropertyOptions$Outbound | undefined;
+    starting_after?: string | undefined;
 };
 /** @internal */
 export declare const StreetQueryRequest$outboundSchema: z.ZodType<StreetQueryRequest$Outbound, z.ZodTypeDef, StreetQueryRequest>;

package/dist/commonjs/sdk/models/shared/streetqueryrequest.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"streetqueryrequest.d.ts","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/streetqueryrequest.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAC5B,OAAO,EACL,wBAAwB,EACxB,iCAAiC,EAElC,MAAM,+BAA+B,CAAC;AACvC,OAAO,EACL,iBAAiB,EACjB,0BAA0B,EAE3B,MAAM,wBAAwB,CAAC;AAChC,OAAO,EACL,qBAAqB,EACrB,8BAA8B,EAE/B,MAAM,4BAA4B,CAAC;AACpC,OAAO,EACL,iBAAiB,EACjB,0BAA0B,EAE3B,MAAM,wBAAwB,CAAC;AAChC,OAAO,EACL,iBAAiB,EACjB,0BAA0B,EAE3B,MAAM,wBAAwB,CAAC;AAEhC;;GAEG;AACH,MAAM,MAAM,UAAU,GAClB,wBAAwB,GACxB,iBAAiB,GACjB,qBAAqB,GACrB,iBAAiB,GACjB,iBAAiB,CAAC;AAEtB;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B;;OAEG;IACH,eAAe,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IACtC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC3B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAC7B,CAAC;AAEF,MAAM,MAAM,kBAAkB,GAAG;IAC/B;;OAEG;IACH,UAAU,EACN,wBAAwB,GACxB,iBAAiB,GACjB,qBAAqB,GACrB,iBAAiB,GACjB,iBAAiB,CAAC;IACtB;;OAEG;IACH,iBAAiB,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IACxC;;OAEG;IACH,iBAAiB,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IACxC;;OAEG;IACH,eAAe,CAAC,EAAE,eAAe,GAAG,SAAS,CAAC;CAC/C,CAAC;AAEF,gBAAgB;AAChB,MAAM,MAAM,mBAAmB,GAC3B,iCAAiC,GACjC,0BAA0B,GAC1B,8BAA8B,GAC9B,0BAA0B,GAC1B,0BAA0B,CAAC;AAE/B,gBAAgB;AAChB,eAAO,MAAM,yBAAyB,EAAE,CAAC,CAAC,OAAO,CAC/C,mBAAmB,EACnB,CAAC,CAAC,UAAU,EACZ,UAAU,CAOV,CAAC;AAEH,wBAAgB,gBAAgB,CAAC,UAAU,EAAE,UAAU,GAAG,MAAM,CAE/D;AAED,gBAAgB;AAChB,MAAM,MAAM,wBAAwB,GAAG;IACrC,eAAe,EAAE,OAAO,CAAC;IACzB,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,8BAA8B,EAAE,CAAC,CAAC,OAAO,CACpD,wBAAwB,EACxB,CAAC,CAAC,UAAU,EACZ,eAAe,CAKf,CAAC;AAEH,wBAAgB,qBAAqB,CACnC,eAAe,EAAE,eAAe,GAC/B,MAAM,CAER;AAED,gBAAgB;AAChB,MAAM,MAAM,2BAA2B,GAAG;IACxC,UAAU,EACN,iCAAiC,GACjC,0BAA0B,GAC1B,8BAA8B,GAC9B,0BAA0B,GAC1B,0BAA0B,CAAC;IAC/B,iBAAiB,EAAE,OAAO,CAAC;IAC3B,iBAAiB,EAAE,OAAO,CAAC;IAC3B,eAAe,CAAC,EAAE,wBAAwB,GAAG,SAAS,CAAC;CACxD,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,iCAAiC,EAAE,CAAC,CAAC,OAAO,CACvD,2BAA2B,EAC3B,CAAC,CAAC,UAAU,EACZ,kBAAkB,CAYlB,CAAC;AAEH,wBAAgB,wBAAwB,CACtC,kBAAkB,EAAE,kBAAkB,GACrC,MAAM,CAIR"}
+{"version":3,"file":"streetqueryrequest.d.ts","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/streetqueryrequest.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAE5B,OAAO,EACL,aAAa,EAEd,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,WAAW,EAA8B,MAAM,kBAAkB,CAAC;AAC3E,OAAO,EACL,qBAAqB,EACrB,8BAA8B,EAE/B,MAAM,4BAA4B,CAAC;AACpC,OAAO,EACL,wBAAwB,EACxB,iCAAiC,EAElC,MAAM,+BAA+B,CAAC;AACvC,OAAO,EACL,iBAAiB,EACjB,0BAA0B,EAE3B,MAAM,wBAAwB,CAAC;AAChC,OAAO,EACL,qBAAqB,EACrB,8BAA8B,EAE/B,MAAM,4BAA4B,CAAC;AACpC,OAAO,EACL,iBAAiB,EACjB,0BAA0B,EAE3B,MAAM,wBAAwB,CAAC;AAChC,OAAO,EACL,iBAAiB,EACjB,0BAA0B,EAE3B,MAAM,wBAAwB,CAAC;AAEhC;;GAEG;AACH,MAAM,MAAM,UAAU,GAClB,wBAAwB,GACxB,iBAAiB,GACjB,qBAAqB,GACrB,iBAAiB,GACjB,iBAAiB,CAAC;AAEtB,MAAM,MAAM,kBAAkB,GAAG;IAC/B;;OAEG;IACH,OAAO,CAAC,EAAE,aAAa,GAAG,SAAS,CAAC;IACpC;;OAEG;IACH,MAAM,CAAC,EAAE,KAAK,CAAC,WAAW,CAAC,GAAG,SAAS,CAAC;IACxC;;OAEG;IACH,UAAU,EACN,wBAAwB,GACxB,iBAAiB,GACjB,qBAAqB,GACrB,iBAAiB,GACjB,iBAAiB,CAAC;IACtB;;OAEG;IACH,iBAAiB,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IACxC;;OAEG;IACH,iBAAiB,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IACxC;;OAEG;IACH,eAAe,CAAC,EAAE,qBAAqB,GAAG,SAAS,CAAC;IACpD;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CACpC,CAAC;AAEF,gBAAgB;AAChB,MAAM,MAAM,mBAAmB,GAC3B,iCAAiC,GACjC,0BAA0B,GAC1B,8BAA8B,GAC9B,0BAA0B,GAC1B,0BAA0B,CAAC;AAE/B,gBAAgB;AAChB,eAAO,MAAM,yBAAyB,EAAE,CAAC,CAAC,OAAO,CAC/C,mBAAmB,EACnB,CAAC,CAAC,UAAU,EACZ,UAAU,CAOV,CAAC;AAEH,wBAAgB,gBAAgB,CAAC,UAAU,EAAE,UAAU,GAAG,MAAM,CAE/D;AAED,gBAAgB;AAChB,MAAM,MAAM,2BAA2B,GAAG;IACxC,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,SAAS,CAAC;IACnC,UAAU,EACN,iCAAiC,GACjC,0BAA0B,GAC1B,8BAA8B,GAC9B,0BAA0B,GAC1B,0BAA0B,CAAC;IAC/B,iBAAiB,EAAE,OAAO,CAAC;IAC3B,iBAAiB,EAAE,OAAO,CAAC;IAC3B,eAAe,CAAC,EAAE,8BAA8B,GAAG,SAAS,CAAC;IAC7D,cAAc,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CACrC,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,iCAAiC,EAAE,CAAC,CAAC,OAAO,CACvD,2BAA2B,EAC3B,CAAC,CAAC,UAAU,EACZ,kBAAkB,CAmBlB,CAAC;AAEH,wBAAgB,wBAAwB,CACtC,kBAAkB,EAAE,kBAAkB,GACrC,MAAM,CAIR"}

package/dist/commonjs/sdk/models/shared/streetqueryrequest.js

@@ -36,11 +36,14 @@ var __importStar = (this && this.__importStar) || (function () {
     };
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.StreetQueryRequest$outboundSchema = exports.PropertyOptions$outboundSchema = exports.Identifier$outboundSchema = void 0;
+exports.StreetQueryRequest$outboundSchema = exports.Identifier$outboundSchema = void 0;
 exports.identifierToJSON = identifierToJSON;
-exports.propertyOptionsToJSON = propertyOptionsToJSON;
 exports.streetQueryRequestToJSON = streetQueryRequestToJSON;
 const z = __importStar(require("zod/v3"));
+const primitives_js_1 = require("../../../lib/primitives.js");
+const streetdataset_js_1 = require("./streetdataset.js");
+const streetfield_js_1 = require("./streetfield.js");
+const streetpropertyoptions_js_1 = require("./streetpropertyoptions.js");
 const streetquerybycoordinates_js_1 = require("./streetquerybycoordinates.js");
 const streetquerybyname_js_1 = require("./streetquerybyname.js");
 const streetquerybypostcode_js_1 = require("./streetquerybypostcode.js");
@@ -58,16 +61,9 @@ function identifierToJSON(identifier) {
     return JSON.stringify(exports.Identifier$outboundSchema.parse(identifier));
 }
 /** @internal */
-exports.PropertyOptions$outboundSchema = z.object({
-    includeHistoric: z.boolean().default(false),
-    limit: z.number().default(100),
-    offset: z.number().default(0),
-});
-function propertyOptionsToJSON(propertyOptions) {
-    return JSON.stringify(exports.PropertyOptions$outboundSchema.parse(propertyOptions));
-}
-/** @internal */
 exports.StreetQueryRequest$outboundSchema = z.object({
+    dataset: streetdataset_js_1.StreetDataset$outboundSchema.default("open_then_ngd"),
+    fields: z.array(streetfield_js_1.StreetField$outboundSchema).optional(),
     identifier: z.union([
         streetquerybycoordinates_js_1.StreetQueryByCoordinates$outboundSchema,
         streetquerybyname_js_1.StreetQueryByName$outboundSchema,
@@ -77,7 +73,12 @@ exports.StreetQueryRequest$outboundSchema = z.object({
     ]),
     includeProperties: z.boolean().default(false),
     includeStatistics: z.boolean().default(false),
-    propertyOptions: z.lazy(() => exports.PropertyOptions$outboundSchema).optional(),
+    propertyOptions: streetpropertyoptions_js_1.StreetPropertyOptions$outboundSchema.optional(),
+    startingAfter: z.string().optional(),
+}).transform((v) => {
+    return (0, primitives_js_1.remap)(v, {
+        startingAfter: "starting_after",
+    });
 });
 function streetQueryRequestToJSON(streetQueryRequest) {
     return JSON.stringify(exports.StreetQueryRequest$outboundSchema.parse(streetQueryRequest));

package/dist/commonjs/sdk/models/shared/streetqueryrequest.js.map

@@ -1 +1 @@
-{"version":3,"file":"streetqueryrequest.js","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/streetqueryrequest.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAsGH,4CAEC;AAoBD,sDAIC;AAiCD,4DAMC;AArKD,0CAA4B;AAC5B,+EAIuC;AACvC,iEAIgC;AAChC,yEAIoC;AACpC,iEAIgC;AAChC,iEAIgC;AA8DhC,gBAAgB;AACH,QAAA,yBAAyB,GAIlC,CAAC,CAAC,KAAK,CAAC;IACV,qEAAuC;IACvC,uDAAgC;IAChC,+DAAoC;IACpC,uDAAgC;IAChC,uDAAgC;CACjC,CAAC,CAAC;AAEH,SAAgB,gBAAgB,CAAC,UAAsB;IACrD,OAAO,IAAI,CAAC,SAAS,CAAC,iCAAyB,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC;AACrE,CAAC;AASD,gBAAgB;AACH,QAAA,8BAA8B,GAIvC,CAAC,CAAC,MAAM,CAAC;IACX,eAAe,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC;IAC3C,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC;IAC9B,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC;CAC9B,CAAC,CAAC;AAEH,SAAgB,qBAAqB,CACnC,eAAgC;IAEhC,OAAO,IAAI,CAAC,SAAS,CAAC,sCAA8B,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC,CAAC;AAC/E,CAAC;AAeD,gBAAgB;AACH,QAAA,iCAAiC,GAI1C,CAAC,CAAC,MAAM,CAAC;IACX,UAAU,EAAE,CAAC,CAAC,KAAK,CAAC;QAClB,qEAAuC;QACvC,uDAAgC;QAChC,+DAAoC;QACpC,uDAAgC;QAChC,uDAAgC;KACjC,CAAC;IACF,iBAAiB,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC;IAC7C,iBAAiB,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC;IAC7C,eAAe,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,sCAA8B,CAAC,CAAC,QAAQ,EAAE;CACzE,CAAC,CAAC;AAEH,SAAgB,wBAAwB,CACtC,kBAAsC;IAEtC,OAAO,IAAI,CAAC,SAAS,CACnB,yCAAiC,CAAC,KAAK,CAAC,kBAAkB,CAAC,CAC5D,CAAC;AACJ,CAAC"}
+{"version":3,"file":"streetqueryrequest.js","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/streetqueryrequest.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA2GH,4CAEC;AA2CD,4DAMC;AA5JD,0CAA4B;AAC5B,8DAA6D;AAC7D,yDAG4B;AAC5B,qDAA2E;AAC3E,yEAIoC;AACpC,+EAIuC;AACvC,iEAIgC;AAChC,yEAIoC;AACpC,iEAIgC;AAChC,iEAIgC;AAwDhC,gBAAgB;AACH,QAAA,yBAAyB,GAIlC,CAAC,CAAC,KAAK,CAAC;IACV,qEAAuC;IACvC,uDAAgC;IAChC,+DAAoC;IACpC,uDAAgC;IAChC,uDAAgC;CACjC,CAAC,CAAC;AAEH,SAAgB,gBAAgB,CAAC,UAAsB;IACrD,OAAO,IAAI,CAAC,SAAS,CAAC,iCAAyB,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC;AACrE,CAAC;AAkBD,gBAAgB;AACH,QAAA,iCAAiC,GAI1C,CAAC,CAAC,MAAM,CAAC;IACX,OAAO,EAAE,+CAA4B,CAAC,OAAO,CAAC,eAAe,CAAC;IAC9D,MAAM,EAAE,CAAC,CAAC,KAAK,CAAC,2CAA0B,CAAC,CAAC,QAAQ,EAAE;IACtD,UAAU,EAAE,CAAC,CAAC,KAAK,CAAC;QAClB,qEAAuC;QACvC,uDAAgC;QAChC,+DAAoC;QACpC,uDAAgC;QAChC,uDAAgC;KACjC,CAAC;IACF,iBAAiB,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC;IAC7C,iBAAiB,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC;IAC7C,eAAe,EAAE,+DAAoC,CAAC,QAAQ,EAAE;IAChE,aAAa,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CACrC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE;IACjB,OAAO,IAAA,qBAAM,EAAC,CAAC,EAAE;QACf,aAAa,EAAE,gBAAgB;KAChC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,SAAgB,wBAAwB,CACtC,kBAAsC;IAEtC,OAAO,IAAI,CAAC,SAAS,CACnB,yCAAiC,CAAC,KAAK,CAAC,kBAAkB,CAAC,CAC5D,CAAC;AACJ,CAAC"}

package/dist/commonjs/sdk/models/shared/streetqueryresponse.d.ts

@@ -2,9 +2,7 @@ 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 { PropertyOnStreet } from "./propertyonstreet.js";
-import { StreetDetails } from "./streetdetails.js";
-import { StreetStatistics } from "./streetstatistics.js";
+import { StreetRecord } from "./streetrecord.js";
 /**
  * Object type discriminator. Always `list`.
  */
@@ -16,10 +14,14 @@ export declare const StreetQueryResponseObject: {
  */
 export type StreetQueryResponseObject = ClosedEnum<typeof StreetQueryResponseObject>;
 export type StreetQueryResponse = {
+    /**
+     * The attribution that must be shown wherever the open-data street fields in this response are displayed. Present when at least one returned street carries open data.
+     */
+    attribution?: string | undefined;
     /**
      * The items on this page.
      */
-    data: Array<StreetDetails>;
+    data: Array<StreetRecord>;
     /**
      * True when further items exist beyond this page.
      */
@@ -32,16 +34,6 @@ export type StreetQueryResponse = {
      * Object type discriminator. Always `list`.
      */
     object: StreetQueryResponseObject;
-    /**
-     * The addressable properties on the matched streets. Not present in every response.
-     */
-    properties?: Array<PropertyOnStreet> | undefined;
-    /**
-     * Property counts for each matched street, keyed by USRN. Not present in every response.
-     */
-    statistics?: {
-        [k: string]: StreetStatistics;
-    } | undefined;
     /**
      * Total number of items matching the request across all pages.
      */

package/dist/commonjs/sdk/models/shared/streetqueryresponse.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"streetqueryresponse.d.ts","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/streetqueryresponse.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,gBAAgB,EAEjB,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAAE,aAAa,EAA+B,MAAM,oBAAoB,CAAC;AAChF,OAAO,EACL,gBAAgB,EAEjB,MAAM,uBAAuB,CAAC;AAE/B;;GAEG;AACH,eAAO,MAAM,yBAAyB;;CAE5B,CAAC;AACX;;GAEG;AACH,MAAM,MAAM,yBAAyB,GAAG,UAAU,CAChD,OAAO,yBAAyB,CACjC,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG;IAChC;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,aAAa,CAAC,CAAC;IAC3B;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IACjB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC7B;;OAEG;IACH,MAAM,EAAE,yBAAyB,CAAC;IAClC;;OAEG;IACH,UAAU,CAAC,EAAE,KAAK,CAAC,gBAAgB,CAAC,GAAG,SAAS,CAAC;IACjD;;OAEG;IACH,UAAU,CAAC,EAAE;QAAE,CAAC,CAAC,EAAE,MAAM,GAAG,gBAAgB,CAAA;KAAE,GAAG,SAAS,CAAC;IAC3D;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAChC;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;CACb,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,uCAAuC,EAAE,CAAC,CAAC,aAAa,CACnE,OAAO,yBAAyB,CACS,CAAC;AAE5C,gBAAgB;AAChB,eAAO,MAAM,iCAAiC,EAAE,CAAC,CAAC,OAAO,CACvD,mBAAmB,EACnB,CAAC,CAAC,UAAU,EACZ,OAAO,CAeP,CAAC;AAEH,wBAAgB,2BAA2B,CACzC,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,mBAAmB,EAAE,kBAAkB,CAAC,CAM1D"}
+{"version":3,"file":"streetqueryresponse.d.ts","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/streetqueryresponse.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,EAAE,YAAY,EAA8B,MAAM,mBAAmB,CAAC;AAE7E;;GAEG;AACH,eAAO,MAAM,yBAAyB;;CAE5B,CAAC;AACX;;GAEG;AACH,MAAM,MAAM,yBAAyB,GAAG,UAAU,CAChD,OAAO,yBAAyB,CACjC,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG;IAChC;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACjC;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,YAAY,CAAC,CAAC;IAC1B;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IACjB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC7B;;OAEG;IACH,MAAM,EAAE,yBAAyB,CAAC;IAClC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAChC;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;CACb,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,uCAAuC,EAAE,CAAC,CAAC,aAAa,CACnE,OAAO,yBAAyB,CACS,CAAC;AAE5C,gBAAgB;AAChB,eAAO,MAAM,iCAAiC,EAAE,CAAC,CAAC,OAAO,CACvD,mBAAmB,EACnB,CAAC,CAAC,UAAU,EACZ,OAAO,CAcP,CAAC;AAEH,wBAAgB,2BAA2B,CACzC,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,mBAAmB,EAAE,kBAAkB,CAAC,CAM1D"}