@vepler/sdk 2.6.6 → 2.8.0

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

@@ -25,11 +25,11 @@ export type ListingPriceChange = {
   /**
    * Amount of change in pence
    */
-  amount?: number | undefined;
+  amount?: number | null | undefined;
   /**
    * Date of price change
    */
-  date?: Date | undefined;
+  date?: Date | null | undefined;
   /**
    * Direction of price change
    */
@@ -37,11 +37,11 @@ export type ListingPriceChange = {
   /**
    * Percentage change
    */
-  percent?: number | undefined;
+  percent?: number | null | undefined;
   /**
    * New price after change in pence
    */
-  price?: number | undefined;
+  price?: number | null | undefined;
 };
 
 /** @internal */
@@ -54,12 +54,13 @@ export const ListingPriceChange$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  amount: z.number().optional(),
-  date: z.string().datetime({ offset: true }).transform(v => new Date(v))
-    .optional(),
+  amount: z.nullable(z.number()).optional(),
+  date: z.nullable(
+    z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  ).optional(),
   direction: Direction$inboundSchema.optional(),
-  percent: z.number().optional(),
-  price: z.number().optional(),
+  percent: z.nullable(z.number()).optional(),
+  price: z.nullable(z.number()).optional(),
 });
 
 export function listingPriceChangeFromJSON(

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

@@ -16,11 +16,11 @@ export const PriceChangeDirection = {
 export type PriceChangeDirection = ClosedEnum<typeof PriceChangeDirection>;
 
 export type PriceChange = {
-  amount?: number | undefined;
-  date?: Date | undefined;
+  amount?: number | null | undefined;
+  date?: Date | null | undefined;
   direction?: PriceChangeDirection | undefined;
-  percent?: number | undefined;
-  price?: number | undefined;
+  percent?: number | null | undefined;
+  price?: number | null | undefined;
 };
 
 /** @internal */
@@ -34,12 +34,13 @@ export const PriceChange$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  amount: z.number().optional(),
-  date: z.string().datetime({ offset: true }).transform(v => new Date(v))
-    .optional(),
+  amount: z.nullable(z.number()).optional(),
+  date: z.nullable(
+    z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  ).optional(),
   direction: PriceChangeDirection$inboundSchema.optional(),
-  percent: z.number().optional(),
-  price: z.number().optional(),
+  percent: z.nullable(z.number()).optional(),
+  price: z.nullable(z.number()).optional(),
 });
 
 export function priceChangeFromJSON(

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

@@ -8,7 +8,7 @@ import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type PricingData = {
-  currency?: string | undefined;
+  currency?: string | null | undefined;
   currentRent?: number | null | undefined;
   currentSale?: number | null | undefined;
   estimatedRent?: number | null | undefined;
@@ -21,7 +21,7 @@ export const PricingData$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  currency: z.string().optional(),
+  currency: z.nullable(z.string()).optional(),
   currentRent: z.nullable(z.number()).optional(),
   currentSale: z.nullable(z.number()).optional(),
   estimatedRent: z.nullable(z.number()).optional(),

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

@@ -0,0 +1,44 @@
+/*
+ * 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";
+
+export type SearchHighlight = {
+  /**
+   * Field name that was highlighted
+   */
+  field: string;
+  /**
+   * Highlighted text fragments with match context
+   */
+  fragments: Array<string>;
+  /**
+   * Terms that matched in this field
+   */
+  matchedTerms?: Array<string> | undefined;
+};
+
+/** @internal */
+export const SearchHighlight$inboundSchema: z.ZodType<
+  SearchHighlight,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  field: z.string(),
+  fragments: z.array(z.string()),
+  matchedTerms: z.array(z.string()).optional(),
+});
+
+export function searchHighlightFromJSON(
+  jsonString: string,
+): SafeParseResult<SearchHighlight, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SearchHighlight$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SearchHighlight' from JSON`,
+  );
+}

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

@@ -0,0 +1,161 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+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 { SearchResult, SearchResult$inboundSchema } from "./searchresult.js";
+
+/**
+ * Pattern detected in the search query:
+ *
+ * @remarks
+ * - postcode: UK postcode (e.g., SW1A 1AA or SW1A for outward code)
+ * - address: Full or partial address with house number (e.g., 10 Downing Street)
+ * - general: No specific pattern detected (general location search)
+ */
+export const QueryPattern = {
+  Postcode: "postcode",
+  Address: "address",
+  General: "general",
+} as const;
+/**
+ * Pattern detected in the search query:
+ *
+ * @remarks
+ * - postcode: UK postcode (e.g., SW1A 1AA or SW1A for outward code)
+ * - address: Full or partial address with house number (e.g., 10 Downing Street)
+ * - general: No specific pattern detected (general location search)
+ */
+export type QueryPattern = ClosedEnum<typeof QueryPattern>;
+
+/**
+ * Data source to search:
+ *
+ * @remarks
+ * - address: UK property addresses with UPRN, full address details, and geocoding
+ * - location: UK postcodes, places, towns, and geographic locations
+ */
+export const Sources = {
+  Address: "address",
+  Location: "location",
+} as const;
+/**
+ * Data source to search:
+ *
+ * @remarks
+ * - address: UK property addresses with UPRN, full address details, and geocoding
+ * - location: UK postcodes, places, towns, and geographic locations
+ */
+export type Sources = ClosedEnum<typeof Sources>;
+
+/**
+ * Search metadata
+ */
+export type Metadata = {
+  /**
+   * Query processing time (e.g., '45ms')
+   */
+  processingTime?: string | undefined;
+  /**
+   * Pattern detected in the search query:
+   *
+   * @remarks
+   * - postcode: UK postcode (e.g., SW1A 1AA or SW1A for outward code)
+   * - address: Full or partial address with house number (e.g., 10 Downing Street)
+   * - general: No specific pattern detected (general location search)
+   */
+  queryPattern?: QueryPattern | undefined;
+  /**
+   * Data sources used in search
+   */
+  sources?: Array<Sources> | undefined;
+};
+
+export type SearchResponse = {
+  /**
+   * Whether more results are available
+   */
+  hasMore?: boolean | undefined;
+  /**
+   * Search metadata
+   */
+  metadata?: Metadata | undefined;
+  /**
+   * Offset for next page of results
+   */
+  nextOffset?: number | undefined;
+  /**
+   * Array of search results
+   */
+  results: Array<SearchResult>;
+  /**
+   * Number of results returned in this response
+   */
+  size: number;
+  /**
+   * Whether the search was successful
+   */
+  success: boolean;
+  /**
+   * Total number of results found
+   */
+  totalResults: number;
+};
+
+/** @internal */
+export const QueryPattern$inboundSchema: z.ZodNativeEnum<typeof QueryPattern> =
+  z.nativeEnum(QueryPattern);
+
+/** @internal */
+export const Sources$inboundSchema: z.ZodNativeEnum<typeof Sources> = z
+  .nativeEnum(Sources);
+
+/** @internal */
+export const Metadata$inboundSchema: z.ZodType<
+  Metadata,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  processingTime: z.string().optional(),
+  queryPattern: QueryPattern$inboundSchema.optional(),
+  sources: z.array(Sources$inboundSchema).optional(),
+});
+
+export function metadataFromJSON(
+  jsonString: string,
+): SafeParseResult<Metadata, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Metadata$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Metadata' from JSON`,
+  );
+}
+
+/** @internal */
+export const SearchResponse$inboundSchema: z.ZodType<
+  SearchResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  hasMore: z.boolean().optional(),
+  metadata: z.lazy(() => Metadata$inboundSchema).optional(),
+  nextOffset: z.number().optional(),
+  results: z.array(SearchResult$inboundSchema),
+  size: z.number(),
+  success: z.boolean(),
+  totalResults: z.number(),
+});
+
+export function searchResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<SearchResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SearchResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SearchResponse' from JSON`,
+  );
+}

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

@@ -0,0 +1,161 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+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 {
+  SearchHighlight,
+  SearchHighlight$inboundSchema,
+} from "./searchhighlight.js";
+
+/**
+ * WGS84 coordinate pair
+ */
+export type Coordinates = {
+  /**
+   * Latitude in decimal degrees
+   */
+  lat: number;
+  /**
+   * Longitude in decimal degrees
+   */
+  lng: number;
+};
+
+/**
+ * Data source to search:
+ *
+ * @remarks
+ * - address: UK property addresses with UPRN, full address details, and geocoding
+ * - location: UK postcodes, places, towns, and geographic locations
+ */
+export const Source = {
+  Address: "address",
+  Location: "location",
+} as const;
+/**
+ * Data source to search:
+ *
+ * @remarks
+ * - address: UK property addresses with UPRN, full address details, and geocoding
+ * - location: UK postcodes, places, towns, and geographic locations
+ */
+export type Source = ClosedEnum<typeof Source>;
+
+export type SearchResult = {
+  /**
+   * Formatted address
+   */
+  address?: string | undefined;
+  /**
+   * Result description
+   */
+  description?: string | undefined;
+  /**
+   * Distance from query point in meters
+   */
+  distance?: number | undefined;
+  /**
+   * Highlighted matching text from search query
+   */
+  highlights?: Array<SearchHighlight> | undefined;
+  /**
+   * Unique result identifier
+   */
+  id: string;
+  /**
+   * WGS84 coordinate pair
+   */
+  location?: Coordinates | undefined;
+  /**
+   * Additional result-specific metadata (varies by result type)
+   */
+  metadata?: { [k: string]: any | null } | undefined;
+  /**
+   * URL path to view full details
+   */
+  path?: string | undefined;
+  /**
+   * Normalised relevance score (0-1)
+   */
+  relevanceScore: number;
+  /**
+   * Raw search score
+   */
+  score: number;
+  /**
+   * Data source to search:
+   *
+   * @remarks
+   * - address: UK property addresses with UPRN, full address details, and geocoding
+   * - location: UK postcodes, places, towns, and geographic locations
+   */
+  source: Source;
+  /**
+   * Result title
+   */
+  title: string;
+  /**
+   * Result type (address, postcode, location, etc.)
+   */
+  type: string;
+};
+
+/** @internal */
+export const Coordinates$inboundSchema: z.ZodType<
+  Coordinates,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  lat: z.number(),
+  lng: z.number(),
+});
+
+export function coordinatesFromJSON(
+  jsonString: string,
+): SafeParseResult<Coordinates, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Coordinates$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Coordinates' from JSON`,
+  );
+}
+
+/** @internal */
+export const Source$inboundSchema: z.ZodNativeEnum<typeof Source> = z
+  .nativeEnum(Source);
+
+/** @internal */
+export const SearchResult$inboundSchema: z.ZodType<
+  SearchResult,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  address: z.string().optional(),
+  description: z.string().optional(),
+  distance: z.number().optional(),
+  highlights: z.array(SearchHighlight$inboundSchema).optional(),
+  id: z.string(),
+  location: z.lazy(() => Coordinates$inboundSchema).optional(),
+  metadata: z.record(z.nullable(z.any())).optional(),
+  path: z.string().optional(),
+  relevanceScore: z.number(),
+  score: z.number(),
+  source: Source$inboundSchema,
+  title: z.string(),
+  type: z.string(),
+});
+
+export function searchResultFromJSON(
+  jsonString: string,
+): SafeParseResult<SearchResult, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SearchResult$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SearchResult' from JSON`,
+  );
+}

package/src/sdk/sdk.ts

@@ -15,6 +15,7 @@ import { Poi } from "./poi.js";
 import { Property } from "./property.js";
 import { Safety } from "./safety.js";
 import { Schools } from "./schools.js";
+import { Search } from "./search.js";
 import { Streets } from "./streets.js";
 import { System } from "./system.js";
 
@@ -88,4 +89,9 @@ export class SDK extends ClientSDK {
   get schools(): Schools {
     return (this._schools ??= new Schools(this._options));
   }
+
+  private _search?: Search;
+  get search(): Search {
+    return (this._search ??= new Search(this._options));
+  }
 }

package/src/sdk/search.ts

@@ -0,0 +1,27 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { searchSearchSuggest } from "../funcs/searchSearchSuggest.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as operations from "./models/operations/index.js";
+import { unwrapAsync } from "./types/fp.js";
+
+export class Search extends ClientSDK {
+  /**
+   * Autocomplete search for UK addresses and locations
+   *
+   * @remarks
+   * Simple autocomplete for UK properties and locations. Searches across Address and Location sources with fuzzy matching. Automatically detects query type (postcode, address, place name) and returns suggestions.
+   */
+  async searchSuggest(
+    request: operations.SearchSuggestRequest,
+    options?: RequestOptions,
+  ): Promise<operations.SearchSuggestResponse> {
+    return unwrapAsync(searchSearchSuggest(
+      this,
+      request,
+      options,
+    ));
+  }
+}

package/src/sdk/system.ts

@@ -9,6 +9,7 @@ import { systemCheckListingsHealth } from "../funcs/systemCheckListingsHealth.js
 import { systemCheckLocationHealth } from "../funcs/systemCheckLocationHealth.js";
 import { systemCheckPlanningHealth } from "../funcs/systemCheckPlanningHealth.js";
 import { systemCheckPropertyHealth } from "../funcs/systemCheckPropertyHealth.js";
+import { systemCheckSearchHealth } from "../funcs/systemCheckSearchHealth.js";
 import { ClientSDK, RequestOptions } from "../lib/sdks.js";
 import * as operations from "./models/operations/index.js";
 import * as shared from "./models/shared/index.js";
@@ -119,4 +120,19 @@ export class System extends ClientSDK {
       options,
     ));
   }
+
+  /**
+   * Search service health check
+   *
+   * @remarks
+   * Check if the search service is operational
+   */
+  async checkSearchHealth(
+    options?: RequestOptions,
+  ): Promise<shared.HealthResponse> {
+    return unwrapAsync(systemCheckSearchHealth(
+      this,
+      options,
+    ));
+  }
 }

package/src/sdk/types/enums.ts

@@ -2,15 +2,64 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
+import * as z from "zod/v3";
+
 declare const __brand: unique symbol;
 export type Unrecognized<T> = T & { [__brand]: "unrecognized" };
+export type ClosedEnum<T extends Readonly<Record<string, string | number>>> =
+  T[keyof T];
+export type OpenEnum<T extends Readonly<Record<string, string | number>>> =
+  | T[keyof T]
+  | Unrecognized<T[keyof T] extends number ? number : string>;
 
-export function catchUnrecognizedEnum<T>(value: T): Unrecognized<T> {
+function unrecognized<T>(value: T): Unrecognized<T> {
+  unrecognizedCount++;
   return value as Unrecognized<T>;
 }
 
-type Prettify<T> = { [K in keyof T]: T[K] } & {};
-export type ClosedEnum<T> = T[keyof T];
-export type OpenEnum<T> =
-  | Prettify<T[keyof T]>
-  | Unrecognized<T[keyof T] extends number ? number : string>;
+let unrecognizedCount = 0;
+let refCount = 0;
+export function unrecognizedCounter() {
+  refCount++;
+  const start = unrecognizedCount;
+  return {
+    count: () => {
+      const count = unrecognizedCount - start;
+      if (--refCount === 0) unrecognizedCount = 0;
+      return count;
+    },
+  };
+}
+
+export function inboundSchema<T extends Record<string, string>>(
+  enumObj: T,
+): z.ZodType<OpenEnum<T>, z.ZodTypeDef, unknown> {
+  const options = Object.values(enumObj);
+  return z.union([
+    ...options.map(x => z.literal(x)),
+    z.string().transform(x => unrecognized(x)),
+  ] as any);
+}
+
+export function inboundSchemaInt<T extends Record<string, number | string>>(
+  enumObj: T,
+): z.ZodType<OpenEnum<T>, z.ZodTypeDef, unknown> {
+  // For numeric enums, Object.values returns both numbers and string keys
+  const options = Object.values(enumObj).filter(v => typeof v === "number");
+  return z.union([
+    ...options.map(x => z.literal(x)),
+    z.number().int().transform(x => unrecognized(x)),
+  ] as any);
+}
+
+export function outboundSchema<T extends Record<string, string>>(
+  _: T,
+): z.ZodType<string, z.ZodTypeDef, OpenEnum<T>> {
+  return z.string() as any;
+}
+
+export function outboundSchemaInt<T extends Record<string, number | string>>(
+  _: T,
+): z.ZodType<number, z.ZodTypeDef, OpenEnum<T>> {
+  return z.number().int() as any;
+}

package/src/sdk/types/index.ts

@@ -3,7 +3,6 @@
  */
 
 export { blobLikeSchema, isBlobLike } from "./blobs.js";
-export { catchUnrecognizedEnum } from "./enums.js";
 export type { ClosedEnum, OpenEnum, Unrecognized } from "./enums.js";
 export type { Result } from "./fp.js";
 export type { PageIterator, Paginator } from "./operations.js";