@vepler/sdk 6.1.0 → 6.36.0

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.
    */
@@ -62,6 +67,10 @@ export type Options = {
    * How specific the result should be. 'address', the default, resolves to a premise and its UPRN. 'street' resolves to a named street with a representative point, for partial inputs such as 'West Street, Sheffield' that carry no building number. 'auto' tries the premise first and drops to street level when no building matches.
    */
   granularity?: AddressResolveRequest1 | AddressResolveRequest2 | undefined;
+  /**
+   * Return the matched premise's position as `coordinates` on each premise match. Defaults to false. A request that includes coordinates is charged at the full address record rate rather than the match rate.
+   */
+  includeCoordinates?: boolean | undefined;
   /**
    * Return what each stage of the match did, under `metadata.processingSteps`.
    */
@@ -130,9 +139,11 @@ 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;
+  includeCoordinates?: boolean | undefined;
   includeProcessingDetails?: boolean | undefined;
   maxResults?: number | undefined;
   timeout?: number | undefined;
@@ -146,12 +157,14 @@ 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([
     AddressResolveRequest1$outboundSchema,
     AddressResolveRequest2$outboundSchema,
   ]).optional(),
+  includeCoordinates: z.boolean().optional(),
   includeProcessingDetails: z.boolean().optional(),
   maxResults: z.number().optional(),
   timeout: z.number().optional(),

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;

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

@@ -8,15 +8,15 @@ import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 /**
- * Bounds either side of the estimate, on the same basis and in the same units as `estimatedPrice`.
+ * A range for the value, on the same basis and in the same units as `estimatedPrice`. For a sale valuation it is a nominal 80 per cent range, built from how far past valuations of comparable properties landed from the price each property sold for. That range is not centred on `estimatedPrice` and is wider where the local evidence is more varied. For a rental valuation the bounds sit the same distance either side of the estimate, in the same units, and are wider where the models behind the estimate agreed less closely.
  */
 export type AVMConfidenceInterval = {
   /**
-   * Lower bound of the estimated value range, in pounds.
+   * Lower bound of the range, in pounds.
    */
   lower: number;
   /**
-   * Upper bound of the estimated value range, in pounds.
+   * Upper bound of the range, in pounds.
    */
   upper: number;
 };

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

@@ -16,7 +16,7 @@ export type AVMMetadata = {
    */
   comparablesCount?: number | undefined;
   /**
-   * 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.
    */
   confidenceScore: number;
   /**

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

@@ -38,7 +38,7 @@ export const Epc = {
 export type Epc = ClosedEnum<typeof Epc>;
 
 /**
- * Overrides the property type held for this location.
+ * Overrides the property type held for this location. Sending `unknown` leaves the held type in place.
  */
 export const PropertyType = {
   Detached: "detached",
@@ -59,7 +59,7 @@ export const PropertyType = {
   Other: "other",
 } as const;
 /**
- * Overrides the property type held for this location.
+ * Overrides the property type held for this location. Sending `unknown` leaves the held type in place.
  */
 export type PropertyType = ClosedEnum<typeof PropertyType>;
 
@@ -114,7 +114,7 @@ export type AVMPredictByLocationRequest = {
    */
   locationId: string;
   /**
-   * Overrides the property type held for this location.
+   * Overrides the property type held for this location. Sending `unknown` leaves the held type in place.
    */
   propertyType?: PropertyType | undefined;
   /**

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

@@ -21,7 +21,7 @@ import {
  */
 export type AVMPredictResponse = {
   /**
-   * Bounds either side of `estimatedPrice`.
+   * A range for the value, in the same units as `estimatedPrice`. For a sale valuation it is a nominal 80 per cent range.
    */
   confidenceInterval: AVMConfidenceInterval;
   /**

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

@@ -0,0 +1,201 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../../lib/primitives.js";
+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";
+
+export const FinishReason = {
+  Stop: "stop",
+} as const;
+export type FinishReason = ClosedEnum<typeof FinishReason>;
+
+export const ChatCompletionRole = {
+  Assistant: "assistant",
+} as const;
+export type ChatCompletionRole = ClosedEnum<typeof ChatCompletionRole>;
+
+export type Message = {
+  /**
+   * The result: one JSON object, as a string, matching the model's output schema.
+   */
+  content: string;
+  refusal?: any | null | undefined;
+  role: ChatCompletionRole;
+};
+
+export type Choices = {
+  finishReason: FinishReason;
+  index: number;
+  logprobs?: any | null | undefined;
+  message: Message;
+};
+
+export const ChatCompletionObject = {
+  ChatCompletion: "chat.completion",
+} as const;
+export type ChatCompletionObject = ClosedEnum<typeof ChatCompletionObject>;
+
+export type Usage = {
+  /**
+   * Tokens the model produced.
+   */
+  completionTokens: number;
+  /**
+   * Tokens the model read as input, including the model's fixed instructions.
+   */
+  promptTokens: number;
+  /**
+   * Sum of prompt and completion tokens.
+   */
+  totalTokens: number;
+  /**
+   * Credits charged for this request. Zero when the result is a repeat served without charge.
+   */
+  veplerCredits: number;
+  /**
+   * Inputs charged for by this request. Zero when the result is a repeat served without charge.
+   */
+  veplerUnits: number;
+};
+
+export type ChatCompletion = {
+  /**
+   * Exactly one result.
+   */
+  choices: Array<Choices>;
+  /**
+   * Unix time in seconds when the result was produced.
+   */
+  created: number;
+  /**
+   * Identifier of this completion.
+   */
+  id: string;
+  /**
+   * Id of the model that ran.
+   */
+  model: string;
+  object: ChatCompletionObject;
+  /**
+   * Version of the model that produced the result.
+   */
+  systemFingerprint: string;
+  usage: Usage;
+};
+
+/** @internal */
+export const FinishReason$inboundSchema: z.ZodNativeEnum<typeof FinishReason> =
+  z.nativeEnum(FinishReason);
+
+/** @internal */
+export const ChatCompletionRole$inboundSchema: z.ZodNativeEnum<
+  typeof ChatCompletionRole
+> = z.nativeEnum(ChatCompletionRole);
+
+/** @internal */
+export const Message$inboundSchema: z.ZodType<Message, z.ZodTypeDef, unknown> =
+  z.object({
+    content: z.string(),
+    refusal: z.nullable(z.any()).optional(),
+    role: ChatCompletionRole$inboundSchema,
+  });
+
+export function messageFromJSON(
+  jsonString: string,
+): SafeParseResult<Message, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Message$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Message' from JSON`,
+  );
+}
+
+/** @internal */
+export const Choices$inboundSchema: z.ZodType<Choices, z.ZodTypeDef, unknown> =
+  z.object({
+    finish_reason: FinishReason$inboundSchema,
+    index: z.number().int(),
+    logprobs: z.nullable(z.any()).optional(),
+    message: z.lazy(() => Message$inboundSchema),
+  }).transform((v) => {
+    return remap$(v, {
+      "finish_reason": "finishReason",
+    });
+  });
+
+export function choicesFromJSON(
+  jsonString: string,
+): SafeParseResult<Choices, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Choices$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Choices' from JSON`,
+  );
+}
+
+/** @internal */
+export const ChatCompletionObject$inboundSchema: z.ZodNativeEnum<
+  typeof ChatCompletionObject
+> = z.nativeEnum(ChatCompletionObject);
+
+/** @internal */
+export const Usage$inboundSchema: z.ZodType<Usage, z.ZodTypeDef, unknown> = z
+  .object({
+    completion_tokens: z.number().int(),
+    prompt_tokens: z.number().int(),
+    total_tokens: z.number().int(),
+    vepler_credits: z.number().int(),
+    vepler_units: z.number().int(),
+  }).transform((v) => {
+    return remap$(v, {
+      "completion_tokens": "completionTokens",
+      "prompt_tokens": "promptTokens",
+      "total_tokens": "totalTokens",
+      "vepler_credits": "veplerCredits",
+      "vepler_units": "veplerUnits",
+    });
+  });
+
+export function usageFromJSON(
+  jsonString: string,
+): SafeParseResult<Usage, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Usage$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Usage' from JSON`,
+  );
+}
+
+/** @internal */
+export const ChatCompletion$inboundSchema: z.ZodType<
+  ChatCompletion,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  choices: z.array(z.lazy(() => Choices$inboundSchema)),
+  created: z.number().int(),
+  id: z.string(),
+  model: z.string(),
+  object: ChatCompletionObject$inboundSchema,
+  system_fingerprint: z.string(),
+  usage: z.lazy(() => Usage$inboundSchema),
+}).transform((v) => {
+  return remap$(v, {
+    "system_fingerprint": "systemFingerprint",
+  });
+});
+
+export function chatCompletionFromJSON(
+  jsonString: string,
+): SafeParseResult<ChatCompletion, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ChatCompletion$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ChatCompletion' from JSON`,
+  );
+}