@vepler/sdk 2.133.0 → 2.138.0

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

@@ -0,0 +1,608 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../../lib/schemas.js";
+import * as openEnums from "../../types/enums.js";
+import { OpenEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  ExtractionCitation,
+  ExtractionCitation$inboundSchema,
+} from "./extractioncitation.js";
+
+/**
+ * Number of affordable units. Null when not residential / not stated.
+ */
+export type AffordableUnitsCount = {
+  /**
+   * Source provenance for this value, or null when inferred / not separately grounded by a single quote.
+   */
+  citation: ExtractionCitation | null;
+  value: number;
+};
+
+/**
+ * Cycle parking spaces provided. Null when not stated.
+ */
+export type CycleSpaces = {
+  /**
+   * Source provenance for this value, or null when inferred / not separately grounded by a single quote.
+   */
+  citation: ExtractionCitation | null;
+  value: number;
+};
+
+/**
+ * Official proposal description, quoted verbatim. Null when none present.
+ */
+export type Description = {
+  /**
+   * Source provenance for this value, or null when inferred / not separately grounded by a single quote.
+   */
+  citation: ExtractionCitation | null;
+  value: string;
+};
+
+/**
+ * Primary nature of the development.
+ */
+export const PlanningDevelopmentExtractionValue = {
+  NewBuild: "new_build",
+  Extension: "extension",
+  Conversion: "conversion",
+  ChangeOfUse: "change_of_use",
+  Demolition: "demolition",
+  Refurbishment: "refurbishment",
+  Advertisement: "advertisement",
+  Outline: "outline",
+  ReservedMatters: "reserved_matters",
+  Other: "other",
+} as const;
+/**
+ * Primary nature of the development.
+ */
+export type PlanningDevelopmentExtractionValue = OpenEnum<
+  typeof PlanningDevelopmentExtractionValue
+>;
+
+/**
+ * Categorised development type. Null when wholly unclear.
+ */
+export type DevelopmentType = {
+  /**
+   * Source provenance for this value, or null when inferred / not separately grounded by a single quote.
+   */
+  citation: ExtractionCitation | null;
+  /**
+   * Primary nature of the development.
+   */
+  value: PlanningDevelopmentExtractionValue;
+};
+
+/**
+ * Gross Internal Area in square metres. Null when not stated.
+ */
+export type FloorAreaGiaSqm = {
+  /**
+   * Source provenance for this value, or null when inferred / not separately grounded by a single quote.
+   */
+  citation: ExtractionCitation | null;
+  value: number;
+};
+
+/**
+ * Net Internal Area in square metres. Null when not stated.
+ */
+export type FloorAreaNiaSqm = {
+  /**
+   * Source provenance for this value, or null when inferred / not separately grounded by a single quote.
+   */
+  citation: ExtractionCitation | null;
+  value: number;
+};
+
+/**
+ * Whether affordable housing is provided. Null when not residential / not addressed.
+ */
+export type HasAffordableHousing = {
+  /**
+   * Source provenance for this value, or null when inferred / not separately grounded by a single quote.
+   */
+  citation: ExtractionCitation | null;
+  value: boolean;
+};
+
+/**
+ * Whether the application is retrospective (works already done). Null when not stated.
+ */
+export type IsRetrospective = {
+  /**
+   * Source provenance for this value, or null when inferred / not separately grounded by a single quote.
+   */
+  citation: ExtractionCitation | null;
+  value: boolean;
+};
+
+/**
+ * Maximum building height in metres above ground. Null when not stated.
+ */
+export type MaxHeightMetres = {
+  /**
+   * Source provenance for this value, or null when inferred / not separately grounded by a single quote.
+   */
+  citation: ExtractionCitation | null;
+  value: number;
+};
+
+/**
+ * Car parking spaces provided. Null when not stated.
+ */
+export type ParkingSpaces = {
+  /**
+   * Source provenance for this value, or null when inferred / not separately grounded by a single quote.
+   */
+  citation: ExtractionCitation | null;
+  value: number;
+};
+
+/**
+ * Number of storeys above ground. Null when not applicable / not stated.
+ */
+export type Storeys = {
+  /**
+   * Source provenance for this value, or null when inferred / not separately grounded by a single quote.
+   */
+  citation: ExtractionCitation | null;
+  value: number;
+};
+
+/**
+ * New commercial / non-residential units. Null when not commercial.
+ */
+export type UnitsCommercial = {
+  /**
+   * Source provenance for this value, or null when inferred / not separately grounded by a single quote.
+   */
+  citation: ExtractionCitation | null;
+  value: number;
+};
+
+/**
+ * New residential dwellings. Null when not residential.
+ */
+export type UnitsResidential = {
+  /**
+   * Source provenance for this value, or null when inferred / not separately grounded by a single quote.
+   */
+  citation: ExtractionCitation | null;
+  value: number;
+};
+
+/**
+ * Total new units (residential + commercial). Null when not unit-based.
+ */
+export type UnitsTotal = {
+  /**
+   * Source provenance for this value, or null when inferred / not separately grounded by a single quote.
+   */
+  citation: ExtractionCitation | null;
+  value: number;
+};
+
+/**
+ * UK Use Class token (e.g. 'C3', 'E(g)', 'Sui Generis') — proposed class on change of use. Null when not stated.
+ */
+export type UseClass = {
+  /**
+   * Source provenance for this value, or null when inferred / not separately grounded by a single quote.
+   */
+  citation: ExtractionCitation | null;
+  value: string;
+};
+
+export type PlanningDevelopmentExtraction = {
+  /**
+   * Number of affordable units. Null when not residential / not stated.
+   */
+  affordableUnitsCount: AffordableUnitsCount | null;
+  /**
+   * Cycle parking spaces provided. Null when not stated.
+   */
+  cycleSpaces: CycleSpaces | null;
+  /**
+   * Official proposal description, quoted verbatim. Null when none present.
+   */
+  description: Description | null;
+  /**
+   * Categorised development type. Null when wholly unclear.
+   */
+  developmentType: DevelopmentType | null;
+  /**
+   * Gross Internal Area in square metres. Null when not stated.
+   */
+  floorAreaGiaSqm: FloorAreaGiaSqm | null;
+  /**
+   * Net Internal Area in square metres. Null when not stated.
+   */
+  floorAreaNiaSqm: FloorAreaNiaSqm | null;
+  /**
+   * Whether affordable housing is provided. Null when not residential / not addressed.
+   */
+  hasAffordableHousing: HasAffordableHousing | null;
+  /**
+   * Whether the application is retrospective (works already done). Null when not stated.
+   */
+  isRetrospective: IsRetrospective | null;
+  /**
+   * Maximum building height in metres above ground. Null when not stated.
+   */
+  maxHeightMetres: MaxHeightMetres | null;
+  /**
+   * Car parking spaces provided. Null when not stated.
+   */
+  parkingSpaces: ParkingSpaces | null;
+  /**
+   * Number of storeys above ground. Null when not applicable / not stated.
+   */
+  storeys: Storeys | null;
+  /**
+   * New commercial / non-residential units. Null when not commercial.
+   */
+  unitsCommercial: UnitsCommercial | null;
+  /**
+   * New residential dwellings. Null when not residential.
+   */
+  unitsResidential: UnitsResidential | null;
+  /**
+   * Total new units (residential + commercial). Null when not unit-based.
+   */
+  unitsTotal: UnitsTotal | null;
+  /**
+   * UK Use Class token (e.g. 'C3', 'E(g)', 'Sui Generis') — proposed class on change of use. Null when not stated.
+   */
+  useClass: UseClass | null;
+};
+
+/** @internal */
+export const AffordableUnitsCount$inboundSchema: z.ZodType<
+  AffordableUnitsCount,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  citation: z.nullable(ExtractionCitation$inboundSchema),
+  value: z.number(),
+});
+
+export function affordableUnitsCountFromJSON(
+  jsonString: string,
+): SafeParseResult<AffordableUnitsCount, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AffordableUnitsCount$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AffordableUnitsCount' from JSON`,
+  );
+}
+
+/** @internal */
+export const CycleSpaces$inboundSchema: z.ZodType<
+  CycleSpaces,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  citation: z.nullable(ExtractionCitation$inboundSchema),
+  value: z.number(),
+});
+
+export function cycleSpacesFromJSON(
+  jsonString: string,
+): SafeParseResult<CycleSpaces, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CycleSpaces$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CycleSpaces' from JSON`,
+  );
+}
+
+/** @internal */
+export const Description$inboundSchema: z.ZodType<
+  Description,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  citation: z.nullable(ExtractionCitation$inboundSchema),
+  value: z.string(),
+});
+
+export function descriptionFromJSON(
+  jsonString: string,
+): SafeParseResult<Description, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Description$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Description' from JSON`,
+  );
+}
+
+/** @internal */
+export const PlanningDevelopmentExtractionValue$inboundSchema: z.ZodType<
+  PlanningDevelopmentExtractionValue,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(PlanningDevelopmentExtractionValue);
+
+/** @internal */
+export const DevelopmentType$inboundSchema: z.ZodType<
+  DevelopmentType,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  citation: z.nullable(ExtractionCitation$inboundSchema),
+  value: PlanningDevelopmentExtractionValue$inboundSchema,
+});
+
+export function developmentTypeFromJSON(
+  jsonString: string,
+): SafeParseResult<DevelopmentType, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => DevelopmentType$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'DevelopmentType' from JSON`,
+  );
+}
+
+/** @internal */
+export const FloorAreaGiaSqm$inboundSchema: z.ZodType<
+  FloorAreaGiaSqm,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  citation: z.nullable(ExtractionCitation$inboundSchema),
+  value: z.number(),
+});
+
+export function floorAreaGiaSqmFromJSON(
+  jsonString: string,
+): SafeParseResult<FloorAreaGiaSqm, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => FloorAreaGiaSqm$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'FloorAreaGiaSqm' from JSON`,
+  );
+}
+
+/** @internal */
+export const FloorAreaNiaSqm$inboundSchema: z.ZodType<
+  FloorAreaNiaSqm,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  citation: z.nullable(ExtractionCitation$inboundSchema),
+  value: z.number(),
+});
+
+export function floorAreaNiaSqmFromJSON(
+  jsonString: string,
+): SafeParseResult<FloorAreaNiaSqm, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => FloorAreaNiaSqm$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'FloorAreaNiaSqm' from JSON`,
+  );
+}
+
+/** @internal */
+export const HasAffordableHousing$inboundSchema: z.ZodType<
+  HasAffordableHousing,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  citation: z.nullable(ExtractionCitation$inboundSchema),
+  value: z.boolean(),
+});
+
+export function hasAffordableHousingFromJSON(
+  jsonString: string,
+): SafeParseResult<HasAffordableHousing, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => HasAffordableHousing$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'HasAffordableHousing' from JSON`,
+  );
+}
+
+/** @internal */
+export const IsRetrospective$inboundSchema: z.ZodType<
+  IsRetrospective,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  citation: z.nullable(ExtractionCitation$inboundSchema),
+  value: z.boolean(),
+});
+
+export function isRetrospectiveFromJSON(
+  jsonString: string,
+): SafeParseResult<IsRetrospective, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => IsRetrospective$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'IsRetrospective' from JSON`,
+  );
+}
+
+/** @internal */
+export const MaxHeightMetres$inboundSchema: z.ZodType<
+  MaxHeightMetres,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  citation: z.nullable(ExtractionCitation$inboundSchema),
+  value: z.number(),
+});
+
+export function maxHeightMetresFromJSON(
+  jsonString: string,
+): SafeParseResult<MaxHeightMetres, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => MaxHeightMetres$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'MaxHeightMetres' from JSON`,
+  );
+}
+
+/** @internal */
+export const ParkingSpaces$inboundSchema: z.ZodType<
+  ParkingSpaces,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  citation: z.nullable(ExtractionCitation$inboundSchema),
+  value: z.number(),
+});
+
+export function parkingSpacesFromJSON(
+  jsonString: string,
+): SafeParseResult<ParkingSpaces, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ParkingSpaces$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ParkingSpaces' from JSON`,
+  );
+}
+
+/** @internal */
+export const Storeys$inboundSchema: z.ZodType<Storeys, z.ZodTypeDef, unknown> =
+  z.object({
+    citation: z.nullable(ExtractionCitation$inboundSchema),
+    value: z.number(),
+  });
+
+export function storeysFromJSON(
+  jsonString: string,
+): SafeParseResult<Storeys, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Storeys$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Storeys' from JSON`,
+  );
+}
+
+/** @internal */
+export const UnitsCommercial$inboundSchema: z.ZodType<
+  UnitsCommercial,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  citation: z.nullable(ExtractionCitation$inboundSchema),
+  value: z.number(),
+});
+
+export function unitsCommercialFromJSON(
+  jsonString: string,
+): SafeParseResult<UnitsCommercial, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => UnitsCommercial$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'UnitsCommercial' from JSON`,
+  );
+}
+
+/** @internal */
+export const UnitsResidential$inboundSchema: z.ZodType<
+  UnitsResidential,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  citation: z.nullable(ExtractionCitation$inboundSchema),
+  value: z.number(),
+});
+
+export function unitsResidentialFromJSON(
+  jsonString: string,
+): SafeParseResult<UnitsResidential, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => UnitsResidential$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'UnitsResidential' from JSON`,
+  );
+}
+
+/** @internal */
+export const UnitsTotal$inboundSchema: z.ZodType<
+  UnitsTotal,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  citation: z.nullable(ExtractionCitation$inboundSchema),
+  value: z.number(),
+});
+
+export function unitsTotalFromJSON(
+  jsonString: string,
+): SafeParseResult<UnitsTotal, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => UnitsTotal$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'UnitsTotal' from JSON`,
+  );
+}
+
+/** @internal */
+export const UseClass$inboundSchema: z.ZodType<
+  UseClass,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  citation: z.nullable(ExtractionCitation$inboundSchema),
+  value: z.string(),
+});
+
+export function useClassFromJSON(
+  jsonString: string,
+): SafeParseResult<UseClass, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => UseClass$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'UseClass' from JSON`,
+  );
+}
+
+/** @internal */
+export const PlanningDevelopmentExtraction$inboundSchema: z.ZodType<
+  PlanningDevelopmentExtraction,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  affordableUnitsCount: z.nullable(
+    z.lazy(() => AffordableUnitsCount$inboundSchema),
+  ),
+  cycleSpaces: z.nullable(z.lazy(() => CycleSpaces$inboundSchema)),
+  description: z.nullable(z.lazy(() => Description$inboundSchema)),
+  developmentType: z.nullable(z.lazy(() => DevelopmentType$inboundSchema)),
+  floorAreaGiaSqm: z.nullable(z.lazy(() => FloorAreaGiaSqm$inboundSchema)),
+  floorAreaNiaSqm: z.nullable(z.lazy(() => FloorAreaNiaSqm$inboundSchema)),
+  hasAffordableHousing: z.nullable(
+    z.lazy(() => HasAffordableHousing$inboundSchema),
+  ),
+  isRetrospective: z.nullable(z.lazy(() => IsRetrospective$inboundSchema)),
+  maxHeightMetres: z.nullable(z.lazy(() => MaxHeightMetres$inboundSchema)),
+  parkingSpaces: z.nullable(z.lazy(() => ParkingSpaces$inboundSchema)),
+  storeys: z.nullable(z.lazy(() => Storeys$inboundSchema)),
+  unitsCommercial: z.nullable(z.lazy(() => UnitsCommercial$inboundSchema)),
+  unitsResidential: z.nullable(z.lazy(() => UnitsResidential$inboundSchema)),
+  unitsTotal: z.nullable(z.lazy(() => UnitsTotal$inboundSchema)),
+  useClass: z.nullable(z.lazy(() => UseClass$inboundSchema)),
+});
+
+export function planningDevelopmentExtractionFromJSON(
+  jsonString: string,
+): SafeParseResult<PlanningDevelopmentExtraction, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PlanningDevelopmentExtraction$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PlanningDevelopmentExtraction' from JSON`,
+  );
+}