@vepler/sdk 6.8.0 → 6.42.0

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`,
+  );
+}

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

@@ -0,0 +1,318 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../../lib/primitives.js";
+
+export type Messages = {
+  content?: any | undefined;
+  role: string;
+  additionalProperties?: { [k: string]: any } | undefined;
+};
+
+/**
+ * Output format: `json_object`, or `json_schema` with `name` set to the model's `output_schema_name` and `schema` either omitted or equal to its `output_schema`. The result is the same JSON object either way.
+ */
+export type ResponseFormat = {
+  type: string;
+  additionalProperties?: { [k: string]: any } | undefined;
+};
+
+/**
+ * Accepted and ignored.
+ */
+export type Stop = string | Array<string>;
+
+/**
+ * With `include_usage: true`, a final chunk carries `usage`.
+ */
+export type StreamOptions = {
+  includeUsage?: boolean | undefined;
+};
+
+export type ChatCompletionRequest = {
+  /**
+   * Accepted and ignored.
+   */
+  frequencyPenalty?: number | null | undefined;
+  /**
+   * Not supported. Any value other than `none` is refused.
+   */
+  functionCall?: any | undefined;
+  /**
+   * Not supported. A non-empty list is refused.
+   */
+  functions?: Array<any> | null | undefined;
+  /**
+   * Accepted and ignored.
+   */
+  logitBias?: { [k: string]: number } | null | undefined;
+  /**
+   * Accepted and ignored.
+   */
+  logprobs?: boolean | null | undefined;
+  /**
+   * Accepted and ignored. Each model has a fixed output limit.
+   */
+  maxCompletionTokens?: number | null | undefined;
+  /**
+   * Accepted and ignored. Each model has a fixed output limit.
+   */
+  maxTokens?: number | null | undefined;
+  /**
+   * Exactly one message with role `user`, whose content is one `image_url` part: an `https` URL on a public host name, or a base64 `data:` URL with a raster image type. The image can be up to 20 MiB. System messages and text parts are refused because the model's instructions are fixed.
+   */
+  messages: Array<Messages>;
+  /**
+   * Accepted and ignored.
+   */
+  metadata?: { [k: string]: string } | null | undefined;
+  /**
+   * Id of the model to run, from `GET /models`.
+   */
+  model: string;
+  /**
+   * Number of results. Only 1 is supported.
+   */
+  n?: number | null | undefined;
+  /**
+   * Accepted and ignored.
+   */
+  parallelToolCalls?: boolean | null | undefined;
+  /**
+   * Accepted and ignored.
+   */
+  presencePenalty?: number | null | undefined;
+  /**
+   * Output format: `json_object`, or `json_schema` with `name` set to the model's `output_schema_name` and `schema` either omitted or equal to its `output_schema`. The result is the same JSON object either way.
+   */
+  responseFormat?: ResponseFormat | null | undefined;
+  /**
+   * Accepted and ignored.
+   */
+  seed?: number | null | undefined;
+  /**
+   * Accepted and ignored.
+   */
+  serviceTier?: string | null | undefined;
+  /**
+   * Accepted and ignored.
+   */
+  stop?: string | Array<string> | null | undefined;
+  /**
+   * Accepted and ignored. A completed result is kept for 15 minutes, only to answer an identical repeat from the same account without a charge.
+   */
+  store?: boolean | null | undefined;
+  /**
+   * When true, the result arrives as server-sent events in one chunk.
+   */
+  stream?: boolean | null | undefined;
+  /**
+   * With `include_usage: true`, a final chunk carries `usage`.
+   */
+  streamOptions?: StreamOptions | null | undefined;
+  /**
+   * Accepted and ignored. The model always runs at temperature 0.
+   */
+  temperature?: number | null | undefined;
+  /**
+   * Not supported. Any value other than `none` is refused.
+   */
+  toolChoice?: any | undefined;
+  /**
+   * Not supported. A non-empty list is refused.
+   */
+  tools?: Array<any> | null | undefined;
+  /**
+   * Accepted and ignored.
+   */
+  topLogprobs?: number | null | undefined;
+  /**
+   * Accepted and ignored.
+   */
+  topP?: number | null | undefined;
+  /**
+   * Accepted and ignored.
+   */
+  user?: string | null | undefined;
+};
+
+/** @internal */
+export type Messages$Outbound = {
+  content?: any | undefined;
+  role: string;
+  [additionalProperties: string]: unknown;
+};
+
+/** @internal */
+export const Messages$outboundSchema: z.ZodType<
+  Messages$Outbound,
+  z.ZodTypeDef,
+  Messages
+> = z.object({
+  additionalProperties: z.record(z.any()).optional(),
+  content: z.any().optional(),
+  role: z.string(),
+}).transform((v) => {
+  return {
+    ...v.additionalProperties,
+    ...remap$(v, {
+      additionalProperties: null,
+    }),
+  };
+});
+
+export function messagesToJSON(messages: Messages): string {
+  return JSON.stringify(Messages$outboundSchema.parse(messages));
+}
+
+/** @internal */
+export type ResponseFormat$Outbound = {
+  type: string;
+  [additionalProperties: string]: unknown;
+};
+
+/** @internal */
+export const ResponseFormat$outboundSchema: z.ZodType<
+  ResponseFormat$Outbound,
+  z.ZodTypeDef,
+  ResponseFormat
+> = z.object({
+  additionalProperties: z.record(z.any()).optional(),
+  type: z.string(),
+}).transform((v) => {
+  return {
+    ...v.additionalProperties,
+    ...remap$(v, {
+      additionalProperties: null,
+    }),
+  };
+});
+
+export function responseFormatToJSON(responseFormat: ResponseFormat): string {
+  return JSON.stringify(ResponseFormat$outboundSchema.parse(responseFormat));
+}
+
+/** @internal */
+export type Stop$Outbound = string | Array<string>;
+
+/** @internal */
+export const Stop$outboundSchema: z.ZodType<Stop$Outbound, z.ZodTypeDef, Stop> =
+  z.union([z.string(), z.array(z.string())]);
+
+export function stopToJSON(stop: Stop): string {
+  return JSON.stringify(Stop$outboundSchema.parse(stop));
+}
+
+/** @internal */
+export type StreamOptions$Outbound = {
+  include_usage?: boolean | undefined;
+};
+
+/** @internal */
+export const StreamOptions$outboundSchema: z.ZodType<
+  StreamOptions$Outbound,
+  z.ZodTypeDef,
+  StreamOptions
+> = z.object({
+  includeUsage: z.boolean().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    includeUsage: "include_usage",
+  });
+});
+
+export function streamOptionsToJSON(streamOptions: StreamOptions): string {
+  return JSON.stringify(StreamOptions$outboundSchema.parse(streamOptions));
+}
+
+/** @internal */
+export type ChatCompletionRequest$Outbound = {
+  frequency_penalty?: number | null | undefined;
+  function_call?: any | undefined;
+  functions?: Array<any> | null | undefined;
+  logit_bias?: { [k: string]: number } | null | undefined;
+  logprobs?: boolean | null | undefined;
+  max_completion_tokens?: number | null | undefined;
+  max_tokens?: number | null | undefined;
+  messages: Array<Messages$Outbound>;
+  metadata?: { [k: string]: string } | null | undefined;
+  model: string;
+  n?: number | null | undefined;
+  parallel_tool_calls?: boolean | null | undefined;
+  presence_penalty?: number | null | undefined;
+  response_format?: ResponseFormat$Outbound | null | undefined;
+  seed?: number | null | undefined;
+  service_tier?: string | null | undefined;
+  stop?: string | Array<string> | null | undefined;
+  store?: boolean | null | undefined;
+  stream?: boolean | null | undefined;
+  stream_options?: StreamOptions$Outbound | null | undefined;
+  temperature?: number | null | undefined;
+  tool_choice?: any | undefined;
+  tools?: Array<any> | null | undefined;
+  top_logprobs?: number | null | undefined;
+  top_p?: number | null | undefined;
+  user?: string | null | undefined;
+};
+
+/** @internal */
+export const ChatCompletionRequest$outboundSchema: z.ZodType<
+  ChatCompletionRequest$Outbound,
+  z.ZodTypeDef,
+  ChatCompletionRequest
+> = z.object({
+  frequencyPenalty: z.nullable(z.number()).optional(),
+  functionCall: z.any().optional(),
+  functions: z.nullable(z.array(z.any())).optional(),
+  logitBias: z.nullable(z.record(z.number())).optional(),
+  logprobs: z.nullable(z.boolean()).optional(),
+  maxCompletionTokens: z.nullable(z.number().int()).optional(),
+  maxTokens: z.nullable(z.number().int()).optional(),
+  messages: z.array(z.lazy(() => Messages$outboundSchema)),
+  metadata: z.nullable(z.record(z.string())).optional(),
+  model: z.string(),
+  n: z.nullable(z.number().int()).optional(),
+  parallelToolCalls: z.nullable(z.boolean()).optional(),
+  presencePenalty: z.nullable(z.number()).optional(),
+  responseFormat: z.nullable(z.lazy(() => ResponseFormat$outboundSchema))
+    .optional(),
+  seed: z.nullable(z.number().int()).optional(),
+  serviceTier: z.nullable(z.string()).optional(),
+  stop: z.nullable(z.union([z.string(), z.array(z.string())])).optional(),
+  store: z.nullable(z.boolean()).optional(),
+  stream: z.nullable(z.boolean()).optional(),
+  streamOptions: z.nullable(z.lazy(() => StreamOptions$outboundSchema))
+    .optional(),
+  temperature: z.nullable(z.number()).optional(),
+  toolChoice: z.any().optional(),
+  tools: z.nullable(z.array(z.any())).optional(),
+  topLogprobs: z.nullable(z.number().int()).optional(),
+  topP: z.nullable(z.number()).optional(),
+  user: z.nullable(z.string()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    frequencyPenalty: "frequency_penalty",
+    functionCall: "function_call",
+    logitBias: "logit_bias",
+    maxCompletionTokens: "max_completion_tokens",
+    maxTokens: "max_tokens",
+    parallelToolCalls: "parallel_tool_calls",
+    presencePenalty: "presence_penalty",
+    responseFormat: "response_format",
+    serviceTier: "service_tier",
+    streamOptions: "stream_options",
+    toolChoice: "tool_choice",
+    topLogprobs: "top_logprobs",
+    topP: "top_p",
+  });
+});
+
+export function chatCompletionRequestToJSON(
+  chatCompletionRequest: ChatCompletionRequest,
+): string {
+  return JSON.stringify(
+    ChatCompletionRequest$outboundSchema.parse(chatCompletionRequest),
+  );
+}

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

@@ -1409,7 +1409,7 @@ export type EPCQueryResponseFabric = {
 };
 
 /**
- * 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 EPCQueryResponseMeesCompliance = {
   Compliant: "compliant",
@@ -1420,7 +1420,7 @@ export const EPCQueryResponseMeesCompliance = {
   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 EPCQueryResponseMeesCompliance = OpenEnum<
   typeof EPCQueryResponseMeesCompliance
@@ -2383,7 +2383,7 @@ export type Data = {
    */
   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: EPCQueryResponseMeesCompliance;
   /**

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

@@ -9,7 +9,7 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type GeographyArea = {
   /**
-   * 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;
   /**
@@ -17,7 +17,7 @@ export type GeographyArea = {
    */
   code: 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/shared/geographyrelatedarea.ts

@@ -9,7 +9,7 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type GeographyRelatedArea = {
   /**
-   * 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;
   /**
@@ -25,7 +25,7 @@ export type GeographyRelatedArea = {
    */
   minFit: 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/shared/historicalvaluation.ts

@@ -8,7 +8,7 @@ import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 /**
- * Bounds either side of `estimatedPrice`.
+ * Lower and upper bounds for the value at that date, in pounds. A wider range means less certainty in the valuation for that date.
  */
 export type ConfidenceInterval = {
   lower: number;
@@ -24,11 +24,11 @@ export type HistoricalValuation = {
    */
   comparablesCount: number;
   /**
-   * How much confidence to place in this valuation, from 0 to 1.
+   * How much confidence to place in this valuation, from 0 to 1, where 1 is the most confident.
    */
   confidence: number;
   /**
-   * Bounds either side of `estimatedPrice`.
+   * Lower and upper bounds for the value at that date, in pounds. A wider range means less certainty in the valuation for that date.
    */
   confidenceInterval: ConfidenceInterval;
   /**