@vepler/sdk 2.164.0 → 3.0.0

package/dist/commonjs/sdk/models/shared/titleproprietor.js

@@ -0,0 +1,75 @@
+"use strict";
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TitleProprietor$inboundSchema = exports.EntityType$inboundSchema = exports.EntityType = void 0;
+exports.titleProprietorFromJSON = titleProprietorFromJSON;
+const z = __importStar(require("zod/v3"));
+const schemas_js_1 = require("../../../lib/schemas.js");
+const openEnums = __importStar(require("../../types/enums.js"));
+exports.EntityType = {
+    Individual: "individual",
+    LimitedCompany: "limited_company",
+    Llp: "llp",
+    CorporateBody: "corporate_body",
+    LocalAuthority: "local_authority",
+    CountyCouncil: "county_council",
+    RegisteredSociety: "registered_society",
+    HousingAssociation: "housing_association",
+    UnlimitedCompany: "unlimited_company",
+    OverseasCompany: "overseas_company",
+    Charity: "charity",
+    Unknown: "unknown",
+};
+/** @internal */
+exports.EntityType$inboundSchema = openEnums.inboundSchema(exports.EntityType);
+/** @internal */
+exports.TitleProprietor$inboundSchema = z.object({
+    addresses: z.array(z.string()),
+    companyRegistrationNumber: z.nullable(z.string()),
+    countryIncorporated: z.nullable(z.string()),
+    entityType: exports.EntityType$inboundSchema,
+    forenames: z.nullable(z.string()),
+    name: z.string(),
+    overseasRegistrationNumber: z.nullable(z.string()),
+    proprietorOrder: z.number().int(),
+    surname: z.nullable(z.string()),
+});
+function titleProprietorFromJSON(jsonString) {
+    return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.TitleProprietor$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'TitleProprietor' from JSON`);
+}
+//# sourceMappingURL=titleproprietor.js.map

package/dist/commonjs/sdk/models/shared/titleproprietor.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"titleproprietor.js","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/titleproprietor.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA+EH,0DAQC;AArFD,0CAA4B;AAC5B,wDAAoD;AACpD,gEAAkD;AAKrC,QAAA,UAAU,GAAG;IACxB,UAAU,EAAE,YAAY;IACxB,cAAc,EAAE,iBAAiB;IACjC,GAAG,EAAE,KAAK;IACV,aAAa,EAAE,gBAAgB;IAC/B,cAAc,EAAE,iBAAiB;IACjC,aAAa,EAAE,gBAAgB;IAC/B,iBAAiB,EAAE,oBAAoB;IACvC,kBAAkB,EAAE,qBAAqB;IACzC,gBAAgB,EAAE,mBAAmB;IACrC,eAAe,EAAE,kBAAkB;IACnC,OAAO,EAAE,SAAS;IAClB,OAAO,EAAE,SAAS;CACV,CAAC;AAiCX,gBAAgB;AACH,QAAA,wBAAwB,GAIjC,SAAS,CAAC,aAAa,CAAC,kBAAU,CAAC,CAAC;AAExC,gBAAgB;AACH,QAAA,6BAA6B,GAItC,CAAC,CAAC,MAAM,CAAC;IACX,SAAS,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;IAC9B,yBAAyB,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;IACjD,mBAAmB,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;IAC3C,UAAU,EAAE,gCAAwB;IACpC,SAAS,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;IACjC,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;IAChB,0BAA0B,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;IAClD,eAAe,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE;IACjC,OAAO,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;CAChC,CAAC,CAAC;AAEH,SAAgB,uBAAuB,CACrC,UAAkB;IAElB,OAAO,IAAA,sBAAS,EACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,qCAA6B,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EACzD,6CAA6C,CAC9C,CAAC;AACJ,CAAC"}

package/dist/commonjs/sdk/models/shared/titlerestriction.d.ts

@@ -0,0 +1,23 @@
+import * as z from "zod/v3";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+export type TitleRestriction = {
+    date: string | null;
+    /**
+     * Legal text quoted verbatim from the register entry
+     */
+    rawText: string;
+    sourceEntryRef: string;
+    /**
+     * Short summary label
+     */
+    title: string;
+    /**
+     * AI-authored plain-language explanation
+     */
+    whyThisMatters: string;
+};
+/** @internal */
+export declare const TitleRestriction$inboundSchema: z.ZodType<TitleRestriction, z.ZodTypeDef, unknown>;
+export declare function titleRestrictionFromJSON(jsonString: string): SafeParseResult<TitleRestriction, SDKValidationError>;
+//# sourceMappingURL=titlerestriction.d.ts.map

package/dist/commonjs/sdk/models/shared/titlerestriction.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"titlerestriction.d.ts","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/titlerestriction.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,gBAAgB,GAAG;IAC7B,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IACpB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB,cAAc,EAAE,MAAM,CAAC;IACvB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;CACxB,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,8BAA8B,EAAE,CAAC,CAAC,OAAO,CACpD,gBAAgB,EAChB,CAAC,CAAC,UAAU,EACZ,OAAO,CAOP,CAAC;AAEH,wBAAgB,wBAAwB,CACtC,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,gBAAgB,EAAE,kBAAkB,CAAC,CAMvD"}

package/dist/commonjs/sdk/models/shared/titlerestriction.js

@@ -0,0 +1,54 @@
+"use strict";
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TitleRestriction$inboundSchema = void 0;
+exports.titleRestrictionFromJSON = titleRestrictionFromJSON;
+const z = __importStar(require("zod/v3"));
+const schemas_js_1 = require("../../../lib/schemas.js");
+/** @internal */
+exports.TitleRestriction$inboundSchema = z.object({
+    date: z.nullable(z.string()),
+    rawText: z.string(),
+    sourceEntryRef: z.string(),
+    title: z.string(),
+    whyThisMatters: z.string(),
+});
+function titleRestrictionFromJSON(jsonString) {
+    return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.TitleRestriction$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'TitleRestriction' from JSON`);
+}
+//# sourceMappingURL=titlerestriction.js.map

package/dist/commonjs/sdk/models/shared/titlerestriction.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"titlerestriction.js","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/titlerestriction.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAqCH,4DAQC;AA3CD,0CAA4B;AAC5B,wDAAoD;AAqBpD,gBAAgB;AACH,QAAA,8BAA8B,GAIvC,CAAC,CAAC,MAAM,CAAC;IACX,IAAI,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;IAC5B,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE;IACnB,cAAc,EAAE,CAAC,CAAC,MAAM,EAAE;IAC1B,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;IACjB,cAAc,EAAE,CAAC,CAAC,MAAM,EAAE;CAC3B,CAAC,CAAC;AAEH,SAAgB,wBAAwB,CACtC,UAAkB;IAElB,OAAO,IAAA,sBAAS,EACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,sCAA8B,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAC1D,8CAA8C,CAC/C,CAAC;AACJ,CAAC"}

package/dist/commonjs/sdk/models/shared/titleschedulenoticeoflease.d.ts

@@ -0,0 +1,13 @@
+import * as z from "zod/v3";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+export type TitleScheduleNoticeOfLease = {
+    /**
+     * Verbatim text of the schedule-of-notices-of-leases block from the register.
+     */
+    rawText: string;
+};
+/** @internal */
+export declare const TitleScheduleNoticeOfLease$inboundSchema: z.ZodType<TitleScheduleNoticeOfLease, z.ZodTypeDef, unknown>;
+export declare function titleScheduleNoticeOfLeaseFromJSON(jsonString: string): SafeParseResult<TitleScheduleNoticeOfLease, SDKValidationError>;
+//# sourceMappingURL=titleschedulenoticeoflease.d.ts.map

package/dist/commonjs/sdk/models/shared/titleschedulenoticeoflease.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"titleschedulenoticeoflease.d.ts","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/titleschedulenoticeoflease.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,0BAA0B,GAAG;IACvC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,wCAAwC,EAAE,CAAC,CAAC,OAAO,CAC9D,0BAA0B,EAC1B,CAAC,CAAC,UAAU,EACZ,OAAO,CAGP,CAAC;AAEH,wBAAgB,kCAAkC,CAChD,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,0BAA0B,EAAE,kBAAkB,CAAC,CAMjE"}

package/dist/commonjs/sdk/models/shared/titleschedulenoticeoflease.js

@@ -0,0 +1,50 @@
+"use strict";
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TitleScheduleNoticeOfLease$inboundSchema = void 0;
+exports.titleScheduleNoticeOfLeaseFromJSON = titleScheduleNoticeOfLeaseFromJSON;
+const z = __importStar(require("zod/v3"));
+const schemas_js_1 = require("../../../lib/schemas.js");
+/** @internal */
+exports.TitleScheduleNoticeOfLease$inboundSchema = z.object({
+    rawText: z.string(),
+});
+function titleScheduleNoticeOfLeaseFromJSON(jsonString) {
+    return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.TitleScheduleNoticeOfLease$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'TitleScheduleNoticeOfLease' from JSON`);
+}
+//# sourceMappingURL=titleschedulenoticeoflease.js.map

package/dist/commonjs/sdk/models/shared/titleschedulenoticeoflease.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"titleschedulenoticeoflease.js","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/titleschedulenoticeoflease.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAuBH,gFAQC;AA7BD,0CAA4B;AAC5B,wDAAoD;AAWpD,gBAAgB;AACH,QAAA,wCAAwC,GAIjD,CAAC,CAAC,MAAM,CAAC;IACX,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE;CACpB,CAAC,CAAC;AAEH,SAAgB,kCAAkC,CAChD,UAAkB;IAElB,OAAO,IAAA,sBAAS,EACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,gDAAwC,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EACpE,wDAAwD,CACzD,CAAC;AACJ,CAAC"}

package/dist/commonjs/sdk/models/shared/titlesummarycounts.d.ts

@@ -0,0 +1,15 @@
+import * as z from "zod/v3";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+export type TitleSummaryCounts = {
+    activeMortgages: number;
+    covenants: number;
+    dischargedMortgages: number;
+    notices: number;
+    otherCharges: number;
+    restrictions: number;
+};
+/** @internal */
+export declare const TitleSummaryCounts$inboundSchema: z.ZodType<TitleSummaryCounts, z.ZodTypeDef, unknown>;
+export declare function titleSummaryCountsFromJSON(jsonString: string): SafeParseResult<TitleSummaryCounts, SDKValidationError>;
+//# sourceMappingURL=titlesummarycounts.d.ts.map

package/dist/commonjs/sdk/models/shared/titlesummarycounts.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"titlesummarycounts.d.ts","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/titlesummarycounts.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,kBAAkB,GAAG;IAC/B,eAAe,EAAE,MAAM,CAAC;IACxB,SAAS,EAAE,MAAM,CAAC;IAClB,mBAAmB,EAAE,MAAM,CAAC;IAC5B,OAAO,EAAE,MAAM,CAAC;IAChB,YAAY,EAAE,MAAM,CAAC;IACrB,YAAY,EAAE,MAAM,CAAC;CACtB,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,gCAAgC,EAAE,CAAC,CAAC,OAAO,CACtD,kBAAkB,EAClB,CAAC,CAAC,UAAU,EACZ,OAAO,CAQP,CAAC;AAEH,wBAAgB,0BAA0B,CACxC,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,kBAAkB,EAAE,kBAAkB,CAAC,CAMzD"}

package/dist/commonjs/sdk/models/shared/titlesummarycounts.js

@@ -0,0 +1,55 @@
+"use strict";
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TitleSummaryCounts$inboundSchema = void 0;
+exports.titleSummaryCountsFromJSON = titleSummaryCountsFromJSON;
+const z = __importStar(require("zod/v3"));
+const schemas_js_1 = require("../../../lib/schemas.js");
+/** @internal */
+exports.TitleSummaryCounts$inboundSchema = z.object({
+    activeMortgages: z.number().int(),
+    covenants: z.number().int(),
+    dischargedMortgages: z.number().int(),
+    notices: z.number().int(),
+    otherCharges: z.number().int(),
+    restrictions: z.number().int(),
+});
+function titleSummaryCountsFromJSON(jsonString) {
+    return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.TitleSummaryCounts$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'TitleSummaryCounts' from JSON`);
+}
+//# sourceMappingURL=titlesummarycounts.js.map

package/dist/commonjs/sdk/models/shared/titlesummarycounts.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"titlesummarycounts.js","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/titlesummarycounts.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA8BH,gEAQC;AApCD,0CAA4B;AAC5B,wDAAoD;AAapD,gBAAgB;AACH,QAAA,gCAAgC,GAIzC,CAAC,CAAC,MAAM,CAAC;IACX,eAAe,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE;IACjC,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE;IAC3B,mBAAmB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE;IACrC,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE;IACzB,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE;IAC9B,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE;CAC/B,CAAC,CAAC;AAEH,SAAgB,0BAA0B,CACxC,UAAkB;IAElB,OAAO,IAAA,sBAAS,EACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,wCAAgC,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAC5D,gDAAgD,CACjD,CAAC;AACJ,CAAC"}

package/dist/commonjs/sdk/search.d.ts

@@ -2,6 +2,17 @@ import { ClientSDK, RequestOptions } from "../lib/sdks.js";
 import * as operations from "./models/operations/index.js";
 import * as shared from "./models/shared/index.js";
 export declare class Search extends ClientSDK {
+    /**
+     * Retrieve the full address record for a selected suggestion
+     *
+     * @remarks
+     * The selection step of the candidate-set search flow. Suggest responses are free and carry only a discovery projection (label + UPRN + match highlights); pass the chosen suggestion's `uprn` here to receive the full address record — address lines, postcode, coordinates and classification.
+     *
+     * Include the `search_id` from the suggest response to complete that search session; the retrieval is then recorded against it. Without a `search_id` (or with one that has expired or is unknown) the endpoint still works as a direct resolve and is recorded as its own transaction.
+     *
+     * This endpoint is charged per retrieved record. Repeat retrievals of the same UPRN within a billing window are charged once — see the `X-Already-Charged` response header.
+     */
+    searchRetrieve(request: operations.SearchRetrieveRequest, options?: RequestOptions): Promise<shared.SearchRetrieveResponse>;
     /**
      * Autocomplete search for UK addresses and locations
      *
@@ -12,7 +23,9 @@ export declare class Search extends ClientSDK {
      * - `geo_mode=bias` (default): soft preference. The best textual matches near the point rank higher, but distant matches are still returned.
      * - `geo_mode=restrict`: hard cutoff. Only address results within `radius_meters` of the point are returned.
      *
-     * 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.
+     * Proximity shapes the RANKING (bias) and membership (restrict) of the address results; pair it with `source=address` for the most predictable proximity behaviour. Suggest returns a discovery projection only — address rows carry the label, UPRN and match highlights, never coordinates, distance or classification. Retrieve a chosen suggestion (`GET /search/retrieve`) for the full record including coordinates.
+     *
+     * Candidate-set sessions: once a query narrows to a small exact match set, the response carries a `search_id` and slim address rows (label + UPRN + match highlights). Pass `search_id` back on subsequent keystrokes to narrow within that set without a new data fetch; when `set_complete` is true the response already contains the complete match set, so further narrowing can happen client-side. Suggest responses are not charged — charging applies when a full record is retrieved.
      */
     searchSuggest(request: operations.SearchSuggestRequest, options?: RequestOptions): Promise<shared.SearchResponse>;
 }

package/dist/commonjs/sdk/search.d.ts.map

@@ -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;;;;;;;;;;;OAWG;IACG,aAAa,CACjB,OAAO,EAAE,UAAU,CAAC,oBAAoB,EACxC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,MAAM,CAAC,cAAc,CAAC;CAOlC"}
+{"version":3,"file":"search.d.ts","sourceRoot":"","sources":["../../../src/sdk/search.ts"],"names":[],"mappings":"AAMA,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;;;;;;;;;OASG;IACG,cAAc,CAClB,OAAO,EAAE,UAAU,CAAC,qBAAqB,EACzC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,MAAM,CAAC,sBAAsB,CAAC;IAQzC;;;;;;;;;;;;;OAaG;IACG,aAAa,CACjB,OAAO,EAAE,UAAU,CAAC,oBAAoB,EACxC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,MAAM,CAAC,cAAc,CAAC;CAOlC"}

package/dist/commonjs/sdk/search.js

@@ -4,10 +4,24 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Search = void 0;
+const searchSearchRetrieve_js_1 = require("../funcs/searchSearchRetrieve.js");
 const searchSearchSuggest_js_1 = require("../funcs/searchSearchSuggest.js");
 const sdks_js_1 = require("../lib/sdks.js");
 const fp_js_1 = require("./types/fp.js");
 class Search extends sdks_js_1.ClientSDK {
+    /**
+     * Retrieve the full address record for a selected suggestion
+     *
+     * @remarks
+     * The selection step of the candidate-set search flow. Suggest responses are free and carry only a discovery projection (label + UPRN + match highlights); pass the chosen suggestion's `uprn` here to receive the full address record — address lines, postcode, coordinates and classification.
+     *
+     * Include the `search_id` from the suggest response to complete that search session; the retrieval is then recorded against it. Without a `search_id` (or with one that has expired or is unknown) the endpoint still works as a direct resolve and is recorded as its own transaction.
+     *
+     * This endpoint is charged per retrieved record. Repeat retrievals of the same UPRN within a billing window are charged once — see the `X-Already-Charged` response header.
+     */
+    async searchRetrieve(request, options) {
+        return (0, fp_js_1.unwrapAsync)((0, searchSearchRetrieve_js_1.searchSearchRetrieve)(this, request, options));
+    }
     /**
      * Autocomplete search for UK addresses and locations
      *
@@ -18,7 +32,9 @@ class Search extends sdks_js_1.ClientSDK {
      * - `geo_mode=bias` (default): soft preference. The best textual matches near the point rank higher, but distant matches are still returned.
      * - `geo_mode=restrict`: hard cutoff. Only address results within `radius_meters` of the point are returned.
      *
-     * 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.
+     * Proximity shapes the RANKING (bias) and membership (restrict) of the address results; pair it with `source=address` for the most predictable proximity behaviour. Suggest returns a discovery projection only — address rows carry the label, UPRN and match highlights, never coordinates, distance or classification. Retrieve a chosen suggestion (`GET /search/retrieve`) for the full record including coordinates.
+     *
+     * Candidate-set sessions: once a query narrows to a small exact match set, the response carries a `search_id` and slim address rows (label + UPRN + match highlights). Pass `search_id` back on subsequent keystrokes to narrow within that set without a new data fetch; when `set_complete` is true the response already contains the complete match set, so further narrowing can happen client-side. Suggest responses are not charged — charging applies when a full record is retrieved.
      */
     async searchSuggest(request, options) {
         return (0, fp_js_1.unwrapAsync)((0, searchSearchSuggest_js_1.searchSearchSuggest)(this, request, options));

package/dist/commonjs/sdk/search.js.map

@@ -1 +1 @@
-{"version":3,"file":"search.js","sourceRoot":"","sources":["../../../src/sdk/search.ts"],"names":[],"mappings":";AAAA;;GAEG;;;AAEH,4EAAsE;AACtE,4CAA2D;AAG3D,yCAA4C;AAE5C,MAAa,MAAO,SAAQ,mBAAS;IACnC;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,aAAa,CACjB,OAAwC,EACxC,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,4CAAmB,EACpC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;CACF;AAvBD,wBAuBC"}
+{"version":3,"file":"search.js","sourceRoot":"","sources":["../../../src/sdk/search.ts"],"names":[],"mappings":";AAAA;;GAEG;;;AAEH,8EAAwE;AACxE,4EAAsE;AACtE,4CAA2D;AAG3D,yCAA4C;AAE5C,MAAa,MAAO,SAAQ,mBAAS;IACnC;;;;;;;;;OASG;IACH,KAAK,CAAC,cAAc,CAClB,OAAyC,EACzC,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,8CAAoB,EACrC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,KAAK,CAAC,aAAa,CACjB,OAAwC,EACxC,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,4CAAmB,EACpC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;CACF;AA9CD,wBA8CC"}

package/dist/esm/address-search/__tests__/controller.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=controller.test.d.ts.map

package/dist/esm/address-search/__tests__/controller.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"controller.test.d.ts","sourceRoot":"","sources":["../../../../src/address-search/__tests__/controller.test.ts"],"names":[],"mappings":""}