@vepler/sdk 2.145.1 → 2.149.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/commonjs/funcs/censusGetBreaks.js +1 -1
- package/dist/commonjs/funcs/censusGetBreaks.js.map +1 -1
- package/dist/commonjs/funcs/censusGetTile.js +1 -1
- package/dist/commonjs/funcs/censusGetTile.js.map +1 -1
- package/dist/commonjs/funcs/censusGetWholeLevel.js +1 -1
- package/dist/commonjs/funcs/censusGetWholeLevel.js.map +1 -1
- package/dist/commonjs/funcs/planningGetPlanningApplications.d.ts +1 -1
- package/dist/commonjs/funcs/planningGetPlanningApplications.js +1 -1
- package/dist/commonjs/funcs/planningGetPlanningApplicationsBySource.d.ts +1 -1
- package/dist/commonjs/funcs/planningGetPlanningApplicationsBySource.js +1 -1
- package/dist/commonjs/funcs/planningSearchPlanningApplications.d.ts +1 -1
- package/dist/commonjs/funcs/planningSearchPlanningApplications.js +1 -1
- package/dist/commonjs/funcs/searchSearchSuggest.d.ts +6 -0
- package/dist/commonjs/funcs/searchSearchSuggest.d.ts.map +1 -1
- package/dist/commonjs/funcs/searchSearchSuggest.js +10 -0
- package/dist/commonjs/funcs/searchSearchSuggest.js.map +1 -1
- package/dist/commonjs/lib/config.d.ts +2 -2
- package/dist/commonjs/lib/config.js +2 -2
- package/dist/commonjs/sdk/models/operations/getplanningapplications.d.ts +1 -1
- package/dist/commonjs/sdk/models/operations/getplanningapplicationsbysource.d.ts +1 -1
- package/dist/commonjs/sdk/models/operations/searchsuggest.d.ts +51 -3
- package/dist/commonjs/sdk/models/operations/searchsuggest.d.ts.map +1 -1
- package/dist/commonjs/sdk/models/operations/searchsuggest.js +27 -2
- package/dist/commonjs/sdk/models/operations/searchsuggest.js.map +1 -1
- package/dist/commonjs/sdk/models/shared/index.d.ts +3 -0
- package/dist/commonjs/sdk/models/shared/index.d.ts.map +1 -1
- package/dist/commonjs/sdk/models/shared/index.js +3 -0
- package/dist/commonjs/sdk/models/shared/index.js.map +1 -1
- package/dist/commonjs/sdk/models/shared/planningapplication.d.ts +27 -0
- package/dist/commonjs/sdk/models/shared/planningapplication.d.ts.map +1 -1
- package/dist/commonjs/sdk/models/shared/planningapplication.js +15 -1
- package/dist/commonjs/sdk/models/shared/planningapplication.js.map +1 -1
- package/dist/commonjs/sdk/models/shared/planningclassificationreasoning.d.ts +45 -0
- package/dist/commonjs/sdk/models/shared/planningclassificationreasoning.d.ts.map +1 -0
- package/dist/commonjs/sdk/models/shared/planningclassificationreasoning.js +57 -0
- package/dist/commonjs/sdk/models/shared/planningclassificationreasoning.js.map +1 -0
- package/dist/commonjs/sdk/models/shared/planningdocument.d.ts +8 -0
- package/dist/commonjs/sdk/models/shared/planningdocument.d.ts.map +1 -1
- package/dist/commonjs/sdk/models/shared/planningdocument.js +2 -0
- package/dist/commonjs/sdk/models/shared/planningdocument.js.map +1 -1
- package/dist/commonjs/sdk/models/shared/planningimage.d.ts +49 -0
- package/dist/commonjs/sdk/models/shared/planningimage.d.ts.map +1 -0
- package/dist/commonjs/sdk/models/shared/planningimage.js +59 -0
- package/dist/commonjs/sdk/models/shared/planningimage.js.map +1 -0
- package/dist/commonjs/sdk/models/shared/planningqueryrequest.d.ts +4 -1
- package/dist/commonjs/sdk/models/shared/planningqueryrequest.d.ts.map +1 -1
- package/dist/commonjs/sdk/models/shared/planningqueryrequest.js +3 -0
- package/dist/commonjs/sdk/models/shared/planningqueryrequest.js.map +1 -1
- package/dist/commonjs/sdk/models/shared/planningsemanticchunk.d.ts +37 -0
- package/dist/commonjs/sdk/models/shared/planningsemanticchunk.d.ts.map +1 -0
- package/dist/commonjs/sdk/models/shared/planningsemanticchunk.js +56 -0
- package/dist/commonjs/sdk/models/shared/planningsemanticchunk.js.map +1 -0
- package/dist/commonjs/sdk/models/shared/searchresult.d.ts +2 -2
- package/dist/commonjs/sdk/planning.d.ts +3 -3
- package/dist/commonjs/sdk/planning.js +3 -3
- package/dist/commonjs/sdk/search.d.ts +6 -0
- package/dist/commonjs/sdk/search.d.ts.map +1 -1
- package/dist/commonjs/sdk/search.js +6 -0
- package/dist/commonjs/sdk/search.js.map +1 -1
- package/dist/esm/funcs/censusGetBreaks.js +1 -1
- package/dist/esm/funcs/censusGetBreaks.js.map +1 -1
- package/dist/esm/funcs/censusGetTile.js +1 -1
- package/dist/esm/funcs/censusGetTile.js.map +1 -1
- package/dist/esm/funcs/censusGetWholeLevel.js +1 -1
- package/dist/esm/funcs/censusGetWholeLevel.js.map +1 -1
- package/dist/esm/funcs/planningGetPlanningApplications.d.ts +1 -1
- package/dist/esm/funcs/planningGetPlanningApplications.js +1 -1
- package/dist/esm/funcs/planningGetPlanningApplicationsBySource.d.ts +1 -1
- package/dist/esm/funcs/planningGetPlanningApplicationsBySource.js +1 -1
- package/dist/esm/funcs/planningSearchPlanningApplications.d.ts +1 -1
- package/dist/esm/funcs/planningSearchPlanningApplications.js +1 -1
- package/dist/esm/funcs/searchSearchSuggest.d.ts +6 -0
- package/dist/esm/funcs/searchSearchSuggest.d.ts.map +1 -1
- package/dist/esm/funcs/searchSearchSuggest.js +10 -0
- package/dist/esm/funcs/searchSearchSuggest.js.map +1 -1
- package/dist/esm/lib/config.d.ts +2 -2
- package/dist/esm/lib/config.js +2 -2
- package/dist/esm/sdk/models/operations/getplanningapplications.d.ts +1 -1
- package/dist/esm/sdk/models/operations/getplanningapplicationsbysource.d.ts +1 -1
- package/dist/esm/sdk/models/operations/searchsuggest.d.ts +51 -3
- package/dist/esm/sdk/models/operations/searchsuggest.d.ts.map +1 -1
- package/dist/esm/sdk/models/operations/searchsuggest.js +26 -1
- package/dist/esm/sdk/models/operations/searchsuggest.js.map +1 -1
- package/dist/esm/sdk/models/shared/index.d.ts +3 -0
- package/dist/esm/sdk/models/shared/index.d.ts.map +1 -1
- package/dist/esm/sdk/models/shared/index.js +3 -0
- package/dist/esm/sdk/models/shared/index.js.map +1 -1
- package/dist/esm/sdk/models/shared/planningapplication.d.ts +27 -0
- package/dist/esm/sdk/models/shared/planningapplication.d.ts.map +1 -1
- package/dist/esm/sdk/models/shared/planningapplication.js +13 -0
- package/dist/esm/sdk/models/shared/planningapplication.js.map +1 -1
- package/dist/esm/sdk/models/shared/planningclassificationreasoning.d.ts +45 -0
- package/dist/esm/sdk/models/shared/planningclassificationreasoning.d.ts.map +1 -0
- package/dist/esm/sdk/models/shared/planningclassificationreasoning.js +20 -0
- package/dist/esm/sdk/models/shared/planningclassificationreasoning.js.map +1 -0
- package/dist/esm/sdk/models/shared/planningdocument.d.ts +8 -0
- package/dist/esm/sdk/models/shared/planningdocument.d.ts.map +1 -1
- package/dist/esm/sdk/models/shared/planningdocument.js +2 -0
- package/dist/esm/sdk/models/shared/planningdocument.js.map +1 -1
- package/dist/esm/sdk/models/shared/planningimage.d.ts +49 -0
- package/dist/esm/sdk/models/shared/planningimage.d.ts.map +1 -0
- package/dist/esm/sdk/models/shared/planningimage.js +22 -0
- package/dist/esm/sdk/models/shared/planningimage.js.map +1 -0
- package/dist/esm/sdk/models/shared/planningqueryrequest.d.ts +4 -1
- package/dist/esm/sdk/models/shared/planningqueryrequest.d.ts.map +1 -1
- package/dist/esm/sdk/models/shared/planningqueryrequest.js +3 -0
- package/dist/esm/sdk/models/shared/planningqueryrequest.js.map +1 -1
- package/dist/esm/sdk/models/shared/planningsemanticchunk.d.ts +37 -0
- package/dist/esm/sdk/models/shared/planningsemanticchunk.d.ts.map +1 -0
- package/dist/esm/sdk/models/shared/planningsemanticchunk.js +19 -0
- package/dist/esm/sdk/models/shared/planningsemanticchunk.js.map +1 -0
- package/dist/esm/sdk/models/shared/searchresult.d.ts +2 -2
- package/dist/esm/sdk/planning.d.ts +3 -3
- package/dist/esm/sdk/planning.js +3 -3
- package/dist/esm/sdk/search.d.ts +6 -0
- package/dist/esm/sdk/search.d.ts.map +1 -1
- package/dist/esm/sdk/search.js +6 -0
- package/dist/esm/sdk/search.js.map +1 -1
- package/package.json +1 -1
- package/src/funcs/censusGetBreaks.ts +1 -1
- package/src/funcs/censusGetTile.ts +1 -1
- package/src/funcs/censusGetWholeLevel.ts +1 -1
- package/src/funcs/planningGetPlanningApplications.ts +1 -1
- package/src/funcs/planningGetPlanningApplicationsBySource.ts +1 -1
- package/src/funcs/planningSearchPlanningApplications.ts +1 -1
- package/src/funcs/searchSearchSuggest.ts +10 -0
- package/src/lib/config.ts +2 -2
- package/src/sdk/models/operations/getplanningapplications.ts +1 -1
- package/src/sdk/models/operations/getplanningapplicationsbysource.ts +1 -1
- package/src/sdk/models/operations/searchsuggest.ts +64 -3
- package/src/sdk/models/shared/index.ts +3 -0
- package/src/sdk/models/shared/planningapplication.ts +53 -0
- package/src/sdk/models/shared/planningclassificationreasoning.ts +69 -0
- package/src/sdk/models/shared/planningdocument.ts +10 -0
- package/src/sdk/models/shared/planningimage.ts +79 -0
- package/src/sdk/models/shared/planningqueryrequest.ts +4 -1
- package/src/sdk/models/shared/planningsemanticchunk.ts +64 -0
- package/src/sdk/models/shared/searchresult.ts +2 -2
- package/src/sdk/planning.ts +3 -3
- package/src/sdk/search.ts +6 -0
|
@@ -3,6 +3,9 @@ import { ClosedEnum } from "../../types/enums.js";
|
|
|
3
3
|
import { PlanningQueryFilters, PlanningQueryFilters$Outbound } from "./planningqueryfilters.js";
|
|
4
4
|
export declare const Include: {
|
|
5
5
|
readonly Extractions: "extractions";
|
|
6
|
+
readonly Images: "images";
|
|
7
|
+
readonly Content: "content";
|
|
8
|
+
readonly Enrichment: "enrichment";
|
|
6
9
|
};
|
|
7
10
|
export type Include = ClosedEnum<typeof Include>;
|
|
8
11
|
/**
|
|
@@ -32,7 +35,7 @@ export declare const PlanningQueryRequestSortOrder: {
|
|
|
32
35
|
export type PlanningQueryRequestSortOrder = ClosedEnum<typeof PlanningQueryRequestSortOrder>;
|
|
33
36
|
export type PlanningQueryRequest = {
|
|
34
37
|
/**
|
|
35
|
-
* Optional expansions to attach to each returned application. 'extractions'
|
|
38
|
+
* Optional expansions to attach to each returned application. 'extractions' — structured, citation-backed extractions (decision, development, s106, officer assessment, consultee responses). 'images' — a deduplicated image gallery with directly-renderable CDN URLs. 'content' — adds fileUrl (CDN PDF) and ocrUrl (CDN Markdown text) to each document so it can be rendered/searched in-browser. 'enrichment' — AI classification reasoning and document segmentation summaries. All are omitted by default to keep responses lean; request only what you need (e.g. a handful of specific applications), not for bulk aggregation.
|
|
36
39
|
*/
|
|
37
40
|
include?: Array<Include> | undefined;
|
|
38
41
|
/**
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"planningqueryrequest.d.ts","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/planningqueryrequest.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAC5B,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAClD,OAAO,EACL,oBAAoB,EACpB,6BAA6B,EAE9B,MAAM,2BAA2B,CAAC;AAEnC,eAAO,MAAM,OAAO
|
|
1
|
+
{"version":3,"file":"planningqueryrequest.d.ts","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/planningqueryrequest.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAC5B,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAClD,OAAO,EACL,oBAAoB,EACpB,6BAA6B,EAE9B,MAAM,2BAA2B,CAAC;AAEnC,eAAO,MAAM,OAAO;;;;;CAKV,CAAC;AACX,MAAM,MAAM,OAAO,GAAG,UAAU,CAAC,OAAO,OAAO,CAAC,CAAC;AAEjD;;GAEG;AACH,eAAO,MAAM,0BAA0B;;;;;;CAM7B,CAAC;AACX;;GAEG;AACH,MAAM,MAAM,0BAA0B,GAAG,UAAU,CACjD,OAAO,0BAA0B,CAClC,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,6BAA6B;;;CAGhC,CAAC;AACX;;GAEG;AACH,MAAM,MAAM,6BAA6B,GAAG,UAAU,CACpD,OAAO,6BAA6B,CACrC,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG;IACjC;;OAEG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,OAAO,CAAC,GAAG,SAAS,CAAC;IACrC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC3B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC5B;;OAEG;IACH,KAAK,CAAC,EAAE,oBAAoB,GAAG,SAAS,CAAC;IACzC;;OAEG;IACH,MAAM,CAAC,EAAE,0BAA0B,GAAG,SAAS,CAAC;IAChD;;OAEG;IACH,SAAS,CAAC,EAAE,6BAA6B,GAAG,SAAS,CAAC;CACvD,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,sBAAsB,EAAE,CAAC,CAAC,aAAa,CAAC,OAAO,OAAO,CAC7C,CAAC;AAEvB,gBAAgB;AAChB,eAAO,MAAM,yCAAyC,EAAE,CAAC,CAAC,aAAa,CACrE,OAAO,0BAA0B,CACS,CAAC;AAE7C,gBAAgB;AAChB,eAAO,MAAM,4CAA4C,EAAE,CAAC,CAAC,aAAa,CACxE,OAAO,6BAA6B,CACS,CAAC;AAEhD,gBAAgB;AAChB,MAAM,MAAM,6BAA6B,GAAG;IAC1C,OAAO,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,SAAS,CAAC;IACpC,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,6BAA6B,GAAG,SAAS,CAAC;IAClD,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,mCAAmC,EAAE,CAAC,CAAC,OAAO,CACzD,6BAA6B,EAC7B,CAAC,CAAC,UAAU,EACZ,oBAAoB,CAQpB,CAAC;AAEH,wBAAgB,0BAA0B,CACxC,oBAAoB,EAAE,oBAAoB,GACzC,MAAM,CAIR"}
|
|
@@ -5,6 +5,9 @@ import * as z from "zod/v3";
|
|
|
5
5
|
import { PlanningQueryFilters$outboundSchema, } from "./planningqueryfilters.js";
|
|
6
6
|
export const Include = {
|
|
7
7
|
Extractions: "extractions",
|
|
8
|
+
Images: "images",
|
|
9
|
+
Content: "content",
|
|
10
|
+
Enrichment: "enrichment",
|
|
8
11
|
};
|
|
9
12
|
/**
|
|
10
13
|
* Field to sort results by. 'receivedDate' -- date the application was received by the council. 'validatedDate' -- date the application was formally validated. 'appealedDate' -- date an appeal was lodged. 'createdAt' -- date the record was created in our system. 'updatedAt' -- date the record was last updated in our system. Defaults to 'receivedDate'.
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"planningqueryrequest.js","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/planningqueryrequest.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAE5B,OAAO,EAGL,mCAAmC,GACpC,MAAM,2BAA2B,CAAC;AAEnC,MAAM,CAAC,MAAM,OAAO,GAAG;IACrB,WAAW,EAAE,aAAa;
|
|
1
|
+
{"version":3,"file":"planningqueryrequest.js","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/planningqueryrequest.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAE5B,OAAO,EAGL,mCAAmC,GACpC,MAAM,2BAA2B,CAAC;AAEnC,MAAM,CAAC,MAAM,OAAO,GAAG;IACrB,WAAW,EAAE,aAAa;IAC1B,MAAM,EAAE,QAAQ;IAChB,OAAO,EAAE,SAAS;IAClB,UAAU,EAAE,YAAY;CAChB,CAAC;AAGX;;GAEG;AACH,MAAM,CAAC,MAAM,0BAA0B,GAAG;IACxC,YAAY,EAAE,cAAc;IAC5B,aAAa,EAAE,eAAe;IAC9B,YAAY,EAAE,cAAc;IAC5B,SAAS,EAAE,WAAW;IACtB,SAAS,EAAE,WAAW;CACd,CAAC;AAQX;;GAEG;AACH,MAAM,CAAC,MAAM,6BAA6B,GAAG;IAC3C,GAAG,EAAE,KAAK;IACV,IAAI,EAAE,MAAM;CACJ,CAAC;AAmCX,gBAAgB;AAChB,MAAM,CAAC,MAAM,sBAAsB,GAAoC,CAAC;KACrE,UAAU,CAAC,OAAO,CAAC,CAAC;AAEvB,gBAAgB;AAChB,MAAM,CAAC,MAAM,yCAAyC,GAElD,CAAC,CAAC,UAAU,CAAC,0BAA0B,CAAC,CAAC;AAE7C,gBAAgB;AAChB,MAAM,CAAC,MAAM,4CAA4C,GAErD,CAAC,CAAC,UAAU,CAAC,6BAA6B,CAAC,CAAC;AAYhD,gBAAgB;AAChB,MAAM,CAAC,MAAM,mCAAmC,GAI5C,CAAC,CAAC,MAAM,CAAC;IACX,OAAO,EAAE,CAAC,CAAC,KAAK,CAAC,sBAAsB,CAAC,CAAC,QAAQ,EAAE;IACnD,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,OAAO,CAAC,EAAE,CAAC;IAC7B,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC;IAC7B,KAAK,EAAE,mCAAmC,CAAC,QAAQ,EAAE;IACrD,MAAM,EAAE,yCAAyC,CAAC,OAAO,CAAC,cAAc,CAAC;IACzE,SAAS,EAAE,4CAA4C,CAAC,OAAO,CAAC,MAAM,CAAC;CACxE,CAAC,CAAC;AAEH,MAAM,UAAU,0BAA0B,CACxC,oBAA0C;IAE1C,OAAO,IAAI,CAAC,SAAS,CACnB,mCAAmC,CAAC,KAAK,CAAC,oBAAoB,CAAC,CAChE,CAAC;AACJ,CAAC"}
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
import * as z from "zod/v3";
|
|
2
|
+
import { Result as SafeParseResult } from "../../types/fp.js";
|
|
3
|
+
import { SDKValidationError } from "../errors/sdkvalidationerror.js";
|
|
4
|
+
export type PlanningSemanticChunk = {
|
|
5
|
+
/**
|
|
6
|
+
* Kind of chunk (e.g. 'document', 'section').
|
|
7
|
+
*/
|
|
8
|
+
chunkType?: string | null | undefined;
|
|
9
|
+
/**
|
|
10
|
+
* AI-written summary giving the surrounding context of this chunk.
|
|
11
|
+
*/
|
|
12
|
+
contextSummary?: string | null | undefined;
|
|
13
|
+
/**
|
|
14
|
+
* UUID of the source document this chunk belongs to.
|
|
15
|
+
*/
|
|
16
|
+
documentId?: string | null | undefined;
|
|
17
|
+
/**
|
|
18
|
+
* Unique identifier for the semantic chunk.
|
|
19
|
+
*/
|
|
20
|
+
id: string;
|
|
21
|
+
/**
|
|
22
|
+
* Last page the chunk spans (1-based).
|
|
23
|
+
*/
|
|
24
|
+
pageEnd?: number | null | undefined;
|
|
25
|
+
/**
|
|
26
|
+
* First page the chunk spans (1-based).
|
|
27
|
+
*/
|
|
28
|
+
pageStart?: number | null | undefined;
|
|
29
|
+
/**
|
|
30
|
+
* Hierarchical section heading path locating the chunk within the document.
|
|
31
|
+
*/
|
|
32
|
+
sectionPath?: Array<string> | null | undefined;
|
|
33
|
+
};
|
|
34
|
+
/** @internal */
|
|
35
|
+
export declare const PlanningSemanticChunk$inboundSchema: z.ZodType<PlanningSemanticChunk, z.ZodTypeDef, unknown>;
|
|
36
|
+
export declare function planningSemanticChunkFromJSON(jsonString: string): SafeParseResult<PlanningSemanticChunk, SDKValidationError>;
|
|
37
|
+
//# sourceMappingURL=planningsemanticchunk.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"planningsemanticchunk.d.ts","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/planningsemanticchunk.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAE5B,OAAO,EAAE,MAAM,IAAI,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAC9D,OAAO,EAAE,kBAAkB,EAAE,MAAM,iCAAiC,CAAC;AAErE,MAAM,MAAM,qBAAqB,GAAG;IAClC;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IACtC;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IAC3C;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IACvC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IACX;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IACpC;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IACtC;;OAEG;IACH,WAAW,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,GAAG,SAAS,CAAC;CAChD,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,mCAAmC,EAAE,CAAC,CAAC,OAAO,CACzD,qBAAqB,EACrB,CAAC,CAAC,UAAU,EACZ,OAAO,CASP,CAAC;AAEH,wBAAgB,6BAA6B,CAC3C,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,qBAAqB,EAAE,kBAAkB,CAAC,CAM5D"}
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
/*
|
|
2
|
+
* Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
|
|
3
|
+
*/
|
|
4
|
+
import * as z from "zod/v3";
|
|
5
|
+
import { safeParse } from "../../../lib/schemas.js";
|
|
6
|
+
/** @internal */
|
|
7
|
+
export const PlanningSemanticChunk$inboundSchema = z.object({
|
|
8
|
+
chunkType: z.nullable(z.string()).optional(),
|
|
9
|
+
contextSummary: z.nullable(z.string()).optional(),
|
|
10
|
+
documentId: z.nullable(z.string()).optional(),
|
|
11
|
+
id: z.string(),
|
|
12
|
+
pageEnd: z.nullable(z.number()).optional(),
|
|
13
|
+
pageStart: z.nullable(z.number()).optional(),
|
|
14
|
+
sectionPath: z.nullable(z.array(z.string())).optional(),
|
|
15
|
+
});
|
|
16
|
+
export function planningSemanticChunkFromJSON(jsonString) {
|
|
17
|
+
return safeParse(jsonString, (x) => PlanningSemanticChunk$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'PlanningSemanticChunk' from JSON`);
|
|
18
|
+
}
|
|
19
|
+
//# sourceMappingURL=planningsemanticchunk.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"planningsemanticchunk.js","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/planningsemanticchunk.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAC5B,OAAO,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAC;AAmCpD,gBAAgB;AAChB,MAAM,CAAC,MAAM,mCAAmC,GAI5C,CAAC,CAAC,MAAM,CAAC;IACX,SAAS,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;IAC5C,cAAc,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;IACjD,UAAU,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;IAC7C,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE;IACd,OAAO,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;IAC1C,SAAS,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;IAC5C,WAAW,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,QAAQ,EAAE;CACxD,CAAC,CAAC;AAEH,MAAM,UAAU,6BAA6B,CAC3C,UAAkB;IAElB,OAAO,SAAS,CACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,mCAAmC,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAC/D,mDAAmD,CACpD,CAAC;AACJ,CAAC"}
|
|
@@ -54,7 +54,7 @@ export type SearchResult = {
|
|
|
54
54
|
*/
|
|
55
55
|
location?: SearchResultCoordinates | undefined;
|
|
56
56
|
/**
|
|
57
|
-
* Primary display text
|
|
57
|
+
* Primary display text: building + street
|
|
58
58
|
*/
|
|
59
59
|
mainText?: string | undefined;
|
|
60
60
|
/**
|
|
@@ -88,7 +88,7 @@ export type SearchResult = {
|
|
|
88
88
|
*/
|
|
89
89
|
score: number;
|
|
90
90
|
/**
|
|
91
|
-
* Secondary display text
|
|
91
|
+
* Secondary display text: locality + postcode
|
|
92
92
|
*/
|
|
93
93
|
secondaryText?: string | undefined;
|
|
94
94
|
/**
|
|
@@ -6,21 +6,21 @@ export declare class Planning extends ClientSDK {
|
|
|
6
6
|
* Get planning applications by application IDs
|
|
7
7
|
*
|
|
8
8
|
* @remarks
|
|
9
|
-
* Retrieve one or more planning applications by their internal UUIDs. Provide up to 100 comma-separated application IDs in the path. Returns the matching applications in a paginated list response. If you have council reference numbers rather than UUIDs, use the GET /sources/{sourceIds} endpoint instead.
|
|
9
|
+
* Retrieve one or more planning applications by their internal UUIDs. Provide up to 100 comma-separated application IDs in the path. Returns the matching applications in a paginated list response. If you have council reference numbers rather than UUIDs, use the GET /sources/{sourceIds} endpoint instead. Use ?include= to attach optional expansions (comma-separated): 'extractions' (structured, citation-backed extractions), 'images' (a renderable image gallery), 'content' (fileUrl + ocrUrl on each document), 'enrichment' (AI classification reasoning and document summaries).
|
|
10
10
|
*/
|
|
11
11
|
getPlanningApplications(request: operations.GetPlanningApplicationsRequest, options?: RequestOptions): Promise<shared.PlanningListResponse>;
|
|
12
12
|
/**
|
|
13
13
|
* Get planning applications by source IDs
|
|
14
14
|
*
|
|
15
15
|
* @remarks
|
|
16
|
-
* Retrieve one or more planning applications by their source identifiers. Each source ID uses the format 'provider::key' where provider is the council slug and key is the council's reference number (e.g. 'lambeth::24/00123/FUL'). Provide up to 100 comma-separated source IDs in the path. This is the recommended lookup method when you know the council and application reference number.
|
|
16
|
+
* Retrieve one or more planning applications by their source identifiers. Each source ID uses the format 'provider::key' where provider is the council slug and key is the council's reference number (e.g. 'lambeth::24/00123/FUL'). Provide up to 100 comma-separated source IDs in the path. This is the recommended lookup method when you know the council and application reference number. Use ?include= to attach optional expansions (comma-separated): 'extractions' (structured, citation-backed extractions), 'images' (a renderable image gallery), 'content' (fileUrl + ocrUrl on each document), 'enrichment' (AI classification reasoning and document summaries).
|
|
17
17
|
*/
|
|
18
18
|
getPlanningApplicationsBySource(request: operations.GetPlanningApplicationsBySourceRequest, options?: RequestOptions): Promise<shared.PlanningListResponse>;
|
|
19
19
|
/**
|
|
20
20
|
* Query planning applications with advanced filters
|
|
21
21
|
*
|
|
22
22
|
* @remarks
|
|
23
|
-
* Search for planning applications using a combination of filters including council, status, type, development category, and date ranges. Use the `near` filter ({ lat, lng, radiusM }) to retrieve applications around a point — the primary way to find a property's planning context; results come back closest-first with `distance` (metres) populated. Pass `include
|
|
23
|
+
* Search for planning applications using a combination of filters including council, status, type, development category, and date ranges. Use the `near` filter ({ lat, lng, radiusM }) to retrieve applications around a point — the primary way to find a property's planning context; results come back closest-first with `distance` (metres) populated. Pass `include` (any of `["extractions", "images", "content", "enrichment"]`) to attach structured citation-backed extractions, a renderable image gallery, document fileUrl/ocrUrl, and/or AI classification reasoning. Filters within the query object are combined with AND logic, whilst array values within a single filter use OR logic. Results are paginated and can be sorted by any date field (the `near` filter overrides sort with closest-first). Supports up to 100 results per page.
|
|
24
24
|
*/
|
|
25
25
|
searchPlanningApplications(request?: shared.PlanningQueryRequest | undefined, options?: RequestOptions): Promise<shared.PlanningListResponse>;
|
|
26
26
|
}
|
package/dist/esm/sdk/planning.js
CHANGED
|
@@ -11,7 +11,7 @@ export class Planning extends ClientSDK {
|
|
|
11
11
|
* Get planning applications by application IDs
|
|
12
12
|
*
|
|
13
13
|
* @remarks
|
|
14
|
-
* Retrieve one or more planning applications by their internal UUIDs. Provide up to 100 comma-separated application IDs in the path. Returns the matching applications in a paginated list response. If you have council reference numbers rather than UUIDs, use the GET /sources/{sourceIds} endpoint instead.
|
|
14
|
+
* Retrieve one or more planning applications by their internal UUIDs. Provide up to 100 comma-separated application IDs in the path. Returns the matching applications in a paginated list response. If you have council reference numbers rather than UUIDs, use the GET /sources/{sourceIds} endpoint instead. Use ?include= to attach optional expansions (comma-separated): 'extractions' (structured, citation-backed extractions), 'images' (a renderable image gallery), 'content' (fileUrl + ocrUrl on each document), 'enrichment' (AI classification reasoning and document summaries).
|
|
15
15
|
*/
|
|
16
16
|
async getPlanningApplications(request, options) {
|
|
17
17
|
return unwrapAsync(planningGetPlanningApplications(this, request, options));
|
|
@@ -20,7 +20,7 @@ export class Planning extends ClientSDK {
|
|
|
20
20
|
* Get planning applications by source IDs
|
|
21
21
|
*
|
|
22
22
|
* @remarks
|
|
23
|
-
* Retrieve one or more planning applications by their source identifiers. Each source ID uses the format 'provider::key' where provider is the council slug and key is the council's reference number (e.g. 'lambeth::24/00123/FUL'). Provide up to 100 comma-separated source IDs in the path. This is the recommended lookup method when you know the council and application reference number.
|
|
23
|
+
* Retrieve one or more planning applications by their source identifiers. Each source ID uses the format 'provider::key' where provider is the council slug and key is the council's reference number (e.g. 'lambeth::24/00123/FUL'). Provide up to 100 comma-separated source IDs in the path. This is the recommended lookup method when you know the council and application reference number. Use ?include= to attach optional expansions (comma-separated): 'extractions' (structured, citation-backed extractions), 'images' (a renderable image gallery), 'content' (fileUrl + ocrUrl on each document), 'enrichment' (AI classification reasoning and document summaries).
|
|
24
24
|
*/
|
|
25
25
|
async getPlanningApplicationsBySource(request, options) {
|
|
26
26
|
return unwrapAsync(planningGetPlanningApplicationsBySource(this, request, options));
|
|
@@ -29,7 +29,7 @@ export class Planning extends ClientSDK {
|
|
|
29
29
|
* Query planning applications with advanced filters
|
|
30
30
|
*
|
|
31
31
|
* @remarks
|
|
32
|
-
* Search for planning applications using a combination of filters including council, status, type, development category, and date ranges. Use the `near` filter ({ lat, lng, radiusM }) to retrieve applications around a point — the primary way to find a property's planning context; results come back closest-first with `distance` (metres) populated. Pass `include
|
|
32
|
+
* Search for planning applications using a combination of filters including council, status, type, development category, and date ranges. Use the `near` filter ({ lat, lng, radiusM }) to retrieve applications around a point — the primary way to find a property's planning context; results come back closest-first with `distance` (metres) populated. Pass `include` (any of `["extractions", "images", "content", "enrichment"]`) to attach structured citation-backed extractions, a renderable image gallery, document fileUrl/ocrUrl, and/or AI classification reasoning. Filters within the query object are combined with AND logic, whilst array values within a single filter use OR logic. Results are paginated and can be sorted by any date field (the `near` filter overrides sort with closest-first). Supports up to 100 results per page.
|
|
33
33
|
*/
|
|
34
34
|
async searchPlanningApplications(request, options) {
|
|
35
35
|
return unwrapAsync(planningSearchPlanningApplications(this, request, options));
|
package/dist/esm/sdk/search.d.ts
CHANGED
|
@@ -7,6 +7,12 @@ export declare class Search extends ClientSDK {
|
|
|
7
7
|
*
|
|
8
8
|
* @remarks
|
|
9
9
|
* Simple autocomplete for UK properties and locations. Searches across Address and Location sources with fuzzy matching. Automatically detects query type (postcode, address, place name) and returns suggestions.
|
|
10
|
+
*
|
|
11
|
+
* Optionally accepts a geographic centre point (`lat`, `lng`) to make results proximity-aware:
|
|
12
|
+
* - `geo_mode=bias` (default): soft preference. The best textual matches near the point rank higher, but distant matches are still returned.
|
|
13
|
+
* - `geo_mode=restrict`: hard cutoff. Only address results within `radius_meters` of the point are returned.
|
|
14
|
+
*
|
|
15
|
+
* When a centre point is supplied, address results include a `distance` (metres from the point). Geographic ranking applies to the address source, so pair it with `source=address` for the most predictable proximity results.
|
|
10
16
|
*/
|
|
11
17
|
searchSuggest(request: operations.SearchSuggestRequest, options?: RequestOptions): Promise<shared.SearchResponse>;
|
|
12
18
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"search.d.ts","sourceRoot":"","sources":["../../../src/sdk/search.ts"],"names":[],"mappings":"AAKA,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,MAAO,SAAQ,SAAS;IACnC
|
|
1
|
+
{"version":3,"file":"search.d.ts","sourceRoot":"","sources":["../../../src/sdk/search.ts"],"names":[],"mappings":"AAKA,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,MAAO,SAAQ,SAAS;IACnC;;;;;;;;;;;OAWG;IACG,aAAa,CACjB,OAAO,EAAE,UAAU,CAAC,oBAAoB,EACxC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,MAAM,CAAC,cAAc,CAAC;CAOlC"}
|
package/dist/esm/sdk/search.js
CHANGED
|
@@ -10,6 +10,12 @@ export class Search extends ClientSDK {
|
|
|
10
10
|
*
|
|
11
11
|
* @remarks
|
|
12
12
|
* Simple autocomplete for UK properties and locations. Searches across Address and Location sources with fuzzy matching. Automatically detects query type (postcode, address, place name) and returns suggestions.
|
|
13
|
+
*
|
|
14
|
+
* Optionally accepts a geographic centre point (`lat`, `lng`) to make results proximity-aware:
|
|
15
|
+
* - `geo_mode=bias` (default): soft preference. The best textual matches near the point rank higher, but distant matches are still returned.
|
|
16
|
+
* - `geo_mode=restrict`: hard cutoff. Only address results within `radius_meters` of the point are returned.
|
|
17
|
+
*
|
|
18
|
+
* When a centre point is supplied, address results include a `distance` (metres from the point). Geographic ranking applies to the address source, so pair it with `source=address` for the most predictable proximity results.
|
|
13
19
|
*/
|
|
14
20
|
async searchSuggest(request, options) {
|
|
15
21
|
return unwrapAsync(searchSearchSuggest(this, request, options));
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"search.js","sourceRoot":"","sources":["../../../src/sdk/search.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,mBAAmB,EAAE,MAAM,iCAAiC,CAAC;AACtE,OAAO,EAAE,SAAS,EAAkB,MAAM,gBAAgB,CAAC;AAG3D,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAE5C,MAAM,OAAO,MAAO,SAAQ,SAAS;IACnC
|
|
1
|
+
{"version":3,"file":"search.js","sourceRoot":"","sources":["../../../src/sdk/search.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,mBAAmB,EAAE,MAAM,iCAAiC,CAAC;AACtE,OAAO,EAAE,SAAS,EAAkB,MAAM,gBAAgB,CAAC;AAG3D,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAE5C,MAAM,OAAO,MAAO,SAAQ,SAAS;IACnC;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,aAAa,CACjB,OAAwC,EACxC,OAAwB;QAExB,OAAO,WAAW,CAAC,mBAAmB,CACpC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;CACF"}
|
package/package.json
CHANGED
|
@@ -109,7 +109,7 @@ async function $do(
|
|
|
109
109
|
}),
|
|
110
110
|
};
|
|
111
111
|
const path = pathToFunc(
|
|
112
|
-
"/v1/census/breaks/{datasetCode}/{geotype}/{categoryCode}
|
|
112
|
+
"/v1/census/breaks/{datasetCode}/{geotype}/{categoryCode}",
|
|
113
113
|
)(pathParams);
|
|
114
114
|
|
|
115
115
|
const query = encodeFormQuery({
|
|
@@ -113,7 +113,7 @@ async function $do(
|
|
|
113
113
|
}),
|
|
114
114
|
};
|
|
115
115
|
const path = pathToFunc(
|
|
116
|
-
"/v1/census/tiles/{datasetCode}/{geotype}/{tile}/{categoryCode}
|
|
116
|
+
"/v1/census/tiles/{datasetCode}/{geotype}/{tile}/{categoryCode}",
|
|
117
117
|
)(pathParams);
|
|
118
118
|
|
|
119
119
|
const query = encodeFormQuery({
|
|
@@ -114,7 +114,7 @@ async function $do(
|
|
|
114
114
|
}),
|
|
115
115
|
};
|
|
116
116
|
const path = pathToFunc(
|
|
117
|
-
"/v1/census/whole/{datasetCode}/{geotype}/{country}/{categoryCode}
|
|
117
|
+
"/v1/census/whole/{datasetCode}/{geotype}/{country}/{categoryCode}",
|
|
118
118
|
)(pathParams);
|
|
119
119
|
|
|
120
120
|
const query = encodeFormQuery({
|
|
@@ -31,7 +31,7 @@ import { Result } from "../sdk/types/fp.js";
|
|
|
31
31
|
* Get planning applications by application IDs
|
|
32
32
|
*
|
|
33
33
|
* @remarks
|
|
34
|
-
* Retrieve one or more planning applications by their internal UUIDs. Provide up to 100 comma-separated application IDs in the path. Returns the matching applications in a paginated list response. If you have council reference numbers rather than UUIDs, use the GET /sources/{sourceIds} endpoint instead.
|
|
34
|
+
* Retrieve one or more planning applications by their internal UUIDs. Provide up to 100 comma-separated application IDs in the path. Returns the matching applications in a paginated list response. If you have council reference numbers rather than UUIDs, use the GET /sources/{sourceIds} endpoint instead. Use ?include= to attach optional expansions (comma-separated): 'extractions' (structured, citation-backed extractions), 'images' (a renderable image gallery), 'content' (fileUrl + ocrUrl on each document), 'enrichment' (AI classification reasoning and document summaries).
|
|
35
35
|
*/
|
|
36
36
|
export function planningGetPlanningApplications(
|
|
37
37
|
client: SDKCore,
|
|
@@ -31,7 +31,7 @@ import { Result } from "../sdk/types/fp.js";
|
|
|
31
31
|
* Get planning applications by source IDs
|
|
32
32
|
*
|
|
33
33
|
* @remarks
|
|
34
|
-
* Retrieve one or more planning applications by their source identifiers. Each source ID uses the format 'provider::key' where provider is the council slug and key is the council's reference number (e.g. 'lambeth::24/00123/FUL'). Provide up to 100 comma-separated source IDs in the path. This is the recommended lookup method when you know the council and application reference number.
|
|
34
|
+
* Retrieve one or more planning applications by their source identifiers. Each source ID uses the format 'provider::key' where provider is the council slug and key is the council's reference number (e.g. 'lambeth::24/00123/FUL'). Provide up to 100 comma-separated source IDs in the path. This is the recommended lookup method when you know the council and application reference number. Use ?include= to attach optional expansions (comma-separated): 'extractions' (structured, citation-backed extractions), 'images' (a renderable image gallery), 'content' (fileUrl + ocrUrl on each document), 'enrichment' (AI classification reasoning and document summaries).
|
|
35
35
|
*/
|
|
36
36
|
export function planningGetPlanningApplicationsBySource(
|
|
37
37
|
client: SDKCore,
|
|
@@ -30,7 +30,7 @@ import { Result } from "../sdk/types/fp.js";
|
|
|
30
30
|
* Query planning applications with advanced filters
|
|
31
31
|
*
|
|
32
32
|
* @remarks
|
|
33
|
-
* Search for planning applications using a combination of filters including council, status, type, development category, and date ranges. Use the `near` filter ({ lat, lng, radiusM }) to retrieve applications around a point — the primary way to find a property's planning context; results come back closest-first with `distance` (metres) populated. Pass `include
|
|
33
|
+
* Search for planning applications using a combination of filters including council, status, type, development category, and date ranges. Use the `near` filter ({ lat, lng, radiusM }) to retrieve applications around a point — the primary way to find a property's planning context; results come back closest-first with `distance` (metres) populated. Pass `include` (any of `["extractions", "images", "content", "enrichment"]`) to attach structured citation-backed extractions, a renderable image gallery, document fileUrl/ocrUrl, and/or AI classification reasoning. Filters within the query object are combined with AND logic, whilst array values within a single filter use OR logic. Results are paginated and can be sorted by any date field (the `near` filter overrides sort with closest-first). Supports up to 100 results per page.
|
|
34
34
|
*/
|
|
35
35
|
export function planningSearchPlanningApplications(
|
|
36
36
|
client: SDKCore,
|
|
@@ -32,6 +32,12 @@ import { Result } from "../sdk/types/fp.js";
|
|
|
32
32
|
*
|
|
33
33
|
* @remarks
|
|
34
34
|
* Simple autocomplete for UK properties and locations. Searches across Address and Location sources with fuzzy matching. Automatically detects query type (postcode, address, place name) and returns suggestions.
|
|
35
|
+
*
|
|
36
|
+
* Optionally accepts a geographic centre point (`lat`, `lng`) to make results proximity-aware:
|
|
37
|
+
* - `geo_mode=bias` (default): soft preference. The best textual matches near the point rank higher, but distant matches are still returned.
|
|
38
|
+
* - `geo_mode=restrict`: hard cutoff. Only address results within `radius_meters` of the point are returned.
|
|
39
|
+
*
|
|
40
|
+
* When a centre point is supplied, address results include a `distance` (metres from the point). Geographic ranking applies to the address source, so pair it with `source=address` for the most predictable proximity results.
|
|
35
41
|
*/
|
|
36
42
|
export function searchSearchSuggest(
|
|
37
43
|
client: SDKCore,
|
|
@@ -96,9 +102,13 @@ async function $do(
|
|
|
96
102
|
|
|
97
103
|
const query = encodeFormQuery({
|
|
98
104
|
"classification": payload.classification,
|
|
105
|
+
"geo_mode": payload.geo_mode,
|
|
106
|
+
"lat": payload.lat,
|
|
99
107
|
"limit": payload.limit,
|
|
108
|
+
"lng": payload.lng,
|
|
100
109
|
"offset": payload.offset,
|
|
101
110
|
"q": payload.q,
|
|
111
|
+
"radius_meters": payload.radius_meters,
|
|
102
112
|
"source": payload.source,
|
|
103
113
|
});
|
|
104
114
|
|
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: "2.
|
|
63
|
+
openapiDocVersion: "2.149.0",
|
|
64
64
|
sdkVersion: "0.10.0",
|
|
65
65
|
genVersion: "2.893.0",
|
|
66
|
-
userAgent: "speakeasy-sdk/typescript 0.10.0 2.893.0 2.
|
|
66
|
+
userAgent: "speakeasy-sdk/typescript 0.10.0 2.893.0 2.149.0 @vepler/sdk",
|
|
67
67
|
} as const;
|
|
@@ -10,7 +10,7 @@ export type GetPlanningApplicationsRequest = {
|
|
|
10
10
|
*/
|
|
11
11
|
applicationIds: string;
|
|
12
12
|
/**
|
|
13
|
-
* Comma-separated list of optional expansions to attach to each application.
|
|
13
|
+
* Comma-separated list of optional expansions to attach to each application. Supported: 'extractions' (structured, citation-backed extractions — decision, development, s106, officer assessment, consultee responses); 'images' (a deduplicated image gallery with directly-renderable CDN URLs); 'content' (adds fileUrl + ocrUrl to each document so it can be rendered/searched in-browser); 'enrichment' (AI classification reasoning and document segmentation summaries). Omitted by default; these expansions can be large, so request only what you need. Example: 'extractions,images,content'.
|
|
14
14
|
*/
|
|
15
15
|
include?: string | undefined;
|
|
16
16
|
};
|
|
@@ -6,7 +6,7 @@ import * as z from "zod/v3";
|
|
|
6
6
|
|
|
7
7
|
export type GetPlanningApplicationsBySourceRequest = {
|
|
8
8
|
/**
|
|
9
|
-
* Comma-separated list of optional expansions to attach to each application.
|
|
9
|
+
* Comma-separated list of optional expansions to attach to each application. Supported: 'extractions' (structured, citation-backed extractions — decision, development, s106, officer assessment, consultee responses); 'images' (a deduplicated image gallery with directly-renderable CDN URLs); 'content' (adds fileUrl + ocrUrl to each document so it can be rendered/searched in-browser); 'enrichment' (AI classification reasoning and document segmentation summaries). Omitted by default; these expansions can be large, so request only what you need. Example: 'extractions,images,content'.
|
|
10
10
|
*/
|
|
11
11
|
include?: string | undefined;
|
|
12
12
|
/**
|
|
@@ -3,10 +3,11 @@
|
|
|
3
3
|
*/
|
|
4
4
|
|
|
5
5
|
import * as z from "zod/v3";
|
|
6
|
+
import { remap as remap$ } from "../../../lib/primitives.js";
|
|
6
7
|
import { ClosedEnum } from "../../types/enums.js";
|
|
7
8
|
|
|
8
9
|
/**
|
|
9
|
-
* Filter address results by property classification. 'residential': dwellings including houses, flats, and HMOs. 'commercial': non-residential premises such as offices, retail, and warehouses. 'all': no filter
|
|
10
|
+
* Filter address results by property classification. 'residential': dwellings including houses, flats, and HMOs. 'commercial': non-residential premises such as offices, retail, and warehouses. 'all': no filter, returns all address types. Defaults to 'residential'.
|
|
10
11
|
*/
|
|
11
12
|
export const Classification = {
|
|
12
13
|
Residential: "residential",
|
|
@@ -14,19 +15,58 @@ export const Classification = {
|
|
|
14
15
|
All: "all",
|
|
15
16
|
} as const;
|
|
16
17
|
/**
|
|
17
|
-
* Filter address results by property classification. 'residential': dwellings including houses, flats, and HMOs. 'commercial': non-residential premises such as offices, retail, and warehouses. 'all': no filter
|
|
18
|
+
* Filter address results by property classification. 'residential': dwellings including houses, flats, and HMOs. 'commercial': non-residential premises such as offices, retail, and warehouses. 'all': no filter, returns all address types. Defaults to 'residential'.
|
|
18
19
|
*/
|
|
19
20
|
export type Classification = ClosedEnum<typeof Classification>;
|
|
20
21
|
|
|
22
|
+
/**
|
|
23
|
+
* Geographic ranking mode (only applies when `lat` and `lng` are both supplied):
|
|
24
|
+
*
|
|
25
|
+
* @remarks
|
|
26
|
+
* - `bias` (default): soft preference. Still returns the best textual matches, but ranks results near the centre point higher.
|
|
27
|
+
* - `restrict`: hard cutoff. Only returns results within `radius_meters` of the centre point (requires `radius_meters`).
|
|
28
|
+
* Applies to address-source results.
|
|
29
|
+
*/
|
|
30
|
+
export const GeoMode = {
|
|
31
|
+
Bias: "bias",
|
|
32
|
+
Restrict: "restrict",
|
|
33
|
+
} as const;
|
|
34
|
+
/**
|
|
35
|
+
* Geographic ranking mode (only applies when `lat` and `lng` are both supplied):
|
|
36
|
+
*
|
|
37
|
+
* @remarks
|
|
38
|
+
* - `bias` (default): soft preference. Still returns the best textual matches, but ranks results near the centre point higher.
|
|
39
|
+
* - `restrict`: hard cutoff. Only returns results within `radius_meters` of the centre point (requires `radius_meters`).
|
|
40
|
+
* Applies to address-source results.
|
|
41
|
+
*/
|
|
42
|
+
export type GeoMode = ClosedEnum<typeof GeoMode>;
|
|
43
|
+
|
|
21
44
|
export type SearchSuggestRequest = {
|
|
22
45
|
/**
|
|
23
|
-
* Filter address results by property classification. 'residential': dwellings including houses, flats, and HMOs. 'commercial': non-residential premises such as offices, retail, and warehouses. 'all': no filter
|
|
46
|
+
* Filter address results by property classification. 'residential': dwellings including houses, flats, and HMOs. 'commercial': non-residential premises such as offices, retail, and warehouses. 'all': no filter, returns all address types. Defaults to 'residential'.
|
|
24
47
|
*/
|
|
25
48
|
classification?: Classification | undefined;
|
|
49
|
+
/**
|
|
50
|
+
* Geographic ranking mode (only applies when `lat` and `lng` are both supplied):
|
|
51
|
+
*
|
|
52
|
+
* @remarks
|
|
53
|
+
* - `bias` (default): soft preference. Still returns the best textual matches, but ranks results near the centre point higher.
|
|
54
|
+
* - `restrict`: hard cutoff. Only returns results within `radius_meters` of the centre point (requires `radius_meters`).
|
|
55
|
+
* Applies to address-source results.
|
|
56
|
+
*/
|
|
57
|
+
geoMode?: GeoMode | undefined;
|
|
58
|
+
/**
|
|
59
|
+
* Latitude of a geographic centre point (WGS84 decimal degrees, -90 to 90). Must be supplied together with `lng`. Enables proximity-aware ranking of address results, most effective when combined with `source=address`.
|
|
60
|
+
*/
|
|
61
|
+
lat?: number | undefined;
|
|
26
62
|
/**
|
|
27
63
|
* Maximum number of results (1-100)
|
|
28
64
|
*/
|
|
29
65
|
limit?: string | undefined;
|
|
66
|
+
/**
|
|
67
|
+
* Longitude of a geographic centre point (WGS84 decimal degrees, -180 to 180). Must be supplied together with `lat`.
|
|
68
|
+
*/
|
|
69
|
+
lng?: number | undefined;
|
|
30
70
|
/**
|
|
31
71
|
* Number of results to skip for pagination
|
|
32
72
|
*/
|
|
@@ -35,6 +75,10 @@ export type SearchSuggestRequest = {
|
|
|
35
75
|
* Search query
|
|
36
76
|
*/
|
|
37
77
|
q: string;
|
|
78
|
+
/**
|
|
79
|
+
* Radius in metres from (`lat`, `lng`). Required when `geo_mode=restrict` (results outside the radius are excluded). When `geo_mode=bias`, it tunes the strength of the soft preference: the distance at which a result's textual score is roughly halved, and defaults to 10000 when omitted.
|
|
80
|
+
*/
|
|
81
|
+
radiusMeters?: number | undefined;
|
|
38
82
|
/**
|
|
39
83
|
* Filter results to specific search source (address or location)
|
|
40
84
|
*/
|
|
@@ -46,12 +90,20 @@ export const Classification$outboundSchema: z.ZodNativeEnum<
|
|
|
46
90
|
typeof Classification
|
|
47
91
|
> = z.nativeEnum(Classification);
|
|
48
92
|
|
|
93
|
+
/** @internal */
|
|
94
|
+
export const GeoMode$outboundSchema: z.ZodNativeEnum<typeof GeoMode> = z
|
|
95
|
+
.nativeEnum(GeoMode);
|
|
96
|
+
|
|
49
97
|
/** @internal */
|
|
50
98
|
export type SearchSuggestRequest$Outbound = {
|
|
51
99
|
classification?: string | undefined;
|
|
100
|
+
geo_mode?: string | undefined;
|
|
101
|
+
lat?: number | undefined;
|
|
52
102
|
limit?: string | undefined;
|
|
103
|
+
lng?: number | undefined;
|
|
53
104
|
offset?: string | undefined;
|
|
54
105
|
q: string;
|
|
106
|
+
radius_meters?: number | undefined;
|
|
55
107
|
source?: string | undefined;
|
|
56
108
|
};
|
|
57
109
|
|
|
@@ -62,10 +114,19 @@ export const SearchSuggestRequest$outboundSchema: z.ZodType<
|
|
|
62
114
|
SearchSuggestRequest
|
|
63
115
|
> = z.object({
|
|
64
116
|
classification: Classification$outboundSchema.optional(),
|
|
117
|
+
geoMode: GeoMode$outboundSchema.optional(),
|
|
118
|
+
lat: z.number().optional(),
|
|
65
119
|
limit: z.string().optional(),
|
|
120
|
+
lng: z.number().optional(),
|
|
66
121
|
offset: z.string().optional(),
|
|
67
122
|
q: z.string(),
|
|
123
|
+
radiusMeters: z.number().int().optional(),
|
|
68
124
|
source: z.string().optional(),
|
|
125
|
+
}).transform((v) => {
|
|
126
|
+
return remap$(v, {
|
|
127
|
+
geoMode: "geo_mode",
|
|
128
|
+
radiusMeters: "radius_meters",
|
|
129
|
+
});
|
|
69
130
|
});
|
|
70
131
|
|
|
71
132
|
export function searchSuggestRequestToJSON(
|
|
@@ -217,6 +217,7 @@ export * from "./personsummary.js";
|
|
|
217
217
|
export * from "./planningagent.js";
|
|
218
218
|
export * from "./planningapplicant.js";
|
|
219
219
|
export * from "./planningapplication.js";
|
|
220
|
+
export * from "./planningclassificationreasoning.js";
|
|
220
221
|
export * from "./planningconsideration.js";
|
|
221
222
|
export * from "./planningconstraint.js";
|
|
222
223
|
export * from "./planningconsulteeresponse.js";
|
|
@@ -229,6 +230,7 @@ export * from "./planningdevelopmentextraction.js";
|
|
|
229
230
|
export * from "./planningdevelopmentextractionenvelope.js";
|
|
230
231
|
export * from "./planningdocument.js";
|
|
231
232
|
export * from "./planningextractioncoverage.js";
|
|
233
|
+
export * from "./planningimage.js";
|
|
232
234
|
export * from "./planninglistresponse.js";
|
|
233
235
|
export * from "./planningofficerassessmentextraction.js";
|
|
234
236
|
export * from "./planningofficerassessmentextractionenvelope.js";
|
|
@@ -242,6 +244,7 @@ export * from "./plannings106extractionenvelope.js";
|
|
|
242
244
|
export * from "./plannings106financialobligation.js";
|
|
243
245
|
export * from "./plannings106nonfinancialobligation.js";
|
|
244
246
|
export * from "./plannings106party.js";
|
|
247
|
+
export * from "./planningsemanticchunk.js";
|
|
245
248
|
export * from "./planningstatushistory.js";
|
|
246
249
|
export * from "./pointcategorystats.js";
|
|
247
250
|
export * from "./pointcategorystatslistresponse.js";
|