@vepler/sdk 1.10.1 → 2.3.0

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

@@ -0,0 +1,102 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+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";
+
+/**
+ * Size of refurbishment required
+ */
+export const RefurbSize = {
+  Small: "small",
+  Medium: "medium",
+  Large: "large",
+} as const;
+/**
+ * Size of refurbishment required
+ */
+export type RefurbSize = ClosedEnum<typeof RefurbSize>;
+
+export type RefurbishmentData = {
+  /**
+   * Size of refurbishment required
+   */
+  refurbSize?: RefurbSize | null | undefined;
+};
+
+/** @internal */
+export const RefurbSize$inboundSchema: z.ZodNativeEnum<typeof RefurbSize> = z
+  .nativeEnum(RefurbSize);
+
+/** @internal */
+export const RefurbSize$outboundSchema: z.ZodNativeEnum<typeof RefurbSize> =
+  RefurbSize$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace RefurbSize$ {
+  /** @deprecated use `RefurbSize$inboundSchema` instead. */
+  export const inboundSchema = RefurbSize$inboundSchema;
+  /** @deprecated use `RefurbSize$outboundSchema` instead. */
+  export const outboundSchema = RefurbSize$outboundSchema;
+}
+
+/** @internal */
+export const RefurbishmentData$inboundSchema: z.ZodType<
+  RefurbishmentData,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  refurbSize: z.nullable(RefurbSize$inboundSchema).optional(),
+});
+
+/** @internal */
+export type RefurbishmentData$Outbound = {
+  refurbSize?: string | null | undefined;
+};
+
+/** @internal */
+export const RefurbishmentData$outboundSchema: z.ZodType<
+  RefurbishmentData$Outbound,
+  z.ZodTypeDef,
+  RefurbishmentData
+> = z.object({
+  refurbSize: z.nullable(RefurbSize$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 RefurbishmentData$ {
+  /** @deprecated use `RefurbishmentData$inboundSchema` instead. */
+  export const inboundSchema = RefurbishmentData$inboundSchema;
+  /** @deprecated use `RefurbishmentData$outboundSchema` instead. */
+  export const outboundSchema = RefurbishmentData$outboundSchema;
+  /** @deprecated use `RefurbishmentData$Outbound` instead. */
+  export type Outbound = RefurbishmentData$Outbound;
+}
+
+export function refurbishmentDataToJSON(
+  refurbishmentData: RefurbishmentData,
+): string {
+  return JSON.stringify(
+    RefurbishmentData$outboundSchema.parse(refurbishmentData),
+  );
+}
+
+export function refurbishmentDataFromJSON(
+  jsonString: string,
+): SafeParseResult<RefurbishmentData, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => RefurbishmentData$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'RefurbishmentData' from JSON`,
+  );
+}

package/src/sdk/models/shared/roomdetails.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";
@@ -11,15 +11,11 @@ export type RoomDetails = {
   /**
    * Number of bathrooms
    */
-  baths?: number | undefined;
+  baths?: number | null | undefined;
   /**
    * Number of bedrooms
    */
-  beds?: number | undefined;
-  /**
-   * Number of reception rooms
-   */
-  receptions?: number | undefined;
+  beds?: number | null | undefined;
 };
 
 /** @internal */
@@ -28,16 +24,14 @@ export const RoomDetails$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  baths: z.number().optional(),
-  beds: z.number().optional(),
-  receptions: z.number().optional(),
+  baths: z.nullable(z.number()).optional(),
+  beds: z.nullable(z.number()).optional(),
 });
 
 /** @internal */
 export type RoomDetails$Outbound = {
-  baths?: number | undefined;
-  beds?: number | undefined;
-  receptions?: number | undefined;
+  baths?: number | null | undefined;
+  beds?: number | null | undefined;
 };
 
 /** @internal */
@@ -46,9 +40,8 @@ export const RoomDetails$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   RoomDetails
 > = z.object({
-  baths: z.number().optional(),
-  beds: z.number().optional(),
-  receptions: z.number().optional(),
+  baths: z.nullable(z.number()).optional(),
+  beds: z.nullable(z.number()).optional(),
 });
 
 /**

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

@@ -2,28 +2,24 @@
  * 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";
 
 export type SaleRecord = {
   /**
-   * Sale completion date
-   */
-  date: string;
-  /**
-   * Was a new build at time of sale
+   * Sale price in pence
    */
-  newBuild?: boolean | undefined;
+  amount: number;
   /**
-   * Sale price in pence
+   * Sale completion date
    */
-  price: number;
+  date: Date;
   /**
-   * Property type at time of sale
+   * Source identifier for this sale record
    */
-  propertyType?: string | undefined;
+  sourceId: string;
 };
 
 /** @internal */
@@ -32,18 +28,16 @@ export const SaleRecord$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  date: z.string(),
-  newBuild: z.boolean().optional(),
-  price: z.number(),
-  propertyType: z.string().optional(),
+  amount: z.number(),
+  date: z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  sourceId: z.string(),
 });
 
 /** @internal */
 export type SaleRecord$Outbound = {
+  amount: number;
   date: string;
-  newBuild?: boolean | undefined;
-  price: number;
-  propertyType?: string | undefined;
+  sourceId: string;
 };
 
 /** @internal */
@@ -52,10 +46,9 @@ export const SaleRecord$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   SaleRecord
 > = z.object({
-  date: z.string(),
-  newBuild: z.boolean().optional(),
-  price: z.number(),
-  propertyType: z.string().optional(),
+  amount: z.number(),
+  date: z.date().transform(v => v.toISOString()),
+  sourceId: z.string(),
 });
 
 /**

package/src/sdk/models/shared/school.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 { ClosedEnum } from "../../types/enums.js";
 import { Result as SafeParseResult } from "../../types/fp.js";

package/src/sdk/models/shared/security.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/streetdescriptor.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/streetdetails.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/streetquerybycoordinates.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 { ClosedEnum } from "../../types/enums.js";
 import { Result as SafeParseResult } from "../../types/fp.js";

package/src/sdk/models/shared/streetquerybyname.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 { ClosedEnum } from "../../types/enums.js";
 import { Result as SafeParseResult } from "../../types/fp.js";

package/src/sdk/models/shared/streetquerybypostcode.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 { ClosedEnum } from "../../types/enums.js";
 import { Result as SafeParseResult } from "../../types/fp.js";

package/src/sdk/models/shared/streetquerybyuprn.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 { ClosedEnum } from "../../types/enums.js";
 import { Result as SafeParseResult } from "../../types/fp.js";

package/src/sdk/models/shared/streetquerybyusrn.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 { ClosedEnum } from "../../types/enums.js";
 import { Result as SafeParseResult } from "../../types/fp.js";

package/src/sdk/models/shared/streetqueryrequest.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/streetqueryresponse.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/streetstatistics.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/tenancydata.ts

@@ -0,0 +1,72 @@
+/*
+ * 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 TenancyData = {
+  /**
+   * Confidence score for tenancy status
+   */
+  confidenceScore: number;
+  /**
+   * Whether property is currently tenanted
+   */
+  isTenanted?: boolean | null | undefined;
+};
+
+/** @internal */
+export const TenancyData$inboundSchema: z.ZodType<
+  TenancyData,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  confidenceScore: z.number(),
+  isTenanted: z.nullable(z.boolean()).optional(),
+});
+
+/** @internal */
+export type TenancyData$Outbound = {
+  confidenceScore: number;
+  isTenanted?: boolean | null | undefined;
+};
+
+/** @internal */
+export const TenancyData$outboundSchema: z.ZodType<
+  TenancyData$Outbound,
+  z.ZodTypeDef,
+  TenancyData
+> = z.object({
+  confidenceScore: z.number(),
+  isTenanted: z.nullable(z.boolean()).optional(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace TenancyData$ {
+  /** @deprecated use `TenancyData$inboundSchema` instead. */
+  export const inboundSchema = TenancyData$inboundSchema;
+  /** @deprecated use `TenancyData$outboundSchema` instead. */
+  export const outboundSchema = TenancyData$outboundSchema;
+  /** @deprecated use `TenancyData$Outbound` instead. */
+  export type Outbound = TenancyData$Outbound;
+}
+
+export function tenancyDataToJSON(tenancyData: TenancyData): string {
+  return JSON.stringify(TenancyData$outboundSchema.parse(tenancyData));
+}
+
+export function tenancyDataFromJSON(
+  jsonString: string,
+): SafeParseResult<TenancyData, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => TenancyData$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'TenancyData' from JSON`,
+  );
+}

package/src/sdk/models/shared/tenuredata.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 { ClosedEnum } from "../../types/enums.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
@@ -22,22 +22,10 @@ export const TenureDataType = {
 export type TenureDataType = ClosedEnum<typeof TenureDataType>;
 
 export type TenureData = {
-  /**
-   * Annual ground rent in pence
-   */
-  groundRent?: number | undefined;
-  /**
-   * Years remaining on lease
-   */
-  leaseYearsRemaining?: number | undefined;
-  /**
-   * Annual service charge in pence
-   */
-  serviceCharge?: number | undefined;
   /**
    * Property tenure type
    */
-  type?: TenureDataType | undefined;
+  type?: TenureDataType | null | undefined;
 };
 
 /** @internal */
@@ -67,18 +55,12 @@ export const TenureData$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  groundRent: z.number().optional(),
-  leaseYearsRemaining: z.number().optional(),
-  serviceCharge: z.number().optional(),
-  type: TenureDataType$inboundSchema.optional(),
+  type: z.nullable(TenureDataType$inboundSchema).optional(),
 });
 
 /** @internal */
 export type TenureData$Outbound = {
-  groundRent?: number | undefined;
-  leaseYearsRemaining?: number | undefined;
-  serviceCharge?: number | undefined;
-  type?: string | undefined;
+  type?: string | null | undefined;
 };
 
 /** @internal */
@@ -87,10 +69,7 @@ export const TenureData$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   TenureData
 > = z.object({
-  groundRent: z.number().optional(),
-  leaseYearsRemaining: z.number().optional(),
-  serviceCharge: z.number().optional(),
-  type: TenureDataType$outboundSchema.optional(),
+  type: z.nullable(TenureDataType$outboundSchema).optional(),
 });
 
 /**

package/src/sdk/poi.ts

@@ -0,0 +1,65 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { poiGetNearestPOI } from "../funcs/poiGetNearestPOI.js";
+import { poiGetPOIMultipleTiles } from "../funcs/poiGetPOIMultipleTiles.js";
+import { GetPOITileAcceptEnum, poiGetPOITile } from "../funcs/poiGetPOITile.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as operations from "./models/operations/index.js";
+import { unwrapAsync } from "./types/fp.js";
+
+export { GetPOITileAcceptEnum } from "../funcs/poiGetPOITile.js";
+
+export class Poi extends ClientSDK {
+  /**
+   * Find nearest points of interest
+   *
+   * @remarks
+   * Find the nearest points of interest to a given location. Filter by POI category and optionally include routing distances.
+   */
+  async getNearestPOI(
+    request: operations.GetNearestPOIRequest,
+    options?: RequestOptions,
+  ): Promise<operations.GetNearestPOIResponse> {
+    return unwrapAsync(poiGetNearestPOI(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Get POIs from multiple tiles
+   *
+   * @remarks
+   * Retrieve points of interest from multiple map tiles in a single request. Tiles specified as comma-separated z/x/y values.
+   */
+  async getPOIMultipleTiles(
+    request: operations.GetPOIMultipleTilesRequest,
+    options?: RequestOptions,
+  ): Promise<operations.GetPOIMultipleTilesResponse> {
+    return unwrapAsync(poiGetPOIMultipleTiles(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Get POIs in a map tile
+   *
+   * @remarks
+   * Retrieve points of interest within a map tile specified by z/x/y coordinates. Supports GeoJSON and MVT formats.
+   */
+  async getPOITile(
+    request: operations.GetPOITileRequest,
+    options?: RequestOptions & { acceptHeaderOverride?: GetPOITileAcceptEnum },
+  ): Promise<operations.GetPOITileResponse> {
+    return unwrapAsync(poiGetPOITile(
+      this,
+      request,
+      options,
+    ));
+  }
+}

package/src/sdk/schools.ts

@@ -5,7 +5,9 @@
 import { schoolsGet } from "../funcs/schoolsGet.js";
 import { schoolsGetBySlug } from "../funcs/schoolsGetBySlug.js";
 import { schoolsGetByUrn } from "../funcs/schoolsGetByUrn.js";
+import { schoolsGetMetrics } from "../funcs/schoolsGetMetrics.js";
 import { schoolsList } from "../funcs/schoolsList.js";
+import { schoolsListProfiles } from "../funcs/schoolsListProfiles.js";
 import { schoolsSearchNearby } from "../funcs/schoolsSearchNearby.js";
 import { schoolsSearchWithin } from "../funcs/schoolsSearchWithin.js";
 import { ClientSDK, RequestOptions } from "../lib/sdks.js";
@@ -64,6 +66,23 @@ export class Schools extends ClientSDK {
     ));
   }
 
+  /**
+   * Get school metrics
+   *
+   * @remarks
+   * Retrieve metrics for specified schools using metric codes or predefined profiles. Supports both point-in-time and time series queries.
+   */
+  async getMetrics(
+    request: operations.GetSchoolMetricsRequest,
+    options?: RequestOptions,
+  ): Promise<operations.GetSchoolMetricsResponse> {
+    return unwrapAsync(schoolsGetMetrics(
+      this,
+      request,
+      options,
+    ));
+  }
+
   /**
    * List schools
    *
@@ -81,6 +100,21 @@ export class Schools extends ClientSDK {
     ));
   }
 
+  /**
+   * List metric profiles
+   *
+   * @remarks
+   * Get a list of all available metric profiles with their descriptions and metric counts
+   */
+  async listProfiles(
+    options?: RequestOptions,
+  ): Promise<operations.GetMetricProfilesResponseBody> {
+    return unwrapAsync(schoolsListProfiles(
+      this,
+      options,
+    ));
+  }
+
   /**
    * Search schools near location
    *