@vepler/sdk 2.0.0 → 2.3.0

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

@@ -0,0 +1,213 @@
+/*
+ * 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(),
+});
+
+/** @internal */
+export type ConstructionAge$Outbound = {
+  endYear: number;
+  isExact: boolean;
+  midYear: number;
+  startYear: number;
+};
+
+/** @internal */
+export const ConstructionAge$outboundSchema: z.ZodType<
+  ConstructionAge$Outbound,
+  z.ZodTypeDef,
+  ConstructionAge
+> = z.object({
+  endYear: z.number(),
+  isExact: z.boolean(),
+  midYear: z.number(),
+  startYear: z.number(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ConstructionAge$ {
+  /** @deprecated use `ConstructionAge$inboundSchema` instead. */
+  export const inboundSchema = ConstructionAge$inboundSchema;
+  /** @deprecated use `ConstructionAge$outboundSchema` instead. */
+  export const outboundSchema = ConstructionAge$outboundSchema;
+  /** @deprecated use `ConstructionAge$Outbound` instead. */
+  export type Outbound = ConstructionAge$Outbound;
+}
+
+export function constructionAgeToJSON(
+  constructionAge: ConstructionAge,
+): string {
+  return JSON.stringify(ConstructionAge$outboundSchema.parse(constructionAge));
+}
+
+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(),
+});
+
+/** @internal */
+export type BuildData$Outbound = {
+  constructionAge?: ConstructionAge$Outbound | null | undefined;
+  floorHeight?: number | null | undefined;
+  mainFuel?: string | null | undefined;
+  mainsGasFlag?: string | null | undefined;
+  propertyType?: string | null | undefined;
+  roofType?: string | null | undefined;
+  subPropertyType?: string | null | undefined;
+  totalFloorArea?: number | null | undefined;
+  wallType?: string | null | undefined;
+  windowType?: string | null | undefined;
+};
+
+/** @internal */
+export const BuildData$outboundSchema: z.ZodType<
+  BuildData$Outbound,
+  z.ZodTypeDef,
+  BuildData
+> = z.object({
+  constructionAge: z.nullable(z.lazy(() => ConstructionAge$outboundSchema))
+    .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(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace BuildData$ {
+  /** @deprecated use `BuildData$inboundSchema` instead. */
+  export const inboundSchema = BuildData$inboundSchema;
+  /** @deprecated use `BuildData$outboundSchema` instead. */
+  export const outboundSchema = BuildData$outboundSchema;
+  /** @deprecated use `BuildData$Outbound` instead. */
+  export type Outbound = BuildData$Outbound;
+}
+
+export function buildDataToJSON(buildData: BuildData): string {
+  return JSON.stringify(BuildData$outboundSchema.parse(buildData));
+}
+
+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,109 @@
+/*
+ * 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(),
+});
+
+/** @internal */
+export type ChargeEntry$Outbound = {
+  confidence: number;
+  currency?: string | undefined;
+  isOutlier: boolean;
+  recordedDate: string;
+  sourceId: string;
+  sourceProvider: string;
+  value: number;
+};
+
+/** @internal */
+export const ChargeEntry$outboundSchema: z.ZodType<
+  ChargeEntry$Outbound,
+  z.ZodTypeDef,
+  ChargeEntry
+> = z.object({
+  confidence: z.number(),
+  currency: z.string().optional(),
+  isOutlier: z.boolean(),
+  recordedDate: z.date().transform(v => v.toISOString()),
+  sourceId: z.string(),
+  sourceProvider: z.string(),
+  value: z.number(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ChargeEntry$ {
+  /** @deprecated use `ChargeEntry$inboundSchema` instead. */
+  export const inboundSchema = ChargeEntry$inboundSchema;
+  /** @deprecated use `ChargeEntry$outboundSchema` instead. */
+  export const outboundSchema = ChargeEntry$outboundSchema;
+  /** @deprecated use `ChargeEntry$Outbound` instead. */
+  export type Outbound = ChargeEntry$Outbound;
+}
+
+export function chargeEntryToJSON(chargeEntry: ChargeEntry): string {
+  return JSON.stringify(ChargeEntry$outboundSchema.parse(chargeEntry));
+}
+
+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,101 @@
+/*
+ * 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,
+  ChargeEntry$Outbound,
+  ChargeEntry$outboundSchema,
+} 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)
+  ),
+});
+
+/** @internal */
+export type ChargeHistory$Outbound = {
+  confidence: number;
+  currency?: string | undefined;
+  current?: number | null | undefined;
+  entries: Array<ChargeEntry$Outbound>;
+  lastUpdated: string;
+};
+
+/** @internal */
+export const ChargeHistory$outboundSchema: z.ZodType<
+  ChargeHistory$Outbound,
+  z.ZodTypeDef,
+  ChargeHistory
+> = z.object({
+  confidence: z.number(),
+  currency: z.string().optional(),
+  current: z.nullable(z.number()).optional(),
+  entries: z.array(ChargeEntry$outboundSchema),
+  lastUpdated: z.date().transform(v => v.toISOString()),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ChargeHistory$ {
+  /** @deprecated use `ChargeHistory$inboundSchema` instead. */
+  export const inboundSchema = ChargeHistory$inboundSchema;
+  /** @deprecated use `ChargeHistory$outboundSchema` instead. */
+  export const outboundSchema = ChargeHistory$outboundSchema;
+  /** @deprecated use `ChargeHistory$Outbound` instead. */
+  export type Outbound = ChargeHistory$Outbound;
+}
+
+export function chargeHistoryToJSON(chargeHistory: ChargeHistory): string {
+  return JSON.stringify(ChargeHistory$outboundSchema.parse(chargeHistory));
+}
+
+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,97 @@
+/*
+ * 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(),
+});
+
+/** @internal */
+export type CouncilTaxBandDetails$Outbound = {
+  annualAmount: number;
+  effectiveFrom: string;
+  effectiveTo?: string | null | undefined;
+  id: number;
+  taxYear: string;
+};
+
+/** @internal */
+export const CouncilTaxBandDetails$outboundSchema: z.ZodType<
+  CouncilTaxBandDetails$Outbound,
+  z.ZodTypeDef,
+  CouncilTaxBandDetails
+> = z.object({
+  annualAmount: z.number(),
+  effectiveFrom: z.string(),
+  effectiveTo: z.nullable(z.string()).optional(),
+  id: z.number(),
+  taxYear: z.string(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace CouncilTaxBandDetails$ {
+  /** @deprecated use `CouncilTaxBandDetails$inboundSchema` instead. */
+  export const inboundSchema = CouncilTaxBandDetails$inboundSchema;
+  /** @deprecated use `CouncilTaxBandDetails$outboundSchema` instead. */
+  export const outboundSchema = CouncilTaxBandDetails$outboundSchema;
+  /** @deprecated use `CouncilTaxBandDetails$Outbound` instead. */
+  export type Outbound = CouncilTaxBandDetails$Outbound;
+}
+
+export function councilTaxBandDetailsToJSON(
+  councilTaxBandDetails: CouncilTaxBandDetails,
+): string {
+  return JSON.stringify(
+    CouncilTaxBandDetails$outboundSchema.parse(councilTaxBandDetails),
+  );
+}
+
+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,12 @@ 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,
+  CouncilTaxBandDetails$Outbound,
+  CouncilTaxBandDetails$outboundSchema,
+} from "./counciltaxbanddetails.js";
 
 /**
  * Council tax band
@@ -29,17 +35,33 @@ 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 */
@@ -67,16 +89,24 @@ export const CouncilTaxData$inboundSchema: z.ZodType<
   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;
+  councilId?: string | null | undefined;
+  currentAnnualAmount?: number | null | undefined;
+  currentTaxYear?: string | null | undefined;
+  isEstimated?: boolean | undefined;
+  status?: string | null | undefined;
+  taxBand?: string | null | undefined;
+  taxBandDetails?: Array<CouncilTaxBandDetails$Outbound> | undefined;
 };
 
 /** @internal */
@@ -85,9 +115,13 @@ export const CouncilTaxData$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   CouncilTaxData
 > = z.object({
-  annualCharge: z.number().optional(),
-  localAuthority: z.string().optional(),
-  taxBand: TaxBand$outboundSchema.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$outboundSchema).optional(),
+  taxBandDetails: z.array(CouncilTaxBandDetails$outboundSchema).optional(),
 });
 
 /**

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;
+  /**
+   * Potential annual hot water cost in pence
+   */
+  hotWaterCostPotential?: number | undefined;
   /**
-   * EPC certificate valid from date
+   * Type of main heating control system
    */
-  validFrom?: string | undefined;
+  mainHeatingControls?: string | undefined;
   /**
-   * EPC certificate valid to date
+   * Potential energy efficiency score
    */
-  validTo?: string | undefined;
+  potentialEnergyEfficiency?: number | undefined;
+  /**
+   * Potential EPC rating
+   */
+  potentialEnergyRating?: PotentialEnergyRating | undefined;
 };
 
 /** @internal */
@@ -116,20 +128,26 @@ 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;
+  heatingCostCurrent?: number | undefined;
+  heatingCostPotential?: number | undefined;
+  hotWaterCostCurrent?: number | undefined;
+  hotWaterCostPotential?: number | undefined;
+  mainHeatingControls?: string | undefined;
   potentialEnergyEfficiency?: number | undefined;
   potentialEnergyRating?: string | undefined;
-  validFrom?: string | undefined;
-  validTo?: string | undefined;
 };
 
 /** @internal */
@@ -140,10 +158,13 @@ export const EPCData$outboundSchema: z.ZodType<
 > = z.object({
   currentEnergyEfficiency: z.number().optional(),
   currentEnergyRating: CurrentEnergyRating$outboundSchema.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$outboundSchema.optional(),
-  validFrom: z.string().optional(),
-  validTo: z.string().optional(),
 });
 
 /**