@vepler/sdk 2.9.0 → 2.12.0

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

@@ -16,10 +16,6 @@ export type PropertyTags = {
    * Is this property being sold at auction
    */
   auction?: boolean | undefined;
-  /**
-   * Below Market Value property
-   */
-  bmv?: boolean | undefined;
   /**
    * Cash buyers only
    */
@@ -32,6 +28,10 @@ export type PropertyTags = {
    * House in Multiple Occupation
    */
   hmo?: boolean | undefined;
+  /**
+   * Holiday let or short-term rental property
+   */
+  holidayLet?: boolean | undefined;
   /**
    * Property in negative equity
    */
@@ -56,6 +56,10 @@ export type PropertyTags = {
    * Property is slow to sell
    */
   slowToSell?: boolean | undefined;
+  /**
+   * Student accommodation or halls of residence
+   */
+  studentAccommodation?: boolean | undefined;
   /**
    * Property is unmodernised
    */
@@ -70,16 +74,17 @@ export const PropertyTags$inboundSchema: z.ZodType<
 > = z.object({
   agriculturalTie: z.boolean().optional(),
   auction: z.boolean().optional(),
-  bmv: z.boolean().optional(),
   cashBuyers: z.boolean().optional(),
   chainFree: z.boolean().optional(),
   hmo: z.boolean().optional(),
+  holidayLet: z.boolean().optional(),
   negativeEquity: z.boolean().optional(),
   newBuildScheme: z.boolean().optional(),
   quickSale: z.boolean().optional(),
   retirement: z.boolean().optional(),
   sharedOwnership: z.boolean().optional(),
   slowToSell: z.boolean().optional(),
+  studentAccommodation: z.boolean().optional(),
   unmodernised: z.boolean().optional(),
 });
 

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

@@ -55,7 +55,7 @@ export type Sources = ClosedEnum<typeof Sources>;
 /**
  * Search metadata
  */
-export type SearchResponseMetadata = {
+export type Metadata = {
   /**
    * Query processing time (e.g., '45ms')
    */
@@ -83,7 +83,7 @@ export type SearchResponse = {
   /**
    * Search metadata
    */
-  metadata?: SearchResponseMetadata | undefined;
+  metadata?: Metadata | undefined;
   /**
    * Offset for next page of results
    */
@@ -115,8 +115,8 @@ export const Sources$inboundSchema: z.ZodNativeEnum<typeof Sources> = z
   .nativeEnum(Sources);
 
 /** @internal */
-export const SearchResponseMetadata$inboundSchema: z.ZodType<
-  SearchResponseMetadata,
+export const Metadata$inboundSchema: z.ZodType<
+  Metadata,
   z.ZodTypeDef,
   unknown
 > = z.object({
@@ -125,13 +125,13 @@ export const SearchResponseMetadata$inboundSchema: z.ZodType<
   sources: z.array(Sources$inboundSchema).optional(),
 });
 
-export function searchResponseMetadataFromJSON(
+export function metadataFromJSON(
   jsonString: string,
-): SafeParseResult<SearchResponseMetadata, SDKValidationError> {
+): SafeParseResult<Metadata, SDKValidationError> {
   return safeParse(
     jsonString,
-    (x) => SearchResponseMetadata$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'SearchResponseMetadata' from JSON`,
+    (x) => Metadata$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Metadata' from JSON`,
   );
 }
 
@@ -142,7 +142,7 @@ export const SearchResponse$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   hasMore: z.boolean().optional(),
-  metadata: z.lazy(() => SearchResponseMetadata$inboundSchema).optional(),
+  metadata: z.lazy(() => Metadata$inboundSchema).optional(),
   nextOffset: z.number().optional(),
   results: z.array(SearchResult$inboundSchema),
   size: z.number(),

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

@@ -15,7 +15,7 @@ import {
 /**
  * WGS84 coordinate pair
  */
-export type SearchResultCoordinates = {
+export type Coordinates = {
   /**
    * Latitude in decimal degrees
    */
@@ -70,7 +70,7 @@ export type SearchResult = {
   /**
    * WGS84 coordinate pair
    */
-  location?: SearchResultCoordinates | undefined;
+  location?: Coordinates | undefined;
   /**
    * Additional result-specific metadata (varies by result type)
    */
@@ -106,8 +106,8 @@ export type SearchResult = {
 };
 
 /** @internal */
-export const SearchResultCoordinates$inboundSchema: z.ZodType<
-  SearchResultCoordinates,
+export const Coordinates$inboundSchema: z.ZodType<
+  Coordinates,
   z.ZodTypeDef,
   unknown
 > = z.object({
@@ -115,13 +115,13 @@ export const SearchResultCoordinates$inboundSchema: z.ZodType<
   lng: z.number(),
 });
 
-export function searchResultCoordinatesFromJSON(
+export function coordinatesFromJSON(
   jsonString: string,
-): SafeParseResult<SearchResultCoordinates, SDKValidationError> {
+): SafeParseResult<Coordinates, SDKValidationError> {
   return safeParse(
     jsonString,
-    (x) => SearchResultCoordinates$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'SearchResultCoordinates' from JSON`,
+    (x) => Coordinates$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Coordinates' from JSON`,
   );
 }
 
@@ -140,7 +140,7 @@ export const SearchResult$inboundSchema: z.ZodType<
   distance: z.number().optional(),
   highlights: z.array(SearchHighlight$inboundSchema).optional(),
   id: z.string(),
-  location: z.lazy(() => SearchResultCoordinates$inboundSchema).optional(),
+  location: z.lazy(() => Coordinates$inboundSchema).optional(),
   metadata: z.record(z.nullable(z.any())).optional(),
   path: z.string().optional(),
   relevanceScore: z.number(),

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

@@ -3,14 +3,6 @@
  */
 
 import * as z from "zod/v3";
-import { ClosedEnum } from "../../types/enums.js";
-
-export const StreetQueryByCoordinatesType = {
-  Coordinates: "coordinates",
-} as const;
-export type StreetQueryByCoordinatesType = ClosedEnum<
-  typeof StreetQueryByCoordinatesType
->;
 
 export type StreetQueryByCoordinates = {
   /**
@@ -25,20 +17,15 @@ export type StreetQueryByCoordinates = {
    * Search radius in meters
    */
   radius?: number | undefined;
-  type: StreetQueryByCoordinatesType;
+  type: "coordinates";
 };
 
-/** @internal */
-export const StreetQueryByCoordinatesType$outboundSchema: z.ZodNativeEnum<
-  typeof StreetQueryByCoordinatesType
-> = z.nativeEnum(StreetQueryByCoordinatesType);
-
 /** @internal */
 export type StreetQueryByCoordinates$Outbound = {
   lat: number;
   lng: number;
   radius: number;
-  type: string;
+  type: "coordinates";
 };
 
 /** @internal */
@@ -50,7 +37,7 @@ export const StreetQueryByCoordinates$outboundSchema: z.ZodType<
   lat: z.number(),
   lng: z.number(),
   radius: z.number().default(50),
-  type: StreetQueryByCoordinatesType$outboundSchema,
+  type: z.literal("coordinates"),
 });
 
 export function streetQueryByCoordinatesToJSON(

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

@@ -3,12 +3,6 @@
  */
 
 import * as z from "zod/v3";
-import { ClosedEnum } from "../../types/enums.js";
-
-export const StreetQueryByNameType = {
-  Name: "name",
-} as const;
-export type StreetQueryByNameType = ClosedEnum<typeof StreetQueryByNameType>;
 
 export type StreetQueryByName = {
   /**
@@ -19,19 +13,14 @@ export type StreetQueryByName = {
    * Street name search term
    */
   searchTerm: string;
-  type: StreetQueryByNameType;
+  type: "name";
 };
 
-/** @internal */
-export const StreetQueryByNameType$outboundSchema: z.ZodNativeEnum<
-  typeof StreetQueryByNameType
-> = z.nativeEnum(StreetQueryByNameType);
-
 /** @internal */
 export type StreetQueryByName$Outbound = {
   limit: number;
   searchTerm: string;
-  type: string;
+  type: "name";
 };
 
 /** @internal */
@@ -42,7 +31,7 @@ export const StreetQueryByName$outboundSchema: z.ZodType<
 > = z.object({
   limit: z.number().default(10),
   searchTerm: z.string(),
-  type: StreetQueryByNameType$outboundSchema,
+  type: z.literal("name"),
 });
 
 export function streetQueryByNameToJSON(

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

@@ -3,32 +3,19 @@
  */
 
 import * as z from "zod/v3";
-import { ClosedEnum } from "../../types/enums.js";
-
-export const StreetQueryByPostcodeType = {
-  Postcode: "postcode",
-} as const;
-export type StreetQueryByPostcodeType = ClosedEnum<
-  typeof StreetQueryByPostcodeType
->;
 
 export type StreetQueryByPostcode = {
   /**
    * UK postcode
    */
   postcode: string;
-  type: StreetQueryByPostcodeType;
+  type: "postcode";
 };
 
-/** @internal */
-export const StreetQueryByPostcodeType$outboundSchema: z.ZodNativeEnum<
-  typeof StreetQueryByPostcodeType
-> = z.nativeEnum(StreetQueryByPostcodeType);
-
 /** @internal */
 export type StreetQueryByPostcode$Outbound = {
   postcode: string;
-  type: string;
+  type: "postcode";
 };
 
 /** @internal */
@@ -38,7 +25,7 @@ export const StreetQueryByPostcode$outboundSchema: z.ZodType<
   StreetQueryByPostcode
 > = z.object({
   postcode: z.string(),
-  type: StreetQueryByPostcodeType$outboundSchema,
+  type: z.literal("postcode"),
 });
 
 export function streetQueryByPostcodeToJSON(

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

@@ -3,29 +3,18 @@
  */
 
 import * as z from "zod/v3";
-import { ClosedEnum } from "../../types/enums.js";
-
-export const StreetQueryByUprnType = {
-  Uprn: "uprn",
-} as const;
-export type StreetQueryByUprnType = ClosedEnum<typeof StreetQueryByUprnType>;
 
 export type StreetQueryByUprn = {
-  type: StreetQueryByUprnType;
+  type: "uprn";
   /**
    * Unique Property Reference Number
    */
   uprn: number;
 };
 
-/** @internal */
-export const StreetQueryByUprnType$outboundSchema: z.ZodNativeEnum<
-  typeof StreetQueryByUprnType
-> = z.nativeEnum(StreetQueryByUprnType);
-
 /** @internal */
 export type StreetQueryByUprn$Outbound = {
-  type: string;
+  type: "uprn";
   uprn: number;
 };
 
@@ -35,7 +24,7 @@ export const StreetQueryByUprn$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   StreetQueryByUprn
 > = z.object({
-  type: StreetQueryByUprnType$outboundSchema,
+  type: z.literal("uprn"),
   uprn: z.number(),
 });
 

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

@@ -3,29 +3,18 @@
  */
 
 import * as z from "zod/v3";
-import { ClosedEnum } from "../../types/enums.js";
-
-export const StreetQueryByUsrnType = {
-  Usrn: "usrn",
-} as const;
-export type StreetQueryByUsrnType = ClosedEnum<typeof StreetQueryByUsrnType>;
 
 export type StreetQueryByUsrn = {
-  type: StreetQueryByUsrnType;
+  type: "usrn";
   /**
    * Unique Street Reference Number
    */
   usrn: number;
 };
 
-/** @internal */
-export const StreetQueryByUsrnType$outboundSchema: z.ZodNativeEnum<
-  typeof StreetQueryByUsrnType
-> = z.nativeEnum(StreetQueryByUsrnType);
-
 /** @internal */
 export type StreetQueryByUsrn$Outbound = {
-  type: string;
+  type: "usrn";
   usrn: number;
 };
 
@@ -35,7 +24,7 @@ export const StreetQueryByUsrn$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   StreetQueryByUsrn
 > = z.object({
-  type: StreetQueryByUsrnType$outboundSchema,
+  type: z.literal("usrn"),
   usrn: z.number(),
 });
 

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

@@ -33,11 +33,11 @@ import {
  * Street identifier - supports multiple query types
  */
 export type Identifier =
-  | (StreetQueryByCoordinates & { type: "coordinates" })
-  | (StreetQueryByName & { type: "name" })
-  | (StreetQueryByPostcode & { type: "postcode" })
-  | (StreetQueryByUprn & { type: "uprn" })
-  | (StreetQueryByUsrn & { type: "usrn" });
+  | StreetQueryByCoordinates
+  | StreetQueryByName
+  | StreetQueryByPostcode
+  | StreetQueryByUprn
+  | StreetQueryByUsrn;
 
 /**
  * Options for property listing
@@ -62,11 +62,11 @@ export type StreetQueryRequest = {
    * Street identifier - supports multiple query types
    */
   identifier:
-    | (StreetQueryByCoordinates & { type: "coordinates" })
-    | (StreetQueryByName & { type: "name" })
-    | (StreetQueryByPostcode & { type: "postcode" })
-    | (StreetQueryByUprn & { type: "uprn" })
-    | (StreetQueryByUsrn & { type: "usrn" });
+    | StreetQueryByCoordinates
+    | StreetQueryByName
+    | StreetQueryByPostcode
+    | StreetQueryByUprn
+    | StreetQueryByUsrn;
   /**
    * Include properties on the street
    */
@@ -83,11 +83,11 @@ export type StreetQueryRequest = {
 
 /** @internal */
 export type Identifier$Outbound =
-  | (StreetQueryByCoordinates$Outbound & { type: "coordinates" })
-  | (StreetQueryByName$Outbound & { type: "name" })
-  | (StreetQueryByPostcode$Outbound & { type: "postcode" })
-  | (StreetQueryByUprn$Outbound & { type: "uprn" })
-  | (StreetQueryByUsrn$Outbound & { type: "usrn" });
+  | StreetQueryByCoordinates$Outbound
+  | StreetQueryByName$Outbound
+  | StreetQueryByPostcode$Outbound
+  | StreetQueryByUprn$Outbound
+  | StreetQueryByUsrn$Outbound;
 
 /** @internal */
 export const Identifier$outboundSchema: z.ZodType<
@@ -95,25 +95,11 @@ export const Identifier$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   Identifier
 > = z.union([
-  StreetQueryByCoordinates$outboundSchema.and(
-    z.object({ type: z.literal("coordinates") }).transform((v) => ({
-      type: v.type,
-    })),
-  ),
-  StreetQueryByName$outboundSchema.and(
-    z.object({ type: z.literal("name") }).transform((v) => ({ type: v.type })),
-  ),
-  StreetQueryByPostcode$outboundSchema.and(
-    z.object({ type: z.literal("postcode") }).transform((v) => ({
-      type: v.type,
-    })),
-  ),
-  StreetQueryByUprn$outboundSchema.and(
-    z.object({ type: z.literal("uprn") }).transform((v) => ({ type: v.type })),
-  ),
-  StreetQueryByUsrn$outboundSchema.and(
-    z.object({ type: z.literal("usrn") }).transform((v) => ({ type: v.type })),
-  ),
+  StreetQueryByCoordinates$outboundSchema,
+  StreetQueryByName$outboundSchema,
+  StreetQueryByPostcode$outboundSchema,
+  StreetQueryByUprn$outboundSchema,
+  StreetQueryByUsrn$outboundSchema,
 ]);
 
 export function identifierToJSON(identifier: Identifier): string {
@@ -147,11 +133,11 @@ export function propertyOptionsToJSON(
 /** @internal */
 export type StreetQueryRequest$Outbound = {
   identifier:
-    | (StreetQueryByCoordinates$Outbound & { type: "coordinates" })
-    | (StreetQueryByName$Outbound & { type: "name" })
-    | (StreetQueryByPostcode$Outbound & { type: "postcode" })
-    | (StreetQueryByUprn$Outbound & { type: "uprn" })
-    | (StreetQueryByUsrn$Outbound & { type: "usrn" });
+    | StreetQueryByCoordinates$Outbound
+    | StreetQueryByName$Outbound
+    | StreetQueryByPostcode$Outbound
+    | StreetQueryByUprn$Outbound
+    | StreetQueryByUsrn$Outbound;
   includeProperties: boolean;
   includeStatistics: boolean;
   propertyOptions?: PropertyOptions$Outbound | undefined;
@@ -164,31 +150,11 @@ export const StreetQueryRequest$outboundSchema: z.ZodType<
   StreetQueryRequest
 > = z.object({
   identifier: z.union([
-    StreetQueryByCoordinates$outboundSchema.and(
-      z.object({ type: z.literal("coordinates") }).transform((v) => ({
-        type: v.type,
-      })),
-    ),
-    StreetQueryByName$outboundSchema.and(
-      z.object({ type: z.literal("name") }).transform((v) => ({
-        type: v.type,
-      })),
-    ),
-    StreetQueryByPostcode$outboundSchema.and(
-      z.object({ type: z.literal("postcode") }).transform((v) => ({
-        type: v.type,
-      })),
-    ),
-    StreetQueryByUprn$outboundSchema.and(
-      z.object({ type: z.literal("uprn") }).transform((v) => ({
-        type: v.type,
-      })),
-    ),
-    StreetQueryByUsrn$outboundSchema.and(
-      z.object({ type: z.literal("usrn") }).transform((v) => ({
-        type: v.type,
-      })),
-    ),
+    StreetQueryByCoordinates$outboundSchema,
+    StreetQueryByName$outboundSchema,
+    StreetQueryByPostcode$outboundSchema,
+    StreetQueryByUprn$outboundSchema,
+    StreetQueryByUsrn$outboundSchema,
   ]),
   includeProperties: z.boolean().default(false),
   includeStatistics: z.boolean().default(false),

package/src/sdk/sdk.ts

@@ -12,7 +12,6 @@ import { Metrics } from "./metrics.js";
 import { Planning } from "./planning.js";
 import { Poi } from "./poi.js";
 import { Property } from "./property.js";
-import { Roa } from "./roa.js";
 import { Safety } from "./safety.js";
 import { Schools } from "./schools.js";
 import { Search } from "./search.js";
@@ -75,11 +74,6 @@ export class SDK extends ClientSDK {
     return (this._property ??= new Property(this._options));
   }
 
-  private _roa?: Roa;
-  get roa(): Roa {
-    return (this._roa ??= new Roa(this._options));
-  }
-
   private _safety?: Safety;
   get safety(): Safety {
     return (this._safety ??= new Safety(this._options));

package/src/sdk/types/unrecognized.ts

@@ -16,8 +16,16 @@ export function startCountingUnrecognized() {
   refCount++;
   const start = globalCount;
   return {
-    end: () => {
+    /**
+     * Ends counting and returns the delta.
+     * @param delta - If provided, only this amount is added to the parent counter
+     *   (used for nested unions where we only want to record the winning option's count).
+     *   If not provided, records all counts since start().
+     */
+    end: (delta?: number) => {
       const count = globalCount - start;
+      // Reset globalCount back to start, then add only the specified delta
+      globalCount = start + (delta ?? count);
       if (--refCount === 0) globalCount = 0;
       return count;
     },

package/tsconfig.json

@@ -1,7 +1,6 @@
 {
   "compilerOptions": {
-    "incremental": true,
-    "tsBuildInfoFile": ".tsbuildinfo",
+    "incremental": false,
     "target": "ES2020",
     "lib": ["ES2022", "DOM", "DOM.Iterable"],
     "jsx": "react-jsx",

package/dist/commonjs/funcs/roaVerifyROA.d.ts

@@ -1,18 +0,0 @@
-import { SDKCore } from "../core.js";
-import { RequestOptions } from "../lib/sdks.js";
-import { ConnectionError, InvalidRequestError, RequestAbortedError, RequestTimeoutError, UnexpectedClientError } from "../sdk/models/errors/httpclienterrors.js";
-import { ResponseValidationError } from "../sdk/models/errors/responsevalidationerror.js";
-import { SDKBaseError } from "../sdk/models/errors/sdkbaseerror.js";
-import { SDKValidationError } from "../sdk/models/errors/sdkvalidationerror.js";
-import * as operations from "../sdk/models/operations/index.js";
-import * as shared from "../sdk/models/shared/index.js";
-import { APIPromise } from "../sdk/types/async.js";
-import { Result } from "../sdk/types/fp.js";
-/**
- * Verify Registered Office Address
- *
- * @remarks
- * Comprehensive Registered Office Address (ROA) verification service for Companies House compliance. Performs address resolution, appropriateness checks, fraud risk analysis, and right-to-use inference. Returns detailed breakdown of all checks and scores for transparent decision-making.
- */
-export declare function roaVerifyROA(client: SDKCore, request?: shared.RoaVerifyRequest | undefined, options?: RequestOptions): APIPromise<Result<operations.VerifyRoaResponse, SDKBaseError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
-//# sourceMappingURL=roaVerifyROA.d.ts.map

package/dist/commonjs/funcs/roaVerifyROA.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"roaVerifyROA.d.ts","sourceRoot":"","sources":["../../../src/funcs/roaVerifyROA.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AAKrC,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAGhD,OAAO,EACL,eAAe,EACf,mBAAmB,EACnB,mBAAmB,EACnB,mBAAmB,EACnB,qBAAqB,EACtB,MAAM,0CAA0C,CAAC;AAClD,OAAO,EAAE,uBAAuB,EAAE,MAAM,iDAAiD,CAAC;AAC1F,OAAO,EAAE,YAAY,EAAE,MAAM,sCAAsC,CAAC;AACpE,OAAO,EAAE,kBAAkB,EAAE,MAAM,4CAA4C,CAAC;AAChF,OAAO,KAAK,UAAU,MAAM,mCAAmC,CAAC;AAChE,OAAO,KAAK,MAAM,MAAM,+BAA+B,CAAC;AACxD,OAAO,EAAW,UAAU,EAAE,MAAM,uBAAuB,CAAC;AAC5D,OAAO,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAC;AAE5C;;;;;GAKG;AACH,wBAAgB,YAAY,CAC1B,MAAM,EAAE,OAAO,EACf,OAAO,CAAC,EAAE,MAAM,CAAC,gBAAgB,GAAG,SAAS,EAC7C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CACX,MAAM,CACJ,UAAU,CAAC,iBAAiB,EAC1B,YAAY,GACZ,uBAAuB,GACvB,eAAe,GACf,mBAAmB,GACnB,mBAAmB,GACnB,mBAAmB,GACnB,qBAAqB,GACrB,kBAAkB,CACrB,CACF,CAMA"}