@vepler/sdk 2.12.0 → 2.20.2

package/src/sdk/models/operations/getlistingbyid.ts

@@ -119,7 +119,7 @@ export type Address = {
   /**
    * Country code
    */
-  country?: string | undefined;
+  country: string;
   /**
    * District
    */
@@ -568,7 +568,7 @@ export type Data = {
   /**
    * Currency code
    */
-  currency?: string | undefined;
+  currency: string;
   /**
    * Formatted display address
    */

package/src/sdk/models/operations/getlistingsbylocation.ts

@@ -91,7 +91,7 @@ export type GetListingsByLocationAddress = {
   /**
    * Country code
    */
-  country?: string | undefined;
+  country: string;
   /**
    * District
    */
@@ -548,7 +548,7 @@ export type GetListingsByLocationResult = {
   /**
    * Currency code
    */
-  currency?: string | undefined;
+  currency: string;
   /**
    * Formatted display address
    */

package/src/sdk/models/operations/getnearestpoi.ts

@@ -88,7 +88,7 @@ export type GetNearestPOIType = ClosedEnum<typeof GetNearestPOIType>;
 /**
  * GeoJSON Point geometry representing the POI location
  */
-export type Location = {
+export type GetNearestPOILocation = {
   /**
    * GeoJSON coordinates [longitude, latitude] in WGS84 (EPSG:4326)
    */
@@ -122,7 +122,7 @@ export type GetNearestPOIResult = {
   /**
    * GeoJSON Point geometry representing the POI location
    */
-  location: Location;
+  location: GetNearestPOILocation;
   /**
    * Name of the point of interest
    */
@@ -292,8 +292,8 @@ export const GetNearestPOIType$inboundSchema: z.ZodNativeEnum<
 > = z.nativeEnum(GetNearestPOIType);
 
 /** @internal */
-export const Location$inboundSchema: z.ZodType<
-  Location,
+export const GetNearestPOILocation$inboundSchema: z.ZodType<
+  GetNearestPOILocation,
   z.ZodTypeDef,
   unknown
 > = z.object({
@@ -301,13 +301,13 @@ export const Location$inboundSchema: z.ZodType<
   type: GetNearestPOIType$inboundSchema,
 });
 
-export function locationFromJSON(
+export function getNearestPOILocationFromJSON(
   jsonString: string,
-): SafeParseResult<Location, SDKValidationError> {
+): SafeParseResult<GetNearestPOILocation, SDKValidationError> {
   return safeParse(
     jsonString,
-    (x) => Location$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'Location' from JSON`,
+    (x) => GetNearestPOILocation$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetNearestPOILocation' from JSON`,
   );
 }
 
@@ -321,7 +321,7 @@ export const GetNearestPOIResult$inboundSchema: z.ZodType<
   categoryId: z.string(),
   distance: z.number().optional(),
   id: z.number(),
-  location: z.lazy(() => Location$inboundSchema),
+  location: z.lazy(() => GetNearestPOILocation$inboundSchema),
   name: z.string(),
   routingDistance: z.number().optional(),
   routingDuration: z.number().optional(),

package/src/sdk/models/operations/index.ts

@@ -11,6 +11,8 @@ export * from "./getareaswithinradius.js";
 export * from "./getborderingareas.js";
 export * from "./getchildareas.js";
 export * from "./getconnectivityscores.js";
+export * from "./getcouncilbyproviderid.js";
+export * from "./getepcbylocationid.js";
 export * from "./getlistingbyid.js";
 export * from "./getlistingbysource.js";
 export * from "./getlistingsbylocation.js";
@@ -31,6 +33,7 @@ export * from "./getschoolbyurn.js";
 export * from "./getschoolmetrics.js";
 export * from "./getv1safetycrime.js";
 export * from "./getv1safetycrimestats.js";
+export * from "./listcouncils.js";
 export * from "./listschools.js";
 export * from "./predictpropertyvalue.js";
 export * from "./predictpropertyvaluebylocation.js";

package/src/sdk/models/operations/listcouncils.ts

@@ -0,0 +1,131 @@
+/*
+ * 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 * as shared from "../shared/index.js";
+
+/**
+ * Filter by country code (GB = Great Britain, IE = Ireland)
+ */
+export const Country = {
+  Gb: "GB",
+  Ie: "IE",
+} as const;
+/**
+ * Filter by country code (GB = Great Britain, IE = Ireland)
+ */
+export type Country = ClosedEnum<typeof Country>;
+
+/**
+ * Filter by council status
+ */
+export const QueryParamStatus = {
+  Active: "active",
+  Merged: "merged",
+  Abolished: "abolished",
+  Inactive: "inactive",
+} as const;
+/**
+ * Filter by council status
+ */
+export type QueryParamStatus = ClosedEnum<typeof QueryParamStatus>;
+
+/**
+ * Filter by council type
+ */
+export const QueryParamType = {
+  Unitary: "unitary",
+  Metropolitan: "metropolitan",
+  County: "county",
+  LondonBorough: "london_borough",
+  District: "district",
+  LocalAuthority: "local_authority",
+} as const;
+/**
+ * Filter by council type
+ */
+export type QueryParamType = ClosedEnum<typeof QueryParamType>;
+
+export type ListCouncilsRequest = {
+  /**
+   * Filter by country code (GB = Great Britain, IE = Ireland)
+   */
+  country?: Country | undefined;
+  /**
+   * Filter by council status
+   */
+  status?: QueryParamStatus | undefined;
+  /**
+   * Filter by council type
+   */
+  type?: QueryParamType | undefined;
+};
+
+export type ListCouncilsResponse =
+  | shared.CouncilListResponse
+  | shared.CouncilErrorResponse;
+
+/** @internal */
+export const Country$outboundSchema: z.ZodNativeEnum<typeof Country> = z
+  .nativeEnum(Country);
+
+/** @internal */
+export const QueryParamStatus$outboundSchema: z.ZodNativeEnum<
+  typeof QueryParamStatus
+> = z.nativeEnum(QueryParamStatus);
+
+/** @internal */
+export const QueryParamType$outboundSchema: z.ZodNativeEnum<
+  typeof QueryParamType
+> = z.nativeEnum(QueryParamType);
+
+/** @internal */
+export type ListCouncilsRequest$Outbound = {
+  country?: string | undefined;
+  status?: string | undefined;
+  type?: string | undefined;
+};
+
+/** @internal */
+export const ListCouncilsRequest$outboundSchema: z.ZodType<
+  ListCouncilsRequest$Outbound,
+  z.ZodTypeDef,
+  ListCouncilsRequest
+> = z.object({
+  country: Country$outboundSchema.optional(),
+  status: QueryParamStatus$outboundSchema.optional(),
+  type: QueryParamType$outboundSchema.optional(),
+});
+
+export function listCouncilsRequestToJSON(
+  listCouncilsRequest: ListCouncilsRequest,
+): string {
+  return JSON.stringify(
+    ListCouncilsRequest$outboundSchema.parse(listCouncilsRequest),
+  );
+}
+
+/** @internal */
+export const ListCouncilsResponse$inboundSchema: z.ZodType<
+  ListCouncilsResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.union([
+  shared.CouncilListResponse$inboundSchema,
+  shared.CouncilErrorResponse$inboundSchema,
+]);
+
+export function listCouncilsResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<ListCouncilsResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListCouncilsResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListCouncilsResponse' from JSON`,
+  );
+}

package/src/sdk/models/operations/querylistings.ts

@@ -184,7 +184,7 @@ export type QueryListingsAddress = {
   /**
    * Country code
    */
-  country?: string | undefined;
+  country: string;
   /**
    * District
    */
@@ -632,7 +632,7 @@ export type QueryListingsResult = {
   /**
    * Currency code
    */
-  currency?: string | undefined;
+  currency: string;
   /**
    * Formatted display address
    */

package/src/sdk/models/operations/querylistingsbysource.ts

@@ -126,7 +126,7 @@ export type QueryListingsBySourceAddress = {
   /**
    * Country code
    */
-  country?: string | undefined;
+  country: string;
   /**
    * District
    */
@@ -587,7 +587,7 @@ export type QueryListingsBySourceResult = {
   /**
    * Currency code
    */
-  currency?: string | undefined;
+  currency: string;
   /**
    * Formatted display address
    */

package/src/sdk/models/operations/resolveaddress.ts

@@ -97,10 +97,122 @@ export type ResolveAddressAddressResponseBody = {
   success: boolean;
 };
 
+/**
+ * Confidence zone: H (High, >66%), M (Medium, 50-66%), L (Low, <50%)
+ */
+export const ConfidenceZone = {
+  H: "H",
+  M: "M",
+  L: "L",
+} as const;
+/**
+ * Confidence zone: H (High, >66%), M (Medium, 50-66%), L (Low, <50%)
+ */
+export type ConfidenceZone = ClosedEnum<typeof ConfidenceZone>;
+
+/**
+ * Recommended action based on match quality
+ */
+export const Action = {
+  Accept: "accept",
+  Review: "review",
+  Reject: "reject",
+} as const;
+/**
+ * Recommended action based on match quality
+ */
+export type Action = ClosedEnum<typeof Action>;
+
+/**
+ * Individual factors contributing to quality assessment
+ */
+export type Factors = {
+  /**
+   * Significant confidence gap from second result
+   */
+  hasClearWinner: boolean;
+  /**
+   * Top result has high absolute confidence
+   */
+  hasHighConfidence: boolean;
+  /**
+   * Building number matched exactly (score = 1.0)
+   */
+  hasPerfectBuildingMatch: boolean;
+  /**
+   * Only one candidate found
+   */
+  isSingleResult: boolean;
+};
+
+/**
+ * Quality grade: A (excellent), B (good), C (acceptable), D (poor), F (fail)
+ */
+export const Grade = {
+  A: "A",
+  B: "B",
+  C: "C",
+  D: "D",
+  F: "F",
+} as const;
+/**
+ * Quality grade: A (excellent), B (good), C (acceptable), D (poor), F (fail)
+ */
+export type Grade = ClosedEnum<typeof Grade>;
+
+/**
+ * Smart match quality evaluation (considers building scores, confidence gaps, unambiguity)
+ */
+export type MatchQuality = {
+  /**
+   * Recommended action based on match quality
+   */
+  action: Action;
+  /**
+   * Individual factors contributing to quality assessment
+   */
+  factors: Factors;
+  /**
+   * Quality grade: A (excellent), B (good), C (acceptable), D (poor), F (fail)
+   */
+  grade: Grade;
+  /**
+   * Whether the match is reliable enough for automatic use
+   */
+  isReliable: boolean;
+  /**
+   * Human-readable explanation of the quality assessment
+   */
+  reason: string;
+  /**
+   * Confidence gap between top 2 results (0-100)
+   */
+  unambiguityScore: number;
+};
+
+/**
+ * ONS AIMS Hopper structural scores
+ */
+export type HopperComponents = {
+  /**
+   * Building score (1.0 = exact number match)
+   */
+  building: number;
+  /**
+   * Locality score (street, town, postcode)
+   */
+  locality: number;
+  /**
+   * Unit score (flat/sub-building)
+   */
+  unit: number;
+};
+
 /**
  * Source of the match
  */
 export const Source = {
+  Elasticsearch: "elasticsearch",
   ElasticsearchExact: "elasticsearch-exact",
   ElasticsearchPartial: "elasticsearch-partial",
   ElasticsearchFuzzy: "elasticsearch-fuzzy",
@@ -122,6 +234,10 @@ export type Matches = {
    * Match confidence score (0-100)
    */
   confidence: number;
+  /**
+   * ONS AIMS Hopper structural scores
+   */
+  hopperComponents?: HopperComponents | undefined;
   /**
    * Original parsed address fragment
    */
@@ -200,10 +316,6 @@ export type ResolveAddressMetadata = {
    * Total execution time in milliseconds
    */
   executionTimeMs: number;
-  /**
-   * Whether fast-path matching was used
-   */
-  fastPath?: boolean | undefined;
   /**
    * Detected address pattern type
    */
@@ -214,6 +326,18 @@ export type ResolveAddressMetadata = {
   processingSteps?: Array<ProcessingSteps> | undefined;
 };
 
+/**
+ * Recommendation: A (Accept - safe to auto-accept) or I (Intervention - requires human review)
+ */
+export const RecommendationCode = {
+  A: "A",
+  I: "I",
+} as const;
+/**
+ * Recommendation: A (Accept - safe to auto-accept) or I (Intervention - requires human review)
+ */
+export type RecommendationCode = ClosedEnum<typeof RecommendationCode>;
+
 /**
  * Matching results (only present on success)
  */
@@ -222,6 +346,14 @@ export type Result = {
    * Overall confidence score of the results
    */
   confidence: number;
+  /**
+   * Confidence zone: H (High, >66%), M (Medium, 50-66%), L (Low, <50%)
+   */
+  confidenceZone?: ConfidenceZone | undefined;
+  /**
+   * Smart match quality evaluation (considers building scores, confidence gaps, unambiguity)
+   */
+  matchQuality?: MatchQuality | undefined;
   /**
    * Array of matched addresses
    */
@@ -230,6 +362,14 @@ export type Result = {
    * Metadata about the matching process
    */
   metadata: ResolveAddressMetadata;
+  /**
+   * Recommendation: A (Accept - safe to auto-accept) or I (Intervention - requires human review)
+   */
+  recommendationCode?: RecommendationCode | undefined;
+  /**
+   * Gap between top-2 match confidences (0-100). Higher values indicate clearer match distinction.
+   */
+  unambiguityScore?: number | undefined;
 };
 
 /**
@@ -388,6 +528,84 @@ export function resolveAddressAddressResponseBodyFromJSON(
   );
 }
 
+/** @internal */
+export const ConfidenceZone$inboundSchema: z.ZodNativeEnum<
+  typeof ConfidenceZone
+> = z.nativeEnum(ConfidenceZone);
+
+/** @internal */
+export const Action$inboundSchema: z.ZodNativeEnum<typeof Action> = z
+  .nativeEnum(Action);
+
+/** @internal */
+export const Factors$inboundSchema: z.ZodType<Factors, z.ZodTypeDef, unknown> =
+  z.object({
+    hasClearWinner: z.boolean(),
+    hasHighConfidence: z.boolean(),
+    hasPerfectBuildingMatch: z.boolean(),
+    isSingleResult: z.boolean(),
+  });
+
+export function factorsFromJSON(
+  jsonString: string,
+): SafeParseResult<Factors, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Factors$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Factors' from JSON`,
+  );
+}
+
+/** @internal */
+export const Grade$inboundSchema: z.ZodNativeEnum<typeof Grade> = z.nativeEnum(
+  Grade,
+);
+
+/** @internal */
+export const MatchQuality$inboundSchema: z.ZodType<
+  MatchQuality,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  action: Action$inboundSchema,
+  factors: z.lazy(() => Factors$inboundSchema),
+  grade: Grade$inboundSchema,
+  isReliable: z.boolean(),
+  reason: z.string(),
+  unambiguityScore: z.number(),
+});
+
+export function matchQualityFromJSON(
+  jsonString: string,
+): SafeParseResult<MatchQuality, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => MatchQuality$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'MatchQuality' from JSON`,
+  );
+}
+
+/** @internal */
+export const HopperComponents$inboundSchema: z.ZodType<
+  HopperComponents,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  building: z.number(),
+  locality: z.number(),
+  unit: z.number(),
+});
+
+export function hopperComponentsFromJSON(
+  jsonString: string,
+): SafeParseResult<HopperComponents, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => HopperComponents$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'HopperComponents' from JSON`,
+  );
+}
+
 /** @internal */
 export const Source$inboundSchema: z.ZodNativeEnum<typeof Source> = z
   .nativeEnum(Source);
@@ -397,6 +615,7 @@ export const Matches$inboundSchema: z.ZodType<Matches, z.ZodTypeDef, unknown> =
   z.object({
     address: z.string(),
     confidence: z.number(),
+    hopperComponents: z.lazy(() => HopperComponents$inboundSchema).optional(),
     originalAddress: z.string(),
     source: Source$inboundSchema,
     uprn: z.string(),
@@ -452,7 +671,6 @@ export const ResolveAddressMetadata$inboundSchema: z.ZodType<
 > = z.object({
   addressCount: z.number(),
   executionTimeMs: z.number(),
-  fastPath: z.boolean().optional(),
   pattern: Pattern$inboundSchema,
   processingSteps: z.array(z.lazy(() => ProcessingSteps$inboundSchema))
     .optional(),
@@ -468,12 +686,21 @@ export function resolveAddressMetadataFromJSON(
   );
 }
 
+/** @internal */
+export const RecommendationCode$inboundSchema: z.ZodNativeEnum<
+  typeof RecommendationCode
+> = z.nativeEnum(RecommendationCode);
+
 /** @internal */
 export const Result$inboundSchema: z.ZodType<Result, z.ZodTypeDef, unknown> = z
   .object({
     confidence: z.number(),
+    confidenceZone: ConfidenceZone$inboundSchema.optional(),
+    matchQuality: z.lazy(() => MatchQuality$inboundSchema).optional(),
     matches: z.array(z.lazy(() => Matches$inboundSchema)),
     metadata: z.lazy(() => ResolveAddressMetadata$inboundSchema),
+    recommendationCode: RecommendationCode$inboundSchema.optional(),
+    unambiguityScore: z.number().optional(),
   });
 
 export function resultFromJSON(