@vepler/sdk 6.50.12 → 6.52.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (62) hide show
  1. package/dist/commonjs/lib/config.d.ts +2 -2
  2. package/dist/commonjs/lib/config.js +2 -2
  3. package/dist/commonjs/lib/config.js.map +1 -1
  4. package/dist/commonjs/sdk/models/shared/index.d.ts +4 -0
  5. package/dist/commonjs/sdk/models/shared/index.d.ts.map +1 -1
  6. package/dist/commonjs/sdk/models/shared/index.js +4 -0
  7. package/dist/commonjs/sdk/models/shared/index.js.map +1 -1
  8. package/dist/commonjs/sdk/models/shared/site.d.ts +14 -0
  9. package/dist/commonjs/sdk/models/shared/site.d.ts.map +1 -1
  10. package/dist/commonjs/sdk/models/shared/site.js +5 -0
  11. package/dist/commonjs/sdk/models/shared/site.js.map +1 -1
  12. package/dist/commonjs/sdk/models/shared/sitebuildingcount.d.ts +17 -0
  13. package/dist/commonjs/sdk/models/shared/sitebuildingcount.d.ts.map +1 -0
  14. package/dist/commonjs/sdk/models/shared/sitebuildingcount.js +51 -0
  15. package/dist/commonjs/sdk/models/shared/sitebuildingcount.js.map +1 -0
  16. package/dist/commonjs/sdk/models/shared/sitebuildingprofile.d.ts +94 -0
  17. package/dist/commonjs/sdk/models/shared/sitebuildingprofile.d.ts.map +1 -0
  18. package/dist/commonjs/sdk/models/shared/sitebuildingprofile.js +75 -0
  19. package/dist/commonjs/sdk/models/shared/sitebuildingprofile.js.map +1 -0
  20. package/dist/commonjs/sdk/models/shared/sitelandprofile.d.ts +74 -0
  21. package/dist/commonjs/sdk/models/shared/sitelandprofile.d.ts.map +1 -0
  22. package/dist/commonjs/sdk/models/shared/sitelandprofile.js +70 -0
  23. package/dist/commonjs/sdk/models/shared/sitelandprofile.js.map +1 -0
  24. package/dist/commonjs/sdk/models/shared/sitelandshare.d.ts +25 -0
  25. package/dist/commonjs/sdk/models/shared/sitelandshare.d.ts.map +1 -0
  26. package/dist/commonjs/sdk/models/shared/sitelandshare.js +53 -0
  27. package/dist/commonjs/sdk/models/shared/sitelandshare.js.map +1 -0
  28. package/dist/esm/lib/config.d.ts +2 -2
  29. package/dist/esm/lib/config.js +2 -2
  30. package/dist/esm/lib/config.js.map +1 -1
  31. package/dist/esm/sdk/models/shared/index.d.ts +4 -0
  32. package/dist/esm/sdk/models/shared/index.d.ts.map +1 -1
  33. package/dist/esm/sdk/models/shared/index.js +4 -0
  34. package/dist/esm/sdk/models/shared/index.js.map +1 -1
  35. package/dist/esm/sdk/models/shared/site.d.ts +14 -0
  36. package/dist/esm/sdk/models/shared/site.d.ts.map +1 -1
  37. package/dist/esm/sdk/models/shared/site.js +5 -0
  38. package/dist/esm/sdk/models/shared/site.js.map +1 -1
  39. package/dist/esm/sdk/models/shared/sitebuildingcount.d.ts +17 -0
  40. package/dist/esm/sdk/models/shared/sitebuildingcount.d.ts.map +1 -0
  41. package/dist/esm/sdk/models/shared/sitebuildingcount.js +14 -0
  42. package/dist/esm/sdk/models/shared/sitebuildingcount.js.map +1 -0
  43. package/dist/esm/sdk/models/shared/sitebuildingprofile.d.ts +94 -0
  44. package/dist/esm/sdk/models/shared/sitebuildingprofile.d.ts.map +1 -0
  45. package/dist/esm/sdk/models/shared/sitebuildingprofile.js +38 -0
  46. package/dist/esm/sdk/models/shared/sitebuildingprofile.js.map +1 -0
  47. package/dist/esm/sdk/models/shared/sitelandprofile.d.ts +74 -0
  48. package/dist/esm/sdk/models/shared/sitelandprofile.d.ts.map +1 -0
  49. package/dist/esm/sdk/models/shared/sitelandprofile.js +33 -0
  50. package/dist/esm/sdk/models/shared/sitelandprofile.js.map +1 -0
  51. package/dist/esm/sdk/models/shared/sitelandshare.d.ts +25 -0
  52. package/dist/esm/sdk/models/shared/sitelandshare.d.ts.map +1 -0
  53. package/dist/esm/sdk/models/shared/sitelandshare.js +16 -0
  54. package/dist/esm/sdk/models/shared/sitelandshare.js.map +1 -0
  55. package/package.json +1 -1
  56. package/src/lib/config.ts +2 -2
  57. package/src/sdk/models/shared/index.ts +4 -0
  58. package/src/sdk/models/shared/site.ts +23 -0
  59. package/src/sdk/models/shared/sitebuildingcount.ts +39 -0
  60. package/src/sdk/models/shared/sitebuildingprofile.ts +140 -0
  61. package/src/sdk/models/shared/sitelandprofile.ts +110 -0
  62. package/src/sdk/models/shared/sitelandshare.ts +49 -0
@@ -0,0 +1,38 @@
1
+ /*
2
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
+ */
4
+ import * as z from "zod/v3";
5
+ import { safeParse } from "../../../lib/schemas.js";
6
+ import { SiteBuildingCount$inboundSchema, } from "./sitebuildingcount.js";
7
+ /**
8
+ * Dataset the profile is computed from. Always `os_ngd_building`.
9
+ */
10
+ export const SiteBuildingProfileSource = {
11
+ OsNgdBuilding: "os_ngd_building",
12
+ };
13
+ /** @internal */
14
+ export const SiteBuildingProfileSource$inboundSchema = z.nativeEnum(SiteBuildingProfileSource);
15
+ /** @internal */
16
+ export const SiteBuildingProfile$inboundSchema = z.object({
17
+ asOf: z.string().optional(),
18
+ connectivity: z.array(SiteBuildingCount$inboundSchema).optional(),
19
+ count: z.number().int().optional(),
20
+ coveragePct: z.number().optional(),
21
+ earliestAgeBand: z.nullable(z.string()).optional(),
22
+ footprintSqm: z.number().optional(),
23
+ latestAgeBand: z.nullable(z.string()).optional(),
24
+ maxFloors: z.nullable(z.number().int()).optional(),
25
+ maxHeightM: z.nullable(z.number()).optional(),
26
+ medianFloors: z.nullable(z.number()).optional(),
27
+ medianHeightM: z.nullable(z.number()).optional(),
28
+ osVersion: z.string().optional(),
29
+ source: SiteBuildingProfileSource$inboundSchema.optional(),
30
+ uses: z.array(SiteBuildingCount$inboundSchema).optional(),
31
+ withAgeBand: z.number().int().optional(),
32
+ withFloors: z.number().int().optional(),
33
+ withHeight: z.number().int().optional(),
34
+ });
35
+ export function siteBuildingProfileFromJSON(jsonString) {
36
+ return safeParse(jsonString, (x) => SiteBuildingProfile$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'SiteBuildingProfile' from JSON`);
37
+ }
38
+ //# sourceMappingURL=sitebuildingprofile.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"sitebuildingprofile.js","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/sitebuildingprofile.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAC5B,OAAO,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAC;AAIpD,OAAO,EAEL,+BAA+B,GAChC,MAAM,wBAAwB,CAAC;AAEhC;;GAEG;AACH,MAAM,CAAC,MAAM,yBAAyB,GAAG;IACvC,aAAa,EAAE,iBAAiB;CACxB,CAAC;AAkFX,gBAAgB;AAChB,MAAM,CAAC,MAAM,uCAAuC,GAEhD,CAAC,CAAC,UAAU,CAAC,yBAAyB,CAAC,CAAC;AAE5C,gBAAgB;AAChB,MAAM,CAAC,MAAM,iCAAiC,GAI1C,CAAC,CAAC,MAAM,CAAC;IACX,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC3B,YAAY,EAAE,CAAC,CAAC,KAAK,CAAC,+BAA+B,CAAC,CAAC,QAAQ,EAAE;IACjE,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;IAClC,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAClC,eAAe,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;IAClD,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACnC,aAAa,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;IAChD,SAAS,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,CAAC,QAAQ,EAAE;IAClD,UAAU,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;IAC7C,YAAY,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;IAC/C,aAAa,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;IAChD,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAChC,MAAM,EAAE,uCAAuC,CAAC,QAAQ,EAAE;IAC1D,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,+BAA+B,CAAC,CAAC,QAAQ,EAAE;IACzD,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;IACxC,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;IACvC,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;CACxC,CAAC,CAAC;AAEH,MAAM,UAAU,2BAA2B,CACzC,UAAkB;IAElB,OAAO,SAAS,CACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,iCAAiC,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAC7D,iDAAiD,CAClD,CAAC;AACJ,CAAC"}
@@ -0,0 +1,74 @@
1
+ import * as z from "zod/v3";
2
+ import { ClosedEnum } from "../../types/enums.js";
3
+ import { Result as SafeParseResult } from "../../types/fp.js";
4
+ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
5
+ import { SiteLandShare } from "./sitelandshare.js";
6
+ /**
7
+ * Dataset the profile is computed from. Always `os_ngd_land`.
8
+ */
9
+ export declare const SiteLandProfileSource: {
10
+ readonly OsNgdLand: "os_ngd_land";
11
+ };
12
+ /**
13
+ * Dataset the profile is computed from. Always `os_ngd_land`.
14
+ */
15
+ export type SiteLandProfileSource = ClosedEnum<typeof SiteLandProfileSource>;
16
+ /**
17
+ * Land cover and use composition of the title, measured on the title boundary. Requires the `osNgdAccess` permission on the licence, and is left out of the response without it.
18
+ */
19
+ export type SiteLandProfile = {
20
+ /**
21
+ * Release date of the Ordnance Survey version the profile was computed from, as an ISO 8601 timestamp.
22
+ */
23
+ asOf?: string | undefined;
24
+ /**
25
+ * The title's land area by Ordnance Survey land cover class, largest first.
26
+ */
27
+ cover?: Array<SiteLandShare> | undefined;
28
+ /**
29
+ * Share of the title area covered by land polygons, from 0 to 100. Building footprints are a separate feature type and are measured in `buildingProfile`, so a built title is rarely fully covered.
30
+ */
31
+ coveredPct?: number | undefined;
32
+ /**
33
+ * Share of the title's land area that is a made surface, from 0 to 100.
34
+ */
35
+ madeSurfacePct?: number | undefined;
36
+ /**
37
+ * Area of the title whose land cover is a made surface, such as paving or hard standing, in square metres. Building footprints are not included.
38
+ */
39
+ madeSurfaceSqm?: number | undefined;
40
+ /**
41
+ * Area of the title whose land cover is recorded as obscured, in square metres.
42
+ */
43
+ obscuredSqm?: number | undefined;
44
+ /**
45
+ * Identifier of that Ordnance Survey release.
46
+ */
47
+ osVersion?: string | undefined;
48
+ /**
49
+ * Number of land polygons that cover part of the title.
50
+ */
51
+ polygonCount?: number | undefined;
52
+ /**
53
+ * Dataset the profile is computed from. Always `os_ngd_land`.
54
+ */
55
+ source?: SiteLandProfileSource | undefined;
56
+ /**
57
+ * Area of the title that is tidal, in square metres.
58
+ */
59
+ tidalSqm?: number | undefined;
60
+ /**
61
+ * Area of the title covered by land polygons, in square metres.
62
+ */
63
+ totalSqm?: number | undefined;
64
+ /**
65
+ * The title's land area by Ordnance Survey land use class, largest first.
66
+ */
67
+ use?: Array<SiteLandShare> | undefined;
68
+ };
69
+ /** @internal */
70
+ export declare const SiteLandProfileSource$inboundSchema: z.ZodNativeEnum<typeof SiteLandProfileSource>;
71
+ /** @internal */
72
+ export declare const SiteLandProfile$inboundSchema: z.ZodType<SiteLandProfile, z.ZodTypeDef, unknown>;
73
+ export declare function siteLandProfileFromJSON(jsonString: string): SafeParseResult<SiteLandProfile, SDKValidationError>;
74
+ //# sourceMappingURL=sitelandprofile.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"sitelandprofile.d.ts","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/sitelandprofile.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAE5B,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAClD,OAAO,EAAE,MAAM,IAAI,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAC9D,OAAO,EAAE,kBAAkB,EAAE,MAAM,iCAAiC,CAAC;AACrE,OAAO,EAAE,aAAa,EAA+B,MAAM,oBAAoB,CAAC;AAEhF;;GAEG;AACH,eAAO,MAAM,qBAAqB;;CAExB,CAAC;AACX;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG,UAAU,CAAC,OAAO,qBAAqB,CAAC,CAAC;AAE7E;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC1B;;OAEG;IACH,KAAK,CAAC,EAAE,KAAK,CAAC,aAAa,CAAC,GAAG,SAAS,CAAC;IACzC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAChC;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACpC;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACpC;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACjC;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC/B;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAClC;;OAEG;IACH,MAAM,CAAC,EAAE,qBAAqB,GAAG,SAAS,CAAC;IAC3C;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC9B;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC9B;;OAEG;IACH,GAAG,CAAC,EAAE,KAAK,CAAC,aAAa,CAAC,GAAG,SAAS,CAAC;CACxC,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,mCAAmC,EAAE,CAAC,CAAC,aAAa,CAC/D,OAAO,qBAAqB,CACS,CAAC;AAExC,gBAAgB;AAChB,eAAO,MAAM,6BAA6B,EAAE,CAAC,CAAC,OAAO,CACnD,eAAe,EACf,CAAC,CAAC,UAAU,EACZ,OAAO,CAcP,CAAC;AAEH,wBAAgB,uBAAuB,CACrC,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,eAAe,EAAE,kBAAkB,CAAC,CAMtD"}
@@ -0,0 +1,33 @@
1
+ /*
2
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
+ */
4
+ import * as z from "zod/v3";
5
+ import { safeParse } from "../../../lib/schemas.js";
6
+ import { SiteLandShare$inboundSchema } from "./sitelandshare.js";
7
+ /**
8
+ * Dataset the profile is computed from. Always `os_ngd_land`.
9
+ */
10
+ export const SiteLandProfileSource = {
11
+ OsNgdLand: "os_ngd_land",
12
+ };
13
+ /** @internal */
14
+ export const SiteLandProfileSource$inboundSchema = z.nativeEnum(SiteLandProfileSource);
15
+ /** @internal */
16
+ export const SiteLandProfile$inboundSchema = z.object({
17
+ asOf: z.string().optional(),
18
+ cover: z.array(SiteLandShare$inboundSchema).optional(),
19
+ coveredPct: z.number().optional(),
20
+ madeSurfacePct: z.number().optional(),
21
+ madeSurfaceSqm: z.number().optional(),
22
+ obscuredSqm: z.number().optional(),
23
+ osVersion: z.string().optional(),
24
+ polygonCount: z.number().int().optional(),
25
+ source: SiteLandProfileSource$inboundSchema.optional(),
26
+ tidalSqm: z.number().optional(),
27
+ totalSqm: z.number().optional(),
28
+ use: z.array(SiteLandShare$inboundSchema).optional(),
29
+ });
30
+ export function siteLandProfileFromJSON(jsonString) {
31
+ return safeParse(jsonString, (x) => SiteLandProfile$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'SiteLandProfile' from JSON`);
32
+ }
33
+ //# sourceMappingURL=sitelandprofile.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"sitelandprofile.js","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/sitelandprofile.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAC5B,OAAO,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAC;AAIpD,OAAO,EAAiB,2BAA2B,EAAE,MAAM,oBAAoB,CAAC;AAEhF;;GAEG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG;IACnC,SAAS,EAAE,aAAa;CAChB,CAAC;AA4DX,gBAAgB;AAChB,MAAM,CAAC,MAAM,mCAAmC,GAE5C,CAAC,CAAC,UAAU,CAAC,qBAAqB,CAAC,CAAC;AAExC,gBAAgB;AAChB,MAAM,CAAC,MAAM,6BAA6B,GAItC,CAAC,CAAC,MAAM,CAAC;IACX,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC3B,KAAK,EAAE,CAAC,CAAC,KAAK,CAAC,2BAA2B,CAAC,CAAC,QAAQ,EAAE;IACtD,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACjC,cAAc,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACrC,cAAc,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACrC,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAClC,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAChC,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;IACzC,MAAM,EAAE,mCAAmC,CAAC,QAAQ,EAAE;IACtD,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC/B,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC/B,GAAG,EAAE,CAAC,CAAC,KAAK,CAAC,2BAA2B,CAAC,CAAC,QAAQ,EAAE;CACrD,CAAC,CAAC;AAEH,MAAM,UAAU,uBAAuB,CACrC,UAAkB;IAElB,OAAO,SAAS,CACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,6BAA6B,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EACzD,6CAA6C,CAC9C,CAAC;AACJ,CAAC"}
@@ -0,0 +1,25 @@
1
+ import * as z from "zod/v3";
2
+ import { Result as SafeParseResult } from "../../types/fp.js";
3
+ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
4
+ export type SiteLandShare = {
5
+ /**
6
+ * Area of the title carrying this class, in square metres.
7
+ */
8
+ areaSqm?: number | undefined;
9
+ /**
10
+ * The broader Ordnance Survey land cover group the class belongs to. Present on cover shares only.
11
+ */
12
+ group?: string | undefined;
13
+ /**
14
+ * Share of the title's land area carrying this class, from 0 to 100.
15
+ */
16
+ pct?: number | undefined;
17
+ /**
18
+ * The Ordnance Survey land cover or land use class this share is keyed by, as published.
19
+ */
20
+ value?: string | undefined;
21
+ };
22
+ /** @internal */
23
+ export declare const SiteLandShare$inboundSchema: z.ZodType<SiteLandShare, z.ZodTypeDef, unknown>;
24
+ export declare function siteLandShareFromJSON(jsonString: string): SafeParseResult<SiteLandShare, SDKValidationError>;
25
+ //# sourceMappingURL=sitelandshare.d.ts.map
@@ -0,0 +1 @@
1
+ {"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"}
@@ -0,0 +1,16 @@
1
+ /*
2
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
+ */
4
+ import * as z from "zod/v3";
5
+ import { safeParse } from "../../../lib/schemas.js";
6
+ /** @internal */
7
+ export const SiteLandShare$inboundSchema = z.object({
8
+ areaSqm: z.number().optional(),
9
+ group: z.string().optional(),
10
+ pct: z.number().optional(),
11
+ value: z.string().optional(),
12
+ });
13
+ export function siteLandShareFromJSON(jsonString) {
14
+ return safeParse(jsonString, (x) => SiteLandShare$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'SiteLandShare' from JSON`);
15
+ }
16
+ //# sourceMappingURL=sitelandshare.js.map
@@ -0,0 +1 @@
1
+ {"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/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@vepler/sdk",
3
- "version": "6.50.12",
3
+ "version": "6.52.0",
4
4
  "author": "Vepler Limited",
5
5
  "type": "module",
6
6
  "tshy": {
package/src/lib/config.ts CHANGED
@@ -60,8 +60,8 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
60
60
 
61
61
  export const SDK_METADATA = {
62
62
  language: "typescript",
63
- openapiDocVersion: "6.50.12",
63
+ openapiDocVersion: "6.52.0",
64
64
  sdkVersion: "0.12.0",
65
65
  genVersion: "2.950.2",
66
- userAgent: "speakeasy-sdk/typescript 0.12.0 2.950.2 6.50.12 @vepler/sdk",
66
+ userAgent: "speakeasy-sdk/typescript 0.12.0 2.950.2 6.52.0 @vepler/sdk",
67
67
  } as const;
@@ -389,8 +389,12 @@ export * from "./siteareafilter.js";
389
389
  export * from "./siteareametrics.js";
390
390
  export * from "./sitebatchidsrequest.js";
391
391
  export * from "./siteboundingboxareafilter.js";
392
+ export * from "./sitebuildingcount.js";
393
+ export * from "./sitebuildingprofile.js";
392
394
  export * from "./sitecontainspointareafilter.js";
393
395
  export * from "./sitefilters.js";
396
+ export * from "./sitelandprofile.js";
397
+ export * from "./sitelandshare.js";
394
398
  export * from "./siteleafaggregation.js";
395
399
  export * from "./sitelistresponse.js";
396
400
  export * from "./sitemultipolygonareafilter.js";
@@ -14,6 +14,14 @@ import {
14
14
  SiteAreaMetrics,
15
15
  SiteAreaMetrics$inboundSchema,
16
16
  } from "./siteareametrics.js";
17
+ import {
18
+ SiteBuildingProfile,
19
+ SiteBuildingProfile$inboundSchema,
20
+ } from "./sitebuildingprofile.js";
21
+ import {
22
+ SiteLandProfile,
23
+ SiteLandProfile$inboundSchema,
24
+ } from "./sitelandprofile.js";
17
25
  import {
18
26
  SitePlanningStats,
19
27
  SitePlanningStats$inboundSchema,
@@ -256,6 +264,14 @@ export type Site = {
256
264
  | SiteGeoJSONMultiPolygon
257
265
  | discriminatedUnionTypes.Unknown<"type">
258
266
  | undefined;
267
+ /**
268
+ * Identifiers of the buildings whose footprint intersects the title, for use with the buildings endpoints. Left out of the default attribute set; request it with `attributes: ["buildingIds"]`. Requires the `osNgdAccess` permission on the licence.
269
+ */
270
+ buildingIds?: Array<string> | undefined;
271
+ /**
272
+ * The buildings whose footprint intersects the title, measured on the title boundary. Requires the `osNgdAccess` permission on the licence, and is left out of the response without it.
273
+ */
274
+ buildingProfile?: SiteBuildingProfile | undefined;
259
275
  /**
260
276
  * Centre point of the title boundary. Present whenever the site has a boundary, unless `centroid` is left out of the requested attributes.
261
277
  */
@@ -272,6 +288,10 @@ export type Site = {
272
288
  * HM Land Registry estate interest code, which records the kind of interest the title covers. Almost always `EL`, an estate in land. It does not distinguish freehold from leasehold; read `classTitleCode` or `tenureType` for that. Left out of the default attribute set; request it with `attributes: ["estateInterestCode"]`.
273
289
  */
274
290
  estateInterestCode?: EstateInterestCode | null | undefined;
291
+ /**
292
+ * Land cover and use composition of the title, measured on the title boundary. Requires the `osNgdAccess` permission on the licence, and is left out of the response without it.
293
+ */
294
+ landProfile?: SiteLandProfile | undefined;
275
295
  /**
276
296
  * Land use classifications recorded for the site.
277
297
  */
@@ -514,10 +534,13 @@ export const Site$inboundSchema: z.ZodType<Site, z.ZodTypeDef, unknown> = z
514
534
  Polygon: z.lazy(() => SiteGeoJSONPolygon$inboundSchema),
515
535
  MultiPolygon: z.lazy(() => SiteGeoJSONMultiPolygon$inboundSchema),
516
536
  }).optional(),
537
+ buildingIds: z.array(z.string()).optional(),
538
+ buildingProfile: SiteBuildingProfile$inboundSchema.optional(),
517
539
  centroid: z.lazy(() => SiteCoordinates$inboundSchema).optional(),
518
540
  classTitleCode: z.nullable(ClassTitleCode$inboundSchema).optional(),
519
541
  country: z.string().optional(),
520
542
  estateInterestCode: z.nullable(EstateInterestCode$inboundSchema).optional(),
543
+ landProfile: SiteLandProfile$inboundSchema.optional(),
521
544
  landUse: z.array(LandUse$inboundSchema).optional(),
522
545
  locationCount: z.number().optional(),
523
546
  locationIds: z.array(z.string()).optional(),
@@ -0,0 +1,39 @@
1
+ /*
2
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
+ */
4
+
5
+ import * as z from "zod/v3";
6
+ import { safeParse } from "../../../lib/schemas.js";
7
+ import { Result as SafeParseResult } from "../../types/fp.js";
8
+ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
9
+
10
+ export type SiteBuildingCount = {
11
+ /**
12
+ * Number of buildings on the title in this class.
13
+ */
14
+ count?: number | undefined;
15
+ /**
16
+ * The Ordnance Survey class this count is keyed by, as published.
17
+ */
18
+ value?: string | undefined;
19
+ };
20
+
21
+ /** @internal */
22
+ export const SiteBuildingCount$inboundSchema: z.ZodType<
23
+ SiteBuildingCount,
24
+ z.ZodTypeDef,
25
+ unknown
26
+ > = z.object({
27
+ count: z.number().int().optional(),
28
+ value: z.string().optional(),
29
+ });
30
+
31
+ export function siteBuildingCountFromJSON(
32
+ jsonString: string,
33
+ ): SafeParseResult<SiteBuildingCount, SDKValidationError> {
34
+ return safeParse(
35
+ jsonString,
36
+ (x) => SiteBuildingCount$inboundSchema.parse(JSON.parse(x)),
37
+ `Failed to parse 'SiteBuildingCount' from JSON`,
38
+ );
39
+ }
@@ -0,0 +1,140 @@
1
+ /*
2
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
+ */
4
+
5
+ import * as z from "zod/v3";
6
+ import { safeParse } from "../../../lib/schemas.js";
7
+ import { ClosedEnum } from "../../types/enums.js";
8
+ import { Result as SafeParseResult } from "../../types/fp.js";
9
+ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
10
+ import {
11
+ SiteBuildingCount,
12
+ SiteBuildingCount$inboundSchema,
13
+ } from "./sitebuildingcount.js";
14
+
15
+ /**
16
+ * Dataset the profile is computed from. Always `os_ngd_building`.
17
+ */
18
+ export const SiteBuildingProfileSource = {
19
+ OsNgdBuilding: "os_ngd_building",
20
+ } as const;
21
+ /**
22
+ * Dataset the profile is computed from. Always `os_ngd_building`.
23
+ */
24
+ export type SiteBuildingProfileSource = ClosedEnum<
25
+ typeof SiteBuildingProfileSource
26
+ >;
27
+
28
+ /**
29
+ * The buildings whose footprint intersects the title, measured on the title boundary. Requires the `osNgdAccess` permission on the licence, and is left out of the response without it.
30
+ */
31
+ export type SiteBuildingProfile = {
32
+ /**
33
+ * Release date of the Ordnance Survey version the profile was computed from, as an ISO 8601 timestamp.
34
+ */
35
+ asOf?: string | undefined;
36
+ /**
37
+ * The buildings on the title by how they connect to neighbouring buildings, such as `Standalone` or `End-Connected`, largest first.
38
+ */
39
+ connectivity?: Array<SiteBuildingCount> | undefined;
40
+ /**
41
+ * Number of buildings whose footprint intersects the title. A building on more than one title counts on each.
42
+ */
43
+ count?: number | undefined;
44
+ /**
45
+ * Share of the title area covered by building footprints, from 0 to 100.
46
+ */
47
+ coveragePct?: number | undefined;
48
+ /**
49
+ * Earliest Ordnance Survey construction period band among the buildings with one, as published. Null when none has one.
50
+ */
51
+ earliestAgeBand?: string | null | undefined;
52
+ /**
53
+ * Footprint area of those buildings that lies within the title, in square metres.
54
+ */
55
+ footprintSqm?: number | undefined;
56
+ /**
57
+ * Latest Ordnance Survey construction period band among the buildings with one, as published. Null when none has one.
58
+ */
59
+ latestAgeBand?: string | null | undefined;
60
+ /**
61
+ * Greatest number of floors among the buildings with a recorded floor count. Null when none has one.
62
+ */
63
+ maxFloors?: number | null | undefined;
64
+ /**
65
+ * Greatest height above ground among the buildings with a recorded height, in metres. Null when none has one.
66
+ */
67
+ maxHeightM?: number | null | undefined;
68
+ /**
69
+ * Median number of floors among the buildings with a recorded floor count. Null when none has one.
70
+ */
71
+ medianFloors?: number | null | undefined;
72
+ /**
73
+ * Median height above ground among the buildings with a recorded height, in metres. Null when none has one.
74
+ */
75
+ medianHeightM?: number | null | undefined;
76
+ /**
77
+ * Identifier of that Ordnance Survey release.
78
+ */
79
+ osVersion?: string | undefined;
80
+ /**
81
+ * Dataset the profile is computed from. Always `os_ngd_building`.
82
+ */
83
+ source?: SiteBuildingProfileSource | undefined;
84
+ /**
85
+ * The buildings on the title by Ordnance Survey building use, largest first.
86
+ */
87
+ uses?: Array<SiteBuildingCount> | undefined;
88
+ /**
89
+ * Number of those buildings with a construction period band.
90
+ */
91
+ withAgeBand?: number | undefined;
92
+ /**
93
+ * Number of those buildings with a recorded floor count.
94
+ */
95
+ withFloors?: number | undefined;
96
+ /**
97
+ * Number of those buildings with a recorded height.
98
+ */
99
+ withHeight?: number | undefined;
100
+ };
101
+
102
+ /** @internal */
103
+ export const SiteBuildingProfileSource$inboundSchema: z.ZodNativeEnum<
104
+ typeof SiteBuildingProfileSource
105
+ > = z.nativeEnum(SiteBuildingProfileSource);
106
+
107
+ /** @internal */
108
+ export const SiteBuildingProfile$inboundSchema: z.ZodType<
109
+ SiteBuildingProfile,
110
+ z.ZodTypeDef,
111
+ unknown
112
+ > = z.object({
113
+ asOf: z.string().optional(),
114
+ connectivity: z.array(SiteBuildingCount$inboundSchema).optional(),
115
+ count: z.number().int().optional(),
116
+ coveragePct: z.number().optional(),
117
+ earliestAgeBand: z.nullable(z.string()).optional(),
118
+ footprintSqm: z.number().optional(),
119
+ latestAgeBand: z.nullable(z.string()).optional(),
120
+ maxFloors: z.nullable(z.number().int()).optional(),
121
+ maxHeightM: z.nullable(z.number()).optional(),
122
+ medianFloors: z.nullable(z.number()).optional(),
123
+ medianHeightM: z.nullable(z.number()).optional(),
124
+ osVersion: z.string().optional(),
125
+ source: SiteBuildingProfileSource$inboundSchema.optional(),
126
+ uses: z.array(SiteBuildingCount$inboundSchema).optional(),
127
+ withAgeBand: z.number().int().optional(),
128
+ withFloors: z.number().int().optional(),
129
+ withHeight: z.number().int().optional(),
130
+ });
131
+
132
+ export function siteBuildingProfileFromJSON(
133
+ jsonString: string,
134
+ ): SafeParseResult<SiteBuildingProfile, SDKValidationError> {
135
+ return safeParse(
136
+ jsonString,
137
+ (x) => SiteBuildingProfile$inboundSchema.parse(JSON.parse(x)),
138
+ `Failed to parse 'SiteBuildingProfile' from JSON`,
139
+ );
140
+ }
@@ -0,0 +1,110 @@
1
+ /*
2
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
+ */
4
+
5
+ import * as z from "zod/v3";
6
+ import { safeParse } from "../../../lib/schemas.js";
7
+ import { ClosedEnum } from "../../types/enums.js";
8
+ import { Result as SafeParseResult } from "../../types/fp.js";
9
+ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
10
+ import { SiteLandShare, SiteLandShare$inboundSchema } from "./sitelandshare.js";
11
+
12
+ /**
13
+ * Dataset the profile is computed from. Always `os_ngd_land`.
14
+ */
15
+ export const SiteLandProfileSource = {
16
+ OsNgdLand: "os_ngd_land",
17
+ } as const;
18
+ /**
19
+ * Dataset the profile is computed from. Always `os_ngd_land`.
20
+ */
21
+ export type SiteLandProfileSource = ClosedEnum<typeof SiteLandProfileSource>;
22
+
23
+ /**
24
+ * Land cover and use composition of the title, measured on the title boundary. Requires the `osNgdAccess` permission on the licence, and is left out of the response without it.
25
+ */
26
+ export type SiteLandProfile = {
27
+ /**
28
+ * Release date of the Ordnance Survey version the profile was computed from, as an ISO 8601 timestamp.
29
+ */
30
+ asOf?: string | undefined;
31
+ /**
32
+ * The title's land area by Ordnance Survey land cover class, largest first.
33
+ */
34
+ cover?: Array<SiteLandShare> | undefined;
35
+ /**
36
+ * Share of the title area covered by land polygons, from 0 to 100. Building footprints are a separate feature type and are measured in `buildingProfile`, so a built title is rarely fully covered.
37
+ */
38
+ coveredPct?: number | undefined;
39
+ /**
40
+ * Share of the title's land area that is a made surface, from 0 to 100.
41
+ */
42
+ madeSurfacePct?: number | undefined;
43
+ /**
44
+ * Area of the title whose land cover is a made surface, such as paving or hard standing, in square metres. Building footprints are not included.
45
+ */
46
+ madeSurfaceSqm?: number | undefined;
47
+ /**
48
+ * Area of the title whose land cover is recorded as obscured, in square metres.
49
+ */
50
+ obscuredSqm?: number | undefined;
51
+ /**
52
+ * Identifier of that Ordnance Survey release.
53
+ */
54
+ osVersion?: string | undefined;
55
+ /**
56
+ * Number of land polygons that cover part of the title.
57
+ */
58
+ polygonCount?: number | undefined;
59
+ /**
60
+ * Dataset the profile is computed from. Always `os_ngd_land`.
61
+ */
62
+ source?: SiteLandProfileSource | undefined;
63
+ /**
64
+ * Area of the title that is tidal, in square metres.
65
+ */
66
+ tidalSqm?: number | undefined;
67
+ /**
68
+ * Area of the title covered by land polygons, in square metres.
69
+ */
70
+ totalSqm?: number | undefined;
71
+ /**
72
+ * The title's land area by Ordnance Survey land use class, largest first.
73
+ */
74
+ use?: Array<SiteLandShare> | undefined;
75
+ };
76
+
77
+ /** @internal */
78
+ export const SiteLandProfileSource$inboundSchema: z.ZodNativeEnum<
79
+ typeof SiteLandProfileSource
80
+ > = z.nativeEnum(SiteLandProfileSource);
81
+
82
+ /** @internal */
83
+ export const SiteLandProfile$inboundSchema: z.ZodType<
84
+ SiteLandProfile,
85
+ z.ZodTypeDef,
86
+ unknown
87
+ > = z.object({
88
+ asOf: z.string().optional(),
89
+ cover: z.array(SiteLandShare$inboundSchema).optional(),
90
+ coveredPct: z.number().optional(),
91
+ madeSurfacePct: z.number().optional(),
92
+ madeSurfaceSqm: z.number().optional(),
93
+ obscuredSqm: z.number().optional(),
94
+ osVersion: z.string().optional(),
95
+ polygonCount: z.number().int().optional(),
96
+ source: SiteLandProfileSource$inboundSchema.optional(),
97
+ tidalSqm: z.number().optional(),
98
+ totalSqm: z.number().optional(),
99
+ use: z.array(SiteLandShare$inboundSchema).optional(),
100
+ });
101
+
102
+ export function siteLandProfileFromJSON(
103
+ jsonString: string,
104
+ ): SafeParseResult<SiteLandProfile, SDKValidationError> {
105
+ return safeParse(
106
+ jsonString,
107
+ (x) => SiteLandProfile$inboundSchema.parse(JSON.parse(x)),
108
+ `Failed to parse 'SiteLandProfile' from JSON`,
109
+ );
110
+ }
@@ -0,0 +1,49 @@
1
+ /*
2
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
+ */
4
+
5
+ import * as z from "zod/v3";
6
+ import { safeParse } from "../../../lib/schemas.js";
7
+ import { Result as SafeParseResult } from "../../types/fp.js";
8
+ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
9
+
10
+ export type SiteLandShare = {
11
+ /**
12
+ * Area of the title carrying this class, in square metres.
13
+ */
14
+ areaSqm?: number | undefined;
15
+ /**
16
+ * The broader Ordnance Survey land cover group the class belongs to. Present on cover shares only.
17
+ */
18
+ group?: string | undefined;
19
+ /**
20
+ * Share of the title's land area carrying this class, from 0 to 100.
21
+ */
22
+ pct?: number | undefined;
23
+ /**
24
+ * The Ordnance Survey land cover or land use class this share is keyed by, as published.
25
+ */
26
+ value?: string | undefined;
27
+ };
28
+
29
+ /** @internal */
30
+ export const SiteLandShare$inboundSchema: z.ZodType<
31
+ SiteLandShare,
32
+ z.ZodTypeDef,
33
+ unknown
34
+ > = z.object({
35
+ areaSqm: z.number().optional(),
36
+ group: z.string().optional(),
37
+ pct: z.number().optional(),
38
+ value: z.string().optional(),
39
+ });
40
+
41
+ export function siteLandShareFromJSON(
42
+ jsonString: string,
43
+ ): SafeParseResult<SiteLandShare, SDKValidationError> {
44
+ return safeParse(
45
+ jsonString,
46
+ (x) => SiteLandShare$inboundSchema.parse(JSON.parse(x)),
47
+ `Failed to parse 'SiteLandShare' from JSON`,
48
+ );
49
+ }