@vepler/sdk 2.131.2 → 2.137.0

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

@@ -0,0 +1,193 @@
+/*
+ * 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 { AuthorityRef, AuthorityRef$inboundSchema } from "./authorityref.js";
+import {
+  RegulatoryZone,
+  RegulatoryZone$inboundSchema,
+} from "./regulatoryzone.js";
+import {
+  RegulatoryZoneCharges,
+  RegulatoryZoneCharges$inboundSchema,
+} from "./regulatoryzonecharges.js";
+
+/**
+ * Optional — the nearest zone of this kind, with distance
+ */
+export type Nearest = {
+  /**
+   * Reference to an administrative authority
+   */
+  authority?: AuthorityRef | undefined;
+  /**
+   * Compass bearing to the feature, degrees from true north (0-360)
+   */
+  bearingDeg?: number | undefined;
+  /**
+   * Charging / penalty schedule for zones that levy one — CAZ, ULEZ, LEZ, ZEZ, and international equivalents (Umweltzone, Crit'Air). Absent for non-charging designations such as AQMAs and flood zones.
+   */
+  charges?: RegulatoryZoneCharges | undefined;
+  /**
+   * Scheme-specific classification — e.g. 'Class D' for CAZ, 'PM2.5 nonattainment' for US
+   */
+  classification?: string | undefined;
+  /**
+   * Regulator-issued identifier for the zone
+   */
+  code?: string | undefined;
+  /**
+   * Air-quality schemes only — pollutants the zone is declared for
+   */
+  declaredPollutants?: Array<string> | undefined;
+  /**
+   * Free-text description provided by the regulator
+   */
+  description?: string | undefined;
+  /**
+   * Distance to the feature in metres
+   */
+  distanceM: number;
+  /**
+   * ISO date when the designation took effect
+   */
+  effectiveDate?: string | undefined;
+  /**
+   * ISO 3166-1 alpha-2 (optionally with subdivision)
+   */
+  jurisdiction: string;
+  /**
+   * Zone name as designated by the regulator
+   */
+  name: string;
+  /**
+   * Canonical URL to the designation document
+   */
+  reference?: string | undefined;
+  /**
+   * Scheme identifier — e.g. 'AQMA', 'CAZ', 'ULEZ', 'LEZ', 'SMOKE_CONTROL', 'US_NONATTAINMENT', 'DE_UMWELTZONE', 'FR_CRITAIR'
+   */
+  system: string;
+  /**
+   * Scheme edition or revision when applicable
+   */
+  systemVersion?: string | undefined;
+};
+
+/**
+ * Outside the zone
+ */
+export type Two = {
+  /**
+   * False — the point is not inside any zone of this kind
+   */
+  inside: false;
+  /**
+   * Optional — the nearest zone of this kind, with distance
+   */
+  nearest?: Nearest | undefined;
+};
+
+/**
+ * Inside the zone
+ */
+export type One = {
+  /**
+   * True — the point is inside this zone
+   */
+  inside: true;
+  /**
+   * Government-defined polygon designation, scheme-discriminated
+   */
+  zone: RegulatoryZone;
+};
+
+/**
+ * Discriminated inside/outside-with-nearest membership wrapper around any zone schema
+ */
+export type AirQualityRegulatoryZoneMembership = One | Two;
+
+/** @internal */
+export const Nearest$inboundSchema: z.ZodType<Nearest, z.ZodTypeDef, unknown> =
+  z.object({
+    authority: AuthorityRef$inboundSchema.optional(),
+    bearingDeg: z.number().optional(),
+    charges: RegulatoryZoneCharges$inboundSchema.optional(),
+    classification: z.string().optional(),
+    code: z.string().optional(),
+    declaredPollutants: z.array(z.string()).optional(),
+    description: z.string().optional(),
+    distanceM: z.number(),
+    effectiveDate: z.string().optional(),
+    jurisdiction: z.string(),
+    name: z.string(),
+    reference: z.string().optional(),
+    system: z.string(),
+    systemVersion: z.string().optional(),
+  });
+
+export function nearestFromJSON(
+  jsonString: string,
+): SafeParseResult<Nearest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Nearest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Nearest' from JSON`,
+  );
+}
+
+/** @internal */
+export const Two$inboundSchema: z.ZodType<Two, z.ZodTypeDef, unknown> = z
+  .object({
+    inside: z.literal(false),
+    nearest: z.lazy(() => Nearest$inboundSchema).optional(),
+  });
+
+export function twoFromJSON(
+  jsonString: string,
+): SafeParseResult<Two, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Two$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Two' from JSON`,
+  );
+}
+
+/** @internal */
+export const One$inboundSchema: z.ZodType<One, z.ZodTypeDef, unknown> = z
+  .object({
+    inside: z.literal(true),
+    zone: RegulatoryZone$inboundSchema,
+  });
+
+export function oneFromJSON(
+  jsonString: string,
+): SafeParseResult<One, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => One$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'One' from JSON`,
+  );
+}
+
+/** @internal */
+export const AirQualityRegulatoryZoneMembership$inboundSchema: z.ZodType<
+  AirQualityRegulatoryZoneMembership,
+  z.ZodTypeDef,
+  unknown
+> = z.union([z.lazy(() => One$inboundSchema), z.lazy(() => Two$inboundSchema)]);
+
+export function airQualityRegulatoryZoneMembershipFromJSON(
+  jsonString: string,
+): SafeParseResult<AirQualityRegulatoryZoneMembership, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      AirQualityRegulatoryZoneMembership$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AirQualityRegulatoryZoneMembership' from JSON`,
+  );
+}

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

@@ -18,16 +18,43 @@ import {
   AirQualityPollutantCode,
   AirQualityPollutantCode$inboundSchema,
 } from "./airqualitypollutantcode.js";
+import { Scale, Scale$inboundSchema } from "./scale.js";
+import { Trend, Trend$inboundSchema } from "./trend.js";
 
 export type AirQualitySummary = {
+  /**
+   * ISO datetime when this score was computed
+   */
+  asOf?: string | undefined;
   band: AirQualityBand;
+  /**
+   * Optional explanation of how the band was derived
+   */
+  bandReason?: string | undefined;
+  /**
+   * Source category contributing the largest share of pollution at this cell
+   */
   dominantSource: AirQualityDominantSource;
   /**
-   * Plain-English one-liner for UI surface
+   * Plain-English one-liner intended for UI surface
    */
   headline: string;
+  /**
+   * Self-describing scale for a score
+   */
+  scale: Scale;
+  /**
+   * Numeric score within the documented scale
+   */
   score: number;
-  worstPollutant: AirQualityPollutantCode;
+  /**
+   * Temporal trend on a score
+   */
+  trend?: Trend | undefined;
+  /**
+   * Pollutant driving the band, when one dominates
+   */
+  worstPollutant?: AirQualityPollutantCode | undefined;
 };
 
 /** @internal */
@@ -36,11 +63,15 @@ export const AirQualitySummary$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
+  asOf: z.string().optional(),
   band: AirQualityBand$inboundSchema,
+  bandReason: z.string().optional(),
   dominantSource: AirQualityDominantSource$inboundSchema,
   headline: z.string(),
-  score: z.number().int(),
-  worstPollutant: AirQualityPollutantCode$inboundSchema,
+  scale: Scale$inboundSchema,
+  score: z.number(),
+  trend: Trend$inboundSchema.optional(),
+  worstPollutant: AirQualityPollutantCode$inboundSchema.optional(),
 });
 
 export function airQualitySummaryFromJSON(

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

@@ -17,13 +17,15 @@ export type AsyncPurchaseTitleDeedResponseObject = ClosedEnum<
   typeof AsyncPurchaseTitleDeedResponseObject
 >;
 
-export const Status = {
+export const AsyncPurchaseTitleDeedResponseStatus = {
   Pending: "pending",
   Analysing: "analysing",
   Complete: "complete",
   Failed: "failed",
 } as const;
-export type Status = OpenEnum<typeof Status>;
+export type AsyncPurchaseTitleDeedResponseStatus = OpenEnum<
+  typeof AsyncPurchaseTitleDeedResponseStatus
+>;
 
 export type AsyncPurchaseTitleDeedResponse = {
   /**
@@ -31,7 +33,7 @@ export type AsyncPurchaseTitleDeedResponse = {
    */
   alreadyOwned: boolean;
   object: AsyncPurchaseTitleDeedResponseObject;
-  status: Status;
+  status: AsyncPurchaseTitleDeedResponseStatus;
   titleNumber: string;
 };
 
@@ -42,8 +44,11 @@ export const AsyncPurchaseTitleDeedResponseObject$inboundSchema:
   );
 
 /** @internal */
-export const Status$inboundSchema: z.ZodType<Status, z.ZodTypeDef, unknown> =
-  openEnums.inboundSchema(Status);
+export const AsyncPurchaseTitleDeedResponseStatus$inboundSchema: z.ZodType<
+  AsyncPurchaseTitleDeedResponseStatus,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(AsyncPurchaseTitleDeedResponseStatus);
 
 /** @internal */
 export const AsyncPurchaseTitleDeedResponse$inboundSchema: z.ZodType<
@@ -53,7 +58,7 @@ export const AsyncPurchaseTitleDeedResponse$inboundSchema: z.ZodType<
 > = z.object({
   already_owned: z.boolean(),
   object: AsyncPurchaseTitleDeedResponseObject$inboundSchema,
-  status: Status$inboundSchema,
+  status: AsyncPurchaseTitleDeedResponseStatus$inboundSchema,
   title_number: z.string(),
 }).transform((v) => {
   return remap$(v, {

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

@@ -0,0 +1,32 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import * as openEnums from "../../types/enums.js";
+import { OpenEnum } from "../../types/enums.js";
+
+/**
+ * Demographic or clinical group with elevated risk
+ */
+export const AtRiskGroup = {
+  Children: "children",
+  Infants: "infants",
+  Elderly: "elderly",
+  Pregnant: "pregnant",
+  RespiratoryConditions: "respiratory_conditions",
+  CardiovascularConditions: "cardiovascular_conditions",
+  Immunocompromised: "immunocompromised",
+  OutdoorWorkers: "outdoor_workers",
+} as const;
+/**
+ * Demographic or clinical group with elevated risk
+ */
+export type AtRiskGroup = OpenEnum<typeof AtRiskGroup>;
+
+/** @internal */
+export const AtRiskGroup$inboundSchema: z.ZodType<
+  AtRiskGroup,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(AtRiskGroup);

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

@@ -0,0 +1,58 @@
+/*
+ * 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 { AuthorityType, AuthorityType$inboundSchema } from "./authoritytype.js";
+
+/**
+ * Reference to an administrative authority
+ */
+export type AuthorityRef = {
+  /**
+   * Authority identifier — ONS GSS code for UK, FIPS for US, NUTS for EU, otherwise local registry code
+   */
+  code: string;
+  /**
+   * Human-readable country or subdivision name
+   */
+  country?: string | undefined;
+  /**
+   * Jurisdiction (ISO 3166-1 alpha-2, optionally with subdivision e.g. 'GB-ENG')
+   */
+  jurisdiction: string;
+  /**
+   * Human-readable name of the authority
+   */
+  name: string;
+  /**
+   * Organisational tier of the authority
+   */
+  type: AuthorityType;
+};
+
+/** @internal */
+export const AuthorityRef$inboundSchema: z.ZodType<
+  AuthorityRef,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  code: z.string(),
+  country: z.string().optional(),
+  jurisdiction: z.string(),
+  name: z.string(),
+  type: AuthorityType$inboundSchema,
+});
+
+export function authorityRefFromJSON(
+  jsonString: string,
+): SafeParseResult<AuthorityRef, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AuthorityRef$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AuthorityRef' from JSON`,
+  );
+}

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

@@ -0,0 +1,31 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import * as openEnums from "../../types/enums.js";
+import { OpenEnum } from "../../types/enums.js";
+
+/**
+ * Organisational tier of the authority
+ */
+export const AuthorityType = {
+  LocalAuthority: "local_authority",
+  Mayoral: "mayoral",
+  National: "national",
+  Devolved: "devolved",
+  Supranational: "supranational",
+  TransportAuthority: "transport_authority",
+  Regional: "regional",
+} as const;
+/**
+ * Organisational tier of the authority
+ */
+export type AuthorityType = OpenEnum<typeof AuthorityType>;
+
+/** @internal */
+export const AuthorityType$inboundSchema: z.ZodType<
+  AuthorityType,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(AuthorityType);

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

@@ -77,7 +77,7 @@ export type ModelWeights = {
 /**
  * Detailed confidence metrics with RICS-aligned decomposition
  */
-export type Confidence = {
+export type AVMAnalysisResponseConfidence = {
   /**
    * Quality metrics for comparable evidence
    */
@@ -105,17 +105,19 @@ export type Change6Month = {
   percentage: number;
 };
 
-export const Trend = {
+export const AVMAnalysisResponseTrend = {
   Rising: "rising",
   Stable: "stable",
   Falling: "falling",
 } as const;
-export type Trend = OpenEnum<typeof Trend>;
+export type AVMAnalysisResponseTrend = OpenEnum<
+  typeof AVMAnalysisResponseTrend
+>;
 
 export type AVMAnalysisResponseSummary = {
   change12Month?: Change12Month | undefined;
   change6Month?: Change6Month | undefined;
-  trend: Trend;
+  trend: AVMAnalysisResponseTrend;
 };
 
 /**
@@ -263,7 +265,7 @@ export type AVMAnalysisResponse = {
   /**
    * Detailed confidence metrics with RICS-aligned decomposition
    */
-  confidence: Confidence;
+  confidence: AVMAnalysisResponseConfidence;
   /**
    * Historical valuation data
    */
@@ -385,8 +387,8 @@ export function modelWeightsFromJSON(
 }
 
 /** @internal */
-export const Confidence$inboundSchema: z.ZodType<
-  Confidence,
+export const AVMAnalysisResponseConfidence$inboundSchema: z.ZodType<
+  AVMAnalysisResponseConfidence,
   z.ZodTypeDef,
   unknown
 > = z.object({
@@ -398,13 +400,13 @@ export const Confidence$inboundSchema: z.ZodType<
   score: z.number().optional(),
 });
 
-export function confidenceFromJSON(
+export function avmAnalysisResponseConfidenceFromJSON(
   jsonString: string,
-): SafeParseResult<Confidence, SDKValidationError> {
+): SafeParseResult<AVMAnalysisResponseConfidence, SDKValidationError> {
   return safeParse(
     jsonString,
-    (x) => Confidence$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'Confidence' from JSON`,
+    (x) => AVMAnalysisResponseConfidence$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AVMAnalysisResponseConfidence' from JSON`,
   );
 }
 
@@ -449,8 +451,11 @@ export function change6MonthFromJSON(
 }
 
 /** @internal */
-export const Trend$inboundSchema: z.ZodType<Trend, z.ZodTypeDef, unknown> =
-  openEnums.inboundSchema(Trend);
+export const AVMAnalysisResponseTrend$inboundSchema: z.ZodType<
+  AVMAnalysisResponseTrend,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(AVMAnalysisResponseTrend);
 
 /** @internal */
 export const AVMAnalysisResponseSummary$inboundSchema: z.ZodType<
@@ -460,7 +465,7 @@ export const AVMAnalysisResponseSummary$inboundSchema: z.ZodType<
 > = z.object({
   change12Month: z.lazy(() => Change12Month$inboundSchema).optional(),
   change6Month: z.lazy(() => Change6Month$inboundSchema).optional(),
-  trend: Trend$inboundSchema,
+  trend: AVMAnalysisResponseTrend$inboundSchema,
 });
 
 export function avmAnalysisResponseSummaryFromJSON(
@@ -658,7 +663,7 @@ export const AVMAnalysisResponse$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   comparables: z.lazy(() => Comparables$inboundSchema),
-  confidence: z.lazy(() => Confidence$inboundSchema),
+  confidence: z.lazy(() => AVMAnalysisResponseConfidence$inboundSchema),
   history: z.lazy(() => History$inboundSchema).optional(),
   issues: z.array(z.lazy(() => Issues$inboundSchema)),
   marketStats: z.lazy(() => MarketStats$inboundSchema),

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

@@ -231,17 +231,6 @@ export const DataSources = {
 } as const;
 export type DataSources = OpenEnum<typeof DataSources>;
 
-/**
- * GeoJSON geometry type
- */
-export const BuildingSchemasType = {
-  MultiPolygon: "MultiPolygon",
-} as const;
-/**
- * GeoJSON geometry type
- */
-export type BuildingSchemasType = ClosedEnum<typeof BuildingSchemasType>;
-
 /**
  * GeoJSON MultiPolygon geometry
  */
@@ -253,22 +242,9 @@ export type GeoJSONMultiPolygon = {
   /**
    * GeoJSON geometry type
    */
-  type: BuildingSchemasType;
+  type: "MultiPolygon";
 };
 
-/**
- * GeoJSON geometry type
- */
-export const BuildingSchemasFootprintType = {
-  Polygon: "Polygon",
-} as const;
-/**
- * GeoJSON geometry type
- */
-export type BuildingSchemasFootprintType = ClosedEnum<
-  typeof BuildingSchemasFootprintType
->;
-
 /**
  * GeoJSON Polygon geometry
  */
@@ -280,13 +256,13 @@ export type GeoJSONPolygon = {
   /**
    * GeoJSON geometry type
    */
-  type: BuildingSchemasFootprintType;
+  type: "Polygon";
 };
 
 /**
  * Building footprint geometry in WGS84 (EPSG:4326). Excluded from the default attribute set for response size — request explicitly via `attributes: ["footprint"]`.
  */
-export type Footprint = GeoJSONPolygon | GeoJSONMultiPolygon | any;
+export type Footprint = GeoJSONPolygon | GeoJSONMultiPolygon;
 
 /**
  * Object type identifier
@@ -580,7 +556,7 @@ export type Building = {
   /**
    * Building footprint geometry in WGS84 (EPSG:4326). Excluded from the default attribute set for response size — request explicitly via `attributes: ["footprint"]`.
    */
-  footprint?: GeoJSONPolygon | GeoJSONMultiPolygon | any | null | undefined;
+  footprint?: GeoJSONPolygon | GeoJSONMultiPolygon | null | undefined;
   /**
    * Maximum building height in metres
    */
@@ -803,11 +779,6 @@ export const DataSources$inboundSchema: z.ZodType<
   unknown
 > = openEnums.inboundSchema(DataSources);
 
-/** @internal */
-export const BuildingSchemasType$inboundSchema: z.ZodNativeEnum<
-  typeof BuildingSchemasType
-> = z.nativeEnum(BuildingSchemasType);
-
 /** @internal */
 export const GeoJSONMultiPolygon$inboundSchema: z.ZodType<
   GeoJSONMultiPolygon,
@@ -815,7 +786,7 @@ export const GeoJSONMultiPolygon$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   coordinates: z.array(z.array(z.array(z.array(z.number())))),
-  type: BuildingSchemasType$inboundSchema,
+  type: z.literal("MultiPolygon"),
 });
 
 export function geoJSONMultiPolygonFromJSON(
@@ -828,11 +799,6 @@ export function geoJSONMultiPolygonFromJSON(
   );
 }
 
-/** @internal */
-export const BuildingSchemasFootprintType$inboundSchema: z.ZodNativeEnum<
-  typeof BuildingSchemasFootprintType
-> = z.nativeEnum(BuildingSchemasFootprintType);
-
 /** @internal */
 export const GeoJSONPolygon$inboundSchema: z.ZodType<
   GeoJSONPolygon,
@@ -840,7 +806,7 @@ export const GeoJSONPolygon$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   coordinates: z.array(z.array(z.array(z.number()))),
-  type: BuildingSchemasFootprintType$inboundSchema,
+  type: z.literal("Polygon"),
 });
 
 export function geoJSONPolygonFromJSON(
@@ -861,7 +827,6 @@ export const Footprint$inboundSchema: z.ZodType<
 > = z.union([
   z.lazy(() => GeoJSONPolygon$inboundSchema),
   z.lazy(() => GeoJSONMultiPolygon$inboundSchema),
-  z.any(),
 ]);
 
 export function footprintFromJSON(
@@ -1021,7 +986,6 @@ export const Building$inboundSchema: z.ZodType<
     z.union([
       z.lazy(() => GeoJSONPolygon$inboundSchema),
       z.lazy(() => GeoJSONMultiPolygon$inboundSchema),
-      z.any(),
     ]),
   ).optional(),
   heightMax: z.nullable(z.number()).optional(),