@vepler/sdk 6.58.0 → 6.61.0

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

@@ -0,0 +1,223 @@
+/*
+ * 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 { ClosedEnum, OpenEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  SiteLandUseClass,
+  SiteLandUseClass$inboundSchema,
+} from "./sitelanduseclass.js";
+import {
+  SiteLandUseTotal,
+  SiteLandUseTotal$inboundSchema,
+} from "./sitelandusetotal.js";
+
+/**
+ * The code in `classes` with the largest share. Null when the title has no land polygons.
+ */
+export const Dominant = {
+  One: "1",
+  Two: "2",
+  Three: "3",
+  Four: "4",
+  Five: "5",
+  Six: "6",
+  One1: "1_1",
+  One11: "1_1_1",
+  One12: "1_1_2",
+  One13: "1_1_3",
+  One2: "1_2",
+  One21: "1_2_1",
+  One22: "1_2_2",
+  One23: "1_2_3",
+  One3: "1_3",
+  One31: "1_3_1",
+  One32: "1_3_2",
+  One33: "1_3_3",
+  One4: "1_4",
+  One41: "1_4_1",
+  One42: "1_4_2",
+  One5: "1_5",
+  One51: "1_5_1",
+  One52: "1_5_2",
+  One53: "1_5_3",
+  Two1: "2_1",
+  Two11: "2_1_1",
+  Two12: "2_1_2",
+  Two13: "2_1_3",
+  Two14: "2_1_4",
+  Two15: "2_1_5",
+  Two16: "2_1_6",
+  Two17: "2_1_7",
+  Two18: "2_1_8",
+  Two19: "2_1_9",
+  Two2: "2_2",
+  Two21: "2_2_1",
+  Two22: "2_2_2",
+  Two23: "2_2_3",
+  Two3: "2_3",
+  Two31: "2_3_1",
+  Two32: "2_3_2",
+  Two33: "2_3_3",
+  Two34: "2_3_4",
+  Two35: "2_3_5",
+  Two4: "2_4",
+  Two41: "2_4_1",
+  Two42: "2_4_2",
+  Two43: "2_4_3",
+  Two44: "2_4_4",
+  Two5: "2_5",
+  Three1: "3_1",
+  Three11: "3_1_1",
+  Three12: "3_1_2",
+  Three13: "3_1_3",
+  Three14: "3_1_4",
+  Three2: "3_2",
+  Three21: "3_2_1",
+  Three22: "3_2_2",
+  Three23: "3_2_3",
+  Three24: "3_2_4",
+  Three25: "3_2_5",
+  Three3: "3_3",
+  Three31: "3_3_1",
+  Three32: "3_3_2",
+  Three33: "3_3_3",
+  Three34: "3_3_4",
+  Three35: "3_3_5",
+  Three4: "3_4",
+  Three41: "3_4_1",
+  Three42: "3_4_2",
+  Three43: "3_4_3",
+  Three44: "3_4_4",
+  Three45: "3_4_5",
+  Three5: "3_5",
+  Four1: "4_1",
+  Four11: "4_1_1",
+  Four12: "4_1_2",
+  Four13: "4_1_3",
+  Four14: "4_1_4",
+  Four15: "4_1_5",
+  Four2: "4_2",
+  Four3: "4_3",
+  Four31: "4_3_1",
+  Four32: "4_3_2",
+  Four33: "4_3_3",
+  Four34: "4_3_4",
+  Five1: "5_1",
+  Five2: "5_2",
+  Five3: "5_3",
+  Six1: "6_1",
+  Six2: "6_2",
+  Six3: "6_3",
+  Six31: "6_3_1",
+  Six32: "6_3_2",
+  Six4: "6_4",
+  Six5: "6_5",
+  Six6: "6_6",
+} as const;
+/**
+ * The code in `classes` with the largest share. Null when the title has no land polygons.
+ */
+export type Dominant = OpenEnum<typeof Dominant>;
+
+/**
+ * How each share is measured. Always `area_share`: the share of the title's land area by area.
+ */
+export const Method = {
+  AreaShare: "area_share",
+} as const;
+/**
+ * How each share is measured. Always `area_share`: the share of the title's land area by area.
+ */
+export type Method = ClosedEnum<typeof Method>;
+
+/**
+ * Classification the classes are coded in. Always `hilucs`.
+ */
+export const SiteLandUseScheme = {
+  Hilucs: "hilucs",
+} as const;
+/**
+ * Classification the classes are coded in. Always `hilucs`.
+ */
+export type SiteLandUseScheme = ClosedEnum<typeof SiteLandUseScheme>;
+
+/**
+ * The title's land use, from Ordnance Survey land use data for the land inside the title boundary, mapped to the EU INSPIRE HILUCS land use code list. Each share is a share of the land area by area. It does not come from the title register or from your own records.
+ */
+export type SiteLandUse = {
+  /**
+   * Every land use class on the title with its area and share, largest first, each at the most detailed HILUCS level its Ordnance Survey value supports. No class is left out for being small.
+   */
+  classes?: Array<SiteLandUseClass> | undefined;
+  /**
+   * Version of the table these classes were mapped with from Ordnance Survey land use values. It changes whenever an Ordnance Survey value moves to a different HILUCS class.
+   */
+  crosswalkVersion?: string | undefined;
+  /**
+   * The code in `classes` with the largest share. Null when the title has no land polygons.
+   */
+  dominant?: Dominant | null | undefined;
+  /**
+   * Share of the title's land area whose use is known, from 0 to 100: every class except `6_6` (not known use). The `sharePct` of the known classes adds up to this, within rounding. 0 when the title has no land polygons.
+   */
+  measuredPct?: number | undefined;
+  /**
+   * How each share is measured. Always `area_share`: the share of the title's land area by area.
+   */
+  method?: Method | undefined;
+  /**
+   * Classification the classes are coded in. Always `hilucs`.
+   */
+  scheme?: SiteLandUseScheme | undefined;
+  /**
+   * The area and share of every HILUCS code on the title at every level, each counting the classes below it, so the share of a broad class such as `1` (primary production) can be read directly. Largest first.
+   */
+  totals?: Array<SiteLandUseTotal> | undefined;
+};
+
+/** @internal */
+export const Dominant$inboundSchema: z.ZodType<
+  Dominant,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(Dominant);
+
+/** @internal */
+export const Method$inboundSchema: z.ZodNativeEnum<typeof Method> = z
+  .nativeEnum(Method);
+
+/** @internal */
+export const SiteLandUseScheme$inboundSchema: z.ZodNativeEnum<
+  typeof SiteLandUseScheme
+> = z.nativeEnum(SiteLandUseScheme);
+
+/** @internal */
+export const SiteLandUse$inboundSchema: z.ZodType<
+  SiteLandUse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  classes: z.array(SiteLandUseClass$inboundSchema).optional(),
+  crosswalkVersion: z.string().optional(),
+  dominant: z.nullable(Dominant$inboundSchema).optional(),
+  measuredPct: z.number().optional(),
+  method: Method$inboundSchema.optional(),
+  scheme: SiteLandUseScheme$inboundSchema.optional(),
+  totals: z.array(SiteLandUseTotal$inboundSchema).optional(),
+});
+
+export function siteLandUseFromJSON(
+  jsonString: string,
+): SafeParseResult<SiteLandUse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SiteLandUse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SiteLandUse' from JSON`,
+  );
+}

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

@@ -0,0 +1,297 @@
+/*
+ * 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 {
+  SiteLandUseSource,
+  SiteLandUseSource$inboundSchema,
+} from "./sitelandusesource.js";
+
+/**
+ * A code from the EU INSPIRE HILUCS land use code list, at level 1, 2 or 3 (for example `1`, `1_1`, `1_1_1`).
+ */
+export const Ancestors = {
+  One: "1",
+  Two: "2",
+  Three: "3",
+  Four: "4",
+  Five: "5",
+  Six: "6",
+  One1: "1_1",
+  One11: "1_1_1",
+  One12: "1_1_2",
+  One13: "1_1_3",
+  One2: "1_2",
+  One21: "1_2_1",
+  One22: "1_2_2",
+  One23: "1_2_3",
+  One3: "1_3",
+  One31: "1_3_1",
+  One32: "1_3_2",
+  One33: "1_3_3",
+  One4: "1_4",
+  One41: "1_4_1",
+  One42: "1_4_2",
+  One5: "1_5",
+  One51: "1_5_1",
+  One52: "1_5_2",
+  One53: "1_5_3",
+  Two1: "2_1",
+  Two11: "2_1_1",
+  Two12: "2_1_2",
+  Two13: "2_1_3",
+  Two14: "2_1_4",
+  Two15: "2_1_5",
+  Two16: "2_1_6",
+  Two17: "2_1_7",
+  Two18: "2_1_8",
+  Two19: "2_1_9",
+  Two2: "2_2",
+  Two21: "2_2_1",
+  Two22: "2_2_2",
+  Two23: "2_2_3",
+  Two3: "2_3",
+  Two31: "2_3_1",
+  Two32: "2_3_2",
+  Two33: "2_3_3",
+  Two34: "2_3_4",
+  Two35: "2_3_5",
+  Two4: "2_4",
+  Two41: "2_4_1",
+  Two42: "2_4_2",
+  Two43: "2_4_3",
+  Two44: "2_4_4",
+  Two5: "2_5",
+  Three1: "3_1",
+  Three11: "3_1_1",
+  Three12: "3_1_2",
+  Three13: "3_1_3",
+  Three14: "3_1_4",
+  Three2: "3_2",
+  Three21: "3_2_1",
+  Three22: "3_2_2",
+  Three23: "3_2_3",
+  Three24: "3_2_4",
+  Three25: "3_2_5",
+  Three3: "3_3",
+  Three31: "3_3_1",
+  Three32: "3_3_2",
+  Three33: "3_3_3",
+  Three34: "3_3_4",
+  Three35: "3_3_5",
+  Three4: "3_4",
+  Three41: "3_4_1",
+  Three42: "3_4_2",
+  Three43: "3_4_3",
+  Three44: "3_4_4",
+  Three45: "3_4_5",
+  Three5: "3_5",
+  Four1: "4_1",
+  Four11: "4_1_1",
+  Four12: "4_1_2",
+  Four13: "4_1_3",
+  Four14: "4_1_4",
+  Four15: "4_1_5",
+  Four2: "4_2",
+  Four3: "4_3",
+  Four31: "4_3_1",
+  Four32: "4_3_2",
+  Four33: "4_3_3",
+  Four34: "4_3_4",
+  Five1: "5_1",
+  Five2: "5_2",
+  Five3: "5_3",
+  Six1: "6_1",
+  Six2: "6_2",
+  Six3: "6_3",
+  Six31: "6_3_1",
+  Six32: "6_3_2",
+  Six4: "6_4",
+  Six5: "6_5",
+  Six6: "6_6",
+} as const;
+/**
+ * A code from the EU INSPIRE HILUCS land use code list, at level 1, 2 or 3 (for example `1`, `1_1`, `1_1_1`).
+ */
+export type Ancestors = OpenEnum<typeof Ancestors>;
+
+/**
+ * The HILUCS code of the class, at the most detailed level its Ordnance Survey value supports.
+ */
+export const Code = {
+  One: "1",
+  Two: "2",
+  Three: "3",
+  Four: "4",
+  Five: "5",
+  Six: "6",
+  One1: "1_1",
+  One11: "1_1_1",
+  One12: "1_1_2",
+  One13: "1_1_3",
+  One2: "1_2",
+  One21: "1_2_1",
+  One22: "1_2_2",
+  One23: "1_2_3",
+  One3: "1_3",
+  One31: "1_3_1",
+  One32: "1_3_2",
+  One33: "1_3_3",
+  One4: "1_4",
+  One41: "1_4_1",
+  One42: "1_4_2",
+  One5: "1_5",
+  One51: "1_5_1",
+  One52: "1_5_2",
+  One53: "1_5_3",
+  Two1: "2_1",
+  Two11: "2_1_1",
+  Two12: "2_1_2",
+  Two13: "2_1_3",
+  Two14: "2_1_4",
+  Two15: "2_1_5",
+  Two16: "2_1_6",
+  Two17: "2_1_7",
+  Two18: "2_1_8",
+  Two19: "2_1_9",
+  Two2: "2_2",
+  Two21: "2_2_1",
+  Two22: "2_2_2",
+  Two23: "2_2_3",
+  Two3: "2_3",
+  Two31: "2_3_1",
+  Two32: "2_3_2",
+  Two33: "2_3_3",
+  Two34: "2_3_4",
+  Two35: "2_3_5",
+  Two4: "2_4",
+  Two41: "2_4_1",
+  Two42: "2_4_2",
+  Two43: "2_4_3",
+  Two44: "2_4_4",
+  Two5: "2_5",
+  Three1: "3_1",
+  Three11: "3_1_1",
+  Three12: "3_1_2",
+  Three13: "3_1_3",
+  Three14: "3_1_4",
+  Three2: "3_2",
+  Three21: "3_2_1",
+  Three22: "3_2_2",
+  Three23: "3_2_3",
+  Three24: "3_2_4",
+  Three25: "3_2_5",
+  Three3: "3_3",
+  Three31: "3_3_1",
+  Three32: "3_3_2",
+  Three33: "3_3_3",
+  Three34: "3_3_4",
+  Three35: "3_3_5",
+  Three4: "3_4",
+  Three41: "3_4_1",
+  Three42: "3_4_2",
+  Three43: "3_4_3",
+  Three44: "3_4_4",
+  Three45: "3_4_5",
+  Three5: "3_5",
+  Four1: "4_1",
+  Four11: "4_1_1",
+  Four12: "4_1_2",
+  Four13: "4_1_3",
+  Four14: "4_1_4",
+  Four15: "4_1_5",
+  Four2: "4_2",
+  Four3: "4_3",
+  Four31: "4_3_1",
+  Four32: "4_3_2",
+  Four33: "4_3_3",
+  Four34: "4_3_4",
+  Five1: "5_1",
+  Five2: "5_2",
+  Five3: "5_3",
+  Six1: "6_1",
+  Six2: "6_2",
+  Six3: "6_3",
+  Six31: "6_3_1",
+  Six32: "6_3_2",
+  Six4: "6_4",
+  Six5: "6_5",
+  Six6: "6_6",
+} as const;
+/**
+ * The HILUCS code of the class, at the most detailed level its Ordnance Survey value supports.
+ */
+export type Code = OpenEnum<typeof Code>;
+
+export type SiteLandUseClass = {
+  /**
+   * The broader HILUCS codes above this one, broadest first. Empty at level 1.
+   */
+  ancestors?: Array<Ancestors> | undefined;
+  /**
+   * Area of the title's land carrying this class, in square metres. Where Ordnance Survey records several detailed uses on one land polygon, its area is split evenly between them.
+   */
+  areaSqm?: number | undefined;
+  /**
+   * The HILUCS code of the class, at the most detailed level its Ordnance Survey value supports.
+   */
+  code?: Code | undefined;
+  /**
+   * English name of the HILUCS class, as published.
+   */
+  label?: string | undefined;
+  /**
+   * Level of the code in the HILUCS hierarchy, from 1 (broadest) to 3.
+   */
+  level?: number | undefined;
+  /**
+   * Share of the title's land area carrying this class, by area, from 0 to 100.
+   */
+  sharePct?: number | undefined;
+  /**
+   * The Ordnance Survey land use values mapped to this class on the title.
+   */
+  sources?: Array<SiteLandUseSource> | undefined;
+};
+
+/** @internal */
+export const Ancestors$inboundSchema: z.ZodType<
+  Ancestors,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(Ancestors);
+
+/** @internal */
+export const Code$inboundSchema: z.ZodType<Code, z.ZodTypeDef, unknown> =
+  openEnums.inboundSchema(Code);
+
+/** @internal */
+export const SiteLandUseClass$inboundSchema: z.ZodType<
+  SiteLandUseClass,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  ancestors: z.array(Ancestors$inboundSchema).optional(),
+  areaSqm: z.number().optional(),
+  code: Code$inboundSchema.optional(),
+  label: z.string().optional(),
+  level: z.number().int().optional(),
+  sharePct: z.number().optional(),
+  sources: z.array(SiteLandUseSource$inboundSchema).optional(),
+});
+
+export function siteLandUseClassFromJSON(
+  jsonString: string,
+): SafeParseResult<SiteLandUseClass, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SiteLandUseClass$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SiteLandUseClass' from JSON`,
+  );
+}

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

@@ -0,0 +1,92 @@
+/*
+ * 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";
+
+/**
+ * How the source class relates to the class it is mapped to: `exact` when they mean the same, `broader` when the source class sits wholly inside the mapped class, which also covers other uses, and `partial` when the source class only partly belongs to it.
+ */
+export const SiteLandUseSourceMapping = {
+  Exact: "exact",
+  Broader: "broader",
+  Partial: "partial",
+} as const;
+/**
+ * How the source class relates to the class it is mapped to: `exact` when they mean the same, `broader` when the source class sits wholly inside the mapped class, which also covers other uses, and `partial` when the source class only partly belongs to it.
+ */
+export type SiteLandUseSourceMapping = OpenEnum<
+  typeof SiteLandUseSourceMapping
+>;
+
+/**
+ * The Ordnance Survey land use field the class was read from: `os_ngd_land_use_tier_b`, the detailed use, or `os_ngd_land_use_tier_a`, the general use, read only where a polygon has no detailed use.
+ */
+export const SiteLandUseSourceScheme = {
+  OsNgdLandUseTierB: "os_ngd_land_use_tier_b",
+  OsNgdLandUseTierA: "os_ngd_land_use_tier_a",
+} as const;
+/**
+ * The Ordnance Survey land use field the class was read from: `os_ngd_land_use_tier_b`, the detailed use, or `os_ngd_land_use_tier_a`, the general use, read only where a polygon has no detailed use.
+ */
+export type SiteLandUseSourceScheme = OpenEnum<typeof SiteLandUseSourceScheme>;
+
+export type SiteLandUseSource = {
+  /**
+   * The Ordnance Survey land use value, as published.
+   */
+  code?: string | undefined;
+  /**
+   * How the source class relates to the class it is mapped to: `exact` when they mean the same, `broader` when the source class sits wholly inside the mapped class, which also covers other uses, and `partial` when the source class only partly belongs to it.
+   */
+  mapping?: SiteLandUseSourceMapping | undefined;
+  /**
+   * Identifier of the Ordnance Survey release the value was read from.
+   */
+  release?: string | undefined;
+  /**
+   * The Ordnance Survey land use field the class was read from: `os_ngd_land_use_tier_b`, the detailed use, or `os_ngd_land_use_tier_a`, the general use, read only where a polygon has no detailed use.
+   */
+  scheme?: SiteLandUseSourceScheme | undefined;
+};
+
+/** @internal */
+export const SiteLandUseSourceMapping$inboundSchema: z.ZodType<
+  SiteLandUseSourceMapping,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(SiteLandUseSourceMapping);
+
+/** @internal */
+export const SiteLandUseSourceScheme$inboundSchema: z.ZodType<
+  SiteLandUseSourceScheme,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(SiteLandUseSourceScheme);
+
+/** @internal */
+export const SiteLandUseSource$inboundSchema: z.ZodType<
+  SiteLandUseSource,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  code: z.string().optional(),
+  mapping: SiteLandUseSourceMapping$inboundSchema.optional(),
+  release: z.string().optional(),
+  scheme: SiteLandUseSourceScheme$inboundSchema.optional(),
+});
+
+export function siteLandUseSourceFromJSON(
+  jsonString: string,
+): SafeParseResult<SiteLandUseSource, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SiteLandUseSource$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SiteLandUseSource' from JSON`,
+  );
+}