@vepler/sdk 2.0.0 → 2.6.2

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

@@ -0,0 +1,52 @@
+/*
+ * 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";
+
+/**
+ * Price rating analysis (only included when ratePrice: true and inputPrice provided)
+ */
+export type AVMPriceRating = {
+  /**
+   * Detailed explanation of the rating and value assessment
+   */
+  explanation: string;
+  /**
+   * Percentage difference from estimated price (negative = below market, positive = above market)
+   */
+  percentageDifference: number;
+  /**
+   * Star rating (1-5) of the input price relative to market value
+   */
+  rating: number;
+  /**
+   * Human-readable rating label
+   */
+  ratingLabel: string;
+};
+
+/** @internal */
+export const AVMPriceRating$inboundSchema: z.ZodType<
+  AVMPriceRating,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  explanation: z.string(),
+  percentageDifference: z.number(),
+  rating: z.number(),
+  ratingLabel: z.string(),
+});
+
+export function avmPriceRatingFromJSON(
+  jsonString: string,
+): SafeParseResult<AVMPriceRating, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AVMPriceRating$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AVMPriceRating' from JSON`,
+  );
+}

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

@@ -0,0 +1,124 @@
+/*
+ * 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";
+
+/**
+ * Construction age information
+ */
+export type ConstructionAge = {
+  /**
+   * Construction period end year
+   */
+  endYear: number;
+  /**
+   * Whether the year is exact or estimated
+   */
+  isExact: boolean;
+  /**
+   * Mid-point year of construction period
+   */
+  midYear: number;
+  /**
+   * Construction period start year
+   */
+  startYear: number;
+};
+
+export type BuildData = {
+  /**
+   * Construction age information
+   */
+  constructionAge?: ConstructionAge | null | undefined;
+  /**
+   * Floor height in metres
+   */
+  floorHeight?: number | null | undefined;
+  /**
+   * Main fuel type
+   */
+  mainFuel?: string | null | undefined;
+  /**
+   * Mains gas availability flag
+   */
+  mainsGasFlag?: string | null | undefined;
+  /**
+   * Property type
+   */
+  propertyType?: string | null | undefined;
+  /**
+   * Roof type
+   */
+  roofType?: string | null | undefined;
+  /**
+   * Property sub-type
+   */
+  subPropertyType?: string | null | undefined;
+  /**
+   * Total floor area in square metres
+   */
+  totalFloorArea?: number | null | undefined;
+  /**
+   * Wall type
+   */
+  wallType?: string | null | undefined;
+  /**
+   * Window type
+   */
+  windowType?: string | null | undefined;
+};
+
+/** @internal */
+export const ConstructionAge$inboundSchema: z.ZodType<
+  ConstructionAge,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  endYear: z.number(),
+  isExact: z.boolean(),
+  midYear: z.number(),
+  startYear: z.number(),
+});
+
+export function constructionAgeFromJSON(
+  jsonString: string,
+): SafeParseResult<ConstructionAge, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ConstructionAge$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ConstructionAge' from JSON`,
+  );
+}
+
+/** @internal */
+export const BuildData$inboundSchema: z.ZodType<
+  BuildData,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  constructionAge: z.nullable(z.lazy(() => ConstructionAge$inboundSchema))
+    .optional(),
+  floorHeight: z.nullable(z.number()).optional(),
+  mainFuel: z.nullable(z.string()).optional(),
+  mainsGasFlag: z.nullable(z.string()).optional(),
+  propertyType: z.nullable(z.string()).optional(),
+  roofType: z.nullable(z.string()).optional(),
+  subPropertyType: z.nullable(z.string()).optional(),
+  totalFloorArea: z.nullable(z.number()).optional(),
+  wallType: z.nullable(z.string()).optional(),
+  windowType: z.nullable(z.string()).optional(),
+});
+
+export function buildDataFromJSON(
+  jsonString: string,
+): SafeParseResult<BuildData, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => BuildData$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'BuildData' from JSON`,
+  );
+}

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

@@ -0,0 +1,66 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type ChargeEntry = {
+  /**
+   * Confidence score (0-100)
+   */
+  confidence: number;
+  /**
+   * Currency code
+   */
+  currency?: string | undefined;
+  /**
+   * Whether this value is an outlier
+   */
+  isOutlier: boolean;
+  /**
+   * Date this charge was recorded
+   */
+  recordedDate: Date;
+  /**
+   * Source identifier
+   */
+  sourceId: string;
+  /**
+   * Source provider
+   */
+  sourceProvider: string;
+  /**
+   * Charge amount in pence
+   */
+  value: number;
+};
+
+/** @internal */
+export const ChargeEntry$inboundSchema: z.ZodType<
+  ChargeEntry,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  confidence: z.number(),
+  currency: z.string().optional(),
+  isOutlier: z.boolean(),
+  recordedDate: z.string().datetime({ offset: true }).transform(v =>
+    new Date(v)
+  ),
+  sourceId: z.string(),
+  sourceProvider: z.string(),
+  value: z.number(),
+});
+
+export function chargeEntryFromJSON(
+  jsonString: string,
+): SafeParseResult<ChargeEntry, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ChargeEntry$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ChargeEntry' from JSON`,
+  );
+}

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

@@ -0,0 +1,57 @@
+/*
+ * 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 { ChargeEntry, ChargeEntry$inboundSchema } from "./chargeentry.js";
+
+export type ChargeHistory = {
+  /**
+   * Overall confidence in current value
+   */
+  confidence: number;
+  /**
+   * Currency code
+   */
+  currency?: string | undefined;
+  /**
+   * Current best estimate (annual) in pence
+   */
+  current?: number | null | undefined;
+  /**
+   * Historical charge records
+   */
+  entries: Array<ChargeEntry>;
+  /**
+   * Last update timestamp
+   */
+  lastUpdated: Date;
+};
+
+/** @internal */
+export const ChargeHistory$inboundSchema: z.ZodType<
+  ChargeHistory,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  confidence: z.number(),
+  currency: z.string().optional(),
+  current: z.nullable(z.number()).optional(),
+  entries: z.array(ChargeEntry$inboundSchema),
+  lastUpdated: z.string().datetime({ offset: true }).transform(v =>
+    new Date(v)
+  ),
+});
+
+export function chargeHistoryFromJSON(
+  jsonString: string,
+): SafeParseResult<ChargeHistory, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ChargeHistory$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ChargeHistory' from JSON`,
+  );
+}

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

@@ -0,0 +1,54 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type CouncilTaxBandDetails = {
+  /**
+   * Annual amount in pence for this period
+   */
+  annualAmount: number;
+  /**
+   * Effective from date
+   */
+  effectiveFrom: string;
+  /**
+   * Effective to date (null if current)
+   */
+  effectiveTo?: string | null | undefined;
+  /**
+   * Record ID
+   */
+  id: number;
+  /**
+   * Tax year
+   */
+  taxYear: string;
+};
+
+/** @internal */
+export const CouncilTaxBandDetails$inboundSchema: z.ZodType<
+  CouncilTaxBandDetails,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  annualAmount: z.number(),
+  effectiveFrom: z.string(),
+  effectiveTo: z.nullable(z.string()).optional(),
+  id: z.number(),
+  taxYear: z.string(),
+});
+
+export function councilTaxBandDetailsFromJSON(
+  jsonString: string,
+): SafeParseResult<CouncilTaxBandDetails, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CouncilTaxBandDetails$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CouncilTaxBandDetails' from JSON`,
+  );
+}

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

@@ -7,6 +7,10 @@ import { safeParse } from "../../../lib/schemas.js";
 import { ClosedEnum } from "../../types/enums.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  CouncilTaxBandDetails,
+  CouncilTaxBandDetails$inboundSchema,
+} from "./counciltaxbanddetails.js";
 
 /**
  * Council tax band
@@ -29,84 +33,54 @@ export type TaxBand = ClosedEnum<typeof TaxBand>;
 
 export type CouncilTaxData = {
   /**
-   * Annual council tax charge in pence
+   * Council identifier
    */
-  annualCharge?: number | undefined;
+  councilId?: string | null | undefined;
   /**
-   * Local authority name
+   * Current annual council tax charge in pence
    */
-  localAuthority?: string | undefined;
+  currentAnnualAmount?: number | null | undefined;
+  /**
+   * Current tax year
+   */
+  currentTaxYear?: string | null | undefined;
+  /**
+   * Whether amount is estimated
+   */
+  isEstimated?: boolean | undefined;
+  /**
+   * Council tax record status
+   */
+  status?: string | null | undefined;
   /**
    * Council tax band
    */
-  taxBand?: TaxBand | undefined;
+  taxBand?: TaxBand | null | undefined;
+  /**
+   * Historical council tax band records
+   */
+  taxBandDetails?: Array<CouncilTaxBandDetails> | undefined;
 };
 
 /** @internal */
 export const TaxBand$inboundSchema: z.ZodNativeEnum<typeof TaxBand> = z
   .nativeEnum(TaxBand);
 
-/** @internal */
-export const TaxBand$outboundSchema: z.ZodNativeEnum<typeof TaxBand> =
-  TaxBand$inboundSchema;
-
-/**
- * @internal
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
- */
-export namespace TaxBand$ {
-  /** @deprecated use `TaxBand$inboundSchema` instead. */
-  export const inboundSchema = TaxBand$inboundSchema;
-  /** @deprecated use `TaxBand$outboundSchema` instead. */
-  export const outboundSchema = TaxBand$outboundSchema;
-}
-
 /** @internal */
 export const CouncilTaxData$inboundSchema: z.ZodType<
   CouncilTaxData,
   z.ZodTypeDef,
   unknown
 > = z.object({
-  annualCharge: z.number().optional(),
-  localAuthority: z.string().optional(),
-  taxBand: TaxBand$inboundSchema.optional(),
+  councilId: z.nullable(z.string()).optional(),
+  currentAnnualAmount: z.nullable(z.number()).optional(),
+  currentTaxYear: z.nullable(z.string()).optional(),
+  isEstimated: z.boolean().optional(),
+  status: z.nullable(z.string()).optional(),
+  taxBand: z.nullable(TaxBand$inboundSchema).optional(),
+  taxBandDetails: z.array(CouncilTaxBandDetails$inboundSchema).optional(),
 });
 
-/** @internal */
-export type CouncilTaxData$Outbound = {
-  annualCharge?: number | undefined;
-  localAuthority?: string | undefined;
-  taxBand?: string | undefined;
-};
-
-/** @internal */
-export const CouncilTaxData$outboundSchema: z.ZodType<
-  CouncilTaxData$Outbound,
-  z.ZodTypeDef,
-  CouncilTaxData
-> = z.object({
-  annualCharge: z.number().optional(),
-  localAuthority: z.string().optional(),
-  taxBand: TaxBand$outboundSchema.optional(),
-});
-
-/**
- * @internal
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
- */
-export namespace CouncilTaxData$ {
-  /** @deprecated use `CouncilTaxData$inboundSchema` instead. */
-  export const inboundSchema = CouncilTaxData$inboundSchema;
-  /** @deprecated use `CouncilTaxData$outboundSchema` instead. */
-  export const outboundSchema = CouncilTaxData$outboundSchema;
-  /** @deprecated use `CouncilTaxData$Outbound` instead. */
-  export type Outbound = CouncilTaxData$Outbound;
-}
-
-export function councilTaxDataToJSON(councilTaxData: CouncilTaxData): string {
-  return JSON.stringify(CouncilTaxData$outboundSchema.parse(councilTaxData));
-}
-
 export function councilTaxDataFromJSON(
   jsonString: string,
 ): SafeParseResult<CouncilTaxData, SDKValidationError> {

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

@@ -52,21 +52,33 @@ export type EPCData = {
    */
   currentEnergyRating?: CurrentEnergyRating | undefined;
   /**
-   * Potential energy efficiency score
+   * Current annual heating cost in pence
    */
-  potentialEnergyEfficiency?: number | undefined;
+  heatingCostCurrent?: number | undefined;
   /**
-   * Potential EPC rating
+   * Potential annual heating cost in pence
    */
-  potentialEnergyRating?: PotentialEnergyRating | undefined;
+  heatingCostPotential?: number | undefined;
+  /**
+   * Current annual hot water cost in pence
+   */
+  hotWaterCostCurrent?: number | undefined;
   /**
-   * EPC certificate valid from date
+   * Potential annual hot water cost in pence
    */
-  validFrom?: string | undefined;
+  hotWaterCostPotential?: number | undefined;
   /**
-   * EPC certificate valid to date
+   * Type of main heating control system
    */
-  validTo?: string | undefined;
+  mainHeatingControls?: string | undefined;
+  /**
+   * Potential energy efficiency score
+   */
+  potentialEnergyEfficiency?: number | undefined;
+  /**
+   * Potential EPC rating
+   */
+  potentialEnergyRating?: PotentialEnergyRating | undefined;
 };
 
 /** @internal */
@@ -74,95 +86,25 @@ export const CurrentEnergyRating$inboundSchema: z.ZodNativeEnum<
   typeof CurrentEnergyRating
 > = z.nativeEnum(CurrentEnergyRating);
 
-/** @internal */
-export const CurrentEnergyRating$outboundSchema: z.ZodNativeEnum<
-  typeof CurrentEnergyRating
-> = CurrentEnergyRating$inboundSchema;
-
-/**
- * @internal
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
- */
-export namespace CurrentEnergyRating$ {
-  /** @deprecated use `CurrentEnergyRating$inboundSchema` instead. */
-  export const inboundSchema = CurrentEnergyRating$inboundSchema;
-  /** @deprecated use `CurrentEnergyRating$outboundSchema` instead. */
-  export const outboundSchema = CurrentEnergyRating$outboundSchema;
-}
-
 /** @internal */
 export const PotentialEnergyRating$inboundSchema: z.ZodNativeEnum<
   typeof PotentialEnergyRating
 > = z.nativeEnum(PotentialEnergyRating);
 
-/** @internal */
-export const PotentialEnergyRating$outboundSchema: z.ZodNativeEnum<
-  typeof PotentialEnergyRating
-> = PotentialEnergyRating$inboundSchema;
-
-/**
- * @internal
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
- */
-export namespace PotentialEnergyRating$ {
-  /** @deprecated use `PotentialEnergyRating$inboundSchema` instead. */
-  export const inboundSchema = PotentialEnergyRating$inboundSchema;
-  /** @deprecated use `PotentialEnergyRating$outboundSchema` instead. */
-  export const outboundSchema = PotentialEnergyRating$outboundSchema;
-}
-
 /** @internal */
 export const EPCData$inboundSchema: z.ZodType<EPCData, z.ZodTypeDef, unknown> =
   z.object({
     currentEnergyEfficiency: z.number().optional(),
     currentEnergyRating: CurrentEnergyRating$inboundSchema.optional(),
+    heatingCostCurrent: z.number().optional(),
+    heatingCostPotential: z.number().optional(),
+    hotWaterCostCurrent: z.number().optional(),
+    hotWaterCostPotential: z.number().optional(),
+    mainHeatingControls: z.string().optional(),
     potentialEnergyEfficiency: z.number().optional(),
     potentialEnergyRating: PotentialEnergyRating$inboundSchema.optional(),
-    validFrom: z.string().optional(),
-    validTo: z.string().optional(),
   });
 
-/** @internal */
-export type EPCData$Outbound = {
-  currentEnergyEfficiency?: number | undefined;
-  currentEnergyRating?: string | undefined;
-  potentialEnergyEfficiency?: number | undefined;
-  potentialEnergyRating?: string | undefined;
-  validFrom?: string | undefined;
-  validTo?: string | undefined;
-};
-
-/** @internal */
-export const EPCData$outboundSchema: z.ZodType<
-  EPCData$Outbound,
-  z.ZodTypeDef,
-  EPCData
-> = z.object({
-  currentEnergyEfficiency: z.number().optional(),
-  currentEnergyRating: CurrentEnergyRating$outboundSchema.optional(),
-  potentialEnergyEfficiency: z.number().optional(),
-  potentialEnergyRating: PotentialEnergyRating$outboundSchema.optional(),
-  validFrom: z.string().optional(),
-  validTo: z.string().optional(),
-});
-
-/**
- * @internal
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
- */
-export namespace EPCData$ {
-  /** @deprecated use `EPCData$inboundSchema` instead. */
-  export const inboundSchema = EPCData$inboundSchema;
-  /** @deprecated use `EPCData$outboundSchema` instead. */
-  export const outboundSchema = EPCData$outboundSchema;
-  /** @deprecated use `EPCData$Outbound` instead. */
-  export type Outbound = EPCData$Outbound;
-}
-
-export function epcDataToJSON(epcData: EPCData): string {
-  return JSON.stringify(EPCData$outboundSchema.parse(epcData));
-}
-
 export function epcDataFromJSON(
   jsonString: string,
 ): SafeParseResult<EPCData, SDKValidationError> {

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

@@ -26,43 +26,6 @@ export const HealthResponse$inboundSchema: z.ZodType<
   version: z.string().optional(),
 });
 
-/** @internal */
-export type HealthResponse$Outbound = {
-  service: string;
-  status: string;
-  timestamp?: string | undefined;
-  version?: string | undefined;
-};
-
-/** @internal */
-export const HealthResponse$outboundSchema: z.ZodType<
-  HealthResponse$Outbound,
-  z.ZodTypeDef,
-  HealthResponse
-> = z.object({
-  service: z.string(),
-  status: z.string(),
-  timestamp: z.string().optional(),
-  version: z.string().optional(),
-});
-
-/**
- * @internal
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
- */
-export namespace HealthResponse$ {
-  /** @deprecated use `HealthResponse$inboundSchema` instead. */
-  export const inboundSchema = HealthResponse$inboundSchema;
-  /** @deprecated use `HealthResponse$outboundSchema` instead. */
-  export const outboundSchema = HealthResponse$outboundSchema;
-  /** @deprecated use `HealthResponse$Outbound` instead. */
-  export type Outbound = HealthResponse$Outbound;
-}
-
-export function healthResponseToJSON(healthResponse: HealthResponse): string {
-  return JSON.stringify(HealthResponse$outboundSchema.parse(healthResponse));
-}
-
 export function healthResponseFromJSON(
   jsonString: string,
 ): SafeParseResult<HealthResponse, SDKValidationError> {