@vepler/sdk 6.1.0 → 6.36.0

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

@@ -0,0 +1,24 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../../types/enums.js";
+
+/**
+ * Which street dataset street-level matches are read from, when `granularity` is 'street' or 'auto'. '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 matches no street. Defaults to 'open_then_ngd'. Rejected when `granularity` is 'address'.
+ */
+export const StreetDataset = {
+  Open: "open",
+  Ngd: "ngd",
+  OpenThenNgd: "open_then_ngd",
+} as const;
+/**
+ * Which street dataset street-level matches are read from, when `granularity` is 'street' or 'auto'. '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 matches no street. Defaults to 'open_then_ngd'. Rejected when `granularity` is 'address'.
+ */
+export type StreetDataset = ClosedEnum<typeof StreetDataset>;
+
+/** @internal */
+export const StreetDataset$outboundSchema: z.ZodNativeEnum<
+  typeof StreetDataset
+> = z.nativeEnum(StreetDataset);

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

@@ -13,9 +13,9 @@ export type StreetDescriptor = {
    */
   administrativeArea?: string | undefined;
   /**
-   * Language this naming is in, as a three-letter code: `ENG` for English, `CYM` for Welsh.
+   * Language this naming is in, as a three-letter code: `ENG` for English, `CYM` for Welsh, `GLA` for Scottish Gaelic. Absent when the dataset does not record the language of the name.
    */
-  language: string;
+  language?: string | undefined;
   /**
    * Locality the street sits in.
    */
@@ -37,7 +37,7 @@ export const StreetDescriptor$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   administrativeArea: z.string().optional(),
-  language: z.string().default("ENG"),
+  language: z.string().optional(),
   locality: z.string().optional(),
   streetDescription: z.string(),
   townName: z.string().optional(),

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

@@ -0,0 +1,22 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../../types/enums.js";
+
+export const StreetField = {
+  Name: "name",
+  Locality: "locality",
+  Town: "town",
+  District: "district",
+  County: "county",
+  PostcodeDistrict: "postcodeDistrict",
+  StreetType: "streetType",
+  Location: "location",
+} as const;
+export type StreetField = ClosedEnum<typeof StreetField>;
+
+/** @internal */
+export const StreetField$outboundSchema: z.ZodNativeEnum<typeof StreetField> = z
+  .nativeEnum(StreetField);

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

@@ -10,9 +10,10 @@ import {
   GeocodePrecision,
   GeocodePrecision$inboundSchema,
 } from "./geocodeprecision.js";
+import { StreetSource, StreetSource$inboundSchema } from "./streetsource.js";
 
 /**
- * Rectangle covering the street's recorded extent.
+ * Rectangle covering the street from its recorded start to its recorded end. Present when the dataset that supplied the street records its start and end, which the NGD does and the open data does not.
  */
 export type BoundingBox = {
   /**
@@ -34,7 +35,7 @@ export type BoundingBox = {
 };
 
 /**
- * Representative point for the street, midway between its recorded start and end.
+ * Representative point for the street, at its centre.
  */
 export type StreetMatchCoordinates = {
   /**
@@ -56,7 +57,7 @@ export type StreetMatch = {
    */
   administrativeArea?: string | undefined;
   /**
-   * Rectangle covering the street's recorded extent.
+   * Rectangle covering the street from its recorded start to its recorded end. Present when the dataset that supplied the street records its start and end, which the NGD does and the open data does not.
    */
   boundingBox?: BoundingBox | undefined;
   /**
@@ -67,6 +68,10 @@ export type StreetMatch = {
    * Territory the street sits in, as an ISO 3166-1 alpha-2 code.
    */
   country: string;
+  /**
+   * The dataset that supplied the street record: 'open' for Ordnance Survey open data, 'ngd' for the Ordnance Survey National Geographic Database.
+   */
+  dataset: StreetSource;
   /**
    * Distance from the query point, in metres, to the nearest metre. Present when a point was supplied.
    */
@@ -84,7 +89,7 @@ export type StreetMatch = {
    */
   locality?: string | undefined;
   /**
-   * Representative point for the street, midway between its recorded start and end.
+   * Representative point for the street, at its centre.
    */
   location: StreetMatchCoordinates;
   /**
@@ -158,6 +163,7 @@ export const StreetMatch$inboundSchema: z.ZodType<
   boundingBox: z.lazy(() => BoundingBox$inboundSchema).optional(),
   confidence: z.number(),
   country: z.string(),
+  dataset: StreetSource$inboundSchema,
   distance: z.number().optional(),
   granularity: z.literal("street"),
   id: z.string(),

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

@@ -0,0 +1,27 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import * as openEnums from "../../types/enums.js";
+import { OpenEnum } from "../../types/enums.js";
+
+/**
+ * How settled the open-data name is. 'confident' is a single name. 'ambiguous' means more than one open-data name competes for the street and `name` is one of them. 'absent' means the open data holds no name, so `name` is null.
+ */
+export const StreetNameConfidence = {
+  Confident: "confident",
+  Ambiguous: "ambiguous",
+  Absent: "absent",
+} as const;
+/**
+ * How settled the open-data name is. 'confident' is a single name. 'ambiguous' means more than one open-data name competes for the street and `name` is one of them. 'absent' means the open data holds no name, so `name` is null.
+ */
+export type StreetNameConfidence = OpenEnum<typeof StreetNameConfidence>;
+
+/** @internal */
+export const StreetNameConfidence$inboundSchema: z.ZodType<
+  StreetNameConfidence,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(StreetNameConfidence);

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

@@ -0,0 +1,26 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import * as openEnums from "../../types/enums.js";
+import { OpenEnum } from "../../types/enums.js";
+
+/**
+ * What `name` holds. 'name' is a street name. 'descriptor' is a description the naming authority records in place of a name, such as a road number or 'Access to ...', and is not a name the street is known by.
+ */
+export const StreetNameKind = {
+  Name: "name",
+  Descriptor: "descriptor",
+} as const;
+/**
+ * What `name` holds. 'name' is a street name. 'descriptor' is a description the naming authority records in place of a name, such as a road number or 'Access to ...', and is not a name the street is known by.
+ */
+export type StreetNameKind = OpenEnum<typeof StreetNameKind>;
+
+/** @internal */
+export const StreetNameKind$inboundSchema: z.ZodType<
+  StreetNameKind,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(StreetNameKind);

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

@@ -0,0 +1,42 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+/**
+ * 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 const StreetProperties$inboundSchema: z.ZodType<
+  StreetProperties,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  hasMore: z.boolean(),
+  uprns: z.array(z.number()),
+});
+
+export function streetPropertiesFromJSON(
+  jsonString: string,
+): SafeParseResult<StreetProperties, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => StreetProperties$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'StreetProperties' from JSON`,
+  );
+}

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

@@ -0,0 +1,49 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+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 const StreetPropertyOptions$outboundSchema: z.ZodType<
+  StreetPropertyOptions$Outbound,
+  z.ZodTypeDef,
+  StreetPropertyOptions
+> = z.object({
+  includeHistoric: z.boolean().default(false),
+  limit: z.number().int().default(100),
+  offset: z.number().int().default(0),
+});
+
+export function streetPropertyOptionsToJSON(
+  streetPropertyOptions: StreetPropertyOptions,
+): string {
+  return JSON.stringify(
+    StreetPropertyOptions$outboundSchema.parse(streetPropertyOptions),
+  );
+}

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

@@ -0,0 +1,73 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import { StreetSource, StreetSource$inboundSchema } 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 const StreetProvenance$inboundSchema: z.ZodType<
+  StreetProvenance,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  county: StreetSource$inboundSchema.optional(),
+  district: StreetSource$inboundSchema.optional(),
+  locality: StreetSource$inboundSchema.optional(),
+  location: StreetSource$inboundSchema.optional(),
+  name: StreetSource$inboundSchema.optional(),
+  postcodeDistrict: StreetSource$inboundSchema.optional(),
+  streetType: StreetSource$inboundSchema.optional(),
+  town: StreetSource$inboundSchema.optional(),
+});
+
+export function streetProvenanceFromJSON(
+  jsonString: string,
+): SafeParseResult<StreetProvenance, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => StreetProvenance$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'StreetProvenance' from JSON`,
+  );
+}

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

@@ -9,12 +9,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";
@@ -23,6 +27,7 @@ export type StreetQueryByCoordinates = {
 /** @internal */
 export type StreetQueryByCoordinates$Outbound = {
   lat: number;
+  limit: number;
   lng: number;
   radius: number;
   type: "coordinates";
@@ -35,6 +40,7 @@ export const StreetQueryByCoordinates$outboundSchema: z.ZodType<
   StreetQueryByCoordinates
 > = z.object({
   lat: z.number(),
+  limit: z.number().int().default(10),
   lng: z.number(),
   radius: z.number().default(50),
   type: z.literal("coordinates"),

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

@@ -6,11 +6,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";
@@ -29,7 +29,7 @@ export const StreetQueryByName$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   StreetQueryByName
 > = z.object({
-  limit: z.number().default(10),
+  limit: z.number().int().default(10),
   searchTerm: z.string(),
   type: z.literal("name"),
 });

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

@@ -5,6 +5,10 @@
 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.
    */
@@ -14,6 +18,7 @@ export type StreetQueryByPostcode = {
 
 /** @internal */
 export type StreetQueryByPostcode$Outbound = {
+  limit: number;
   postcode: string;
   type: "postcode";
 };
@@ -24,6 +29,7 @@ export const StreetQueryByPostcode$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   StreetQueryByPostcode
 > = z.object({
+  limit: z.number().int().default(10),
   postcode: z.string(),
   type: z.literal("postcode"),
 });

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

@@ -3,6 +3,17 @@
  */
 
 import * as z from "zod/v3";
+import { remap as remap$ } from "../../../lib/primitives.js";
+import {
+  StreetDataset,
+  StreetDataset$outboundSchema,
+} from "./streetdataset.js";
+import { StreetField, StreetField$outboundSchema } from "./streetfield.js";
+import {
+  StreetPropertyOptions,
+  StreetPropertyOptions$Outbound,
+  StreetPropertyOptions$outboundSchema,
+} from "./streetpropertyoptions.js";
 import {
   StreetQueryByCoordinates,
   StreetQueryByCoordinates$Outbound,
@@ -39,25 +50,15 @@ export type Identifier =
   | 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.
    */
@@ -68,17 +69,21 @@ export type StreetQueryRequest = {
     | 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 */
@@ -106,32 +111,10 @@ export function identifierToJSON(identifier: Identifier): string {
   return JSON.stringify(Identifier$outboundSchema.parse(identifier));
 }
 
-/** @internal */
-export type PropertyOptions$Outbound = {
-  includeHistoric: boolean;
-  limit: number;
-  offset: number;
-};
-
-/** @internal */
-export const PropertyOptions$outboundSchema: z.ZodType<
-  PropertyOptions$Outbound,
-  z.ZodTypeDef,
-  PropertyOptions
-> = z.object({
-  includeHistoric: z.boolean().default(false),
-  limit: z.number().default(100),
-  offset: z.number().default(0),
-});
-
-export function propertyOptionsToJSON(
-  propertyOptions: PropertyOptions,
-): string {
-  return JSON.stringify(PropertyOptions$outboundSchema.parse(propertyOptions));
-}
-
 /** @internal */
 export type StreetQueryRequest$Outbound = {
+  dataset: string;
+  fields?: Array<string> | undefined;
   identifier:
     | StreetQueryByCoordinates$Outbound
     | StreetQueryByName$Outbound
@@ -140,7 +123,8 @@ export type StreetQueryRequest$Outbound = {
     | StreetQueryByUsrn$Outbound;
   includeProperties: boolean;
   includeStatistics: boolean;
-  propertyOptions?: PropertyOptions$Outbound | undefined;
+  propertyOptions?: StreetPropertyOptions$Outbound | undefined;
+  starting_after?: string | undefined;
 };
 
 /** @internal */
@@ -149,6 +133,8 @@ export const StreetQueryRequest$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   StreetQueryRequest
 > = z.object({
+  dataset: StreetDataset$outboundSchema.default("open_then_ngd"),
+  fields: z.array(StreetField$outboundSchema).optional(),
   identifier: z.union([
     StreetQueryByCoordinates$outboundSchema,
     StreetQueryByName$outboundSchema,
@@ -158,7 +144,12 @@ export const StreetQueryRequest$outboundSchema: z.ZodType<
   ]),
   includeProperties: z.boolean().default(false),
   includeStatistics: z.boolean().default(false),
-  propertyOptions: z.lazy(() => PropertyOptions$outboundSchema).optional(),
+  propertyOptions: StreetPropertyOptions$outboundSchema.optional(),
+  startingAfter: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    startingAfter: "starting_after",
+  });
 });
 
 export function streetQueryRequestToJSON(

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

@@ -8,15 +8,7 @@ import { safeParse } from "../../../lib/schemas.js";
 import { ClosedEnum } from "../../types/enums.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
-import {
-  PropertyOnStreet,
-  PropertyOnStreet$inboundSchema,
-} from "./propertyonstreet.js";
-import { StreetDetails, StreetDetails$inboundSchema } from "./streetdetails.js";
-import {
-  StreetStatistics,
-  StreetStatistics$inboundSchema,
-} from "./streetstatistics.js";
+import { StreetRecord, StreetRecord$inboundSchema } from "./streetrecord.js";
 
 /**
  * Object type discriminator. Always `list`.
@@ -32,10 +24,14 @@ export type StreetQueryResponseObject = ClosedEnum<
 >;
 
 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.
    */
@@ -48,14 +44,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.
    */
@@ -77,12 +65,11 @@ export const StreetQueryResponse$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  data: z.array(StreetDetails$inboundSchema),
+  attribution: z.string().optional(),
+  data: z.array(StreetRecord$inboundSchema),
   has_more: z.boolean(),
   message: z.string().optional(),
   object: StreetQueryResponseObject$inboundSchema,
-  properties: z.array(PropertyOnStreet$inboundSchema).optional(),
-  statistics: z.record(StreetStatistics$inboundSchema).optional(),
   total_count: z.number().optional(),
   url: z.string(),
 }).transform((v) => {