@vepler/sdk 6.50.12 → 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.
- package/README.md +424 -416
- package/dist/commonjs/funcs/sitesGet.d.ts +1 -1
- package/dist/commonjs/funcs/sitesGet.js +5 -1
- package/dist/commonjs/funcs/sitesGet.js.map +1 -1
- package/dist/commonjs/funcs/sitesGetLand.d.ts +19 -0
- package/dist/commonjs/funcs/sitesGetLand.d.ts.map +1 -0
- package/dist/commonjs/funcs/sitesGetLand.js +131 -0
- package/dist/commonjs/funcs/sitesGetLand.js.map +1 -0
- package/dist/commonjs/funcs/sitesSearch.d.ts +1 -1
- package/dist/commonjs/funcs/sitesSearch.js +1 -1
- package/dist/commonjs/lib/config.d.ts +3 -3
- package/dist/commonjs/lib/config.js +3 -3
- package/dist/commonjs/lib/config.js.map +1 -1
- package/dist/commonjs/sdk/models/errors/getsiteland.d.ts +396 -0
- package/dist/commonjs/sdk/models/errors/getsiteland.d.ts.map +1 -0
- package/dist/commonjs/sdk/models/errors/getsiteland.js +381 -0
- package/dist/commonjs/sdk/models/errors/getsiteland.js.map +1 -0
- package/dist/commonjs/sdk/models/errors/index.d.ts +1 -0
- package/dist/commonjs/sdk/models/errors/index.d.ts.map +1 -1
- package/dist/commonjs/sdk/models/errors/index.js +1 -0
- package/dist/commonjs/sdk/models/errors/index.js.map +1 -1
- package/dist/commonjs/sdk/models/operations/getsitebyid.d.ts +5 -0
- package/dist/commonjs/sdk/models/operations/getsitebyid.d.ts.map +1 -1
- package/dist/commonjs/sdk/models/operations/getsitebyid.js +1 -0
- package/dist/commonjs/sdk/models/operations/getsitebyid.js.map +1 -1
- package/dist/commonjs/sdk/models/operations/getsiteland.d.ts +30 -0
- package/dist/commonjs/sdk/models/operations/getsiteland.d.ts.map +1 -0
- package/dist/commonjs/sdk/models/operations/getsiteland.js +52 -0
- package/dist/commonjs/sdk/models/operations/getsiteland.js.map +1 -0
- package/dist/commonjs/sdk/models/operations/index.d.ts +1 -0
- package/dist/commonjs/sdk/models/operations/index.d.ts.map +1 -1
- package/dist/commonjs/sdk/models/operations/index.js +1 -0
- package/dist/commonjs/sdk/models/operations/index.js.map +1 -1
- package/dist/commonjs/sdk/models/shared/building.d.ts +5 -5
- package/dist/commonjs/sdk/models/shared/building.d.ts.map +1 -1
- package/dist/commonjs/sdk/models/shared/building.js +7 -7
- package/dist/commonjs/sdk/models/shared/building.js.map +1 -1
- package/dist/commonjs/sdk/models/shared/index.d.ts +11 -0
- package/dist/commonjs/sdk/models/shared/index.d.ts.map +1 -1
- package/dist/commonjs/sdk/models/shared/index.js +11 -0
- package/dist/commonjs/sdk/models/shared/index.js.map +1 -1
- package/dist/commonjs/sdk/models/shared/site.d.ts +68 -14
- package/dist/commonjs/sdk/models/shared/site.d.ts.map +1 -1
- package/dist/commonjs/sdk/models/shared/site.js +29 -6
- package/dist/commonjs/sdk/models/shared/site.js.map +1 -1
- package/dist/commonjs/sdk/models/shared/sitebuilding.d.ts +176 -0
- package/dist/commonjs/sdk/models/shared/sitebuilding.d.ts.map +1 -0
- package/dist/commonjs/sdk/models/shared/sitebuilding.js +141 -0
- package/dist/commonjs/sdk/models/shared/sitebuilding.js.map +1 -0
- package/dist/commonjs/sdk/models/shared/sitebuildingcount.d.ts +17 -0
- package/dist/commonjs/sdk/models/shared/sitebuildingcount.d.ts.map +1 -0
- package/dist/commonjs/sdk/models/shared/sitebuildingcount.js +51 -0
- package/dist/commonjs/sdk/models/shared/sitebuildingcount.js.map +1 -0
- package/dist/commonjs/sdk/models/shared/sitebuildingprofile.d.ts +94 -0
- package/dist/commonjs/sdk/models/shared/sitebuildingprofile.d.ts.map +1 -0
- package/dist/commonjs/sdk/models/shared/sitebuildingprofile.js +75 -0
- package/dist/commonjs/sdk/models/shared/sitebuildingprofile.js.map +1 -0
- package/dist/commonjs/sdk/models/shared/siteconstraintflags.d.ts +32 -0
- package/dist/commonjs/sdk/models/shared/siteconstraintflags.d.ts.map +1 -0
- package/dist/commonjs/sdk/models/shared/siteconstraintflags.js +54 -0
- package/dist/commonjs/sdk/models/shared/siteconstraintflags.js.map +1 -0
- package/dist/commonjs/sdk/models/shared/siteconstraintlayer.d.ts +45 -0
- package/dist/commonjs/sdk/models/shared/siteconstraintlayer.d.ts.map +1 -0
- package/dist/commonjs/sdk/models/shared/siteconstraintlayer.js +58 -0
- package/dist/commonjs/sdk/models/shared/siteconstraintlayer.js.map +1 -0
- package/dist/commonjs/sdk/models/shared/siteconstraints.d.ts +31 -0
- package/dist/commonjs/sdk/models/shared/siteconstraints.d.ts.map +1 -0
- package/dist/commonjs/sdk/models/shared/siteconstraints.js +56 -0
- package/dist/commonjs/sdk/models/shared/siteconstraints.js.map +1 -0
- package/dist/commonjs/sdk/models/shared/siteconstraintunmeasured.d.ts +49 -0
- package/dist/commonjs/sdk/models/shared/siteconstraintunmeasured.d.ts.map +1 -0
- package/dist/commonjs/sdk/models/shared/siteconstraintunmeasured.js +75 -0
- package/dist/commonjs/sdk/models/shared/siteconstraintunmeasured.js.map +1 -0
- package/dist/commonjs/sdk/models/shared/sitelandfeature.d.ts +90 -0
- package/dist/commonjs/sdk/models/shared/sitelandfeature.d.ts.map +1 -0
- package/dist/commonjs/sdk/models/shared/sitelandfeature.js +79 -0
- package/dist/commonjs/sdk/models/shared/sitelandfeature.js.map +1 -0
- package/dist/commonjs/sdk/models/shared/sitelandlistresponse.d.ts +46 -0
- package/dist/commonjs/sdk/models/shared/sitelandlistresponse.d.ts.map +1 -0
- package/dist/commonjs/sdk/models/shared/sitelandlistresponse.js +69 -0
- package/dist/commonjs/sdk/models/shared/sitelandlistresponse.js.map +1 -0
- package/dist/commonjs/sdk/models/shared/sitelandprofile.d.ts +74 -0
- package/dist/commonjs/sdk/models/shared/sitelandprofile.d.ts.map +1 -0
- package/dist/commonjs/sdk/models/shared/sitelandprofile.js +70 -0
- package/dist/commonjs/sdk/models/shared/sitelandprofile.js.map +1 -0
- package/dist/commonjs/sdk/models/shared/sitelandshare.d.ts +25 -0
- package/dist/commonjs/sdk/models/shared/sitelandshare.d.ts.map +1 -0
- package/dist/commonjs/sdk/models/shared/sitelandshare.js +53 -0
- package/dist/commonjs/sdk/models/shared/sitelandshare.js.map +1 -0
- package/dist/commonjs/sdk/models/shared/sitequeryrequest.d.ts +2 -2
- package/dist/commonjs/sdk/models/shared/sitetags.d.ts +4 -0
- package/dist/commonjs/sdk/models/shared/sitetags.d.ts.map +1 -1
- package/dist/commonjs/sdk/models/shared/sitetags.js +1 -0
- package/dist/commonjs/sdk/models/shared/sitetags.js.map +1 -1
- package/dist/commonjs/sdk/sites.d.ts +9 -2
- package/dist/commonjs/sdk/sites.d.ts.map +1 -1
- package/dist/commonjs/sdk/sites.js +12 -2
- package/dist/commonjs/sdk/sites.js.map +1 -1
- package/dist/esm/funcs/sitesGet.d.ts +1 -1
- package/dist/esm/funcs/sitesGet.js +6 -2
- package/dist/esm/funcs/sitesGet.js.map +1 -1
- package/dist/esm/funcs/sitesGetLand.d.ts +19 -0
- package/dist/esm/funcs/sitesGetLand.d.ts.map +1 -0
- package/dist/esm/funcs/sitesGetLand.js +95 -0
- package/dist/esm/funcs/sitesGetLand.js.map +1 -0
- package/dist/esm/funcs/sitesSearch.d.ts +1 -1
- package/dist/esm/funcs/sitesSearch.js +1 -1
- package/dist/esm/lib/config.d.ts +3 -3
- package/dist/esm/lib/config.js +3 -3
- package/dist/esm/lib/config.js.map +1 -1
- package/dist/esm/sdk/models/errors/getsiteland.d.ts +396 -0
- package/dist/esm/sdk/models/errors/getsiteland.d.ts.map +1 -0
- package/dist/esm/sdk/models/errors/getsiteland.js +333 -0
- package/dist/esm/sdk/models/errors/getsiteland.js.map +1 -0
- package/dist/esm/sdk/models/errors/index.d.ts +1 -0
- package/dist/esm/sdk/models/errors/index.d.ts.map +1 -1
- package/dist/esm/sdk/models/errors/index.js +1 -0
- package/dist/esm/sdk/models/errors/index.js.map +1 -1
- package/dist/esm/sdk/models/operations/getsitebyid.d.ts +5 -0
- package/dist/esm/sdk/models/operations/getsitebyid.d.ts.map +1 -1
- package/dist/esm/sdk/models/operations/getsitebyid.js +1 -0
- package/dist/esm/sdk/models/operations/getsitebyid.js.map +1 -1
- package/dist/esm/sdk/models/operations/getsiteland.d.ts +30 -0
- package/dist/esm/sdk/models/operations/getsiteland.d.ts.map +1 -0
- package/dist/esm/sdk/models/operations/getsiteland.js +15 -0
- package/dist/esm/sdk/models/operations/getsiteland.js.map +1 -0
- package/dist/esm/sdk/models/operations/index.d.ts +1 -0
- package/dist/esm/sdk/models/operations/index.d.ts.map +1 -1
- package/dist/esm/sdk/models/operations/index.js +1 -0
- package/dist/esm/sdk/models/operations/index.js.map +1 -1
- package/dist/esm/sdk/models/shared/building.d.ts +5 -5
- package/dist/esm/sdk/models/shared/building.d.ts.map +1 -1
- package/dist/esm/sdk/models/shared/building.js +5 -5
- package/dist/esm/sdk/models/shared/building.js.map +1 -1
- package/dist/esm/sdk/models/shared/index.d.ts +11 -0
- package/dist/esm/sdk/models/shared/index.d.ts.map +1 -1
- package/dist/esm/sdk/models/shared/index.js +11 -0
- package/dist/esm/sdk/models/shared/index.js.map +1 -1
- package/dist/esm/sdk/models/shared/site.d.ts +68 -14
- package/dist/esm/sdk/models/shared/site.d.ts.map +1 -1
- package/dist/esm/sdk/models/shared/site.js +28 -5
- package/dist/esm/sdk/models/shared/site.js.map +1 -1
- package/dist/esm/sdk/models/shared/sitebuilding.d.ts +176 -0
- package/dist/esm/sdk/models/shared/sitebuilding.d.ts.map +1 -0
- package/dist/esm/sdk/models/shared/sitebuilding.js +101 -0
- package/dist/esm/sdk/models/shared/sitebuilding.js.map +1 -0
- package/dist/esm/sdk/models/shared/sitebuildingcount.d.ts +17 -0
- package/dist/esm/sdk/models/shared/sitebuildingcount.d.ts.map +1 -0
- package/dist/esm/sdk/models/shared/sitebuildingcount.js +14 -0
- package/dist/esm/sdk/models/shared/sitebuildingcount.js.map +1 -0
- package/dist/esm/sdk/models/shared/sitebuildingprofile.d.ts +94 -0
- package/dist/esm/sdk/models/shared/sitebuildingprofile.d.ts.map +1 -0
- package/dist/esm/sdk/models/shared/sitebuildingprofile.js +38 -0
- package/dist/esm/sdk/models/shared/sitebuildingprofile.js.map +1 -0
- package/dist/esm/sdk/models/shared/siteconstraintflags.d.ts +32 -0
- package/dist/esm/sdk/models/shared/siteconstraintflags.d.ts.map +1 -0
- package/dist/esm/sdk/models/shared/siteconstraintflags.js +17 -0
- package/dist/esm/sdk/models/shared/siteconstraintflags.js.map +1 -0
- package/dist/esm/sdk/models/shared/siteconstraintlayer.d.ts +45 -0
- package/dist/esm/sdk/models/shared/siteconstraintlayer.d.ts.map +1 -0
- package/dist/esm/sdk/models/shared/siteconstraintlayer.js +21 -0
- package/dist/esm/sdk/models/shared/siteconstraintlayer.js.map +1 -0
- package/dist/esm/sdk/models/shared/siteconstraints.d.ts +31 -0
- package/dist/esm/sdk/models/shared/siteconstraints.d.ts.map +1 -0
- package/dist/esm/sdk/models/shared/siteconstraints.js +19 -0
- package/dist/esm/sdk/models/shared/siteconstraints.js.map +1 -0
- package/dist/esm/sdk/models/shared/siteconstraintunmeasured.d.ts +49 -0
- package/dist/esm/sdk/models/shared/siteconstraintunmeasured.d.ts.map +1 -0
- package/dist/esm/sdk/models/shared/siteconstraintunmeasured.js +38 -0
- package/dist/esm/sdk/models/shared/siteconstraintunmeasured.js.map +1 -0
- package/dist/esm/sdk/models/shared/sitelandfeature.d.ts +90 -0
- package/dist/esm/sdk/models/shared/sitelandfeature.d.ts.map +1 -0
- package/dist/esm/sdk/models/shared/sitelandfeature.js +41 -0
- package/dist/esm/sdk/models/shared/sitelandfeature.js.map +1 -0
- package/dist/esm/sdk/models/shared/sitelandlistresponse.d.ts +46 -0
- package/dist/esm/sdk/models/shared/sitelandlistresponse.d.ts.map +1 -0
- package/dist/esm/sdk/models/shared/sitelandlistresponse.js +32 -0
- package/dist/esm/sdk/models/shared/sitelandlistresponse.js.map +1 -0
- package/dist/esm/sdk/models/shared/sitelandprofile.d.ts +74 -0
- package/dist/esm/sdk/models/shared/sitelandprofile.d.ts.map +1 -0
- package/dist/esm/sdk/models/shared/sitelandprofile.js +33 -0
- package/dist/esm/sdk/models/shared/sitelandprofile.js.map +1 -0
- package/dist/esm/sdk/models/shared/sitelandshare.d.ts +25 -0
- package/dist/esm/sdk/models/shared/sitelandshare.d.ts.map +1 -0
- package/dist/esm/sdk/models/shared/sitelandshare.js +16 -0
- package/dist/esm/sdk/models/shared/sitelandshare.js.map +1 -0
- package/dist/esm/sdk/models/shared/sitequeryrequest.d.ts +2 -2
- package/dist/esm/sdk/models/shared/sitetags.d.ts +4 -0
- package/dist/esm/sdk/models/shared/sitetags.d.ts.map +1 -1
- package/dist/esm/sdk/models/shared/sitetags.js +1 -0
- package/dist/esm/sdk/models/shared/sitetags.js.map +1 -1
- package/dist/esm/sdk/sites.d.ts +9 -2
- package/dist/esm/sdk/sites.d.ts.map +1 -1
- package/dist/esm/sdk/sites.js +12 -2
- package/dist/esm/sdk/sites.js.map +1 -1
- package/package.json +1 -1
- package/src/funcs/sitesGet.ts +7 -2
- package/src/funcs/sitesGetLand.ts +213 -0
- package/src/funcs/sitesSearch.ts +1 -1
- package/src/lib/config.ts +3 -3
- package/src/sdk/models/errors/getsiteland.ts +770 -0
- package/src/sdk/models/errors/index.ts +1 -0
- package/src/sdk/models/operations/getsitebyid.ts +6 -0
- package/src/sdk/models/operations/getsiteland.ts +52 -0
- package/src/sdk/models/operations/index.ts +1 -0
- package/src/sdk/models/shared/building.ts +11 -11
- package/src/sdk/models/shared/index.ts +11 -0
- package/src/sdk/models/shared/site.ts +95 -17
- package/src/sdk/models/shared/sitebuilding.ts +288 -0
- package/src/sdk/models/shared/sitebuildingcount.ts +39 -0
- package/src/sdk/models/shared/sitebuildingprofile.ts +140 -0
- package/src/sdk/models/shared/siteconstraintflags.ts +57 -0
- package/src/sdk/models/shared/siteconstraintlayer.ts +74 -0
- package/src/sdk/models/shared/siteconstraints.ts +64 -0
- package/src/sdk/models/shared/siteconstraintunmeasured.ts +83 -0
- package/src/sdk/models/shared/sitelandfeature.ts +145 -0
- package/src/sdk/models/shared/sitelandlistresponse.ts +86 -0
- package/src/sdk/models/shared/sitelandprofile.ts +110 -0
- package/src/sdk/models/shared/sitelandshare.ts +49 -0
- package/src/sdk/models/shared/sitequeryrequest.ts +2 -2
- package/src/sdk/models/shared/sitetags.ts +5 -0
- package/src/sdk/sites.ts +20 -2
|
@@ -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;
|
|
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"}
|
package/dist/esm/sdk/sites.d.ts
CHANGED
|
@@ -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":"
|
|
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"}
|
package/dist/esm/sdk/sites.js
CHANGED
|
@@ -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
package/src/funcs/sitesGet.ts
CHANGED
|
@@ -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
|
+
}
|
package/src/funcs/sitesSearch.ts
CHANGED
|
@@ -30,7 +30,7 @@ import { Result } from "../sdk/types/fp.js";
|
|
|
30
30
|
* Search sites
|
|
31
31
|
*
|
|
32
32
|
* @remarks
|
|
33
|
-
* 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.
|
|
33
|
+
* 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.
|
|
34
34
|
*/
|
|
35
35
|
export function sitesSearch(
|
|
36
36
|
client: SDKCore,
|
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.
|
|
63
|
+
openapiDocVersion: "6.57.1",
|
|
64
64
|
sdkVersion: "0.12.0",
|
|
65
|
-
genVersion: "2.950.
|
|
66
|
-
userAgent: "speakeasy-sdk/typescript 0.12.0 2.950.
|
|
65
|
+
genVersion: "2.950.13",
|
|
66
|
+
userAgent: "speakeasy-sdk/typescript 0.12.0 2.950.13 6.57.1 @vepler/sdk",
|
|
67
67
|
} as const;
|