@vepler/sdk 1.10.1 → 2.3.0

package/src/sdk/models/operations/searchplanningapplications.ts

@@ -2,7 +2,7 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
-import * as z from "zod";
+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";

package/src/sdk/models/operations/searchproperties.ts

@@ -2,7 +2,7 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
-import * as z from "zod";
+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";

package/src/sdk/models/operations/searchschoolsnearby.ts

@@ -2,7 +2,7 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
-import * as z from "zod";
+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";
@@ -23,37 +23,13 @@ export const Unit = {
 export type Unit = ClosedEnum<typeof Unit>;
 
 export type SearchSchoolsNearbyRequest = {
-  /**
-   * Comma-separated list of related data to include (currently supports: ratings)
-   */
   expand?: string | undefined;
-  /**
-   * Comma-separated list of fields to include
-   */
   fields?: string | undefined;
-  /**
-   * Latitude coordinate
-   */
   latitude: string;
-  /**
-   * Maximum number of results
-   */
   limit?: string | undefined;
-  /**
-   * Longitude coordinate
-   */
   longitude: string;
-  /**
-   * Search radius
-   */
   radius?: string | undefined;
-  /**
-   * Ofsted rating filter
-   */
   rating?: string | undefined;
-  /**
-   * School status filter
-   */
   status?: string | undefined;
   /**
    * Unit for radius

package/src/sdk/models/operations/searchschoolswithin.ts

@@ -2,7 +2,7 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
-import * as z from "zod";
+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";
@@ -11,41 +11,14 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 import * as shared from "../shared/index.js";
 
 export type SearchSchoolsWithinRequest = {
-  /**
-   * Eastern boundary longitude
-   */
   east: string;
-  /**
-   * Comma-separated list of related data to include (currently supports: ratings)
-   */
   expand?: string | undefined;
-  /**
-   * Comma-separated list of fields to include
-   */
   fields?: string | undefined;
-  /**
-   * Maximum number of results
-   */
   limit?: string | undefined;
-  /**
-   * Northern boundary latitude
-   */
   north: string;
-  /**
-   * Ofsted rating filter
-   */
   rating?: string | undefined;
-  /**
-   * Southern boundary latitude
-   */
   south: string;
-  /**
-   * School status filter
-   */
   status?: string | undefined;
-  /**
-   * Western boundary longitude
-   */
   west: string;
 };
 

package/src/sdk/models/operations/searchstreets.ts

@@ -2,7 +2,7 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
-import * as z from "zod";
+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";

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