@vepler/sdk 6.58.0 → 6.61.0

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

@@ -0,0 +1,166 @@
+/*
+ * 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";
+
+/**
+ * The HILUCS code, at any level.
+ */
+export const SiteLandUseTotalCode = {
+  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, at any level.
+ */
+export type SiteLandUseTotalCode = OpenEnum<typeof SiteLandUseTotalCode>;
+
+export type SiteLandUseTotal = {
+  /**
+   * Area of the title's land carrying this class or any class below it, in square metres.
+   */
+  areaSqm?: number | undefined;
+  /**
+   * The HILUCS code, at any level.
+   */
+  code?: SiteLandUseTotalCode | 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 or any class below it, by area, from 0 to 100.
+   */
+  sharePct?: number | undefined;
+};
+
+/** @internal */
+export const SiteLandUseTotalCode$inboundSchema: z.ZodType<
+  SiteLandUseTotalCode,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(SiteLandUseTotalCode);
+
+/** @internal */
+export const SiteLandUseTotal$inboundSchema: z.ZodType<
+  SiteLandUseTotal,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  areaSqm: z.number().optional(),
+  code: SiteLandUseTotalCode$inboundSchema.optional(),
+  level: z.number().int().optional(),
+  sharePct: z.number().optional(),
+});
+
+export function siteLandUseTotalFromJSON(
+  jsonString: string,
+): SafeParseResult<SiteLandUseTotal, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SiteLandUseTotal$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SiteLandUseTotal' from JSON`,
+  );
+}

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

@@ -12,9 +12,9 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
  */
 export type SiteTags = {
   /**
-   * True when the site's land use includes agricultural land.
+   * True when HILUCS class `1_1` (agriculture) and the classes below it cover at least 10% of the title's land area, by area. Read from `landProfile.use`, which comes from Ordnance Survey land use data for the land inside the title boundary, mapped to the EU INSPIRE HILUCS land use code list, not from the title register or from your own records. False when it covers less. Null when the title has no land polygons to measure. The exact area and share of every land use class on the title is in `landProfile.use`. Requires the `osNgdAccess` permission on the licence, and is left out of the response without it.
    */
-  agricultural?: boolean | undefined;
+  agricultural?: boolean | null | undefined;
   /**
    * Whether the title is on brownfield land, the same value as `constraints.flags.brownfield`. Null when brownfield land was not measured on the title; `constraints.unmeasured` says why.
    */
@@ -39,7 +39,7 @@ export const SiteTags$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  agricultural: z.boolean().optional(),
+  agricultural: z.nullable(z.boolean()).optional(),
   brownfield: z.nullable(z.boolean()).optional(),
   multipleProperties: z.boolean().optional(),
   noProperties: z.boolean().optional(),

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

@@ -12,7 +12,7 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 /**
  * Stable code identifying why the tier was skipped, safe to branch on.
  */
-export const Code = {
+export const TierSkipReasonCode = {
   NoCoverageForLpa: "no_coverage_for_lpa",
   NoCoverageForSchool: "no_coverage_for_school",
   NoPolygonIntersects: "no_polygon_intersects",
@@ -24,7 +24,7 @@ export const Code = {
 /**
  * Stable code identifying why the tier was skipped, safe to branch on.
  */
-export type Code = OpenEnum<typeof Code>;
+export type TierSkipReasonCode = OpenEnum<typeof TierSkipReasonCode>;
 
 /**
  * What evidence tied the school to the property. 'designated_polygon' means the property falls inside a catchment area the local authority publishes for the school. 'faith_jurisdiction' means it falls inside a parish or diocese tied to the school's faith criterion. 'last_admitted_distance' means it is at least as close as the furthest pupil the school admitted in the year read. 'feeder_link' means the school is named as a feeder destination by another school that already matched. 'distance_ranking' means the school is simply one of the nearest, the fallback that keeps a result set from being empty.
@@ -45,7 +45,7 @@ export type TierSkipReason = {
   /**
    * Stable code identifying why the tier was skipped, safe to branch on.
    */
-  code: Code;
+  code: TierSkipReasonCode;
   /**
    * Human-readable explanation of the skip, suitable for showing to an end user.
    */
@@ -57,8 +57,11 @@ export type TierSkipReason = {
 };
 
 /** @internal */
-export const Code$inboundSchema: z.ZodType<Code, z.ZodTypeDef, unknown> =
-  openEnums.inboundSchema(Code);
+export const TierSkipReasonCode$inboundSchema: z.ZodType<
+  TierSkipReasonCode,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(TierSkipReasonCode);
 
 /** @internal */
 export const TierSkipReasonTier$inboundSchema: z.ZodType<
@@ -73,7 +76,7 @@ export const TierSkipReason$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  code: Code$inboundSchema,
+  code: TierSkipReasonCode$inboundSchema,
   reason: z.string(),
   tier: TierSkipReasonTier$inboundSchema,
 });

package/dist/commonjs/sdk/models/shared/sitelandshare.d.ts

@@ -1,25 +0,0 @@
-import * as z from "zod/v3";
-import { Result as SafeParseResult } from "../../types/fp.js";
-import { SDKValidationError } from "../errors/sdkvalidationerror.js";
-export type SiteLandShare = {
-    /**
-     * Area of the title carrying this class, in square metres.
-     */
-    areaSqm?: number | undefined;
-    /**
-     * The broader Ordnance Survey land cover group the class belongs to. Present on cover shares only.
-     */
-    group?: string | undefined;
-    /**
-     * Share of the title's land area carrying this class, from 0 to 100.
-     */
-    pct?: number | undefined;
-    /**
-     * The Ordnance Survey land cover or land use class this share is keyed by, as published.
-     */
-    value?: string | undefined;
-};
-/** @internal */
-export declare const SiteLandShare$inboundSchema: z.ZodType<SiteLandShare, z.ZodTypeDef, unknown>;
-export declare function siteLandShareFromJSON(jsonString: string): SafeParseResult<SiteLandShare, SDKValidationError>;
-//# sourceMappingURL=sitelandshare.d.ts.map

package/dist/commonjs/sdk/models/shared/sitelandshare.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"sitelandshare.d.ts","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/sitelandshare.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAE5B,OAAO,EAAE,MAAM,IAAI,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAC9D,OAAO,EAAE,kBAAkB,EAAE,MAAM,iCAAiC,CAAC;AAErE,MAAM,MAAM,aAAa,GAAG;IAC1B;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC7B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC3B;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACzB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAC5B,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,2BAA2B,EAAE,CAAC,CAAC,OAAO,CACjD,aAAa,EACb,CAAC,CAAC,UAAU,EACZ,OAAO,CAMP,CAAC;AAEH,wBAAgB,qBAAqB,CACnC,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,aAAa,EAAE,kBAAkB,CAAC,CAMpD"}

package/dist/commonjs/sdk/models/shared/sitelandshare.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"sitelandshare.js","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/sitelandshare.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAsCH,sDAQC;AA5CD,0CAA4B;AAC5B,wDAAoD;AAuBpD,gBAAgB;AACH,QAAA,2BAA2B,GAIpC,CAAC,CAAC,MAAM,CAAC;IACX,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC9B,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC5B,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC1B,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CAC7B,CAAC,CAAC;AAEH,SAAgB,qBAAqB,CACnC,UAAkB;IAElB,OAAO,IAAA,sBAAS,EACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,mCAA2B,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EACvD,2CAA2C,CAC5C,CAAC;AACJ,CAAC"}

package/dist/esm/sdk/models/shared/sitelandshare.d.ts

@@ -1,25 +0,0 @@
-import * as z from "zod/v3";
-import { Result as SafeParseResult } from "../../types/fp.js";
-import { SDKValidationError } from "../errors/sdkvalidationerror.js";
-export type SiteLandShare = {
-    /**
-     * Area of the title carrying this class, in square metres.
-     */
-    areaSqm?: number | undefined;
-    /**
-     * The broader Ordnance Survey land cover group the class belongs to. Present on cover shares only.
-     */
-    group?: string | undefined;
-    /**
-     * Share of the title's land area carrying this class, from 0 to 100.
-     */
-    pct?: number | undefined;
-    /**
-     * The Ordnance Survey land cover or land use class this share is keyed by, as published.
-     */
-    value?: string | undefined;
-};
-/** @internal */
-export declare const SiteLandShare$inboundSchema: z.ZodType<SiteLandShare, z.ZodTypeDef, unknown>;
-export declare function siteLandShareFromJSON(jsonString: string): SafeParseResult<SiteLandShare, SDKValidationError>;
-//# sourceMappingURL=sitelandshare.d.ts.map

package/dist/esm/sdk/models/shared/sitelandshare.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"sitelandshare.d.ts","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/sitelandshare.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAE5B,OAAO,EAAE,MAAM,IAAI,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAC9D,OAAO,EAAE,kBAAkB,EAAE,MAAM,iCAAiC,CAAC;AAErE,MAAM,MAAM,aAAa,GAAG;IAC1B;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC7B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC3B;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACzB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAC5B,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,2BAA2B,EAAE,CAAC,CAAC,OAAO,CACjD,aAAa,EACb,CAAC,CAAC,UAAU,EACZ,OAAO,CAMP,CAAC;AAEH,wBAAgB,qBAAqB,CACnC,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,aAAa,EAAE,kBAAkB,CAAC,CAMpD"}

package/dist/esm/sdk/models/shared/sitelandshare.js

@@ -1,16 +0,0 @@
-/*
- * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
- */
-import * as z from "zod/v3";
-import { safeParse } from "../../../lib/schemas.js";
-/** @internal */
-export const SiteLandShare$inboundSchema = z.object({
-    areaSqm: z.number().optional(),
-    group: z.string().optional(),
-    pct: z.number().optional(),
-    value: z.string().optional(),
-});
-export function siteLandShareFromJSON(jsonString) {
-    return safeParse(jsonString, (x) => SiteLandShare$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'SiteLandShare' from JSON`);
-}
-//# sourceMappingURL=sitelandshare.js.map

package/dist/esm/sdk/models/shared/sitelandshare.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"sitelandshare.js","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/sitelandshare.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAC5B,OAAO,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAC;AAuBpD,gBAAgB;AAChB,MAAM,CAAC,MAAM,2BAA2B,GAIpC,CAAC,CAAC,MAAM,CAAC;IACX,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC9B,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC5B,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC1B,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CAC7B,CAAC,CAAC;AAEH,MAAM,UAAU,qBAAqB,CACnC,UAAkB;IAElB,OAAO,SAAS,CACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,2BAA2B,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EACvD,2CAA2C,CAC5C,CAAC;AACJ,CAAC"}

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

@@ -1,49 +0,0 @@
-/*
- * 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 SiteLandShare = {
-  /**
-   * Area of the title carrying this class, in square metres.
-   */
-  areaSqm?: number | undefined;
-  /**
-   * The broader Ordnance Survey land cover group the class belongs to. Present on cover shares only.
-   */
-  group?: string | undefined;
-  /**
-   * Share of the title's land area carrying this class, from 0 to 100.
-   */
-  pct?: number | undefined;
-  /**
-   * The Ordnance Survey land cover or land use class this share is keyed by, as published.
-   */
-  value?: string | undefined;
-};
-
-/** @internal */
-export const SiteLandShare$inboundSchema: z.ZodType<
-  SiteLandShare,
-  z.ZodTypeDef,
-  unknown
-> = z.object({
-  areaSqm: z.number().optional(),
-  group: z.string().optional(),
-  pct: z.number().optional(),
-  value: z.string().optional(),
-});
-
-export function siteLandShareFromJSON(
-  jsonString: string,
-): SafeParseResult<SiteLandShare, SDKValidationError> {
-  return safeParse(
-    jsonString,
-    (x) => SiteLandShare$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'SiteLandShare' from JSON`,
-  );
-}