@vepler/sdk 7.1.2 → 7.7.0

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

@@ -0,0 +1,69 @@
+/*
+ * 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 { NoiseBand, NoiseBand$inboundSchema } from "./noiseband.js";
+import { NoiseBandSet, NoiseBandSet$inboundSchema } from "./noisebandset.js";
+import {
+  NoiseMapSource,
+  NoiseMapSource$inboundSchema,
+} from "./noisemapsource.js";
+import {
+  NoiseReadingStatus,
+  NoiseReadingStatus$inboundSchema,
+} from "./noisereadingstatus.js";
+
+/**
+ * Day-evening-night level (Lden), weighted for the evening and night.
+ */
+export type NoiseReading = {
+  /**
+   * The band from `bandSet` the level falls in. Null when there is no level, the level is below the quietest band, or the metric has no band set.
+   */
+  band: NoiseBand | null;
+  /**
+   * The bands this metric is banded with. Null for Lnight.
+   */
+  bandSet: NoiseBandSet | null;
+  /**
+   * The lowest level the map draws, in decibels. Set when `status` is `below_floor`: the level at the point is at or below this figure.
+   */
+  floorDb: number | null;
+  /**
+   * Noise level at the point, in decibels, to one decimal place. Set only when `status` is `mapped`.
+   */
+  levelDb: number | null;
+  source: NoiseMapSource;
+  /**
+   * What the map says at the point. `mapped` means it draws a level above its floor, given in `levelDb`. `below_floor` means it draws no level above its floor, which is given in `floorDb`. `not_covered` means no map covers the point or the metric is not available there, so nothing is known about the noise.
+   */
+  status: NoiseReadingStatus;
+};
+
+/** @internal */
+export const NoiseReading$inboundSchema: z.ZodType<
+  NoiseReading,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  band: z.nullable(NoiseBand$inboundSchema),
+  bandSet: z.nullable(NoiseBandSet$inboundSchema),
+  floorDb: z.nullable(z.number()),
+  levelDb: z.nullable(z.number()),
+  source: NoiseMapSource$inboundSchema,
+  status: NoiseReadingStatus$inboundSchema,
+});
+
+export function noiseReadingFromJSON(
+  jsonString: string,
+): SafeParseResult<NoiseReading, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => NoiseReading$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'NoiseReading' from JSON`,
+  );
+}

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

@@ -0,0 +1,27 @@
+/*
+ * 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";
+
+/**
+ * What the map says at the point. `mapped` means it draws a level above its floor, given in `levelDb`. `below_floor` means it draws no level above its floor, which is given in `floorDb`. `not_covered` means no map covers the point or the metric is not available there, so nothing is known about the noise.
+ */
+export const NoiseReadingStatus = {
+  Mapped: "mapped",
+  BelowFloor: "below_floor",
+  NotCovered: "not_covered",
+} as const;
+/**
+ * What the map says at the point. `mapped` means it draws a level above its floor, given in `levelDb`. `below_floor` means it draws no level above its floor, which is given in `floorDb`. `not_covered` means no map covers the point or the metric is not available there, so nothing is known about the noise.
+ */
+export type NoiseReadingStatus = OpenEnum<typeof NoiseReadingStatus>;
+
+/** @internal */
+export const NoiseReadingStatus$inboundSchema: z.ZodType<
+  NoiseReadingStatus,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(NoiseReadingStatus);

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

@@ -0,0 +1,40 @@
+/*
+ * 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 { NoiseReading, NoiseReading$inboundSchema } from "./noisereading.js";
+
+/**
+ * Road traffic noise at the point.
+ */
+export type NoiseSourceReadings = {
+  /**
+   * Day-evening-night level (Lden), weighted for the evening and night.
+   */
+  lden: NoiseReading;
+  lnight: NoiseReading;
+};
+
+/** @internal */
+export const NoiseSourceReadings$inboundSchema: z.ZodType<
+  NoiseSourceReadings,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  lden: NoiseReading$inboundSchema,
+  lnight: NoiseReading$inboundSchema,
+});
+
+export function noiseSourceReadingsFromJSON(
+  jsonString: string,
+): SafeParseResult<NoiseSourceReadings, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => NoiseSourceReadings$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'NoiseSourceReadings' from JSON`,
+  );
+}

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

@@ -5,7 +5,8 @@
 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";
+import * as openEnums from "../../types/enums.js";
+import { ClosedEnum, OpenEnum } from "../../types/enums.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 import {
@@ -13,6 +14,49 @@ import {
   PlanningApplication$inboundSchema,
 } from "./planningapplication.js";
 
+/**
+ * How far the council's register can be relied on as of this response. 'current' means it is complete through completeThrough and that day is no more than 28 days before the request. 'unconfirmed' means completeThrough is more than 28 days before the request, or no day in the last 52 weeks can be confirmed although the register has been read, so applications received since may be missing. 'never_harvested' means no complete week of the council's register has been read, so completeThrough is null and an empty result says nothing about the area.
+ */
+export const PlanningListResponseStatus = {
+  Current: "current",
+  Unconfirmed: "unconfirmed",
+  NeverHarvested: "never_harvested",
+} as const;
+/**
+ * How far the council's register can be relied on as of this response. 'current' means it is complete through completeThrough and that day is no more than 28 days before the request. 'unconfirmed' means completeThrough is more than 28 days before the request, or no day in the last 52 weeks can be confirmed although the register has been read, so applications received since may be missing. 'never_harvested' means no complete week of the council's register has been read, so completeThrough is null and an empty result says nothing about the area.
+ */
+export type PlanningListResponseStatus = OpenEnum<
+  typeof PlanningListResponseStatus
+>;
+
+/**
+ * How current this council's planning register is.
+ */
+export type PlanningListResponseRegister = {
+  /**
+   * The last day, as YYYY-MM-DD, of the newest week of the council's register read in full that closes at least 4 consecutive weeks read in full, within the last 52 weeks. Applications the council received after this day may not be included yet. Null when no such day exists.
+   */
+  completeThrough: string | null;
+  /**
+   * How far the council's register can be relied on as of this response. 'current' means it is complete through completeThrough and that day is no more than 28 days before the request. 'unconfirmed' means completeThrough is more than 28 days before the request, or no day in the last 52 weeks can be confirmed although the register has been read, so applications received since may be missing. 'never_harvested' means no complete week of the council's register has been read, so completeThrough is null and an empty result says nothing about the area.
+   */
+  status: PlanningListResponseStatus;
+};
+
+/**
+ * A local planning authority the response covers, with how current its register is.
+ */
+export type Councils = {
+  /**
+   * Identifier for the local planning authority, the same slug as each application's provider field, for example 'lambeth'.
+   */
+  provider: string;
+  /**
+   * How current this council's planning register is.
+   */
+  register: PlanningListResponseRegister;
+};
+
 /**
  * Object type discriminator. Always `list`.
  */
@@ -26,10 +70,11 @@ export type PlanningListResponseObject = ClosedEnum<
   typeof PlanningListResponseObject
 >;
 
-/**
- * One page of results, with the metadata needed to fetch the rest.
- */
 export type PlanningListResponse = {
+  /**
+   * Every council the response covers, once each: on POST /query, each council named in the councils filter and each council holding an application that matches the request on any page; on the lookups by identifier, each council of a returned application, and on GET /sources/{sourceIds} also each council named in the identifiers. Read register to date the result: an empty data list is only evidence of no applications through that council's completeThrough day. Empty when the request names no council and matches nothing.
+   */
+  councils: Array<Councils>;
   /**
    * The items on this page.
    */
@@ -52,6 +97,53 @@ export type PlanningListResponse = {
   url: string;
 };
 
+/** @internal */
+export const PlanningListResponseStatus$inboundSchema: z.ZodType<
+  PlanningListResponseStatus,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(PlanningListResponseStatus);
+
+/** @internal */
+export const PlanningListResponseRegister$inboundSchema: z.ZodType<
+  PlanningListResponseRegister,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  completeThrough: z.nullable(z.string()),
+  status: PlanningListResponseStatus$inboundSchema,
+});
+
+export function planningListResponseRegisterFromJSON(
+  jsonString: string,
+): SafeParseResult<PlanningListResponseRegister, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PlanningListResponseRegister$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PlanningListResponseRegister' from JSON`,
+  );
+}
+
+/** @internal */
+export const Councils$inboundSchema: z.ZodType<
+  Councils,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  provider: z.string(),
+  register: z.lazy(() => PlanningListResponseRegister$inboundSchema),
+});
+
+export function councilsFromJSON(
+  jsonString: string,
+): SafeParseResult<Councils, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Councils$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Councils' from JSON`,
+  );
+}
+
 /** @internal */
 export const PlanningListResponseObject$inboundSchema: z.ZodNativeEnum<
   typeof PlanningListResponseObject
@@ -63,6 +155,7 @@ export const PlanningListResponse$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
+  councils: z.array(z.lazy(() => Councils$inboundSchema)),
   data: z.array(PlanningApplication$inboundSchema),
   has_more: z.boolean(),
   object: PlanningListResponseObject$inboundSchema,

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

@@ -0,0 +1,46 @@
+/*
+ * 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 { HazardEdition, HazardEdition$inboundSchema } from "./hazardedition.js";
+import { RadonSquare, RadonSquare$inboundSchema } from "./radonsquare.js";
+
+export type RadonPointResponse = {
+  /**
+   * Whether a square of the atlas contains the point. False for a point the atlas does not map, such as one offshore; `square` is then null and nothing is known about radon there.
+   */
+  covered: boolean;
+  /**
+   * The atlas release the square was read from. Null when `covered` is false.
+   */
+  edition: HazardEdition | null;
+  /**
+   * The atlas square containing the point. A point on the shared edge or corner of squares takes the square with the highest class. Null when `covered` is false.
+   */
+  square: RadonSquare | null;
+};
+
+/** @internal */
+export const RadonPointResponse$inboundSchema: z.ZodType<
+  RadonPointResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  covered: z.boolean(),
+  edition: z.nullable(HazardEdition$inboundSchema),
+  square: z.nullable(RadonSquare$inboundSchema),
+});
+
+export function radonPointResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<RadonPointResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => RadonPointResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'RadonPointResponse' from JSON`,
+  );
+}

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

@@ -0,0 +1,42 @@
+/*
+ * 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";
+
+/**
+ * The class as a band of the share of homes in the square estimated to be at or above the radon Action Level: 0 to 1 for class 1, 1 to 3 for class 2, 3 to 5 for class 3, 5 to 10 for class 4, 10 to 30 for class 5, and 30 to 100 for class 6.
+ */
+export type RadonPotentialBand = {
+  /**
+   * Lower bound of the band, as a percentage of homes.
+   */
+  lowerPercent: number;
+  /**
+   * Upper bound of the band, as a percentage of homes.
+   */
+  upperPercent: number;
+};
+
+/** @internal */
+export const RadonPotentialBand$inboundSchema: z.ZodType<
+  RadonPotentialBand,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  lowerPercent: z.number(),
+  upperPercent: z.number(),
+});
+
+export function radonPotentialBandFromJSON(
+  jsonString: string,
+): SafeParseResult<RadonPotentialBand, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => RadonPotentialBand$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'RadonPotentialBand' from JSON`,
+  );
+}

package/src/sdk/models/shared/radonsquare.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 { HazardOutline, HazardOutline$inboundSchema } from "./hazardoutline.js";
+import {
+  RadonPotentialBand,
+  RadonPotentialBand$inboundSchema,
+} from "./radonpotentialband.js";
+
+/**
+ * The atlas square containing the point. A point on the shared edge or corner of squares takes the square with the highest class. Null when `covered` is false.
+ */
+export type RadonSquare = {
+  /**
+   * The 1 km square's grid reference, for example `TQ5812`.
+   */
+  gridReference: string;
+  /**
+   * The outline as a GeoJSON MultiPolygon in WGS84.
+   */
+  outline: HazardOutline;
+  /**
+   * The class as a band of the share of homes in the square estimated to be at or above the radon Action Level: 0 to 1 for class 1, 1 to 3 for class 2, 3 to 5 for class 3, 5 to 10 for class 4, 10 to 30 for class 5, and 30 to 100 for class 6.
+   */
+  potential: RadonPotentialBand;
+  /**
+   * The square's radon class in the Indicative Atlas of Radon, from 1 (lowest potential) to 6 (highest). It is the highest class mapped anywhere in the square.
+   */
+  radonClass: number;
+};
+
+/** @internal */
+export const RadonSquare$inboundSchema: z.ZodType<
+  RadonSquare,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  gridReference: z.string(),
+  outline: HazardOutline$inboundSchema,
+  potential: RadonPotentialBand$inboundSchema,
+  radonClass: z.number().int(),
+});
+
+export function radonSquareFromJSON(
+  jsonString: string,
+): SafeParseResult<RadonSquare, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => RadonSquare$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'RadonSquare' from JSON`,
+  );
+}

package/src/sdk/noise.ts

@@ -0,0 +1,27 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { noisePoint } from "../funcs/noisePoint.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as shared from "./models/shared/index.js";
+import { unwrapAsync } from "./types/fp.js";
+
+export class Noise extends ClientSDK {
+  /**
+   * Read road and rail noise at a coordinate
+   *
+   * @remarks
+   * Returns road traffic and railway noise at one latitude and longitude, each as a day-evening-night level (Lden) and a night level (Lnight) in decibels. Read `status` on each reading before its level: `mapped` carries a level, `below_floor` states the lowest level the map draws instead of a level, and `not_covered` means no map covers the point or the metric is not available there. Each reading names its map's publisher, round, data year, edition and licence where the map states them, with the attribution and any use limitation the publisher requires to be shown alongside it. `nations` lists which UK nations the maps cover.
+   */
+  async point(
+    request?: shared.NoisePointRequest | undefined,
+    options?: RequestOptions,
+  ): Promise<shared.NoisePointResponse> {
+    return unwrapAsync(noisePoint(
+      this,
+      request,
+      options,
+    ));
+  }
+}

package/src/sdk/poi.ts

@@ -16,7 +16,7 @@ export class Poi extends ClientSDK {
    * Find nearest points of interest
    *
    * @remarks
-   * Returns the points of interest closest to a location, nearest first, with the straight-line distance to each. Narrow the search with `types`, and add distances and times along roads and paths with `routing`.
+   * Returns the points of interest closest to a location, nearest first, with the straight-line distance and the direction to each. Narrow the search with `types`, and add distances and times by car, by bicycle and on foot with `routing`.
    */
   async getNearestPOI(
     request: operations.GetNearestPOIRequest,

package/src/sdk/sdk.ts

@@ -22,6 +22,7 @@ import { LandConstraint } from "./landconstraint.js";
 import { Listings } from "./listings.js";
 import { Metrics } from "./metrics.js";
 import { Models } from "./models.js";
+import { Noise } from "./noise.js";
 import { Planning } from "./planning.js";
 import { Poi } from "./poi.js";
 import { Property } from "./property.js";
@@ -147,6 +148,11 @@ export class SDK extends ClientSDK {
     return (this._streets ??= new Streets(this._options));
   }
 
+  private _noise?: Noise;
+  get noise(): Noise {
+    return (this._noise ??= new Noise(this._options));
+  }
+
   private _planning?: Planning;
   get planning(): Planning {
     return (this._planning ??= new Planning(this._options));