@vepler/sdk 2.39.0 → 2.45.0

package/dist/esm/sdk/models/operations/searchplanningpolicy.d.ts

@@ -0,0 +1,123 @@
+import * as z from "zod/v3";
+import { ClosedEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+/**
+ * Filter by rule type
+ */
+export declare const RuleType: {
+    readonly Requirement: "requirement";
+    readonly Guideline: "guideline";
+    readonly Standard: "standard";
+    readonly Threshold: "threshold";
+    readonly Procedure: "procedure";
+    readonly Definition: "definition";
+    readonly Exemption: "exemption";
+};
+/**
+ * Filter by rule type
+ */
+export type RuleType = ClosedEnum<typeof RuleType>;
+/**
+ * Filter by source type
+ */
+export declare const SourceType: {
+    readonly NationalFramework: "national_framework";
+    readonly LocalPlan: "local_plan";
+    readonly SupplementaryPlanningDocument: "supplementary_planning_document";
+    readonly DesignGuide: "design_guide";
+    readonly NeighbourhoodPlan: "neighbourhood_plan";
+};
+/**
+ * Filter by source type
+ */
+export type SourceType = ClosedEnum<typeof SourceType>;
+export type SearchPlanningPolicyRequest = {
+    council?: string | undefined;
+    limit?: number | undefined;
+    q: string;
+    /**
+     * Filter by rule type
+     */
+    ruleType?: RuleType | undefined;
+    /**
+     * Filter by source type
+     */
+    sourceType?: SourceType | undefined;
+};
+export type Meta = {
+    query: string;
+    searchTimeMs: number;
+    total: number;
+};
+export type Two = {
+    content: string;
+    contextSummary: string | null;
+    id: string;
+    pageEnd: number | null;
+    pageStart: number | null;
+    score: number;
+    sectionPath: Array<string> | null;
+    source: string;
+    type: "chunk";
+};
+export type Provenance = {
+    chapter?: string | undefined;
+    page?: number | undefined;
+    paragraph?: string | undefined;
+    section?: string | undefined;
+    source: string;
+    url?: string | undefined;
+};
+export type One = {
+    category: string | null;
+    confidence: number | null;
+    id: string;
+    provenance: Provenance;
+    ruleText: string;
+    ruleType: string;
+    score: number;
+    type: "rule";
+};
+export type Results = One | Two;
+/**
+ * Search results
+ */
+export type SearchPlanningPolicyResponseBody = {
+    meta: Meta;
+    results: Array<One | Two>;
+};
+/** @internal */
+export declare const RuleType$outboundSchema: z.ZodNativeEnum<typeof RuleType>;
+/** @internal */
+export declare const SourceType$outboundSchema: z.ZodNativeEnum<typeof SourceType>;
+/** @internal */
+export type SearchPlanningPolicyRequest$Outbound = {
+    council?: string | undefined;
+    limit: number;
+    q: string;
+    rule_type?: string | undefined;
+    source_type?: string | undefined;
+};
+/** @internal */
+export declare const SearchPlanningPolicyRequest$outboundSchema: z.ZodType<SearchPlanningPolicyRequest$Outbound, z.ZodTypeDef, SearchPlanningPolicyRequest>;
+export declare function searchPlanningPolicyRequestToJSON(searchPlanningPolicyRequest: SearchPlanningPolicyRequest): string;
+/** @internal */
+export declare const Meta$inboundSchema: z.ZodType<Meta, z.ZodTypeDef, unknown>;
+export declare function metaFromJSON(jsonString: string): SafeParseResult<Meta, SDKValidationError>;
+/** @internal */
+export declare const Two$inboundSchema: z.ZodType<Two, z.ZodTypeDef, unknown>;
+export declare function twoFromJSON(jsonString: string): SafeParseResult<Two, SDKValidationError>;
+/** @internal */
+export declare const Provenance$inboundSchema: z.ZodType<Provenance, z.ZodTypeDef, unknown>;
+export declare function provenanceFromJSON(jsonString: string): SafeParseResult<Provenance, SDKValidationError>;
+/** @internal */
+export declare const One$inboundSchema: z.ZodType<One, z.ZodTypeDef, unknown>;
+export declare function oneFromJSON(jsonString: string): SafeParseResult<One, SDKValidationError>;
+/** @internal */
+export declare const Results$inboundSchema: z.ZodType<Results, z.ZodTypeDef, unknown>;
+export declare function resultsFromJSON(jsonString: string): SafeParseResult<Results, SDKValidationError>;
+/** @internal */
+export declare const SearchPlanningPolicyResponseBody$inboundSchema: z.ZodType<SearchPlanningPolicyResponseBody, z.ZodTypeDef, unknown>;
+export declare function searchPlanningPolicyResponseBodyFromJSON(jsonString: string): SafeParseResult<SearchPlanningPolicyResponseBody, SDKValidationError>;
+//# sourceMappingURL=searchplanningpolicy.d.ts.map

package/dist/esm/sdk/models/operations/searchplanningpolicy.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"searchplanningpolicy.d.ts","sourceRoot":"","sources":["../../../../../src/sdk/models/operations/searchplanningpolicy.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;AAErE;;GAEG;AACH,eAAO,MAAM,QAAQ;;;;;;;;CAQX,CAAC;AACX;;GAEG;AACH,MAAM,MAAM,QAAQ,GAAG,UAAU,CAAC,OAAO,QAAQ,CAAC,CAAC;AAEnD;;GAEG;AACH,eAAO,MAAM,UAAU;;;;;;CAMb,CAAC;AACX;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG,UAAU,CAAC,OAAO,UAAU,CAAC,CAAC;AAEvD,MAAM,MAAM,2BAA2B,GAAG;IACxC,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC7B,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC3B,CAAC,EAAE,MAAM,CAAC;IACV;;OAEG;IACH,QAAQ,CAAC,EAAE,QAAQ,GAAG,SAAS,CAAC;IAChC;;OAEG;IACH,UAAU,CAAC,EAAE,UAAU,GAAG,SAAS,CAAC;CACrC,CAAC;AAEF,MAAM,MAAM,IAAI,GAAG;IACjB,KAAK,EAAE,MAAM,CAAC;IACd,YAAY,EAAE,MAAM,CAAC;IACrB,KAAK,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,MAAM,MAAM,GAAG,GAAG;IAChB,OAAO,EAAE,MAAM,CAAC;IAChB,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;IAClC,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,OAAO,CAAC;CACf,CAAC;AAEF,MAAM,MAAM,UAAU,GAAG;IACvB,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC7B,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC1B,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC/B,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC7B,MAAM,EAAE,MAAM,CAAC;IACf,GAAG,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAC1B,CAAC;AAEF,MAAM,MAAM,GAAG,GAAG;IAChB,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,EAAE,EAAE,MAAM,CAAC;IACX,UAAU,EAAE,UAAU,CAAC;IACvB,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;CACd,CAAC;AAEF,MAAM,MAAM,OAAO,GAAG,GAAG,GAAG,GAAG,CAAC;AAEhC;;GAEG;AACH,MAAM,MAAM,gCAAgC,GAAG;IAC7C,IAAI,EAAE,IAAI,CAAC;IACX,OAAO,EAAE,KAAK,CAAC,GAAG,GAAG,GAAG,CAAC,CAAC;CAC3B,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,uBAAuB,EAAE,CAAC,CAAC,aAAa,CAAC,OAAO,QAAQ,CAC9C,CAAC;AAExB,gBAAgB;AAChB,eAAO,MAAM,yBAAyB,EAAE,CAAC,CAAC,aAAa,CAAC,OAAO,UAAU,CAChD,CAAC;AAE1B,gBAAgB;AAChB,MAAM,MAAM,oCAAoC,GAAG;IACjD,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC7B,KAAK,EAAE,MAAM,CAAC;IACd,CAAC,EAAE,MAAM,CAAC;IACV,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC/B,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAClC,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,0CAA0C,EAAE,CAAC,CAAC,OAAO,CAChE,oCAAoC,EACpC,CAAC,CAAC,UAAU,EACZ,2BAA2B,CAY3B,CAAC;AAEH,wBAAgB,iCAAiC,CAC/C,2BAA2B,EAAE,2BAA2B,GACvD,MAAM,CAMR;AAED,gBAAgB;AAChB,eAAO,MAAM,kBAAkB,EAAE,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC,UAAU,EAAE,OAAO,CAKlE,CAAC;AAEL,wBAAgB,YAAY,CAC1B,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,IAAI,EAAE,kBAAkB,CAAC,CAM3C;AAED,gBAAgB;AAChB,eAAO,MAAM,iBAAiB,EAAE,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,CAAC,UAAU,EAAE,OAAO,CAWhE,CAAC;AAEL,wBAAgB,WAAW,CACzB,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,GAAG,EAAE,kBAAkB,CAAC,CAM1C;AAED,gBAAgB;AAChB,eAAO,MAAM,wBAAwB,EAAE,CAAC,CAAC,OAAO,CAC9C,UAAU,EACV,CAAC,CAAC,UAAU,EACZ,OAAO,CAQP,CAAC;AAEH,wBAAgB,kBAAkB,CAChC,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,UAAU,EAAE,kBAAkB,CAAC,CAMjD;AAED,gBAAgB;AAChB,eAAO,MAAM,iBAAiB,EAAE,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,CAAC,UAAU,EAAE,OAAO,CAUhE,CAAC;AAEL,wBAAgB,WAAW,CACzB,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,GAAG,EAAE,kBAAkB,CAAC,CAM1C;AAED,gBAAgB;AAChB,eAAO,MAAM,qBAAqB,EAAE,CAAC,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC,UAAU,EAAE,OAAO,CACC,CAAC;AAE9E,wBAAgB,eAAe,CAC7B,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,OAAO,EAAE,kBAAkB,CAAC,CAM9C;AAED,gBAAgB;AAChB,eAAO,MAAM,8CAA8C,EAAE,CAAC,CAAC,OAAO,CACpE,gCAAgC,EAChC,CAAC,CAAC,UAAU,EACZ,OAAO,CAMP,CAAC;AAEH,wBAAgB,wCAAwC,CACtD,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,gCAAgC,EAAE,kBAAkB,CAAC,CAMvE"}

package/dist/esm/sdk/models/operations/searchplanningpolicy.js

@@ -0,0 +1,117 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../../lib/primitives.js";
+import { safeParse } from "../../../lib/schemas.js";
+/**
+ * Filter by rule type
+ */
+export const RuleType = {
+    Requirement: "requirement",
+    Guideline: "guideline",
+    Standard: "standard",
+    Threshold: "threshold",
+    Procedure: "procedure",
+    Definition: "definition",
+    Exemption: "exemption",
+};
+/**
+ * Filter by source type
+ */
+export const SourceType = {
+    NationalFramework: "national_framework",
+    LocalPlan: "local_plan",
+    SupplementaryPlanningDocument: "supplementary_planning_document",
+    DesignGuide: "design_guide",
+    NeighbourhoodPlan: "neighbourhood_plan",
+};
+/** @internal */
+export const RuleType$outboundSchema = z
+    .nativeEnum(RuleType);
+/** @internal */
+export const SourceType$outboundSchema = z
+    .nativeEnum(SourceType);
+/** @internal */
+export const SearchPlanningPolicyRequest$outboundSchema = z.object({
+    council: z.string().optional(),
+    limit: z.number().int().default(10),
+    q: z.string(),
+    ruleType: RuleType$outboundSchema.optional(),
+    sourceType: SourceType$outboundSchema.optional(),
+}).transform((v) => {
+    return remap$(v, {
+        ruleType: "rule_type",
+        sourceType: "source_type",
+    });
+});
+export function searchPlanningPolicyRequestToJSON(searchPlanningPolicyRequest) {
+    return JSON.stringify(SearchPlanningPolicyRequest$outboundSchema.parse(searchPlanningPolicyRequest));
+}
+/** @internal */
+export const Meta$inboundSchema = z
+    .object({
+    query: z.string(),
+    searchTimeMs: z.number(),
+    total: z.number(),
+});
+export function metaFromJSON(jsonString) {
+    return safeParse(jsonString, (x) => Meta$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'Meta' from JSON`);
+}
+/** @internal */
+export const Two$inboundSchema = z
+    .object({
+    content: z.string(),
+    contextSummary: z.nullable(z.string()),
+    id: z.string(),
+    pageEnd: z.nullable(z.number()),
+    pageStart: z.nullable(z.number()),
+    score: z.number(),
+    sectionPath: z.nullable(z.array(z.string())),
+    source: z.string(),
+    type: z.literal("chunk"),
+});
+export function twoFromJSON(jsonString) {
+    return safeParse(jsonString, (x) => Two$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'Two' from JSON`);
+}
+/** @internal */
+export const Provenance$inboundSchema = z.object({
+    chapter: z.string().optional(),
+    page: z.number().optional(),
+    paragraph: z.string().optional(),
+    section: z.string().optional(),
+    source: z.string(),
+    url: z.string().optional(),
+});
+export function provenanceFromJSON(jsonString) {
+    return safeParse(jsonString, (x) => Provenance$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'Provenance' from JSON`);
+}
+/** @internal */
+export const One$inboundSchema = z
+    .object({
+    category: z.nullable(z.string()),
+    confidence: z.nullable(z.number()),
+    id: z.string(),
+    provenance: z.lazy(() => Provenance$inboundSchema),
+    ruleText: z.string(),
+    ruleType: z.string(),
+    score: z.number(),
+    type: z.literal("rule"),
+});
+export function oneFromJSON(jsonString) {
+    return safeParse(jsonString, (x) => One$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'One' from JSON`);
+}
+/** @internal */
+export const Results$inboundSchema = z.union([z.lazy(() => One$inboundSchema), z.lazy(() => Two$inboundSchema)]);
+export function resultsFromJSON(jsonString) {
+    return safeParse(jsonString, (x) => Results$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'Results' from JSON`);
+}
+/** @internal */
+export const SearchPlanningPolicyResponseBody$inboundSchema = z.object({
+    meta: z.lazy(() => Meta$inboundSchema),
+    results: z.array(z.union([z.lazy(() => One$inboundSchema), z.lazy(() => Two$inboundSchema)])),
+});
+export function searchPlanningPolicyResponseBodyFromJSON(jsonString) {
+    return safeParse(jsonString, (x) => SearchPlanningPolicyResponseBody$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'SearchPlanningPolicyResponseBody' from JSON`);
+}
+//# sourceMappingURL=searchplanningpolicy.js.map

package/dist/esm/sdk/models/operations/searchplanningpolicy.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"searchplanningpolicy.js","sourceRoot":"","sources":["../../../../../src/sdk/models/operations/searchplanningpolicy.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;AAKpD;;GAEG;AACH,MAAM,CAAC,MAAM,QAAQ,GAAG;IACtB,WAAW,EAAE,aAAa;IAC1B,SAAS,EAAE,WAAW;IACtB,QAAQ,EAAE,UAAU;IACpB,SAAS,EAAE,WAAW;IACtB,SAAS,EAAE,WAAW;IACtB,UAAU,EAAE,YAAY;IACxB,SAAS,EAAE,WAAW;CACd,CAAC;AAMX;;GAEG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG;IACxB,iBAAiB,EAAE,oBAAoB;IACvC,SAAS,EAAE,YAAY;IACvB,6BAA6B,EAAE,iCAAiC;IAChE,WAAW,EAAE,cAAc;IAC3B,iBAAiB,EAAE,oBAAoB;CAC/B,CAAC;AAoEX,gBAAgB;AAChB,MAAM,CAAC,MAAM,uBAAuB,GAAqC,CAAC;KACvE,UAAU,CAAC,QAAQ,CAAC,CAAC;AAExB,gBAAgB;AAChB,MAAM,CAAC,MAAM,yBAAyB,GAAuC,CAAC;KAC3E,UAAU,CAAC,UAAU,CAAC,CAAC;AAW1B,gBAAgB;AAChB,MAAM,CAAC,MAAM,0CAA0C,GAInD,CAAC,CAAC,MAAM,CAAC;IACX,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC9B,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,EAAE,CAAC;IACnC,CAAC,EAAE,CAAC,CAAC,MAAM,EAAE;IACb,QAAQ,EAAE,uBAAuB,CAAC,QAAQ,EAAE;IAC5C,UAAU,EAAE,yBAAyB,CAAC,QAAQ,EAAE;CACjD,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE;IACjB,OAAO,MAAM,CAAC,CAAC,EAAE;QACf,QAAQ,EAAE,WAAW;QACrB,UAAU,EAAE,aAAa;KAC1B,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,MAAM,UAAU,iCAAiC,CAC/C,2BAAwD;IAExD,OAAO,IAAI,CAAC,SAAS,CACnB,0CAA0C,CAAC,KAAK,CAC9C,2BAA2B,CAC5B,CACF,CAAC;AACJ,CAAC;AAED,gBAAgB;AAChB,MAAM,CAAC,MAAM,kBAAkB,GAA2C,CAAC;KACxE,MAAM,CAAC;IACN,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;IACjB,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE;IACxB,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;CAClB,CAAC,CAAC;AAEL,MAAM,UAAU,YAAY,CAC1B,UAAkB;IAElB,OAAO,SAAS,CACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,kBAAkB,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAC9C,kCAAkC,CACnC,CAAC;AACJ,CAAC;AAED,gBAAgB;AAChB,MAAM,CAAC,MAAM,iBAAiB,GAA0C,CAAC;KACtE,MAAM,CAAC;IACN,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE;IACnB,cAAc,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;IACtC,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE;IACd,OAAO,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;IAC/B,SAAS,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;IACjC,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;IACjB,WAAW,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC;IAC5C,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE;IAClB,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC;CACzB,CAAC,CAAC;AAEL,MAAM,UAAU,WAAW,CACzB,UAAkB;IAElB,OAAO,SAAS,CACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,iBAAiB,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAC7C,iCAAiC,CAClC,CAAC;AACJ,CAAC;AAED,gBAAgB;AAChB,MAAM,CAAC,MAAM,wBAAwB,GAIjC,CAAC,CAAC,MAAM,CAAC;IACX,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC9B,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC3B,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAChC,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC9B,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE;IAClB,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CAC3B,CAAC,CAAC;AAEH,MAAM,UAAU,kBAAkB,CAChC,UAAkB;IAElB,OAAO,SAAS,CACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,wBAAwB,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EACpD,wCAAwC,CACzC,CAAC;AACJ,CAAC;AAED,gBAAgB;AAChB,MAAM,CAAC,MAAM,iBAAiB,GAA0C,CAAC;KACtE,MAAM,CAAC;IACN,QAAQ,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;IAChC,UAAU,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;IAClC,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE;IACd,UAAU,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,wBAAwB,CAAC;IAClD,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE;IACpB,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE;IACpB,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;IACjB,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC;CACxB,CAAC,CAAC;AAEL,MAAM,UAAU,WAAW,CACzB,UAAkB;IAElB,OAAO,SAAS,CACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,iBAAiB,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAC7C,iCAAiC,CAClC,CAAC;AACJ,CAAC;AAED,gBAAgB;AAChB,MAAM,CAAC,MAAM,qBAAqB,GAChC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,iBAAiB,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC;AAE9E,MAAM,UAAU,eAAe,CAC7B,UAAkB;IAElB,OAAO,SAAS,CACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,qBAAqB,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EACjD,qCAAqC,CACtC,CAAC;AACJ,CAAC;AAED,gBAAgB;AAChB,MAAM,CAAC,MAAM,8CAA8C,GAIvD,CAAC,CAAC,MAAM,CAAC;IACX,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,kBAAkB,CAAC;IACtC,OAAO,EAAE,CAAC,CAAC,KAAK,CACd,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,iBAAiB,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAC5E;CACF,CAAC,CAAC;AAEH,MAAM,UAAU,wCAAwC,CACtD,UAAkB;IAElB,OAAO,SAAS,CACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,8CAA8C,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAC1E,8DAA8D,CAC/D,CAAC;AACJ,CAAC"}

package/dist/esm/sdk/models/operations/searchsubstations.d.ts

@@ -0,0 +1,198 @@
+import * as z from "zod/v3";
+import { ClosedEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+export type SearchSubstationsSearchSubstationsInput = {
+    /**
+     * Filter by country code
+     */
+    country?: string | undefined;
+    /**
+     * Maximum number of results to return
+     */
+    limit?: number | undefined;
+    /**
+     * Maximum demand headroom in MW
+     */
+    maxDemandHeadroomMw?: number | null | undefined;
+    /**
+     * Minimum demand headroom in MW
+     */
+    minDemandHeadroomMw?: number | null | undefined;
+    /**
+     * Minimum generation headroom in MW
+     */
+    minGenerationHeadroomMw?: number | null | undefined;
+    /**
+     * Number of results to skip for pagination
+     */
+    offset?: number | null | undefined;
+    /**
+     * Filter by operating region name
+     */
+    operatingRegion?: string | undefined;
+    /**
+     * Filter by network operator code
+     */
+    operator?: string | undefined;
+    /**
+     * Filter by substation type
+     */
+    substationType?: string | undefined;
+};
+/**
+ * WGS84 coordinate pair
+ */
+export type SearchSubstationsCoordinates = {
+    /**
+     * Latitude in decimal degrees
+     */
+    lat: number;
+    /**
+     * Longitude in decimal degrees
+     */
+    lng: number;
+};
+/**
+ * Object type identifier
+ */
+export declare const SearchSubstationsEnergyObject: {
+    readonly Substation: "substation";
+};
+/**
+ * Object type identifier
+ */
+export type SearchSubstationsEnergyObject = ClosedEnum<typeof SearchSubstationsEnergyObject>;
+/**
+ * A network operator substation with its current capacity and headroom data
+ */
+export type SearchSubstationsSubstation = {
+    /**
+     * Unique substation identifier, prefixed with the operator code
+     */
+    code: string;
+    /**
+     * ISO 3166-1 alpha-2 country code
+     */
+    country: string;
+    /**
+     * Available spare capacity for new demand connections, in megawatts (MW). Calculated as firm capacity minus peak demand
+     */
+    demandHeadroomMw: number | null;
+    /**
+     * Current peak electricity demand at this substation, in megawatts (MW)
+     */
+    demandMw: number | null;
+    /**
+     * Maximum firm capacity rating, in megawatts (MW). This is the guaranteed capacity available under all operating conditions
+     */
+    firmCapacityMw: number | null;
+    /**
+     * Available spare capacity for new generation connections (e.g. solar, wind), in megawatts (MW)
+     */
+    generationHeadroomMw: number | null;
+    /**
+     * WGS84 coordinate pair
+     */
+    location: SearchSubstationsCoordinates | null;
+    /**
+     * Human-readable substation name, where available
+     */
+    name: string | null;
+    /**
+     * Object type identifier
+     */
+    object: SearchSubstationsEnergyObject;
+    /**
+     * Operating region name (e.g. 'UKPN (SPN)' in GB, or region name in other countries)
+     */
+    operatingRegion: string | null;
+    /**
+     * Network operator identifier. Known values include: 'ukpn', 'npg', 'nged', 'ssen', 'spen', 'enw', 'neso'. New operators can be added without code changes.
+     */
+    operator: string;
+    /**
+     * Code of the parent substation in the network hierarchy (e.g. a primary's parent grid substation). Null for top-level GSPs
+     */
+    parentSubstationCode: string | null;
+    /**
+     * Maximum capacity for reverse power flow (generation exceeding local demand), in megawatts (MW)
+     */
+    reversePowerCapacityMw: number | null;
+    /**
+     * Classification of substation within the electricity network hierarchy. Known values: 'gsp', 'bulk_supply', 'grid', 'primary', 'distribution'. 'gsp' (Grid Supply Point) connects to the national transmission grid. 'bulk_supply' and 'grid' operate at intermediate voltages. 'primary' steps down to 11kV for local distribution. 'distribution' serves end customers at low voltage.
+     */
+    substationType: string | null;
+    /**
+     * Current utilisation as a percentage of firm capacity. Higher values indicate less available headroom
+     */
+    utilisationPct: number | null;
+    /**
+     * Operating voltage, in kilovolts (kV)
+     */
+    voltageKv: number | null;
+};
+/**
+ * Object type identifier
+ */
+export declare const SearchSubstationsObject: {
+    readonly List: "list";
+};
+/**
+ * Object type identifier
+ */
+export type SearchSubstationsObject = ClosedEnum<typeof SearchSubstationsObject>;
+/**
+ * Paginated list response
+ */
+export type SearchSubstationsResponseBody = {
+    /**
+     * Array of items
+     */
+    data: Array<SearchSubstationsSubstation>;
+    /**
+     * Whether more items exist
+     */
+    hasMore: boolean;
+    /**
+     * Object type identifier
+     */
+    object: SearchSubstationsObject;
+    /**
+     * Total number of items available
+     */
+    totalCount?: number | undefined;
+    /**
+     * URL of the request
+     */
+    url: string;
+};
+/** @internal */
+export type SearchSubstationsSearchSubstationsInput$Outbound = {
+    country?: string | undefined;
+    limit: number;
+    maxDemandHeadroomMw?: number | null | undefined;
+    minDemandHeadroomMw?: number | null | undefined;
+    minGenerationHeadroomMw?: number | null | undefined;
+    offset: number | null;
+    operatingRegion?: string | undefined;
+    operator?: string | undefined;
+    substationType?: string | undefined;
+};
+/** @internal */
+export declare const SearchSubstationsSearchSubstationsInput$outboundSchema: z.ZodType<SearchSubstationsSearchSubstationsInput$Outbound, z.ZodTypeDef, SearchSubstationsSearchSubstationsInput>;
+export declare function searchSubstationsSearchSubstationsInputToJSON(searchSubstationsSearchSubstationsInput: SearchSubstationsSearchSubstationsInput): string;
+/** @internal */
+export declare const SearchSubstationsCoordinates$inboundSchema: z.ZodType<SearchSubstationsCoordinates, z.ZodTypeDef, unknown>;
+export declare function searchSubstationsCoordinatesFromJSON(jsonString: string): SafeParseResult<SearchSubstationsCoordinates, SDKValidationError>;
+/** @internal */
+export declare const SearchSubstationsEnergyObject$inboundSchema: z.ZodNativeEnum<typeof SearchSubstationsEnergyObject>;
+/** @internal */
+export declare const SearchSubstationsSubstation$inboundSchema: z.ZodType<SearchSubstationsSubstation, z.ZodTypeDef, unknown>;
+export declare function searchSubstationsSubstationFromJSON(jsonString: string): SafeParseResult<SearchSubstationsSubstation, SDKValidationError>;
+/** @internal */
+export declare const SearchSubstationsObject$inboundSchema: z.ZodNativeEnum<typeof SearchSubstationsObject>;
+/** @internal */
+export declare const SearchSubstationsResponseBody$inboundSchema: z.ZodType<SearchSubstationsResponseBody, z.ZodTypeDef, unknown>;
+export declare function searchSubstationsResponseBodyFromJSON(jsonString: string): SafeParseResult<SearchSubstationsResponseBody, SDKValidationError>;
+//# sourceMappingURL=searchsubstations.d.ts.map

package/dist/esm/sdk/models/operations/searchsubstations.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"searchsubstations.d.ts","sourceRoot":"","sources":["../../../../../src/sdk/models/operations/searchsubstations.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;AAErE,MAAM,MAAM,uCAAuC,GAAG;IACpD;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC7B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC3B;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IAChD;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IAChD;;OAEG;IACH,uBAAuB,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IACpD;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IACnC;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACrC;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC9B;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CACrC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,4BAA4B,GAAG;IACzC;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IACZ;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;CACb,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,6BAA6B;;CAEhC,CAAC;AACX;;GAEG;AACH,MAAM,MAAM,6BAA6B,GAAG,UAAU,CACpD,OAAO,6BAA6B,CACrC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,2BAA2B,GAAG;IACxC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,gBAAgB,EAAE,MAAM,GAAG,IAAI,CAAC;IAChC;;OAEG;IACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB;;OAEG;IACH,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B;;OAEG;IACH,oBAAoB,EAAE,MAAM,GAAG,IAAI,CAAC;IACpC;;OAEG;IACH,QAAQ,EAAE,4BAA4B,GAAG,IAAI,CAAC;IAC9C;;OAEG;IACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IACpB;;OAEG;IACH,MAAM,EAAE,6BAA6B,CAAC;IACtC;;OAEG;IACH,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/B;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,oBAAoB,EAAE,MAAM,GAAG,IAAI,CAAC;IACpC;;OAEG;IACH,sBAAsB,EAAE,MAAM,GAAG,IAAI,CAAC;IACtC;;OAEG;IACH,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B;;OAEG;IACH,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B;;OAEG;IACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;CAC1B,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,uBAAuB;;CAE1B,CAAC;AACX;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAAG,UAAU,CAC9C,OAAO,uBAAuB,CAC/B,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,6BAA6B,GAAG;IAC1C;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,2BAA2B,CAAC,CAAC;IACzC;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IACjB;;OAEG;IACH,MAAM,EAAE,uBAAuB,CAAC;IAChC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAChC;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;CACb,CAAC;AAEF,gBAAgB;AAChB,MAAM,MAAM,gDAAgD,GAAG;IAC7D,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC7B,KAAK,EAAE,MAAM,CAAC;IACd,mBAAmB,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IAChD,mBAAmB,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IAChD,uBAAuB,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IACpD,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,eAAe,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACrC,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC9B,cAAc,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CACrC,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,sDAAsD,EAAE,CAAC,CAAC,OAAO,CAC5E,gDAAgD,EAChD,CAAC,CAAC,UAAU,EACZ,uCAAuC,CAWvC,CAAC;AAEH,wBAAgB,6CAA6C,CAC3D,uCAAuC,EACrC,uCAAuC,GACxC,MAAM,CAMR;AAED,gBAAgB;AAChB,eAAO,MAAM,0CAA0C,EAAE,CAAC,CAAC,OAAO,CAChE,4BAA4B,EAC5B,CAAC,CAAC,UAAU,EACZ,OAAO,CAIP,CAAC;AAEH,wBAAgB,oCAAoC,CAClD,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,4BAA4B,EAAE,kBAAkB,CAAC,CAMnE;AAED,gBAAgB;AAChB,eAAO,MAAM,2CAA2C,EAAE,CAAC,CAAC,aAAa,CACvE,OAAO,6BAA6B,CACS,CAAC;AAEhD,gBAAgB;AAChB,eAAO,MAAM,yCAAyC,EAAE,CAAC,CAAC,OAAO,CAC/D,2BAA2B,EAC3B,CAAC,CAAC,UAAU,EACZ,OAAO,CAoBP,CAAC;AAEH,wBAAgB,mCAAmC,CACjD,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,2BAA2B,EAAE,kBAAkB,CAAC,CAMlE;AAED,gBAAgB;AAChB,eAAO,MAAM,qCAAqC,EAAE,CAAC,CAAC,aAAa,CACjE,OAAO,uBAAuB,CACS,CAAC;AAE1C,gBAAgB;AAChB,eAAO,MAAM,2CAA2C,EAAE,CAAC,CAAC,OAAO,CACjE,6BAA6B,EAC7B,CAAC,CAAC,UAAU,EACZ,OAAO,CAYP,CAAC;AAEH,wBAAgB,qCAAqC,CACnD,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,6BAA6B,EAAE,kBAAkB,CAAC,CAMpE"}

package/dist/esm/sdk/models/operations/searchsubstations.js

@@ -0,0 +1,84 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../../lib/primitives.js";
+import { safeParse } from "../../../lib/schemas.js";
+/**
+ * Object type identifier
+ */
+export const SearchSubstationsEnergyObject = {
+    Substation: "substation",
+};
+/**
+ * Object type identifier
+ */
+export const SearchSubstationsObject = {
+    List: "list",
+};
+/** @internal */
+export const SearchSubstationsSearchSubstationsInput$outboundSchema = z.object({
+    country: z.string().optional(),
+    limit: z.number().default(100),
+    maxDemandHeadroomMw: z.nullable(z.number()).optional(),
+    minDemandHeadroomMw: z.nullable(z.number()).optional(),
+    minGenerationHeadroomMw: z.nullable(z.number()).optional(),
+    offset: z.nullable(z.number().default(0)),
+    operatingRegion: z.string().optional(),
+    operator: z.string().optional(),
+    substationType: z.string().optional(),
+});
+export function searchSubstationsSearchSubstationsInputToJSON(searchSubstationsSearchSubstationsInput) {
+    return JSON.stringify(SearchSubstationsSearchSubstationsInput$outboundSchema.parse(searchSubstationsSearchSubstationsInput));
+}
+/** @internal */
+export const SearchSubstationsCoordinates$inboundSchema = z.object({
+    lat: z.number(),
+    lng: z.number(),
+});
+export function searchSubstationsCoordinatesFromJSON(jsonString) {
+    return safeParse(jsonString, (x) => SearchSubstationsCoordinates$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'SearchSubstationsCoordinates' from JSON`);
+}
+/** @internal */
+export const SearchSubstationsEnergyObject$inboundSchema = z.nativeEnum(SearchSubstationsEnergyObject);
+/** @internal */
+export const SearchSubstationsSubstation$inboundSchema = z.object({
+    code: z.string(),
+    country: z.string(),
+    demandHeadroomMw: z.nullable(z.number()),
+    demandMw: z.nullable(z.number()),
+    firmCapacityMw: z.nullable(z.number()),
+    generationHeadroomMw: z.nullable(z.number()),
+    location: z.nullable(z.lazy(() => SearchSubstationsCoordinates$inboundSchema)),
+    name: z.nullable(z.string()),
+    object: SearchSubstationsEnergyObject$inboundSchema,
+    operatingRegion: z.nullable(z.string()),
+    operator: z.string(),
+    parentSubstationCode: z.nullable(z.string()),
+    reversePowerCapacityMw: z.nullable(z.number()),
+    substationType: z.nullable(z.string()),
+    utilisationPct: z.nullable(z.number()),
+    voltageKv: z.nullable(z.number()),
+});
+export function searchSubstationsSubstationFromJSON(jsonString) {
+    return safeParse(jsonString, (x) => SearchSubstationsSubstation$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'SearchSubstationsSubstation' from JSON`);
+}
+/** @internal */
+export const SearchSubstationsObject$inboundSchema = z.nativeEnum(SearchSubstationsObject);
+/** @internal */
+export const SearchSubstationsResponseBody$inboundSchema = z.object({
+    data: z.array(z.lazy(() => SearchSubstationsSubstation$inboundSchema)),
+    has_more: z.boolean(),
+    object: SearchSubstationsObject$inboundSchema,
+    total_count: z.number().optional(),
+    url: z.string(),
+}).transform((v) => {
+    return remap$(v, {
+        "has_more": "hasMore",
+        "total_count": "totalCount",
+    });
+});
+export function searchSubstationsResponseBodyFromJSON(jsonString) {
+    return safeParse(jsonString, (x) => SearchSubstationsResponseBody$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'SearchSubstationsResponseBody' from JSON`);
+}
+//# sourceMappingURL=searchsubstations.js.map

package/dist/esm/sdk/models/operations/searchsubstations.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"searchsubstations.js","sourceRoot":"","sources":["../../../../../src/sdk/models/operations/searchsubstations.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;AA0DpD;;GAEG;AACH,MAAM,CAAC,MAAM,6BAA6B,GAAG;IAC3C,UAAU,EAAE,YAAY;CAChB,CAAC;AA8EX;;GAEG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAG;IACrC,IAAI,EAAE,MAAM;CACJ,CAAC;AA+CX,gBAAgB;AAChB,MAAM,CAAC,MAAM,sDAAsD,GAI/D,CAAC,CAAC,MAAM,CAAC;IACX,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC9B,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC;IAC9B,mBAAmB,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;IACtD,mBAAmB,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;IACtD,uBAAuB,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;IAC1D,MAAM,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;IACzC,eAAe,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACtC,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC/B,cAAc,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CACtC,CAAC,CAAC;AAEH,MAAM,UAAU,6CAA6C,CAC3D,uCACyC;IAEzC,OAAO,IAAI,CAAC,SAAS,CACnB,sDAAsD,CAAC,KAAK,CAC1D,uCAAuC,CACxC,CACF,CAAC;AACJ,CAAC;AAED,gBAAgB;AAChB,MAAM,CAAC,MAAM,0CAA0C,GAInD,CAAC,CAAC,MAAM,CAAC;IACX,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE;IACf,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE;CAChB,CAAC,CAAC;AAEH,MAAM,UAAU,oCAAoC,CAClD,UAAkB;IAElB,OAAO,SAAS,CACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,0CAA0C,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EACtE,0DAA0D,CAC3D,CAAC;AACJ,CAAC;AAED,gBAAgB;AAChB,MAAM,CAAC,MAAM,2CAA2C,GAEpD,CAAC,CAAC,UAAU,CAAC,6BAA6B,CAAC,CAAC;AAEhD,gBAAgB;AAChB,MAAM,CAAC,MAAM,yCAAyC,GAIlD,CAAC,CAAC,MAAM,CAAC;IACX,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;IAChB,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE;IACnB,gBAAgB,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;IACxC,QAAQ,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;IAChC,cAAc,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;IACtC,oBAAoB,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;IAC5C,QAAQ,EAAE,CAAC,CAAC,QAAQ,CAClB,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,0CAA0C,CAAC,CACzD;IACD,IAAI,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;IAC5B,MAAM,EAAE,2CAA2C;IACnD,eAAe,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;IACvC,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE;IACpB,oBAAoB,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;IAC5C,sBAAsB,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;IAC9C,cAAc,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;IACtC,cAAc,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;IACtC,SAAS,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;CAClC,CAAC,CAAC;AAEH,MAAM,UAAU,mCAAmC,CACjD,UAAkB;IAElB,OAAO,SAAS,CACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,yCAAyC,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EACrE,yDAAyD,CAC1D,CAAC;AACJ,CAAC;AAED,gBAAgB;AAChB,MAAM,CAAC,MAAM,qCAAqC,GAE9C,CAAC,CAAC,UAAU,CAAC,uBAAuB,CAAC,CAAC;AAE1C,gBAAgB;AAChB,MAAM,CAAC,MAAM,2CAA2C,GAIpD,CAAC,CAAC,MAAM,CAAC;IACX,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,yCAAyC,CAAC,CAAC;IACtE,QAAQ,EAAE,CAAC,CAAC,OAAO,EAAE;IACrB,MAAM,EAAE,qCAAqC;IAC7C,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,qCAAqC,CACnD,UAAkB;IAElB,OAAO,SAAS,CACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,2CAA2C,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EACvE,2DAA2D,CAC5D,CAAC;AACJ,CAAC"}

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

@@ -0,0 +1,81 @@
+import * as z from "zod/v3";
+import { ClosedEnum } from "../../types/enums.js";
+/**
+ * Filter matched addresses 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'.
+ */
+export declare const Classification: {
+    readonly Residential: "residential";
+    readonly Commercial: "commercial";
+    readonly All: "all";
+};
+/**
+ * Filter matched addresses 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'.
+ */
+export type Classification = ClosedEnum<typeof Classification>;
+/**
+ * Optional matching configuration
+ */
+export type Options = {
+    /**
+     * Filter matched addresses 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'.
+     */
+    classification?: Classification | undefined;
+    /**
+     * Minimum confidence threshold for matches (0-100)
+     */
+    confidenceThreshold?: number | undefined;
+    /**
+     * Enable postcode-based fallback matching
+     */
+    enableFallback?: boolean | undefined;
+    /**
+     * Confidence threshold below which fallback matching is triggered
+     */
+    fallbackThreshold?: number | undefined;
+    /**
+     * Include detailed processing steps in response
+     */
+    includeProcessingDetails?: boolean | undefined;
+    /**
+     * Maximum number of results to return
+     */
+    maxResults?: number | undefined;
+    /**
+     * Request timeout in milliseconds
+     */
+    timeout?: number | undefined;
+};
+export type AddressResolveRequest = {
+    /**
+     * The address string to resolve
+     */
+    address: string;
+    /**
+     * Optional matching configuration
+     */
+    options?: Options | undefined;
+};
+/** @internal */
+export declare const Classification$outboundSchema: z.ZodNativeEnum<typeof Classification>;
+/** @internal */
+export type Options$Outbound = {
+    classification?: string | undefined;
+    confidenceThreshold?: number | undefined;
+    enableFallback?: boolean | undefined;
+    fallbackThreshold?: number | undefined;
+    includeProcessingDetails?: boolean | undefined;
+    maxResults?: number | undefined;
+    timeout?: number | undefined;
+};
+/** @internal */
+export declare const Options$outboundSchema: z.ZodType<Options$Outbound, z.ZodTypeDef, Options>;
+export declare function optionsToJSON(options: Options): string;
+/** @internal */
+export type AddressResolveRequest$Outbound = {
+    address: string;
+    options?: Options$Outbound | undefined;
+};
+/** @internal */
+export declare const AddressResolveRequest$outboundSchema: z.ZodType<AddressResolveRequest$Outbound, z.ZodTypeDef, AddressResolveRequest>;
+export declare function addressResolveRequestToJSON(addressResolveRequest: AddressResolveRequest): string;
+//# sourceMappingURL=addressresolverequest.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"addressresolverequest.d.ts","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/addressresolverequest.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAC5B,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAElD;;GAEG;AACH,eAAO,MAAM,cAAc;;;;CAIjB,CAAC;AACX;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG,UAAU,CAAC,OAAO,cAAc,CAAC,CAAC;AAE/D;;GAEG;AACH,MAAM,MAAM,OAAO,GAAG;IACpB;;OAEG;IACH,cAAc,CAAC,EAAE,cAAc,GAAG,SAAS,CAAC;IAC5C;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACzC;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IACrC;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACvC;;OAEG;IACH,wBAAwB,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAC/C;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAChC;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAC9B,CAAC;AAEF,MAAM,MAAM,qBAAqB,GAAG;IAClC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;CAC/B,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,6BAA6B,EAAE,CAAC,CAAC,aAAa,CACzD,OAAO,cAAc,CACS,CAAC;AAEjC,gBAAgB;AAChB,MAAM,MAAM,gBAAgB,GAAG;IAC7B,cAAc,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACpC,mBAAmB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACzC,cAAc,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IACrC,iBAAiB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACvC,wBAAwB,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAC/C,UAAU,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAChC,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAC9B,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,sBAAsB,EAAE,CAAC,CAAC,OAAO,CAC5C,gBAAgB,EAChB,CAAC,CAAC,UAAU,EACZ,OAAO,CASP,CAAC;AAEH,wBAAgB,aAAa,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAEtD;AAED,gBAAgB;AAChB,MAAM,MAAM,8BAA8B,GAAG;IAC3C,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,gBAAgB,GAAG,SAAS,CAAC;CACxC,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,oCAAoC,EAAE,CAAC,CAAC,OAAO,CAC1D,8BAA8B,EAC9B,CAAC,CAAC,UAAU,EACZ,qBAAqB,CAIrB,CAAC;AAEH,wBAAgB,2BAA2B,CACzC,qBAAqB,EAAE,qBAAqB,GAC3C,MAAM,CAIR"}