@vepler/sdk 2.18.12 → 2.20.2

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/resolveaddress.ts

@@ -110,10 +110,109 @@ export const ConfidenceZone = {
  */
 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",
@@ -135,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
    */
@@ -247,6 +350,10 @@ export type Result = {
    * 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
    */
@@ -426,6 +533,79 @@ 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);
@@ -435,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(),
@@ -515,6 +696,7 @@ 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(),

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

@@ -0,0 +1,191 @@
+/*
+ * 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 {
+  CouncilBranding,
+  CouncilBranding$inboundSchema,
+} from "./councilbranding.js";
+import {
+  CouncilContactDetails,
+  CouncilContactDetails$inboundSchema,
+} from "./councilcontactdetails.js";
+import {
+  CouncilMetadata,
+  CouncilMetadata$inboundSchema,
+} from "./councilmetadata.js";
+import {
+  CouncilServiceUrls,
+  CouncilServiceUrls$inboundSchema,
+} from "./councilserviceurls.js";
+
+/**
+ * Country code (GB = Great Britain, IE = Ireland)
+ */
+export const Country = {
+  Gb: "GB",
+  Ie: "IE",
+} as const;
+/**
+ * Country code (GB = Great Britain, IE = Ireland)
+ */
+export type Country = ClosedEnum<typeof Country>;
+
+/**
+ * Object type identifier
+ */
+export const ObjectT = {
+  Council: "council",
+} as const;
+/**
+ * Object type identifier
+ */
+export type ObjectT = ClosedEnum<typeof ObjectT>;
+
+/**
+ * Current operational status
+ */
+export const Status = {
+  Active: "active",
+  Merged: "merged",
+  Abolished: "abolished",
+  Inactive: "inactive",
+} as const;
+/**
+ * Current operational status
+ */
+export type Status = ClosedEnum<typeof Status>;
+
+/**
+ * Council type classification
+ */
+export const Type = {
+  Unitary: "unitary",
+  Metropolitan: "metropolitan",
+  County: "county",
+  LondonBorough: "london_borough",
+  District: "district",
+  LocalAuthority: "local_authority",
+} as const;
+/**
+ * Council type classification
+ */
+export type Type = ClosedEnum<typeof Type>;
+
+export type Council = {
+  branding?: CouncilBranding | undefined;
+  contactDetails?: CouncilContactDetails | undefined;
+  /**
+   * Irish council code
+   */
+  councilCode?: string | null | undefined;
+  /**
+   * Country code (GB = Great Britain, IE = Ireland)
+   */
+  country: Country;
+  /**
+   * Creation timestamp in ISO format
+   */
+  createdAt: string;
+  /**
+   * Government Statistical Service code
+   */
+  gssCode: string | null;
+  /**
+   * Unique council identifier
+   */
+  id: string;
+  metadata?: CouncilMetadata | undefined;
+  /**
+   * Official council name
+   */
+  name: string;
+  /**
+   * Normalised name for matching
+   */
+  normalisedName: string;
+  /**
+   * Object type identifier
+   */
+  object: ObjectT;
+  /**
+   * Office for National Statistics code
+   */
+  onsCode: string | null;
+  /**
+   * Provider identifier for integrations
+   */
+  providerId: string | null;
+  serviceUrls?: CouncilServiceUrls | undefined;
+  /**
+   * Current operational status
+   */
+  status: Status;
+  /**
+   * Council type classification
+   */
+  type: Type | null;
+  /**
+   * Last update timestamp in ISO format
+   */
+  updatedAt: string;
+  /**
+   * Whether the council data has been verified
+   */
+  verified: boolean;
+};
+
+/** @internal */
+export const Country$inboundSchema: z.ZodNativeEnum<typeof Country> = z
+  .nativeEnum(Country);
+
+/** @internal */
+export const ObjectT$inboundSchema: z.ZodNativeEnum<typeof ObjectT> = z
+  .nativeEnum(ObjectT);
+
+/** @internal */
+export const Status$inboundSchema: z.ZodNativeEnum<typeof Status> = z
+  .nativeEnum(Status);
+
+/** @internal */
+export const Type$inboundSchema: z.ZodNativeEnum<typeof Type> = z.nativeEnum(
+  Type,
+);
+
+/** @internal */
+export const Council$inboundSchema: z.ZodType<Council, z.ZodTypeDef, unknown> =
+  z.object({
+    branding: CouncilBranding$inboundSchema.optional(),
+    contactDetails: CouncilContactDetails$inboundSchema.optional(),
+    councilCode: z.nullable(z.string()).optional(),
+    country: Country$inboundSchema,
+    createdAt: z.string(),
+    gssCode: z.nullable(z.string()),
+    id: z.string(),
+    metadata: CouncilMetadata$inboundSchema.optional(),
+    name: z.string(),
+    normalisedName: z.string(),
+    object: ObjectT$inboundSchema,
+    onsCode: z.nullable(z.string()),
+    providerId: z.nullable(z.string()),
+    serviceUrls: CouncilServiceUrls$inboundSchema.optional(),
+    status: Status$inboundSchema,
+    type: z.nullable(Type$inboundSchema),
+    updatedAt: z.string(),
+    verified: z.boolean(),
+  });
+
+export function councilFromJSON(
+  jsonString: string,
+): SafeParseResult<Council, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Council$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Council' from JSON`,
+  );
+}

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

@@ -0,0 +1,77 @@
+/*
+ * 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 SocialMedia = {
+  facebook?: string | undefined;
+  instagram?: string | undefined;
+  linkedin?: string | undefined;
+  twitter?: string | undefined;
+  youtube?: string | undefined;
+};
+
+export type CouncilBranding = {
+  /**
+   * URL to council logo
+   */
+  logoUrl?: string | undefined;
+  /**
+   * Primary brand colour (hex)
+   */
+  primaryColour?: string | undefined;
+  /**
+   * Secondary brand colour (hex)
+   */
+  secondaryColour?: string | undefined;
+  socialMedia?: SocialMedia | undefined;
+};
+
+/** @internal */
+export const SocialMedia$inboundSchema: z.ZodType<
+  SocialMedia,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  facebook: z.string().optional(),
+  instagram: z.string().optional(),
+  linkedin: z.string().optional(),
+  twitter: z.string().optional(),
+  youtube: z.string().optional(),
+});
+
+export function socialMediaFromJSON(
+  jsonString: string,
+): SafeParseResult<SocialMedia, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SocialMedia$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SocialMedia' from JSON`,
+  );
+}
+
+/** @internal */
+export const CouncilBranding$inboundSchema: z.ZodType<
+  CouncilBranding,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  logoUrl: z.string().optional(),
+  primaryColour: z.string().optional(),
+  secondaryColour: z.string().optional(),
+  socialMedia: z.lazy(() => SocialMedia$inboundSchema).optional(),
+});
+
+export function councilBrandingFromJSON(
+  jsonString: string,
+): SafeParseResult<CouncilBranding, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CouncilBranding$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CouncilBranding' from JSON`,
+  );
+}