@vepler/sdk 6.8.0 → 6.36.0

package/src/funcs/modelsPostV1AiResponses.ts

@@ -0,0 +1,175 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { SDKCore } from "../core.js";
+import { encodeJSON } from "../lib/encodings.js";
+import { matchStatusCode } from "../lib/http.js";
+import * as M from "../lib/matchers.js";
+import { compactMap } from "../lib/primitives.js";
+import { safeParse } from "../lib/schemas.js";
+import { RequestOptions } from "../lib/sdks.js";
+import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
+import { pathToFunc } from "../lib/url.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../sdk/models/errors/httpclienterrors.js";
+import * as errors from "../sdk/models/errors/index.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 shared from "../sdk/models/shared/index.js";
+import { APICall, APIPromise } from "../sdk/types/async.js";
+import { Result } from "../sdk/types/fp.js";
+
+/**
+ * Run a model (Responses)
+ *
+ * @remarks
+ * Runs a model on one input and returns its result as one `output_text` holding one JSON object. Send exactly one user message holding one `input_image` part. Charged, and repeats served from cache, exactly as chat completions. Streaming is not supported on this route.
+ */
+export function modelsPostV1AiResponses(
+  client: SDKCore,
+  request: shared.ResponseRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    shared.ModelResponse,
+    | errors.ModelApiError
+    | SDKBaseError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: SDKCore,
+  request: shared.ResponseRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      shared.ModelResponse,
+      | errors.ModelApiError
+      | SDKBaseError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) => shared.ResponseRequest$outboundSchema.parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = encodeJSON("body", payload, { explode: true });
+
+  const path = pathToFunc("/v1/ai/responses")();
+
+  const headers = new Headers(compactMap({
+    "Content-Type": "application/json",
+    Accept: "application/json",
+  }));
+
+  const secConfig = await extractSecurity(client._options.apiKeyAuth);
+  const securityInput = secConfig == null ? {} : { apiKeyAuth: secConfig };
+  const requestSecurity = resolveGlobalSecurity(securityInput);
+
+  const context = {
+    options: client._options,
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
+    operationID: "post_/v1/ai/responses",
+    oAuth2Scopes: null,
+
+    resolvedSecurity: requestSecurity,
+
+    securitySource: client._options.apiKeyAuth,
+    retryConfig: options?.retries
+      || client._options.retryConfig
+      || { strategy: "none" },
+    retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
+  };
+
+  const requestRes = client._createRequest(context, {
+    security: requestSecurity,
+    method: "POST",
+    baseURL: options?.serverURL,
+    path: path,
+    headers: headers,
+    body: body,
+    userAgent: client._options.userAgent,
+    timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
+  }, options);
+  if (!requestRes.ok) {
+    return [requestRes, { status: "invalid" }];
+  }
+  const req = requestRes.value;
+
+  const doResult = await client._do(req, {
+    context,
+    isErrorStatusCode: (statusCode: number) =>
+      matchStatusCode({ status: statusCode } as Response, ["4XX", "5XX"]),
+    retryConfig: context.retryConfig,
+    retryCodes: context.retryCodes,
+  });
+  if (!doResult.ok) {
+    return [doResult, { status: "request-error", request: req }];
+  }
+  const response = doResult.value;
+
+  const responseFields = {
+    HttpMeta: { Response: response, Request: req },
+  };
+
+  const [result] = await M.match<
+    shared.ModelResponse,
+    | errors.ModelApiError
+    | SDKBaseError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, shared.ModelResponse$inboundSchema),
+    M.jsonErr(
+      [400, 401, 402, 403, 404, 413, 429],
+      errors.ModelApiError$inboundSchema,
+    ),
+    M.jsonErr([500, 503], errors.ModelApiError$inboundSchema),
+    M.fail("4XX"),
+    M.fail("5XX"),
+  )(response, req, { extraFields: responseFields });
+  if (!result.ok) {
+    return [result, { status: "complete", request: req, response }];
+  }
+
+  return [result, { status: "complete", request: req, response }];
+}

package/src/funcs/searchSearchSuggest.ts

@@ -97,6 +97,7 @@ async function $do(
   const query = encodeFormQuery({
     "addressable_only": payload.addressable_only,
     "classification": payload.classification,
+    "dataset": payload.dataset,
     "geo_mode": payload.geo_mode,
     "granularity": payload.granularity,
     "lat": payload.lat,

package/src/funcs/sitesGet.ts

@@ -31,7 +31,7 @@ import { Result } from "../sdk/types/fp.js";
  * Get site by ID
  *
  * @remarks
- * Retrieve one registered title by its identifier, which joins the country, the registry and the title number with colons, as in `GB:NPS:AGL123456`. This endpoint returns every attribute, including the boundary geometry, ownership, property statistics, planning statistics and area metrics.
+ * Retrieve one registered title by its identifier, which joins the country, the registry and the title number with colons, as in `GB:LR:AGL123456`. This endpoint returns every attribute, including the boundary geometry, ownership, property statistics, planning statistics and area metrics.
  */
 export function sitesGet(
   client: SDKCore,

package/src/funcs/streetsSearchStreets.ts

@@ -30,7 +30,7 @@ import { Result } from "../sdk/types/fp.js";
  * Query streets by any identifier
  *
  * @remarks
- * Returns the streets picked out by one of five identifiers: a USRN, a UPRN, a coordinate and radius, a name search, or a postcode. Each street comes back with its reference number, the coordinates of its start and end, and its name in each language it is recorded in. When an identifier matches no street, the response is an empty list with a `message` explaining which one missed.
+ * Returns the streets picked out by one of five identifiers: a USRN, a UPRN, a coordinate and radius, a name search, or a postcode. Each street comes back with its reference number, the dataset that supplied it, its name in each language it is recorded in, its place names and a representative point. `dataset` chooses between Ordnance Survey open data, the Ordnance Survey National Geographic Database (NGD), or open data with the NGD answering only where the open data has nothing. Name, coordinate and postcode lookups are paged: pass the `id` of the last street as `starting_after` while `has_more` is true. Responses that carry open data include the `attribution` that must be shown with it. When an identifier matches no street, the response is an empty list with a `message` explaining which one missed.
  */
 export function streetsSearchStreets(
   client: SDKCore,

package/src/lib/config.ts

@@ -60,8 +60,8 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
 
 export const SDK_METADATA = {
   language: "typescript",
-  openapiDocVersion: "6.8.0",
+  openapiDocVersion: "6.36.0",
   sdkVersion: "0.12.0",
-  genVersion: "2.937.18",
-  userAgent: "speakeasy-sdk/typescript 0.12.0 2.937.18 6.8.0 @vepler/sdk",
+  genVersion: "2.943.0",
+  userAgent: "speakeasy-sdk/typescript 0.12.0 2.943.0 6.36.0 @vepler/sdk",
 } as const;

package/src/sdk/geography.ts

@@ -17,7 +17,7 @@ export class Geography extends ClientSDK {
    * Everything containing this area
    *
    * @remarks
-   * Walks the whole way up in one read: the containing area at every tier, with how many hops away it is and the worst fit along that path. Check `minFit` before aggregating — an LSOA reaches its local authority by best fit in the current release, because the exact-fit spine exists only at the 2022 boundaries.
+   * Walks the whole way up in one read: the containing area at every tier, with how many hops away it is and the worst fit along that path. Check `minFit` before aggregating: an LSOA reaches its local authority by best fit in the current release, because the exact-fit spine exists only at the 2022 boundaries.
    */
   async getGeographyAncestors(
     request: operations.GetGeographyAncestorsRequest,
@@ -34,7 +34,7 @@ export class Geography extends ClientSDK {
    * Look up areas by code
    *
    * @remarks
-   * Resolves up to 100 comma-separated GSS codes to their name, type, vintage, nation and tier. A code can legitimately exist at more than one layer or edition, so every match is returned — narrow with `areaType` when a single answer is wanted.
+   * Resolves up to 100 comma-separated GSS codes to their name, type, vintage, nation and tier. A code can legitimately exist at more than one layer or edition, so every match is returned. Narrow with `areaType` when you want a single answer.
    */
   async getGeographyAreas(
     request: operations.GetGeographyAreasRequest,
@@ -68,7 +68,7 @@ export class Geography extends ClientSDK {
    * Everything inside this area
    *
    * @remarks
-   * Paged, because the honest answer can be very large — England and Wales hold 188,880 Output Areas. `total_count` reports the full size of the set being paged through. Note that every unitary authority is both a district and a county under one code, so narrow with `areaType` or each descendant is returned once per matching type.
+   * Paged, because the set can be very large: England and Wales hold 188,880 Output Areas. `total_count` reports the full size of the set being paged through. Note that every unitary authority is both a district and a county under one code, so narrow with `areaType` or each descendant is returned once per matching type.
    */
   async getGeographyDescendants(
     request: operations.GetGeographyDescendantsRequest,
@@ -85,7 +85,7 @@ export class Geography extends ClientSDK {
    * Where this area's record came from
    *
    * @remarks
-   * The publisher, the pinned file, its licence, and the acknowledgement line that licence requires — verbatim, because the wording differs per custodian and anyone redistributing this data has to reproduce it. `sha256` identifies the exact file the record was parsed from; `fromArchive` is true when the publisher was unreachable and the bytes came from our own archive.
+   * The publisher, the pinned file, its licence, and the acknowledgement line that licence requires, verbatim, because the wording differs per custodian and anyone redistributing this data has to reproduce it. `sha256` identifies the exact file the record was parsed from; `fromArchive` is true when the publisher was unreachable and the file came from Vepler's archive.
    */
   async getGeographyProvenance(
     request: operations.GetGeographyProvenanceRequest,
@@ -102,7 +102,7 @@ export class Geography extends ClientSDK {
    * Get the current geography release
    *
    * @remarks
-   * Returns the release every other geography endpoint answers from unless one is pinned. A release is a named set of publisher vintages that compose into one consistent tree — the nations publish on their own cycles, so a UK-wide release is a composition rather than a date.
+   * Returns the release every other geography endpoint answers from unless one is pinned. A release is a named set of publisher vintages that compose into one consistent tree. The nations publish on their own cycles, so a UK-wide release is a composition rather than a date.
    */
   async getGeographyRelease(
     options?: RequestOptions,

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

@@ -113,6 +113,7 @@ export * from "./listschoolschangelog.js";
 export * from "./lookupoutcode.js";
 export * from "./lookuppostcode.js";
 export * from "./lookupuprn.js";
+export * from "./modelapierror.js";
 export * from "./postcensusareaprofile.js";
 export * from "./postcensusrollup.js";
 export * from "./postv1titledeedstitlenumberpurchase.js";

package/src/sdk/models/errors/modelapierror.ts

@@ -0,0 +1,118 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../../lib/schemas.js";
+import * as openEnums from "../../types/enums.js";
+import { OpenEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKBaseError } from "./sdkbaseerror.js";
+import { SDKValidationError } from "./sdkvalidationerror.js";
+
+/**
+ * Broad category of the failure: a request problem, an authentication problem, a rate limit or a server fault.
+ */
+export const SchemasModelApiErrorType = {
+  InvalidRequestError: "invalid_request_error",
+  AuthenticationError: "authentication_error",
+  RateLimitError: "rate_limit_error",
+  ApiError: "api_error",
+} as const;
+/**
+ * Broad category of the failure: a request problem, an authentication problem, a rate limit or a server fault.
+ */
+export type SchemasModelApiErrorType = OpenEnum<
+  typeof SchemasModelApiErrorType
+>;
+
+export type SchemasModelApiErrorError = {
+  /**
+   * Stable code identifying the failure, safe to branch on, or null.
+   */
+  code: string | null;
+  /**
+   * Human-readable explanation of what went wrong.
+   */
+  message: string;
+  /**
+   * Request parameter at fault, or null when the failure has none.
+   */
+  param: string | null;
+  /**
+   * Broad category of the failure: a request problem, an authentication problem, a rate limit or a server fault.
+   */
+  type: SchemasModelApiErrorType;
+};
+
+export type ModelApiErrorData = {
+  error: SchemasModelApiErrorError;
+};
+
+export class ModelApiError extends SDKBaseError {
+  error: SchemasModelApiErrorError;
+
+  /** The original data that was passed to this error instance. */
+  data$: ModelApiErrorData;
+
+  constructor(
+    err: ModelApiErrorData,
+    httpMeta: { response: Response; request: Request; body: string },
+  ) {
+    const message = err.error?.message
+      || `API error occurred: ${JSON.stringify(err)}`;
+    super(message, httpMeta);
+    this.data$ = err;
+    this.error = err.error;
+
+    this.name = "ModelApiError";
+  }
+}
+
+/** @internal */
+export const SchemasModelApiErrorType$inboundSchema: z.ZodType<
+  SchemasModelApiErrorType,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(SchemasModelApiErrorType);
+
+/** @internal */
+export const SchemasModelApiErrorError$inboundSchema: z.ZodType<
+  SchemasModelApiErrorError,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  code: z.nullable(z.string()),
+  message: z.string(),
+  param: z.nullable(z.string()),
+  type: SchemasModelApiErrorType$inboundSchema,
+});
+
+export function schemasModelApiErrorErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<SchemasModelApiErrorError, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SchemasModelApiErrorError$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SchemasModelApiErrorError' from JSON`,
+  );
+}
+
+/** @internal */
+export const ModelApiError$inboundSchema: z.ZodType<
+  ModelApiError,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  error: z.lazy(() => SchemasModelApiErrorError$inboundSchema),
+  request$: z.instanceof(Request),
+  response$: z.instanceof(Response),
+  body$: z.string(),
+})
+  .transform((v) => {
+    return new ModelApiError(v, {
+      request: v.request$,
+      response: v.response$,
+      body: v.body$,
+    });
+  });

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

@@ -1427,7 +1427,7 @@ export type Fabric = {
 };
 
 /**
- * Whether the building meets the Minimum Energy Efficiency Standard, worked out from the current rating band, the certificate type and the nation. `compliant` covers bands A to D, `non_compliant` bands F and G, and `at_risk` marks band E as lettable today with no headroom under the expected tightening to C. The standard is SI 2015/962, which covers both domestic and non-domestic private rented property in England and Wales but does not extend to Scotland, and which is assessed on an asset rating rather than the operational rating a Display Energy Certificate carries — so Scottish certificates and DECs are `not_applicable`. `exempt` means a registered PRS exemption and appears only on legacy rows; it is never derived from certificate data. `unknown` means there is not enough data to decide.
+ * Whether the building meets the Minimum Energy Efficiency Standard, worked out from the current rating band, the certificate type and the nation. `compliant` covers bands A to D, `non_compliant` bands F and G, and `at_risk` marks band E as lettable today with no headroom under the expected tightening to C. The standard is SI 2015/962, which covers both domestic and non-domestic private rented property in England and Wales but does not extend to Scotland, and which is assessed on an asset rating rather than the operational rating a Display Energy Certificate carries. Scottish certificates and DECs are therefore `not_applicable`. `exempt` means a registered PRS exemption and appears only on legacy rows; it is never derived from certificate data. `unknown` means there is not enough data to decide.
  */
 export const MeesCompliance = {
   Compliant: "compliant",
@@ -1438,7 +1438,7 @@ export const MeesCompliance = {
   Unknown: "unknown",
 } as const;
 /**
- * Whether the building meets the Minimum Energy Efficiency Standard, worked out from the current rating band, the certificate type and the nation. `compliant` covers bands A to D, `non_compliant` bands F and G, and `at_risk` marks band E as lettable today with no headroom under the expected tightening to C. The standard is SI 2015/962, which covers both domestic and non-domestic private rented property in England and Wales but does not extend to Scotland, and which is assessed on an asset rating rather than the operational rating a Display Energy Certificate carries — so Scottish certificates and DECs are `not_applicable`. `exempt` means a registered PRS exemption and appears only on legacy rows; it is never derived from certificate data. `unknown` means there is not enough data to decide.
+ * Whether the building meets the Minimum Energy Efficiency Standard, worked out from the current rating band, the certificate type and the nation. `compliant` covers bands A to D, `non_compliant` bands F and G, and `at_risk` marks band E as lettable today with no headroom under the expected tightening to C. The standard is SI 2015/962, which covers both domestic and non-domestic private rented property in England and Wales but does not extend to Scotland, and which is assessed on an asset rating rather than the operational rating a Display Energy Certificate carries. Scottish certificates and DECs are therefore `not_applicable`. `exempt` means a registered PRS exemption and appears only on legacy rows; it is never derived from certificate data. `unknown` means there is not enough data to decide.
  */
 export type MeesCompliance = OpenEnum<typeof MeesCompliance>;
 
@@ -2377,7 +2377,7 @@ export type GetEpcByLocationIdData = {
    */
   lodgementDate: string;
   /**
-   * Whether the building meets the Minimum Energy Efficiency Standard, worked out from the current rating band, the certificate type and the nation. `compliant` covers bands A to D, `non_compliant` bands F and G, and `at_risk` marks band E as lettable today with no headroom under the expected tightening to C. The standard is SI 2015/962, which covers both domestic and non-domestic private rented property in England and Wales but does not extend to Scotland, and which is assessed on an asset rating rather than the operational rating a Display Energy Certificate carries — so Scottish certificates and DECs are `not_applicable`. `exempt` means a registered PRS exemption and appears only on legacy rows; it is never derived from certificate data. `unknown` means there is not enough data to decide.
+   * Whether the building meets the Minimum Energy Efficiency Standard, worked out from the current rating band, the certificate type and the nation. `compliant` covers bands A to D, `non_compliant` bands F and G, and `at_risk` marks band E as lettable today with no headroom under the expected tightening to C. The standard is SI 2015/962, which covers both domestic and non-domestic private rented property in England and Wales but does not extend to Scotland, and which is assessed on an asset rating rather than the operational rating a Display Energy Certificate carries. Scottish certificates and DECs are therefore `not_applicable`. `exempt` means a registered PRS exemption and appears only on legacy rows; it is never derived from certificate data. `unknown` means there is not enough data to decide.
    */
   meesCompliance: MeesCompliance;
   /**

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

@@ -30,7 +30,7 @@ export type GetGeographyChildrenRequest = {
 
 export type GetGeographyChildrenData = {
   /**
-   * The layer as its publisher names it — `lsoa`, `sct_dz`, `nir_dz`. Never carries a vintage.
+   * The layer as its publisher names it, such as `lsoa`, `sct_dz` or `nir_dz`. Never carries a vintage.
    */
   areaType: string;
   /**
@@ -39,7 +39,7 @@ export type GetGeographyChildrenData = {
   code: string;
   fitType: string;
   /**
-   * Publisher name. Null where none is published — ONS issues no names for Output Areas — and never unique, so never key on it.
+   * Publisher name. Null where none is published (ONS issues no names for Output Areas). Names are not unique, so never key on one.
    */
   name: string | null;
   /**

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

@@ -0,0 +1,34 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+
+export type GetV1AiModelsModelRequest = {
+  /**
+   * Id of the model.
+   */
+  model: string;
+};
+
+/** @internal */
+export type GetV1AiModelsModelRequest$Outbound = {
+  model: string;
+};
+
+/** @internal */
+export const GetV1AiModelsModelRequest$outboundSchema: z.ZodType<
+  GetV1AiModelsModelRequest$Outbound,
+  z.ZodTypeDef,
+  GetV1AiModelsModelRequest
+> = z.object({
+  model: z.string(),
+});
+
+export function getV1AiModelsModelRequestToJSON(
+  getV1AiModelsModelRequest: GetV1AiModelsModelRequest,
+): string {
+  return JSON.stringify(
+    GetV1AiModelsModelRequest$outboundSchema.parse(getV1AiModelsModelRequest),
+  );
+}

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

@@ -91,6 +91,7 @@ export * from "./getsubstationcapacity.js";
 export * from "./getsubstationdfes.js";
 export * from "./gettransactionbyid.js";
 export * from "./gettransactionsbyuprn.js";
+export * from "./getv1aimodelsmodel.js";
 export * from "./getv1titledeedstitlenumber.js";
 export * from "./getv1titledeedstitlenumberapplications.js";
 export * from "./getv1titledeedstitlenumberavailability.js";
@@ -106,6 +107,7 @@ export * from "./lookuppostcode.js";
 export * from "./lookupuprn.js";
 export * from "./postcensusareaprofile.js";
 export * from "./postcensusrollup.js";
+export * from "./postv1aichatcompletions.js";
 export * from "./postv1titledeedstitlenumberpurchase.js";
 export * from "./postv1titledeedstitlenumberpurchaseasync.js";
 export * from "./querylistings.js";

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

@@ -0,0 +1,28 @@
+/*
+ * 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 * as shared from "../shared/index.js";
+
+export type PostV1AiChatCompletionsResponse = shared.ChatCompletion | string;
+
+/** @internal */
+export const PostV1AiChatCompletionsResponse$inboundSchema: z.ZodType<
+  PostV1AiChatCompletionsResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.union([shared.ChatCompletion$inboundSchema, z.string()]);
+
+export function postV1AiChatCompletionsResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<PostV1AiChatCompletionsResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PostV1AiChatCompletionsResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PostV1AiChatCompletionsResponse' from JSON`,
+  );
+}

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

@@ -307,6 +307,10 @@ export type RecommendationCode = OpenEnum<typeof RecommendationCode>;
  * The matches and how they were arrived at. Present when the resolution succeeded.
  */
 export type Result = {
+  /**
+   * 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;
   /**
    * Overall confidence in this result set, from 0 to 100.
    */
@@ -586,6 +590,7 @@ export const RecommendationCode$inboundSchema: z.ZodType<
 /** @internal */
 export const Result$inboundSchema: z.ZodType<Result, z.ZodTypeDef, unknown> = z
   .object({
+    attribution: z.string().optional(),
     confidence: z.number(),
     confidenceZone: ConfidenceZone$inboundSchema.optional(),
     matchQuality: z.lazy(() => MatchQuality$inboundSchema).optional(),

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

@@ -31,6 +31,21 @@ export const Classification = {
  */
 export type Classification = ClosedEnum<typeof Classification>;
 
+/**
+ * Which street dataset street results are read from, with `granularity=street` only. '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 with any other granularity.
+ */
+export const SearchSuggestQueryParamDataset = {
+  Open: "open",
+  Ngd: "ngd",
+  OpenThenNgd: "open_then_ngd",
+} as const;
+/**
+ * Which street dataset street results are read from, with `granularity=street` only. '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 with any other granularity.
+ */
+export type SearchSuggestQueryParamDataset = ClosedEnum<
+  typeof SearchSuggestQueryParamDataset
+>;
+
 /**
  * How the centre point shapes results, applied only when `lat` and `lng` are both supplied. 'bias', the default, is a soft preference: the best text matches are still returned, but results near the point rank higher. 'restrict' is a hard cutoff: only results within `radius_meters` of the point are returned, and `radius_meters` becomes required. Applies to address results.
  */
@@ -64,6 +79,10 @@ export type SearchSuggestRequest = {
    * Filter address results by how the property is used. 'residential' covers dwellings, including houses, flats and houses in multiple occupation. 'commercial' covers non-residential premises such as offices, retail and warehouses. 'all' applies no filter. Defaults to 'residential'.
    */
   classification?: Classification | undefined;
+  /**
+   * Which street dataset street results are read from, with `granularity=street` only. '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 with any other granularity.
+   */
+  dataset?: SearchSuggestQueryParamDataset | undefined;
   /**
    * How the centre point shapes results, applied only when `lat` and `lng` are both supplied. 'bias', the default, is a soft preference: the best text matches are still returned, but results near the point rank higher. 'restrict' is a hard cutoff: only results within `radius_meters` of the point are returned, and `radius_meters` becomes required. Applies to address results.
    */
@@ -116,6 +135,11 @@ export const Classification$outboundSchema: z.ZodNativeEnum<
   typeof Classification
 > = z.nativeEnum(Classification);
 
+/** @internal */
+export const SearchSuggestQueryParamDataset$outboundSchema: z.ZodNativeEnum<
+  typeof SearchSuggestQueryParamDataset
+> = z.nativeEnum(SearchSuggestQueryParamDataset);
+
 /** @internal */
 export const GeoMode$outboundSchema: z.ZodNativeEnum<typeof GeoMode> = z
   .nativeEnum(GeoMode);
@@ -128,6 +152,7 @@ export const Granularity$outboundSchema: z.ZodNativeEnum<typeof Granularity> = z
 export type SearchSuggestRequest$Outbound = {
   addressable_only?: string | undefined;
   classification?: string | undefined;
+  dataset?: string | undefined;
   geo_mode?: string | undefined;
   granularity?: string | undefined;
   lat?: number | undefined;
@@ -148,6 +173,7 @@ export const SearchSuggestRequest$outboundSchema: z.ZodType<
 > = z.object({
   addressableOnly: AddressableOnly$outboundSchema.optional(),
   classification: Classification$outboundSchema.optional(),
+  dataset: SearchSuggestQueryParamDataset$outboundSchema.optional(),
   geoMode: GeoMode$outboundSchema.optional(),
   granularity: Granularity$outboundSchema.optional(),
   lat: z.number().optional(),

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

@@ -4,6 +4,10 @@
 
 import * as z from "zod/v3";
 import { ClosedEnum } from "../../types/enums.js";
+import {
+  StreetDataset,
+  StreetDataset$outboundSchema,
+} from "./streetdataset.js";
 
 /**
  * Filter matched addresses by how the property is used. 'residential' covers dwellings, including houses, flats and houses in multiple occupation. 'commercial' covers non-residential premises such as offices, retail and warehouses. 'all' applies no filter. Defaults to 'residential'.
@@ -50,6 +54,7 @@ export type Options = {
    * Minimum confidence, from 0 to 100, that a postcode-level fallback match must reach to count.
    */
   confidenceThreshold?: number | undefined;
+  dataset?: StreetDataset | undefined;
   /**
    * Allow postcode-level fallback matching when the primary match is weak or absent. Defaults to true.
    */
@@ -134,6 +139,7 @@ export function addressResolveRequestGranularityToJSON(
 export type Options$Outbound = {
   classification?: string | undefined;
   confidenceThreshold?: number | undefined;
+  dataset: string;
   enableFallback?: boolean | undefined;
   fallbackThreshold?: number | undefined;
   granularity?: string | string | undefined;
@@ -151,6 +157,7 @@ export const Options$outboundSchema: z.ZodType<
 > = z.object({
   classification: AddressResolveRequestClassification$outboundSchema.optional(),
   confidenceThreshold: z.number().optional(),
+  dataset: StreetDataset$outboundSchema.default("open_then_ngd"),
   enableFallback: z.boolean().optional(),
   fallbackThreshold: z.number().optional(),
   granularity: z.union([

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

@@ -237,7 +237,7 @@ export type SaleHistory = {
  */
 export type Valuation = {
   /**
-   * How much confidence to place in the estimate, from 0 to 1, where 1 is the most confident.
+   * How much confidence to place in the estimate, from 0 to 1, where 1 is the most confident. For a sale valuation it is one minus the typical error of past valuations of comparable properties, so 0.88 means half of those valuations landed within 12 per cent of the price the property sold for.
    */
   confidence: number;
   confidenceInterval: AVMConfidenceInterval;