@vepler/sdk 6.52.0 → 6.57.1

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 (186) hide show
  1. package/README.md +424 -416
  2. package/dist/commonjs/funcs/sitesGet.d.ts +1 -1
  3. package/dist/commonjs/funcs/sitesGet.js +5 -1
  4. package/dist/commonjs/funcs/sitesGet.js.map +1 -1
  5. package/dist/commonjs/funcs/sitesGetLand.d.ts +19 -0
  6. package/dist/commonjs/funcs/sitesGetLand.d.ts.map +1 -0
  7. package/dist/commonjs/funcs/sitesGetLand.js +131 -0
  8. package/dist/commonjs/funcs/sitesGetLand.js.map +1 -0
  9. package/dist/commonjs/funcs/sitesSearch.d.ts +1 -1
  10. package/dist/commonjs/funcs/sitesSearch.js +1 -1
  11. package/dist/commonjs/lib/config.d.ts +3 -3
  12. package/dist/commonjs/lib/config.js +3 -3
  13. package/dist/commonjs/lib/config.js.map +1 -1
  14. package/dist/commonjs/sdk/models/errors/getsiteland.d.ts +396 -0
  15. package/dist/commonjs/sdk/models/errors/getsiteland.d.ts.map +1 -0
  16. package/dist/commonjs/sdk/models/errors/getsiteland.js +381 -0
  17. package/dist/commonjs/sdk/models/errors/getsiteland.js.map +1 -0
  18. package/dist/commonjs/sdk/models/errors/index.d.ts +1 -0
  19. package/dist/commonjs/sdk/models/errors/index.d.ts.map +1 -1
  20. package/dist/commonjs/sdk/models/errors/index.js +1 -0
  21. package/dist/commonjs/sdk/models/errors/index.js.map +1 -1
  22. package/dist/commonjs/sdk/models/operations/getsitebyid.d.ts +5 -0
  23. package/dist/commonjs/sdk/models/operations/getsitebyid.d.ts.map +1 -1
  24. package/dist/commonjs/sdk/models/operations/getsitebyid.js +1 -0
  25. package/dist/commonjs/sdk/models/operations/getsitebyid.js.map +1 -1
  26. package/dist/commonjs/sdk/models/operations/getsiteland.d.ts +30 -0
  27. package/dist/commonjs/sdk/models/operations/getsiteland.d.ts.map +1 -0
  28. package/dist/commonjs/sdk/models/operations/getsiteland.js +52 -0
  29. package/dist/commonjs/sdk/models/operations/getsiteland.js.map +1 -0
  30. package/dist/commonjs/sdk/models/operations/index.d.ts +1 -0
  31. package/dist/commonjs/sdk/models/operations/index.d.ts.map +1 -1
  32. package/dist/commonjs/sdk/models/operations/index.js +1 -0
  33. package/dist/commonjs/sdk/models/operations/index.js.map +1 -1
  34. package/dist/commonjs/sdk/models/shared/building.d.ts +5 -5
  35. package/dist/commonjs/sdk/models/shared/building.d.ts.map +1 -1
  36. package/dist/commonjs/sdk/models/shared/building.js +7 -7
  37. package/dist/commonjs/sdk/models/shared/building.js.map +1 -1
  38. package/dist/commonjs/sdk/models/shared/index.d.ts +7 -0
  39. package/dist/commonjs/sdk/models/shared/index.d.ts.map +1 -1
  40. package/dist/commonjs/sdk/models/shared/index.js +7 -0
  41. package/dist/commonjs/sdk/models/shared/index.js.map +1 -1
  42. package/dist/commonjs/sdk/models/shared/site.d.ts +54 -14
  43. package/dist/commonjs/sdk/models/shared/site.d.ts.map +1 -1
  44. package/dist/commonjs/sdk/models/shared/site.js +24 -6
  45. package/dist/commonjs/sdk/models/shared/site.js.map +1 -1
  46. package/dist/commonjs/sdk/models/shared/sitebuilding.d.ts +176 -0
  47. package/dist/commonjs/sdk/models/shared/sitebuilding.d.ts.map +1 -0
  48. package/dist/commonjs/sdk/models/shared/sitebuilding.js +141 -0
  49. package/dist/commonjs/sdk/models/shared/sitebuilding.js.map +1 -0
  50. package/dist/commonjs/sdk/models/shared/siteconstraintflags.d.ts +32 -0
  51. package/dist/commonjs/sdk/models/shared/siteconstraintflags.d.ts.map +1 -0
  52. package/dist/commonjs/sdk/models/shared/siteconstraintflags.js +54 -0
  53. package/dist/commonjs/sdk/models/shared/siteconstraintflags.js.map +1 -0
  54. package/dist/commonjs/sdk/models/shared/siteconstraintlayer.d.ts +45 -0
  55. package/dist/commonjs/sdk/models/shared/siteconstraintlayer.d.ts.map +1 -0
  56. package/dist/commonjs/sdk/models/shared/siteconstraintlayer.js +58 -0
  57. package/dist/commonjs/sdk/models/shared/siteconstraintlayer.js.map +1 -0
  58. package/dist/commonjs/sdk/models/shared/siteconstraints.d.ts +31 -0
  59. package/dist/commonjs/sdk/models/shared/siteconstraints.d.ts.map +1 -0
  60. package/dist/commonjs/sdk/models/shared/siteconstraints.js +56 -0
  61. package/dist/commonjs/sdk/models/shared/siteconstraints.js.map +1 -0
  62. package/dist/commonjs/sdk/models/shared/siteconstraintunmeasured.d.ts +49 -0
  63. package/dist/commonjs/sdk/models/shared/siteconstraintunmeasured.d.ts.map +1 -0
  64. package/dist/commonjs/sdk/models/shared/siteconstraintunmeasured.js +75 -0
  65. package/dist/commonjs/sdk/models/shared/siteconstraintunmeasured.js.map +1 -0
  66. package/dist/commonjs/sdk/models/shared/sitelandfeature.d.ts +90 -0
  67. package/dist/commonjs/sdk/models/shared/sitelandfeature.d.ts.map +1 -0
  68. package/dist/commonjs/sdk/models/shared/sitelandfeature.js +79 -0
  69. package/dist/commonjs/sdk/models/shared/sitelandfeature.js.map +1 -0
  70. package/dist/commonjs/sdk/models/shared/sitelandlistresponse.d.ts +46 -0
  71. package/dist/commonjs/sdk/models/shared/sitelandlistresponse.d.ts.map +1 -0
  72. package/dist/commonjs/sdk/models/shared/sitelandlistresponse.js +69 -0
  73. package/dist/commonjs/sdk/models/shared/sitelandlistresponse.js.map +1 -0
  74. package/dist/commonjs/sdk/models/shared/sitequeryrequest.d.ts +2 -2
  75. package/dist/commonjs/sdk/models/shared/sitetags.d.ts +4 -0
  76. package/dist/commonjs/sdk/models/shared/sitetags.d.ts.map +1 -1
  77. package/dist/commonjs/sdk/models/shared/sitetags.js +1 -0
  78. package/dist/commonjs/sdk/models/shared/sitetags.js.map +1 -1
  79. package/dist/commonjs/sdk/sites.d.ts +9 -2
  80. package/dist/commonjs/sdk/sites.d.ts.map +1 -1
  81. package/dist/commonjs/sdk/sites.js +12 -2
  82. package/dist/commonjs/sdk/sites.js.map +1 -1
  83. package/dist/esm/funcs/sitesGet.d.ts +1 -1
  84. package/dist/esm/funcs/sitesGet.js +6 -2
  85. package/dist/esm/funcs/sitesGet.js.map +1 -1
  86. package/dist/esm/funcs/sitesGetLand.d.ts +19 -0
  87. package/dist/esm/funcs/sitesGetLand.d.ts.map +1 -0
  88. package/dist/esm/funcs/sitesGetLand.js +95 -0
  89. package/dist/esm/funcs/sitesGetLand.js.map +1 -0
  90. package/dist/esm/funcs/sitesSearch.d.ts +1 -1
  91. package/dist/esm/funcs/sitesSearch.js +1 -1
  92. package/dist/esm/lib/config.d.ts +3 -3
  93. package/dist/esm/lib/config.js +3 -3
  94. package/dist/esm/lib/config.js.map +1 -1
  95. package/dist/esm/sdk/models/errors/getsiteland.d.ts +396 -0
  96. package/dist/esm/sdk/models/errors/getsiteland.d.ts.map +1 -0
  97. package/dist/esm/sdk/models/errors/getsiteland.js +333 -0
  98. package/dist/esm/sdk/models/errors/getsiteland.js.map +1 -0
  99. package/dist/esm/sdk/models/errors/index.d.ts +1 -0
  100. package/dist/esm/sdk/models/errors/index.d.ts.map +1 -1
  101. package/dist/esm/sdk/models/errors/index.js +1 -0
  102. package/dist/esm/sdk/models/errors/index.js.map +1 -1
  103. package/dist/esm/sdk/models/operations/getsitebyid.d.ts +5 -0
  104. package/dist/esm/sdk/models/operations/getsitebyid.d.ts.map +1 -1
  105. package/dist/esm/sdk/models/operations/getsitebyid.js +1 -0
  106. package/dist/esm/sdk/models/operations/getsitebyid.js.map +1 -1
  107. package/dist/esm/sdk/models/operations/getsiteland.d.ts +30 -0
  108. package/dist/esm/sdk/models/operations/getsiteland.d.ts.map +1 -0
  109. package/dist/esm/sdk/models/operations/getsiteland.js +15 -0
  110. package/dist/esm/sdk/models/operations/getsiteland.js.map +1 -0
  111. package/dist/esm/sdk/models/operations/index.d.ts +1 -0
  112. package/dist/esm/sdk/models/operations/index.d.ts.map +1 -1
  113. package/dist/esm/sdk/models/operations/index.js +1 -0
  114. package/dist/esm/sdk/models/operations/index.js.map +1 -1
  115. package/dist/esm/sdk/models/shared/building.d.ts +5 -5
  116. package/dist/esm/sdk/models/shared/building.d.ts.map +1 -1
  117. package/dist/esm/sdk/models/shared/building.js +5 -5
  118. package/dist/esm/sdk/models/shared/building.js.map +1 -1
  119. package/dist/esm/sdk/models/shared/index.d.ts +7 -0
  120. package/dist/esm/sdk/models/shared/index.d.ts.map +1 -1
  121. package/dist/esm/sdk/models/shared/index.js +7 -0
  122. package/dist/esm/sdk/models/shared/index.js.map +1 -1
  123. package/dist/esm/sdk/models/shared/site.d.ts +54 -14
  124. package/dist/esm/sdk/models/shared/site.d.ts.map +1 -1
  125. package/dist/esm/sdk/models/shared/site.js +23 -5
  126. package/dist/esm/sdk/models/shared/site.js.map +1 -1
  127. package/dist/esm/sdk/models/shared/sitebuilding.d.ts +176 -0
  128. package/dist/esm/sdk/models/shared/sitebuilding.d.ts.map +1 -0
  129. package/dist/esm/sdk/models/shared/sitebuilding.js +101 -0
  130. package/dist/esm/sdk/models/shared/sitebuilding.js.map +1 -0
  131. package/dist/esm/sdk/models/shared/siteconstraintflags.d.ts +32 -0
  132. package/dist/esm/sdk/models/shared/siteconstraintflags.d.ts.map +1 -0
  133. package/dist/esm/sdk/models/shared/siteconstraintflags.js +17 -0
  134. package/dist/esm/sdk/models/shared/siteconstraintflags.js.map +1 -0
  135. package/dist/esm/sdk/models/shared/siteconstraintlayer.d.ts +45 -0
  136. package/dist/esm/sdk/models/shared/siteconstraintlayer.d.ts.map +1 -0
  137. package/dist/esm/sdk/models/shared/siteconstraintlayer.js +21 -0
  138. package/dist/esm/sdk/models/shared/siteconstraintlayer.js.map +1 -0
  139. package/dist/esm/sdk/models/shared/siteconstraints.d.ts +31 -0
  140. package/dist/esm/sdk/models/shared/siteconstraints.d.ts.map +1 -0
  141. package/dist/esm/sdk/models/shared/siteconstraints.js +19 -0
  142. package/dist/esm/sdk/models/shared/siteconstraints.js.map +1 -0
  143. package/dist/esm/sdk/models/shared/siteconstraintunmeasured.d.ts +49 -0
  144. package/dist/esm/sdk/models/shared/siteconstraintunmeasured.d.ts.map +1 -0
  145. package/dist/esm/sdk/models/shared/siteconstraintunmeasured.js +38 -0
  146. package/dist/esm/sdk/models/shared/siteconstraintunmeasured.js.map +1 -0
  147. package/dist/esm/sdk/models/shared/sitelandfeature.d.ts +90 -0
  148. package/dist/esm/sdk/models/shared/sitelandfeature.d.ts.map +1 -0
  149. package/dist/esm/sdk/models/shared/sitelandfeature.js +41 -0
  150. package/dist/esm/sdk/models/shared/sitelandfeature.js.map +1 -0
  151. package/dist/esm/sdk/models/shared/sitelandlistresponse.d.ts +46 -0
  152. package/dist/esm/sdk/models/shared/sitelandlistresponse.d.ts.map +1 -0
  153. package/dist/esm/sdk/models/shared/sitelandlistresponse.js +32 -0
  154. package/dist/esm/sdk/models/shared/sitelandlistresponse.js.map +1 -0
  155. package/dist/esm/sdk/models/shared/sitequeryrequest.d.ts +2 -2
  156. package/dist/esm/sdk/models/shared/sitetags.d.ts +4 -0
  157. package/dist/esm/sdk/models/shared/sitetags.d.ts.map +1 -1
  158. package/dist/esm/sdk/models/shared/sitetags.js +1 -0
  159. package/dist/esm/sdk/models/shared/sitetags.js.map +1 -1
  160. package/dist/esm/sdk/sites.d.ts +9 -2
  161. package/dist/esm/sdk/sites.d.ts.map +1 -1
  162. package/dist/esm/sdk/sites.js +12 -2
  163. package/dist/esm/sdk/sites.js.map +1 -1
  164. package/package.json +1 -1
  165. package/src/funcs/sitesGet.ts +7 -2
  166. package/src/funcs/sitesGetLand.ts +213 -0
  167. package/src/funcs/sitesSearch.ts +1 -1
  168. package/src/lib/config.ts +3 -3
  169. package/src/sdk/models/errors/getsiteland.ts +770 -0
  170. package/src/sdk/models/errors/index.ts +1 -0
  171. package/src/sdk/models/operations/getsitebyid.ts +6 -0
  172. package/src/sdk/models/operations/getsiteland.ts +52 -0
  173. package/src/sdk/models/operations/index.ts +1 -0
  174. package/src/sdk/models/shared/building.ts +11 -11
  175. package/src/sdk/models/shared/index.ts +7 -0
  176. package/src/sdk/models/shared/site.ts +72 -17
  177. package/src/sdk/models/shared/sitebuilding.ts +288 -0
  178. package/src/sdk/models/shared/siteconstraintflags.ts +57 -0
  179. package/src/sdk/models/shared/siteconstraintlayer.ts +74 -0
  180. package/src/sdk/models/shared/siteconstraints.ts +64 -0
  181. package/src/sdk/models/shared/siteconstraintunmeasured.ts +83 -0
  182. package/src/sdk/models/shared/sitelandfeature.ts +145 -0
  183. package/src/sdk/models/shared/sitelandlistresponse.ts +86 -0
  184. package/src/sdk/models/shared/sitequeryrequest.ts +2 -2
  185. package/src/sdk/models/shared/sitetags.ts +5 -0
  186. package/src/sdk/sites.ts +20 -2
@@ -0,0 +1,90 @@
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
+ /**
6
+ * Geometry type discriminator. Always `Polygon`.
7
+ */
8
+ export declare const SiteLandFeatureType: {
9
+ readonly Polygon: "Polygon";
10
+ };
11
+ /**
12
+ * Geometry type discriminator. Always `Polygon`.
13
+ */
14
+ export type SiteLandFeatureType = ClosedEnum<typeof SiteLandFeatureType>;
15
+ /**
16
+ * The whole polygon as published, in WGS84 with positions as [longitude, latitude]. It can extend beyond the title boundary; `areaOnTitleSqm` measures only the part within it. Left out by default; request it with `attributes=geometry`.
17
+ */
18
+ export type GeoJSONPolygon = {
19
+ /**
20
+ * The rings that make up the polygon. The first ring is the outer boundary and any further rings are holes inside it. Each ring needs at least four positions and closes by repeating its first position as the last.
21
+ */
22
+ coordinates: Array<Array<Array<number>>>;
23
+ /**
24
+ * Geometry type discriminator. Always `Polygon`.
25
+ */
26
+ type: SiteLandFeatureType;
27
+ };
28
+ export type SiteLandFeature = {
29
+ /**
30
+ * Area of the polygon that lies within the title boundary, in square metres, to one decimal place.
31
+ */
32
+ areaOnTitleSqm: number;
33
+ /**
34
+ * Release date of the Ordnance Survey version the polygon was read from, as an ISO 8601 timestamp.
35
+ */
36
+ asOf: string;
37
+ /**
38
+ * Ordnance Survey land cover of the polygon (tier B), as published. The set of values is open.
39
+ */
40
+ cover: string;
41
+ /**
42
+ * Ordnance Survey land cover group the `cover` value belongs to (tier A), as published.
43
+ */
44
+ coverGroup: string;
45
+ /**
46
+ * Ordnance Survey description of the feature, as published.
47
+ */
48
+ description: string;
49
+ /**
50
+ * The whole polygon as published, in WGS84 with positions as [longitude, latitude]. It can extend beyond the title boundary; `areaOnTitleSqm` measures only the part within it. Left out by default; request it with `attributes=geometry`.
51
+ */
52
+ geometry?: GeoJSONPolygon | undefined;
53
+ /**
54
+ * Identifier of the land polygon: `GB:NGD:` followed by its Ordnance Survey feature identifier.
55
+ */
56
+ id: string;
57
+ /**
58
+ * True when Ordnance Survey records the polygon's land cover as obscured.
59
+ */
60
+ isObscured: boolean;
61
+ /**
62
+ * True when Ordnance Survey records the polygon as tidal.
63
+ */
64
+ isTidal: boolean;
65
+ /**
66
+ * Ordnance Survey landform of the polygon, such as a pit or quarry, as published. Null when none is recorded.
67
+ */
68
+ landform: string | null;
69
+ /**
70
+ * Kind of feature. Every item is `land` today, and the set of values is open.
71
+ */
72
+ type: string;
73
+ /**
74
+ * Ordnance Survey land use of the polygon (tier A), as published. The set of values is open.
75
+ */
76
+ use: string;
77
+ /**
78
+ * Ordnance Survey detailed land use of the polygon (tier B), as published. Null when none is recorded.
79
+ */
80
+ useDetail: string | null;
81
+ };
82
+ /** @internal */
83
+ export declare const SiteLandFeatureType$inboundSchema: z.ZodNativeEnum<typeof SiteLandFeatureType>;
84
+ /** @internal */
85
+ export declare const GeoJSONPolygon$inboundSchema: z.ZodType<GeoJSONPolygon, z.ZodTypeDef, unknown>;
86
+ export declare function geoJSONPolygonFromJSON(jsonString: string): SafeParseResult<GeoJSONPolygon, SDKValidationError>;
87
+ /** @internal */
88
+ export declare const SiteLandFeature$inboundSchema: z.ZodType<SiteLandFeature, z.ZodTypeDef, unknown>;
89
+ export declare function siteLandFeatureFromJSON(jsonString: string): SafeParseResult<SiteLandFeature, SDKValidationError>;
90
+ //# sourceMappingURL=sitelandfeature.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"sitelandfeature.d.ts","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/sitelandfeature.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;AAErE;;GAEG;AACH,eAAO,MAAM,mBAAmB;;CAEtB,CAAC;AACX;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG,UAAU,CAAC,OAAO,mBAAmB,CAAC,CAAC;AAEzE;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B;;OAEG;IACH,WAAW,EAAE,KAAK,CAAC,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;IACzC;;OAEG;IACH,IAAI,EAAE,mBAAmB,CAAC;CAC3B,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG;IAC5B;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IACvB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,QAAQ,CAAC,EAAE,cAAc,GAAG,SAAS,CAAC;IACtC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IACX;;OAEG;IACH,UAAU,EAAE,OAAO,CAAC;IACpB;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IACjB;;OAEG;IACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IACZ;;OAEG;IACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;CAC1B,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,iCAAiC,EAAE,CAAC,CAAC,aAAa,CAC7D,OAAO,mBAAmB,CACS,CAAC;AAEtC,gBAAgB;AAChB,eAAO,MAAM,4BAA4B,EAAE,CAAC,CAAC,OAAO,CAClD,cAAc,EACd,CAAC,CAAC,UAAU,EACZ,OAAO,CAIP,CAAC;AAEH,wBAAgB,sBAAsB,CACpC,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,cAAc,EAAE,kBAAkB,CAAC,CAMrD;AAED,gBAAgB;AAChB,eAAO,MAAM,6BAA6B,EAAE,CAAC,CAAC,OAAO,CACnD,eAAe,EACf,CAAC,CAAC,UAAU,EACZ,OAAO,CAeP,CAAC;AAEH,wBAAgB,uBAAuB,CACrC,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,eAAe,EAAE,kBAAkB,CAAC,CAMtD"}
@@ -0,0 +1,41 @@
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
+ /**
7
+ * Geometry type discriminator. Always `Polygon`.
8
+ */
9
+ export const SiteLandFeatureType = {
10
+ Polygon: "Polygon",
11
+ };
12
+ /** @internal */
13
+ export const SiteLandFeatureType$inboundSchema = z.nativeEnum(SiteLandFeatureType);
14
+ /** @internal */
15
+ export const GeoJSONPolygon$inboundSchema = z.object({
16
+ coordinates: z.array(z.array(z.array(z.number()))),
17
+ type: SiteLandFeatureType$inboundSchema,
18
+ });
19
+ export function geoJSONPolygonFromJSON(jsonString) {
20
+ return safeParse(jsonString, (x) => GeoJSONPolygon$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'GeoJSONPolygon' from JSON`);
21
+ }
22
+ /** @internal */
23
+ export const SiteLandFeature$inboundSchema = z.object({
24
+ areaOnTitleSqm: z.number(),
25
+ asOf: z.string(),
26
+ cover: z.string(),
27
+ coverGroup: z.string(),
28
+ description: z.string(),
29
+ geometry: z.lazy(() => GeoJSONPolygon$inboundSchema).optional(),
30
+ id: z.string(),
31
+ isObscured: z.boolean(),
32
+ isTidal: z.boolean(),
33
+ landform: z.nullable(z.string()),
34
+ type: z.string(),
35
+ use: z.string(),
36
+ useDetail: z.nullable(z.string()),
37
+ });
38
+ export function siteLandFeatureFromJSON(jsonString) {
39
+ return safeParse(jsonString, (x) => SiteLandFeature$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'SiteLandFeature' from JSON`);
40
+ }
41
+ //# sourceMappingURL=sitelandfeature.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"sitelandfeature.js","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/sitelandfeature.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAC5B,OAAO,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAC;AAKpD;;GAEG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG;IACjC,OAAO,EAAE,SAAS;CACV,CAAC;AA2EX,gBAAgB;AAChB,MAAM,CAAC,MAAM,iCAAiC,GAE1C,CAAC,CAAC,UAAU,CAAC,mBAAmB,CAAC,CAAC;AAEtC,gBAAgB;AAChB,MAAM,CAAC,MAAM,4BAA4B,GAIrC,CAAC,CAAC,MAAM,CAAC;IACX,WAAW,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;IAClD,IAAI,EAAE,iCAAiC;CACxC,CAAC,CAAC;AAEH,MAAM,UAAU,sBAAsB,CACpC,UAAkB;IAElB,OAAO,SAAS,CACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,4BAA4B,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EACxD,4CAA4C,CAC7C,CAAC;AACJ,CAAC;AAED,gBAAgB;AAChB,MAAM,CAAC,MAAM,6BAA6B,GAItC,CAAC,CAAC,MAAM,CAAC;IACX,cAAc,EAAE,CAAC,CAAC,MAAM,EAAE;IAC1B,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;IAChB,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;IACjB,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE;IACtB,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE;IACvB,QAAQ,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,4BAA4B,CAAC,CAAC,QAAQ,EAAE;IAC/D,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE;IACd,UAAU,EAAE,CAAC,CAAC,OAAO,EAAE;IACvB,OAAO,EAAE,CAAC,CAAC,OAAO,EAAE;IACpB,QAAQ,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;IAChC,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;IAChB,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE;IACf,SAAS,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;CAClC,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,46 @@
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 { SiteLandFeature } from "./sitelandfeature.js";
6
+ /**
7
+ * Object type discriminator. Always `list`.
8
+ */
9
+ export declare const SiteLandListResponseObject: {
10
+ readonly List: "list";
11
+ };
12
+ /**
13
+ * Object type discriminator. Always `list`.
14
+ */
15
+ export type SiteLandListResponseObject = ClosedEnum<typeof SiteLandListResponseObject>;
16
+ /**
17
+ * One page of results, with the metadata needed to fetch the rest.
18
+ */
19
+ export type SiteLandListResponse = {
20
+ /**
21
+ * The items on this page.
22
+ */
23
+ data: Array<SiteLandFeature>;
24
+ /**
25
+ * True when further items exist beyond this page.
26
+ */
27
+ hasMore: boolean;
28
+ /**
29
+ * Object type discriminator. Always `list`.
30
+ */
31
+ object: SiteLandListResponseObject;
32
+ /**
33
+ * Total number of items matching the request across all pages.
34
+ */
35
+ totalCount?: number | undefined;
36
+ /**
37
+ * Path this list was requested from.
38
+ */
39
+ url: string;
40
+ };
41
+ /** @internal */
42
+ export declare const SiteLandListResponseObject$inboundSchema: z.ZodNativeEnum<typeof SiteLandListResponseObject>;
43
+ /** @internal */
44
+ export declare const SiteLandListResponse$inboundSchema: z.ZodType<SiteLandListResponse, z.ZodTypeDef, unknown>;
45
+ export declare function siteLandListResponseFromJSON(jsonString: string): SafeParseResult<SiteLandListResponse, SDKValidationError>;
46
+ //# sourceMappingURL=sitelandlistresponse.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"sitelandlistresponse.d.ts","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/sitelandlistresponse.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAG5B,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,EACL,eAAe,EAEhB,MAAM,sBAAsB,CAAC;AAE9B;;GAEG;AACH,eAAO,MAAM,0BAA0B;;CAE7B,CAAC;AACX;;GAEG;AACH,MAAM,MAAM,0BAA0B,GAAG,UAAU,CACjD,OAAO,0BAA0B,CAClC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG;IACjC;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,eAAe,CAAC,CAAC;IAC7B;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IACjB;;OAEG;IACH,MAAM,EAAE,0BAA0B,CAAC;IACnC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAChC;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;CACb,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,wCAAwC,EAAE,CAAC,CAAC,aAAa,CACpE,OAAO,0BAA0B,CACS,CAAC;AAE7C,gBAAgB;AAChB,eAAO,MAAM,kCAAkC,EAAE,CAAC,CAAC,OAAO,CACxD,oBAAoB,EACpB,CAAC,CAAC,UAAU,EACZ,OAAO,CAYP,CAAC;AAEH,wBAAgB,4BAA4B,CAC1C,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,oBAAoB,EAAE,kBAAkB,CAAC,CAM3D"}
@@ -0,0 +1,32 @@
1
+ /*
2
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
+ */
4
+ import * as z from "zod/v3";
5
+ import { remap as remap$ } from "../../../lib/primitives.js";
6
+ import { safeParse } from "../../../lib/schemas.js";
7
+ import { SiteLandFeature$inboundSchema, } from "./sitelandfeature.js";
8
+ /**
9
+ * Object type discriminator. Always `list`.
10
+ */
11
+ export const SiteLandListResponseObject = {
12
+ List: "list",
13
+ };
14
+ /** @internal */
15
+ export const SiteLandListResponseObject$inboundSchema = z.nativeEnum(SiteLandListResponseObject);
16
+ /** @internal */
17
+ export const SiteLandListResponse$inboundSchema = z.object({
18
+ data: z.array(SiteLandFeature$inboundSchema),
19
+ has_more: z.boolean(),
20
+ object: SiteLandListResponseObject$inboundSchema,
21
+ total_count: z.number().optional(),
22
+ url: z.string(),
23
+ }).transform((v) => {
24
+ return remap$(v, {
25
+ "has_more": "hasMore",
26
+ "total_count": "totalCount",
27
+ });
28
+ });
29
+ export function siteLandListResponseFromJSON(jsonString) {
30
+ return safeParse(jsonString, (x) => SiteLandListResponse$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'SiteLandListResponse' from JSON`);
31
+ }
32
+ //# sourceMappingURL=sitelandlistresponse.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"sitelandlistresponse.js","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/sitelandlistresponse.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAC5B,OAAO,EAAE,KAAK,IAAI,MAAM,EAAE,MAAM,4BAA4B,CAAC;AAC7D,OAAO,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAC;AAIpD,OAAO,EAEL,6BAA6B,GAC9B,MAAM,sBAAsB,CAAC;AAE9B;;GAEG;AACH,MAAM,CAAC,MAAM,0BAA0B,GAAG;IACxC,IAAI,EAAE,MAAM;CACJ,CAAC;AAkCX,gBAAgB;AAChB,MAAM,CAAC,MAAM,wCAAwC,GAEjD,CAAC,CAAC,UAAU,CAAC,0BAA0B,CAAC,CAAC;AAE7C,gBAAgB;AAChB,MAAM,CAAC,MAAM,kCAAkC,GAI3C,CAAC,CAAC,MAAM,CAAC;IACX,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,6BAA6B,CAAC;IAC5C,QAAQ,EAAE,CAAC,CAAC,OAAO,EAAE;IACrB,MAAM,EAAE,wCAAwC;IAChD,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAClC,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE;CAChB,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE;IACjB,OAAO,MAAM,CAAC,CAAC,EAAE;QACf,UAAU,EAAE,SAAS;QACrB,aAAa,EAAE,YAAY;KAC5B,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,MAAM,UAAU,4BAA4B,CAC1C,UAAkB;IAElB,OAAO,SAAS,CACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,kCAAkC,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAC9D,kDAAkD,CACnD,CAAC;AACJ,CAAC"}
@@ -4,7 +4,7 @@ import { SiteAreaFilter, SiteAreaFilter$Outbound } from "./siteareafilter.js";
4
4
  import { SiteFilters, SiteFilters$Outbound } from "./sitefilters.js";
5
5
  import { SiteQueryOperator, SiteQueryOperator$Outbound } from "./sitequeryoperator.js";
6
6
  /**
7
- * Fields to return, either as an array of names or as one comma-separated string such as "siteId,tenureType,areaSqm". Defaults to a standard set that leaves out the `boundary` geometry; name `boundary` to get site polygons back.
7
+ * Fields to return, either as an array of names or as one comma-separated string such as "siteId,tenureType,areaSqm". Defaults to a standard set that leaves out the `boundary` geometry and the per-building lists; name `boundary` to get site polygons back, `buildings` for the summary of every building on the title, or `buildingIds` for their identifiers alone.
8
8
  */
9
9
  export type SiteQueryRequestAttributes = string | Array<string>;
10
10
  /**
@@ -120,7 +120,7 @@ export type SiteQueryRequest = {
120
120
  */
121
121
  area?: Array<SiteAreaFilter> | undefined;
122
122
  /**
123
- * Fields to return, either as an array of names or as one comma-separated string such as "siteId,tenureType,areaSqm". Defaults to a standard set that leaves out the `boundary` geometry; name `boundary` to get site polygons back.
123
+ * Fields to return, either as an array of names or as one comma-separated string such as "siteId,tenureType,areaSqm". Defaults to a standard set that leaves out the `boundary` geometry and the per-building lists; name `boundary` to get site polygons back, `buildings` for the summary of every building on the title, or `buildingIds` for their identifiers alone.
124
124
  */
125
125
  attributes?: string | Array<string> | undefined;
126
126
  /**
@@ -9,6 +9,10 @@ export type SiteTags = {
9
9
  * True when the site's land use includes agricultural land.
10
10
  */
11
11
  agricultural?: boolean | undefined;
12
+ /**
13
+ * 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.
14
+ */
15
+ brownfield?: boolean | null | undefined;
12
16
  /**
13
17
  * True when more than one property is linked to this site.
14
18
  */
@@ -1 +1 @@
1
- {"version":3,"file":"sitetags.d.ts","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/sitetags.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;;GAEG;AACH,MAAM,MAAM,QAAQ,GAAG;IACrB;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IACnC;;OAEG;IACH,kBAAkB,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IACzC;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IACnC;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;CAC9B,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,sBAAsB,EAAE,CAAC,CAAC,OAAO,CAC5C,QAAQ,EACR,CAAC,CAAC,UAAU,EACZ,OAAO,CAMP,CAAC;AAEH,wBAAgB,gBAAgB,CAC9B,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,QAAQ,EAAE,kBAAkB,CAAC,CAM/C"}
1
+ {"version":3,"file":"sitetags.d.ts","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/sitetags.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;;GAEG;AACH,MAAM,MAAM,QAAQ,GAAG;IACrB;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IACnC;;OAEG;IACH,UAAU,CAAC,EAAE,OAAO,GAAG,IAAI,GAAG,SAAS,CAAC;IACxC;;OAEG;IACH,kBAAkB,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IACzC;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IACnC;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;CAC9B,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,sBAAsB,EAAE,CAAC,CAAC,OAAO,CAC5C,QAAQ,EACR,CAAC,CAAC,UAAU,EACZ,OAAO,CAOP,CAAC;AAEH,wBAAgB,gBAAgB,CAC9B,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,QAAQ,EAAE,kBAAkB,CAAC,CAM/C"}
@@ -6,6 +6,7 @@ import { safeParse } from "../../../lib/schemas.js";
6
6
  /** @internal */
7
7
  export const SiteTags$inboundSchema = z.object({
8
8
  agricultural: z.boolean().optional(),
9
+ brownfield: z.nullable(z.boolean()).optional(),
9
10
  multipleProperties: z.boolean().optional(),
10
11
  noProperties: z.boolean().optional(),
11
12
  vacant: z.boolean().optional(),
@@ -1 +1 @@
1
- {"version":3,"file":"sitetags.js","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/sitetags.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAC5B,OAAO,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAC;AA0BpD,gBAAgB;AAChB,MAAM,CAAC,MAAM,sBAAsB,GAI/B,CAAC,CAAC,MAAM,CAAC;IACX,YAAY,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IACpC,kBAAkB,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IAC1C,YAAY,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IACpC,MAAM,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;CAC/B,CAAC,CAAC;AAEH,MAAM,UAAU,gBAAgB,CAC9B,UAAkB;IAElB,OAAO,SAAS,CACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,sBAAsB,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAClD,sCAAsC,CACvC,CAAC;AACJ,CAAC"}
1
+ {"version":3,"file":"sitetags.js","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/sitetags.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAC5B,OAAO,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAC;AA8BpD,gBAAgB;AAChB,MAAM,CAAC,MAAM,sBAAsB,GAI/B,CAAC,CAAC,MAAM,CAAC;IACX,YAAY,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IACpC,UAAU,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC,QAAQ,EAAE;IAC9C,kBAAkB,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IAC1C,YAAY,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IACpC,MAAM,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;CAC/B,CAAC,CAAC;AAEH,MAAM,UAAU,gBAAgB,CAC9B,UAAkB;IAElB,OAAO,SAAS,CACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,sBAAsB,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAClD,sCAAsC,CACvC,CAAC;AACJ,CAAC"}
@@ -34,9 +34,16 @@ export declare class Sites extends ClientSDK {
34
34
  * Get site by ID
35
35
  *
36
36
  * @remarks
37
- * Retrieve one registered title by its identifier, which joins the country, the registry and the title number with colons, as in `GB:LR:AGL123456`. This endpoint returns every attribute, including the boundary geometry, ownership, property statistics, planning statistics and area metrics.
37
+ * Retrieve one registered title by its identifier, which joins the country, the registry and the title number with colons, as in `GB:LR:AGL123456`. This endpoint returns every attribute, including the boundary geometry, ownership, property statistics, planning statistics and area metrics, except the per-building lists: pass `attributes=buildings` to add the summary of every building on the title, or `attributes=buildingIds` for their identifiers alone.
38
38
  */
39
39
  get(request: operations.GetSiteByIdRequest, options?: RequestOptions): Promise<shared.Site>;
40
+ /**
41
+ * Get land polygons in site
42
+ *
43
+ * @remarks
44
+ * List the Ordnance Survey land polygons that cover part of one registered title, each with its land cover, land use, landform and the area of it that lies within the title. This is the per-polygon detail behind the site's `landProfile`, measured on the title boundary in the same way, read from the current Ordnance Survey release rather than from the stored profile. Polygons come back in order of identifier, so `limit` and `offset` page through them. Each polygon appears on exactly one page while the Ordnance Survey release stays the same; a new release published between two page requests can move a polygon across a page boundary. The polygon boundary is left out by default because of its size; pass `attributes=geometry` to get it. Requires the `osNgdAccess` permission on the licence.
45
+ */
46
+ getLand(request: operations.GetSiteLandRequest, options?: RequestOptions): Promise<shared.SiteLandListResponse>;
40
47
  /**
41
48
  * Get properties in site
42
49
  *
@@ -55,7 +62,7 @@ export declare class Sites extends ClientSDK {
55
62
  * Search sites
56
63
  *
57
64
  * @remarks
58
- * Search registered titles by their attributes, by geographic area, or by both, with sorting and pagination. Area filters accept a polygon, a multi-polygon, a point with a radius, a point the boundary must enclose, or a bounding box; a site matches the area clause if it satisfies any one of the filters supplied, and that has to hold on top of `filters` and `query`. The `boundary` geometry is left out by default because of its size, so pass `attributes: ["boundary"]` to get site polygons back. Up to 1000 sites come back per request, from an offset of at most 100000.
65
+ * Search registered titles by their attributes, by geographic area, or by both, with sorting and pagination. Area filters accept a polygon, a multi-polygon, a point with a radius, a point the boundary must enclose, or a bounding box; a site matches the area clause if it satisfies any one of the filters supplied, and that has to hold on top of `filters` and `query`. The `boundary` geometry is left out by default because of its size, so pass `attributes: ["boundary"]` to get site polygons back; likewise pass `attributes: ["buildings"]` for the summary of every building on each title. Up to 1000 sites come back per request, from an offset of at most 100000.
59
66
  */
60
67
  search(request?: shared.SiteQueryRequest | undefined, options?: RequestOptions): Promise<shared.SiteListResponse>;
61
68
  }
@@ -1 +1 @@
1
- {"version":3,"file":"sites.d.ts","sourceRoot":"","sources":["../../../src/sdk/sites.ts"],"names":[],"mappings":"AAYA,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAC3D,OAAO,KAAK,UAAU,MAAM,8BAA8B,CAAC;AAC3D,OAAO,KAAK,MAAM,MAAM,0BAA0B,CAAC;AAGnD,qBAAa,KAAM,SAAQ,SAAS;IAClC;;;;;OAKG;IACG,SAAS,CACb,OAAO,CAAC,EAAE,MAAM,CAAC,oBAAoB,GAAG,SAAS,EACjD,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,MAAM,CAAC,qBAAqB,CAAC;IAQxC;;;;;OAKG;IACG,SAAS,CACb,OAAO,CAAC,EAAE,MAAM,CAAC,mBAAmB,GAAG,SAAS,EAChD,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,MAAM,CAAC,gBAAgB,CAAC;IAQnC;;;;;OAKG;IACG,WAAW,CACf,OAAO,CAAC,EAAE,UAAU,CAAC,uBAAuB,GAAG,SAAS,EACxD,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,MAAM,CAAC,gBAAgB,CAAC;IAQnC;;;;;OAKG;IACG,cAAc,CAClB,OAAO,EAAE,UAAU,CAAC,0BAA0B,EAC9C,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,MAAM,CAAC,gBAAgB,CAAC;IAQnC;;;;;OAKG;IACG,GAAG,CACP,OAAO,EAAE,UAAU,CAAC,kBAAkB,EACtC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC;IAQvB;;;;;OAKG;IACG,aAAa,CACjB,OAAO,EAAE,UAAU,CAAC,0BAA0B,EAC9C,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,MAAM,CAAC,sBAAsB,CAAC;IAQzC;;;;;OAKG;IACG,QAAQ,CACZ,OAAO,EAAE,UAAU,CAAC,mBAAmB,EACvC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC;IAQtB;;;;;OAKG;IACG,MAAM,CACV,OAAO,CAAC,EAAE,MAAM,CAAC,gBAAgB,GAAG,SAAS,EAC7C,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,MAAM,CAAC,gBAAgB,CAAC;CAOpC"}
1
+ {"version":3,"file":"sites.d.ts","sourceRoot":"","sources":["../../../src/sdk/sites.ts"],"names":[],"mappings":"AAaA,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAC3D,OAAO,KAAK,UAAU,MAAM,8BAA8B,CAAC;AAC3D,OAAO,KAAK,MAAM,MAAM,0BAA0B,CAAC;AAGnD,qBAAa,KAAM,SAAQ,SAAS;IAClC;;;;;OAKG;IACG,SAAS,CACb,OAAO,CAAC,EAAE,MAAM,CAAC,oBAAoB,GAAG,SAAS,EACjD,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,MAAM,CAAC,qBAAqB,CAAC;IAQxC;;;;;OAKG;IACG,SAAS,CACb,OAAO,CAAC,EAAE,MAAM,CAAC,mBAAmB,GAAG,SAAS,EAChD,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,MAAM,CAAC,gBAAgB,CAAC;IAQnC;;;;;OAKG;IACG,WAAW,CACf,OAAO,CAAC,EAAE,UAAU,CAAC,uBAAuB,GAAG,SAAS,EACxD,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,MAAM,CAAC,gBAAgB,CAAC;IAQnC;;;;;OAKG;IACG,cAAc,CAClB,OAAO,EAAE,UAAU,CAAC,0BAA0B,EAC9C,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,MAAM,CAAC,gBAAgB,CAAC;IAQnC;;;;;OAKG;IACG,GAAG,CACP,OAAO,EAAE,UAAU,CAAC,kBAAkB,EACtC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC;IAQvB;;;;;OAKG;IACG,OAAO,CACX,OAAO,EAAE,UAAU,CAAC,kBAAkB,EACtC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,MAAM,CAAC,oBAAoB,CAAC;IAQvC;;;;;OAKG;IACG,aAAa,CACjB,OAAO,EAAE,UAAU,CAAC,0BAA0B,EAC9C,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,MAAM,CAAC,sBAAsB,CAAC;IAQzC;;;;;OAKG;IACG,QAAQ,CACZ,OAAO,EAAE,UAAU,CAAC,mBAAmB,EACvC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC;IAQtB;;;;;OAKG;IACG,MAAM,CACV,OAAO,CAAC,EAAE,MAAM,CAAC,gBAAgB,GAAG,SAAS,EAC7C,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,MAAM,CAAC,gBAAgB,CAAC;CAOpC"}
@@ -6,6 +6,7 @@ import { sitesFindByIds } from "../funcs/sitesFindByIds.js";
6
6
  import { sitesFindByPoint } from "../funcs/sitesFindByPoint.js";
7
7
  import { sitesFindByProperty } from "../funcs/sitesFindByProperty.js";
8
8
  import { sitesGet } from "../funcs/sitesGet.js";
9
+ import { sitesGetLand } from "../funcs/sitesGetLand.js";
9
10
  import { sitesGetProperties } from "../funcs/sitesGetProperties.js";
10
11
  import { sitesGetTiles } from "../funcs/sitesGetTiles.js";
11
12
  import { sitesSearch } from "../funcs/sitesSearch.js";
@@ -52,11 +53,20 @@ export class Sites extends ClientSDK {
52
53
  * Get site by ID
53
54
  *
54
55
  * @remarks
55
- * Retrieve one registered title by its identifier, which joins the country, the registry and the title number with colons, as in `GB:LR:AGL123456`. This endpoint returns every attribute, including the boundary geometry, ownership, property statistics, planning statistics and area metrics.
56
+ * Retrieve one registered title by its identifier, which joins the country, the registry and the title number with colons, as in `GB:LR:AGL123456`. This endpoint returns every attribute, including the boundary geometry, ownership, property statistics, planning statistics and area metrics, except the per-building lists: pass `attributes=buildings` to add the summary of every building on the title, or `attributes=buildingIds` for their identifiers alone.
56
57
  */
57
58
  async get(request, options) {
58
59
  return unwrapAsync(sitesGet(this, request, options));
59
60
  }
61
+ /**
62
+ * Get land polygons in site
63
+ *
64
+ * @remarks
65
+ * List the Ordnance Survey land polygons that cover part of one registered title, each with its land cover, land use, landform and the area of it that lies within the title. This is the per-polygon detail behind the site's `landProfile`, measured on the title boundary in the same way, read from the current Ordnance Survey release rather than from the stored profile. Polygons come back in order of identifier, so `limit` and `offset` page through them. Each polygon appears on exactly one page while the Ordnance Survey release stays the same; a new release published between two page requests can move a polygon across a page boundary. The polygon boundary is left out by default because of its size; pass `attributes=geometry` to get it. Requires the `osNgdAccess` permission on the licence.
66
+ */
67
+ async getLand(request, options) {
68
+ return unwrapAsync(sitesGetLand(this, request, options));
69
+ }
60
70
  /**
61
71
  * Get properties in site
62
72
  *
@@ -79,7 +89,7 @@ export class Sites extends ClientSDK {
79
89
  * Search sites
80
90
  *
81
91
  * @remarks
82
- * Search registered titles by their attributes, by geographic area, or by both, with sorting and pagination. Area filters accept a polygon, a multi-polygon, a point with a radius, a point the boundary must enclose, or a bounding box; a site matches the area clause if it satisfies any one of the filters supplied, and that has to hold on top of `filters` and `query`. The `boundary` geometry is left out by default because of its size, so pass `attributes: ["boundary"]` to get site polygons back. Up to 1000 sites come back per request, from an offset of at most 100000.
92
+ * Search registered titles by their attributes, by geographic area, or by both, with sorting and pagination. Area filters accept a polygon, a multi-polygon, a point with a radius, a point the boundary must enclose, or a bounding box; a site matches the area clause if it satisfies any one of the filters supplied, and that has to hold on top of `filters` and `query`. The `boundary` geometry is left out by default because of its size, so pass `attributes: ["boundary"]` to get site polygons back; likewise pass `attributes: ["buildings"]` for the summary of every building on each title. Up to 1000 sites come back per request, from an offset of at most 100000.
83
93
  */
84
94
  async search(request, options) {
85
95
  return unwrapAsync(sitesSearch(this, request, options));
@@ -1 +1 @@
1
- {"version":3,"file":"sites.js","sourceRoot":"","sources":["../../../src/sdk/sites.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAC;AAC5D,OAAO,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAC;AAC5D,OAAO,EAAE,gBAAgB,EAAE,MAAM,8BAA8B,CAAC;AAChE,OAAO,EAAE,mBAAmB,EAAE,MAAM,iCAAiC,CAAC;AACtE,OAAO,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAChD,OAAO,EAAE,kBAAkB,EAAE,MAAM,gCAAgC,CAAC;AACpE,OAAO,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAC;AAC1D,OAAO,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC;AACtD,OAAO,EAAE,SAAS,EAAkB,MAAM,gBAAgB,CAAC;AAG3D,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAE5C,MAAM,OAAO,KAAM,SAAQ,SAAS;IAClC;;;;;OAKG;IACH,KAAK,CAAC,SAAS,CACb,OAAiD,EACjD,OAAwB;QAExB,OAAO,WAAW,CAAC,cAAc,CAC/B,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,SAAS,CACb,OAAgD,EAChD,OAAwB;QAExB,OAAO,WAAW,CAAC,cAAc,CAC/B,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,WAAW,CACf,OAAwD,EACxD,OAAwB;QAExB,OAAO,WAAW,CAAC,gBAAgB,CACjC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,cAAc,CAClB,OAA8C,EAC9C,OAAwB;QAExB,OAAO,WAAW,CAAC,mBAAmB,CACpC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,GAAG,CACP,OAAsC,EACtC,OAAwB;QAExB,OAAO,WAAW,CAAC,QAAQ,CACzB,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,aAAa,CACjB,OAA8C,EAC9C,OAAwB;QAExB,OAAO,WAAW,CAAC,kBAAkB,CACnC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,QAAQ,CACZ,OAAuC,EACvC,OAAwB;QAExB,OAAO,WAAW,CAAC,aAAa,CAC9B,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,MAAM,CACV,OAA6C,EAC7C,OAAwB;QAExB,OAAO,WAAW,CAAC,WAAW,CAC5B,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;CACF"}
1
+ {"version":3,"file":"sites.js","sourceRoot":"","sources":["../../../src/sdk/sites.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAC;AAC5D,OAAO,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAC;AAC5D,OAAO,EAAE,gBAAgB,EAAE,MAAM,8BAA8B,CAAC;AAChE,OAAO,EAAE,mBAAmB,EAAE,MAAM,iCAAiC,CAAC;AACtE,OAAO,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAChD,OAAO,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAC;AACxD,OAAO,EAAE,kBAAkB,EAAE,MAAM,gCAAgC,CAAC;AACpE,OAAO,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAC;AAC1D,OAAO,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC;AACtD,OAAO,EAAE,SAAS,EAAkB,MAAM,gBAAgB,CAAC;AAG3D,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAE5C,MAAM,OAAO,KAAM,SAAQ,SAAS;IAClC;;;;;OAKG;IACH,KAAK,CAAC,SAAS,CACb,OAAiD,EACjD,OAAwB;QAExB,OAAO,WAAW,CAAC,cAAc,CAC/B,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,SAAS,CACb,OAAgD,EAChD,OAAwB;QAExB,OAAO,WAAW,CAAC,cAAc,CAC/B,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,WAAW,CACf,OAAwD,EACxD,OAAwB;QAExB,OAAO,WAAW,CAAC,gBAAgB,CACjC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,cAAc,CAClB,OAA8C,EAC9C,OAAwB;QAExB,OAAO,WAAW,CAAC,mBAAmB,CACpC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,GAAG,CACP,OAAsC,EACtC,OAAwB;QAExB,OAAO,WAAW,CAAC,QAAQ,CACzB,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,OAAO,CACX,OAAsC,EACtC,OAAwB;QAExB,OAAO,WAAW,CAAC,YAAY,CAC7B,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,aAAa,CACjB,OAA8C,EAC9C,OAAwB;QAExB,OAAO,WAAW,CAAC,kBAAkB,CACnC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,QAAQ,CACZ,OAAuC,EACvC,OAAwB;QAExB,OAAO,WAAW,CAAC,aAAa,CAC9B,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,MAAM,CACV,OAA6C,EAC7C,OAAwB;QAExB,OAAO,WAAW,CAAC,WAAW,CAC5B,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;CACF"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@vepler/sdk",
3
- "version": "6.52.0",
3
+ "version": "6.57.1",
4
4
  "author": "Vepler Limited",
5
5
  "type": "module",
6
6
  "tshy": {
@@ -3,7 +3,7 @@
3
3
  */
4
4
 
5
5
  import { SDKCore } from "../core.js";
6
- import { encodeSimple } from "../lib/encodings.js";
6
+ import { encodeFormQuery, encodeSimple } from "../lib/encodings.js";
7
7
  import { matchStatusCode } from "../lib/http.js";
8
8
  import * as M from "../lib/matchers.js";
9
9
  import { compactMap } from "../lib/primitives.js";
@@ -31,7 +31,7 @@ import { Result } from "../sdk/types/fp.js";
31
31
  * Get site by ID
32
32
  *
33
33
  * @remarks
34
- * Retrieve one registered title by its identifier, which joins the country, the registry and the title number with colons, as in `GB:LR:AGL123456`. This endpoint returns every attribute, including the boundary geometry, ownership, property statistics, planning statistics and area metrics.
34
+ * Retrieve one registered title by its identifier, which joins the country, the registry and the title number with colons, as in `GB:LR:AGL123456`. This endpoint returns every attribute, including the boundary geometry, ownership, property statistics, planning statistics and area metrics, except the per-building lists: pass `attributes=buildings` to add the summary of every building on the title, or `attributes=buildingIds` for their identifiers alone.
35
35
  */
36
36
  export function sitesGet(
37
37
  client: SDKCore,
@@ -106,6 +106,10 @@ async function $do(
106
106
  };
107
107
  const path = pathToFunc("/v1/sites/{siteId}")(pathParams);
108
108
 
109
+ const query = encodeFormQuery({
110
+ "attributes": payload.attributes,
111
+ });
112
+
109
113
  const headers = new Headers(compactMap({
110
114
  Accept: "application/json",
111
115
  }));
@@ -135,6 +139,7 @@ async function $do(
135
139
  baseURL: options?.serverURL,
136
140
  path: path,
137
141
  headers: headers,
142
+ query: query,
138
143
  body: body,
139
144
  userAgent: client._options.userAgent,
140
145
  timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
@@ -0,0 +1,213 @@
1
+ /*
2
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
+ */
4
+
5
+ import { SDKCore } from "../core.js";
6
+ import { encodeFormQuery, encodeSimple } from "../lib/encodings.js";
7
+ import { matchStatusCode } from "../lib/http.js";
8
+ import * as M from "../lib/matchers.js";
9
+ import { compactMap } from "../lib/primitives.js";
10
+ import { safeParse } from "../lib/schemas.js";
11
+ import { RequestOptions } from "../lib/sdks.js";
12
+ import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
13
+ import { pathToFunc } from "../lib/url.js";
14
+ import {
15
+ ConnectionError,
16
+ InvalidRequestError,
17
+ RequestAbortedError,
18
+ RequestTimeoutError,
19
+ UnexpectedClientError,
20
+ } from "../sdk/models/errors/httpclienterrors.js";
21
+ import * as errors from "../sdk/models/errors/index.js";
22
+ import { ResponseValidationError } from "../sdk/models/errors/responsevalidationerror.js";
23
+ import { SDKBaseError } from "../sdk/models/errors/sdkbaseerror.js";
24
+ import { SDKValidationError } from "../sdk/models/errors/sdkvalidationerror.js";
25
+ import * as operations from "../sdk/models/operations/index.js";
26
+ import * as shared from "../sdk/models/shared/index.js";
27
+ import { APICall, APIPromise } from "../sdk/types/async.js";
28
+ import { Result } from "../sdk/types/fp.js";
29
+
30
+ /**
31
+ * Get land polygons in site
32
+ *
33
+ * @remarks
34
+ * List the Ordnance Survey land polygons that cover part of one registered title, each with its land cover, land use, landform and the area of it that lies within the title. This is the per-polygon detail behind the site's `landProfile`, measured on the title boundary in the same way, read from the current Ordnance Survey release rather than from the stored profile. Polygons come back in order of identifier, so `limit` and `offset` page through them. Each polygon appears on exactly one page while the Ordnance Survey release stays the same; a new release published between two page requests can move a polygon across a page boundary. The polygon boundary is left out by default because of its size; pass `attributes=geometry` to get it. Requires the `osNgdAccess` permission on the licence.
35
+ */
36
+ export function sitesGetLand(
37
+ client: SDKCore,
38
+ request: operations.GetSiteLandRequest,
39
+ options?: RequestOptions,
40
+ ): APIPromise<
41
+ Result<
42
+ shared.SiteLandListResponse,
43
+ | errors.GetSiteLandResponseBody
44
+ | errors.GetSiteLandSitesResponseBody
45
+ | errors.GetSiteLandSitesResponseResponseBody
46
+ | errors.GetSiteLandSitesResponse404ResponseBody
47
+ | errors.GetSiteLandSitesResponse429ResponseBody
48
+ | errors.GetSiteLandSitesResponse500ResponseBody
49
+ | SDKBaseError
50
+ | ResponseValidationError
51
+ | ConnectionError
52
+ | RequestAbortedError
53
+ | RequestTimeoutError
54
+ | InvalidRequestError
55
+ | UnexpectedClientError
56
+ | SDKValidationError
57
+ >
58
+ > {
59
+ return new APIPromise($do(
60
+ client,
61
+ request,
62
+ options,
63
+ ));
64
+ }
65
+
66
+ async function $do(
67
+ client: SDKCore,
68
+ request: operations.GetSiteLandRequest,
69
+ options?: RequestOptions,
70
+ ): Promise<
71
+ [
72
+ Result<
73
+ shared.SiteLandListResponse,
74
+ | errors.GetSiteLandResponseBody
75
+ | errors.GetSiteLandSitesResponseBody
76
+ | errors.GetSiteLandSitesResponseResponseBody
77
+ | errors.GetSiteLandSitesResponse404ResponseBody
78
+ | errors.GetSiteLandSitesResponse429ResponseBody
79
+ | errors.GetSiteLandSitesResponse500ResponseBody
80
+ | SDKBaseError
81
+ | ResponseValidationError
82
+ | ConnectionError
83
+ | RequestAbortedError
84
+ | RequestTimeoutError
85
+ | InvalidRequestError
86
+ | UnexpectedClientError
87
+ | SDKValidationError
88
+ >,
89
+ APICall,
90
+ ]
91
+ > {
92
+ const parsed = safeParse(
93
+ request,
94
+ (value) => operations.GetSiteLandRequest$outboundSchema.parse(value),
95
+ "Input validation failed",
96
+ );
97
+ if (!parsed.ok) {
98
+ return [parsed, { status: "invalid" }];
99
+ }
100
+ const payload = parsed.value;
101
+ const body = null;
102
+
103
+ const pathParams = {
104
+ siteId: encodeSimple("siteId", payload.siteId, {
105
+ explode: false,
106
+ charEncoding: "percent",
107
+ }),
108
+ };
109
+ const path = pathToFunc("/v1/sites/land/{siteId}")(pathParams);
110
+
111
+ const query = encodeFormQuery({
112
+ "attributes": payload.attributes,
113
+ "limit": payload.limit,
114
+ "offset": payload.offset,
115
+ });
116
+
117
+ const headers = new Headers(compactMap({
118
+ Accept: "application/json",
119
+ }));
120
+
121
+ const secConfig = await extractSecurity(client._options.apiKeyAuth);
122
+ const securityInput = secConfig == null ? {} : { apiKeyAuth: secConfig };
123
+ const requestSecurity = resolveGlobalSecurity(securityInput);
124
+
125
+ const context = {
126
+ options: client._options,
127
+ baseURL: options?.serverURL ?? client._baseURL ?? "",
128
+ operationID: "getSiteLand",
129
+ oAuth2Scopes: null,
130
+
131
+ resolvedSecurity: requestSecurity,
132
+
133
+ securitySource: client._options.apiKeyAuth,
134
+ retryConfig: options?.retries
135
+ || client._options.retryConfig
136
+ || { strategy: "none" },
137
+ retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
138
+ };
139
+
140
+ const requestRes = client._createRequest(context, {
141
+ security: requestSecurity,
142
+ method: "GET",
143
+ baseURL: options?.serverURL,
144
+ path: path,
145
+ headers: headers,
146
+ query: query,
147
+ body: body,
148
+ userAgent: client._options.userAgent,
149
+ timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
150
+ }, options);
151
+ if (!requestRes.ok) {
152
+ return [requestRes, { status: "invalid" }];
153
+ }
154
+ const req = requestRes.value;
155
+
156
+ const doResult = await client._do(req, {
157
+ context,
158
+ isErrorStatusCode: (statusCode: number) =>
159
+ matchStatusCode({ status: statusCode } as Response, ["4XX", "5XX"]),
160
+ retryConfig: context.retryConfig,
161
+ retryCodes: context.retryCodes,
162
+ });
163
+ if (!doResult.ok) {
164
+ return [doResult, { status: "request-error", request: req }];
165
+ }
166
+ const response = doResult.value;
167
+
168
+ const responseFields = {
169
+ HttpMeta: { Response: response, Request: req },
170
+ };
171
+
172
+ const [result] = await M.match<
173
+ shared.SiteLandListResponse,
174
+ | errors.GetSiteLandResponseBody
175
+ | errors.GetSiteLandSitesResponseBody
176
+ | errors.GetSiteLandSitesResponseResponseBody
177
+ | errors.GetSiteLandSitesResponse404ResponseBody
178
+ | errors.GetSiteLandSitesResponse429ResponseBody
179
+ | errors.GetSiteLandSitesResponse500ResponseBody
180
+ | SDKBaseError
181
+ | ResponseValidationError
182
+ | ConnectionError
183
+ | RequestAbortedError
184
+ | RequestTimeoutError
185
+ | InvalidRequestError
186
+ | UnexpectedClientError
187
+ | SDKValidationError
188
+ >(
189
+ M.json(200, shared.SiteLandListResponse$inboundSchema),
190
+ M.jsonErr(400, errors.GetSiteLandResponseBody$inboundSchema),
191
+ M.jsonErr(401, errors.GetSiteLandSitesResponseBody$inboundSchema),
192
+ M.jsonErr(403, errors.GetSiteLandSitesResponseResponseBody$inboundSchema),
193
+ M.jsonErr(
194
+ 404,
195
+ errors.GetSiteLandSitesResponse404ResponseBody$inboundSchema,
196
+ ),
197
+ M.jsonErr(
198
+ 429,
199
+ errors.GetSiteLandSitesResponse429ResponseBody$inboundSchema,
200
+ ),
201
+ M.jsonErr(
202
+ 500,
203
+ errors.GetSiteLandSitesResponse500ResponseBody$inboundSchema,
204
+ ),
205
+ M.fail("4XX"),
206
+ M.fail("5XX"),
207
+ )(response, req, { extraFields: responseFields });
208
+ if (!result.ok) {
209
+ return [result, { status: "complete", request: req, response }];
210
+ }
211
+
212
+ return [result, { status: "complete", request: req, response }];
213
+ }