@vepler/sdk 2.30.4 → 2.37.0

package/dist/commonjs/sdk/address.js

@@ -4,10 +4,72 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Address = void 0;
+const addressBulkLookupPostcodes_js_1 = require("../funcs/addressBulkLookupPostcodes.js");
+const addressCleanseAddresses_js_1 = require("../funcs/addressCleanseAddresses.js");
+const addressGetNearestPostcodes_js_1 = require("../funcs/addressGetNearestPostcodes.js");
+const addressLookupOutcode_js_1 = require("../funcs/addressLookupOutcode.js");
+const addressLookupPostcode_js_1 = require("../funcs/addressLookupPostcode.js");
+const addressLookupUprn_js_1 = require("../funcs/addressLookupUprn.js");
 const addressResolveAddress_js_1 = require("../funcs/addressResolveAddress.js");
+const addressReverseGeocode_js_1 = require("../funcs/addressReverseGeocode.js");
+const addressValidatePostcode_js_1 = require("../funcs/addressValidatePostcode.js");
 const sdks_js_1 = require("../lib/sdks.js");
 const fp_js_1 = require("./types/fp.js");
 class Address extends sdks_js_1.ClientSDK {
+    /**
+     * Batch postcode lookup
+     *
+     * @remarks
+     * Look up addresses for up to 100 postcodes in a single request. Results are returned keyed by formatted postcode.
+     */
+    async bulkLookupPostcodes(request, options) {
+        return (0, fp_js_1.unwrapAsync)((0, addressBulkLookupPostcodes_js_1.addressBulkLookupPostcodes)(this, request, options));
+    }
+    /**
+     * Batch address cleansing and verification
+     *
+     * @remarks
+     * Verifies and cleanses up to 25 raw address strings against the national address database. Returns match status, confidence scores, and corrected fields.
+     */
+    async cleanseAddresses(request, options) {
+        return (0, fp_js_1.unwrapAsync)((0, addressCleanseAddresses_js_1.addressCleanseAddresses)(this, request, options));
+    }
+    /**
+     * Find nearest postcodes
+     *
+     * @remarks
+     * Returns postcodes near the specified postcode, sorted by distance.
+     */
+    async getNearestPostcodes(request, options) {
+        return (0, fp_js_1.unwrapAsync)((0, addressGetNearestPostcodes_js_1.addressGetNearestPostcodes)(this, request, options));
+    }
+    /**
+     * Look up outcode area
+     *
+     * @remarks
+     * Returns metadata for an outward code (e.g. SW1A, E1, M1) including centroid, country, region, and postcode count.
+     */
+    async lookupOutcode(request, options) {
+        return (0, fp_js_1.unwrapAsync)((0, addressLookupOutcode_js_1.addressLookupOutcode)(this, request, options));
+    }
+    /**
+     * Look up addresses by postcode
+     *
+     * @remarks
+     * Returns all addresses at a given UK postcode, sorted by house number. Supports pagination and optional geographic context enrichment.
+     */
+    async lookupPostcode(request, options) {
+        return (0, fp_js_1.unwrapAsync)((0, addressLookupPostcode_js_1.addressLookupPostcode)(this, request, options));
+    }
+    /**
+     * Look up address by UPRN
+     *
+     * @remarks
+     * Returns a single address by its Unique Property Reference Number (UPRN).
+     */
+    async lookupUprn(request, options) {
+        return (0, fp_js_1.unwrapAsync)((0, addressLookupUprn_js_1.addressLookupUprn)(this, request, options));
+    }
     /**
      * Resolve addresses to UPRNs with AI
      *
@@ -17,6 +79,24 @@ class Address extends sdks_js_1.ClientSDK {
     async resolveAddress(request, options) {
         return (0, fp_js_1.unwrapAsync)((0, addressResolveAddress_js_1.addressResolveAddress)(this, request, options));
     }
+    /**
+     * Reverse geocode (coordinates to addresses)
+     *
+     * @remarks
+     * Returns addresses near the specified coordinates, sorted by distance.
+     */
+    async reverseGeocode(request, options) {
+        return (0, fp_js_1.unwrapAsync)((0, addressReverseGeocode_js_1.addressReverseGeocode)(this, request, options));
+    }
+    /**
+     * Validate a UK postcode
+     *
+     * @remarks
+     * Validates whether a UK postcode exists and is active. Always returns 200 — the `valid` field indicates the result. Includes centroid coordinates and area codes when valid.
+     */
+    async validatePostcode(request, options) {
+        return (0, fp_js_1.unwrapAsync)((0, addressValidatePostcode_js_1.addressValidatePostcode)(this, request, options));
+    }
 }
 exports.Address = Address;
 //# sourceMappingURL=address.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"address.js","sourceRoot":"","sources":["../../../src/sdk/address.ts"],"names":[],"mappings":";AAAA;;GAEG;;;AAEH,gFAA0E;AAC1E,4CAA2D;AAE3D,yCAA4C;AAE5C,MAAa,OAAQ,SAAQ,mBAAS;IACpC;;;;;OAKG;IACH,KAAK,CAAC,cAAc,CAClB,OAA0D,EAC1D,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,gDAAqB,EACtC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;CACF;AAjBD,0BAiBC"}
+{"version":3,"file":"address.js","sourceRoot":"","sources":["../../../src/sdk/address.ts"],"names":[],"mappings":";AAAA;;GAEG;;;AAEH,0FAAoF;AACpF,oFAA8E;AAC9E,0FAAoF;AACpF,8EAAwE;AACxE,gFAA0E;AAC1E,wEAAkE;AAClE,gFAA0E;AAC1E,gFAA0E;AAC1E,oFAA8E;AAC9E,4CAA2D;AAG3D,yCAA4C;AAE5C,MAAa,OAAQ,SAAQ,mBAAS;IACpC;;;;;OAKG;IACH,KAAK,CAAC,mBAAmB,CACvB,OAAsD,EACtD,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,0DAA0B,EAC3C,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,gBAAgB,CACpB,OAAkD,EAClD,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,oDAAuB,EACxC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,mBAAmB,CACvB,OAA8C,EAC9C,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,0DAA0B,EAC3C,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,aAAa,CACjB,OAAwC,EACxC,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,8CAAoB,EACrC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,cAAc,CAClB,OAAyC,EACzC,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,gDAAqB,EACtC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,UAAU,CACd,OAAqC,EACrC,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,wCAAiB,EAClC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,cAAc,CAClB,OAA0D,EAC1D,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,gDAAqB,EACtC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,cAAc,CAClB,OAAyC,EACzC,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,gDAAqB,EACtC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,gBAAgB,CACpB,OAA2C,EAC3C,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,oDAAuB,EACxC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;CACF;AAzJD,0BAyJC"}

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

@@ -29,5 +29,18 @@ export declare class Areas extends ClientSDK {
      * Retrieve all child areas contained within a parent geographic area. Optionally filter by child type using the childType query parameter.
      */
     getChildAreas(request: operations.GetChildAreasRequest, options?: RequestOptions): Promise<operations.GetChildAreasResponseBody>;
+    /**
+     * Calculate geographic coverage
+     *
+     * @remarks
+     * Calculate spatial coverage for a geographic area. Supports two modes:
+     *
+     * 1. **Geography-to-geography**: Use `sourceCode` + `targetCode` to calculate the overlap between two geographic areas.
+     *
+     * 2. **Environmental coverage**: Use `sourceCode` + `coverageType` to calculate coverage of an environmental layer (flood risk, noise, radon, conservation areas, etc.) within the source geography.
+     *
+     * Optionally use `intersectsWith` with environmental coverage to find entities (buildings, parcels) affected by the environmental layer.
+     */
+    getCoverage(request: operations.GetAreaCoverageRequest, options?: RequestOptions): Promise<operations.GetAreaCoverageResponseBody>;
 }
 //# sourceMappingURL=areas.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"areas.d.ts","sourceRoot":"","sources":["../../../src/sdk/areas.ts"],"names":[],"mappings":"AAQA,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAC3D,OAAO,KAAK,UAAU,MAAM,8BAA8B,CAAC;AAG3D,qBAAa,KAAM,SAAQ,SAAS;IAClC;;;;;OAKG;IACG,QAAQ,CACZ,OAAO,EAAE,UAAU,CAAC,4BAA4B,EAChD,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,iCAAiC,CAAC;IAQxD;;;;;OAKG;IACG,cAAc,CAClB,OAAO,EAAE,UAAU,CAAC,2BAA2B,EAC/C,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,gCAAgC,CAAC;IAQvD;;;;;OAKG;IACG,iBAAiB,CACrB,OAAO,EAAE,UAAU,CAAC,wBAAwB,EAC5C,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,6BAA6B,CAAC;IAQpD;;;;;OAKG;IACG,aAAa,CACjB,OAAO,EAAE,UAAU,CAAC,oBAAoB,EACxC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,yBAAyB,CAAC;CAOjD"}
+{"version":3,"file":"areas.d.ts","sourceRoot":"","sources":["../../../src/sdk/areas.ts"],"names":[],"mappings":"AASA,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAC3D,OAAO,KAAK,UAAU,MAAM,8BAA8B,CAAC;AAG3D,qBAAa,KAAM,SAAQ,SAAS;IAClC;;;;;OAKG;IACG,QAAQ,CACZ,OAAO,EAAE,UAAU,CAAC,4BAA4B,EAChD,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,iCAAiC,CAAC;IAQxD;;;;;OAKG;IACG,cAAc,CAClB,OAAO,EAAE,UAAU,CAAC,2BAA2B,EAC/C,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,gCAAgC,CAAC;IAQvD;;;;;OAKG;IACG,iBAAiB,CACrB,OAAO,EAAE,UAAU,CAAC,wBAAwB,EAC5C,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,6BAA6B,CAAC;IAQpD;;;;;OAKG;IACG,aAAa,CACjB,OAAO,EAAE,UAAU,CAAC,oBAAoB,EACxC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,yBAAyB,CAAC;IAQhD;;;;;;;;;;;OAWG;IACG,WAAW,CACf,OAAO,EAAE,UAAU,CAAC,sBAAsB,EAC1C,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,2BAA2B,CAAC;CAOnD"}

package/dist/commonjs/sdk/areas.js

@@ -8,6 +8,7 @@ const areasGetAreas_js_1 = require("../funcs/areasGetAreas.js");
 const areasGetAreasWithin_js_1 = require("../funcs/areasGetAreasWithin.js");
 const areasGetBorderingAreas_js_1 = require("../funcs/areasGetBorderingAreas.js");
 const areasGetChildAreas_js_1 = require("../funcs/areasGetChildAreas.js");
+const areasGetCoverage_js_1 = require("../funcs/areasGetCoverage.js");
 const sdks_js_1 = require("../lib/sdks.js");
 const fp_js_1 = require("./types/fp.js");
 class Areas extends sdks_js_1.ClientSDK {
@@ -47,6 +48,21 @@ class Areas extends sdks_js_1.ClientSDK {
     async getChildAreas(request, options) {
         return (0, fp_js_1.unwrapAsync)((0, areasGetChildAreas_js_1.areasGetChildAreas)(this, request, options));
     }
+    /**
+     * Calculate geographic coverage
+     *
+     * @remarks
+     * Calculate spatial coverage for a geographic area. Supports two modes:
+     *
+     * 1. **Geography-to-geography**: Use `sourceCode` + `targetCode` to calculate the overlap between two geographic areas.
+     *
+     * 2. **Environmental coverage**: Use `sourceCode` + `coverageType` to calculate coverage of an environmental layer (flood risk, noise, radon, conservation areas, etc.) within the source geography.
+     *
+     * Optionally use `intersectsWith` with environmental coverage to find entities (buildings, parcels) affected by the environmental layer.
+     */
+    async getCoverage(request, options) {
+        return (0, fp_js_1.unwrapAsync)((0, areasGetCoverage_js_1.areasGetCoverage)(this, request, options));
+    }
 }
 exports.Areas = Areas;
 //# sourceMappingURL=areas.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"areas.js","sourceRoot":"","sources":["../../../src/sdk/areas.ts"],"names":[],"mappings":";AAAA;;GAEG;;;AAEH,gEAA0D;AAC1D,4EAAsE;AACtE,kFAA4E;AAC5E,0EAAoE;AACpE,4CAA2D;AAE3D,yCAA4C;AAE5C,MAAa,KAAM,SAAQ,mBAAS;IAClC;;;;;OAKG;IACH,KAAK,CAAC,QAAQ,CACZ,OAAgD,EAChD,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,gCAAa,EAC9B,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,cAAc,CAClB,OAA+C,EAC/C,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,4CAAmB,EACpC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,iBAAiB,CACrB,OAA4C,EAC5C,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,kDAAsB,EACvC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,aAAa,CACjB,OAAwC,EACxC,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,0CAAkB,EACnC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;CACF;AApED,sBAoEC"}
+{"version":3,"file":"areas.js","sourceRoot":"","sources":["../../../src/sdk/areas.ts"],"names":[],"mappings":";AAAA;;GAEG;;;AAEH,gEAA0D;AAC1D,4EAAsE;AACtE,kFAA4E;AAC5E,0EAAoE;AACpE,sEAAgE;AAChE,4CAA2D;AAE3D,yCAA4C;AAE5C,MAAa,KAAM,SAAQ,mBAAS;IAClC;;;;;OAKG;IACH,KAAK,CAAC,QAAQ,CACZ,OAAgD,EAChD,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,gCAAa,EAC9B,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,cAAc,CAClB,OAA+C,EAC/C,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,4CAAmB,EACpC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,iBAAiB,CACrB,OAA4C,EAC5C,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,kDAAsB,EACvC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,aAAa,CACjB,OAAwC,EACxC,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,0CAAkB,EACnC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,WAAW,CACf,OAA0C,EAC1C,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,sCAAgB,EACjC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;CACF;AA3FD,sBA2FC"}

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

@@ -0,0 +1,83 @@
+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 Companies extends ClientSDK {
+    /**
+     * Get companies at a property location
+     *
+     * @remarks
+     * Retrieve all companies registered at a specific property using the UPRN (Unique Property Reference Number). Useful for property-company intelligence and ownership analysis.
+     */
+    getCompaniesByLocation(request: operations.GetCompaniesByLocationRequest, options?: RequestOptions): Promise<shared.CompaniesByLocationResponse>;
+    /**
+     * Get company by registration number
+     *
+     * @remarks
+     * Retrieve detailed company information using the 8-character Companies House registration number. Optionally includes active officers and PSCs.
+     */
+    getCompany(request: operations.GetCompanyRequest, options?: RequestOptions): Promise<shared.CompanyResponse>;
+    /**
+     * Get officers for a company
+     *
+     * @remarks
+     * Retrieve officer appointments (directors, secretaries, LLP members) for a company. By default returns only active officers.
+     */
+    getCompanyOfficers(request: operations.GetCompanyOfficersRequest, options?: RequestOptions): Promise<shared.OfficerListResponse>;
+    /**
+     * Get persons with significant control for a company
+     *
+     * @remarks
+     * Retrieve PSC (Person with Significant Control) records for a company. PSCs are individuals or entities who hold significant influence over a company, as defined by the Companies Act 2006 Part 21A. Includes individuals, corporate entities, and legal persons. By default, super-secure persons (whose identities are protected by court order) are excluded.
+     */
+    getCompanyPscs(request: operations.GetCompanyPscsRequest, options?: RequestOptions): Promise<shared.PscListResponse>;
+    /**
+     * Get officer appointment by ID
+     *
+     * @remarks
+     * Retrieve a specific officer appointment record by its unique identifier.
+     */
+    getOfficer(request: operations.GetOfficerRequest, options?: RequestOptions): Promise<shared.OfficerResponse>;
+    /**
+     * Get person by ID
+     *
+     * @remarks
+     * Retrieve a deduplicated person record with entity resolution data. Persons are natural individuals linked to officer appointments and PSC notifications.
+     */
+    getPerson(request: operations.GetPersonRequest, options?: RequestOptions): Promise<shared.PersonResponse>;
+    /**
+     * Get all appointments held by a person
+     *
+     * @remarks
+     * Retrieve all officer appointments held by a person across all companies. Includes company name and status for each appointment.
+     */
+    getPersonAppointments(request: operations.GetPersonAppointmentsRequest, options?: RequestOptions): Promise<shared.AppointmentsResponse>;
+    /**
+     * Get all persons in an entity resolution cluster (Premium)
+     *
+     * @remarks
+     * Retrieve all person records that belong to the same entity resolution cluster. Entity resolution uses probabilistic matching to link records belonging to the same real person. **Requires COMPANIES_HOUSE_PREMIUM product access.**
+     */
+    getPersonCluster(request: operations.GetPersonClusterRequest, options?: RequestOptions): Promise<shared.PersonClusterResponse>;
+    /**
+     * Get PSC notification by ID
+     *
+     * @remarks
+     * Retrieve a specific PSC (Person with Significant Control) record by its unique identifier.
+     */
+    getPsc(request: operations.GetPscRequest, options?: RequestOptions): Promise<shared.PscResponse>;
+    /**
+     * Search companies with filters
+     *
+     * @remarks
+     * Search for companies using name, status, type, SIC codes, location, and other criteria. Returns paginated results with company summaries.
+     */
+    queryCompanies(request?: shared.CompanyQueryRequest | undefined, options?: RequestOptions): Promise<shared.CompanyListResponse>;
+    /**
+     * Search persons with filters
+     *
+     * @remarks
+     * Search for persons using name, date of birth, nationality, and appointment criteria. By default returns only canonical records (deduplicated).
+     */
+    queryPersons(request?: shared.PersonQueryRequest | undefined, options?: RequestOptions): Promise<shared.PersonListResponse>;
+}
+//# sourceMappingURL=companies.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"companies.d.ts","sourceRoot":"","sources":["../../../src/sdk/companies.ts"],"names":[],"mappings":"AAeA,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,SAAU,SAAQ,SAAS;IACtC;;;;;OAKG;IACG,sBAAsB,CAC1B,OAAO,EAAE,UAAU,CAAC,6BAA6B,EACjD,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,MAAM,CAAC,2BAA2B,CAAC;IAQ9C;;;;;OAKG;IACG,UAAU,CACd,OAAO,EAAE,UAAU,CAAC,iBAAiB,EACrC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,MAAM,CAAC,eAAe,CAAC;IAQlC;;;;;OAKG;IACG,kBAAkB,CACtB,OAAO,EAAE,UAAU,CAAC,yBAAyB,EAC7C,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,MAAM,CAAC,mBAAmB,CAAC;IAQtC;;;;;OAKG;IACG,cAAc,CAClB,OAAO,EAAE,UAAU,CAAC,qBAAqB,EACzC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,MAAM,CAAC,eAAe,CAAC;IAQlC;;;;;OAKG;IACG,UAAU,CACd,OAAO,EAAE,UAAU,CAAC,iBAAiB,EACrC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,MAAM,CAAC,eAAe,CAAC;IAQlC;;;;;OAKG;IACG,SAAS,CACb,OAAO,EAAE,UAAU,CAAC,gBAAgB,EACpC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,MAAM,CAAC,cAAc,CAAC;IAQjC;;;;;OAKG;IACG,qBAAqB,CACzB,OAAO,EAAE,UAAU,CAAC,4BAA4B,EAChD,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,MAAM,CAAC,oBAAoB,CAAC;IAQvC;;;;;OAKG;IACG,gBAAgB,CACpB,OAAO,EAAE,UAAU,CAAC,uBAAuB,EAC3C,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,MAAM,CAAC,qBAAqB,CAAC;IAQxC;;;;;OAKG;IACG,MAAM,CACV,OAAO,EAAE,UAAU,CAAC,aAAa,EACjC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,MAAM,CAAC,WAAW,CAAC;IAQ9B;;;;;OAKG;IACG,cAAc,CAClB,OAAO,CAAC,EAAE,MAAM,CAAC,mBAAmB,GAAG,SAAS,EAChD,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,MAAM,CAAC,mBAAmB,CAAC;IAQtC;;;;;OAKG;IACG,YAAY,CAChB,OAAO,CAAC,EAAE,MAAM,CAAC,kBAAkB,GAAG,SAAS,EAC/C,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,MAAM,CAAC,kBAAkB,CAAC;CAOtC"}

package/dist/commonjs/sdk/companies.js

@@ -0,0 +1,122 @@
+"use strict";
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Companies = void 0;
+const companiesGetCompaniesByLocation_js_1 = require("../funcs/companiesGetCompaniesByLocation.js");
+const companiesGetCompany_js_1 = require("../funcs/companiesGetCompany.js");
+const companiesGetCompanyOfficers_js_1 = require("../funcs/companiesGetCompanyOfficers.js");
+const companiesGetCompanyPscs_js_1 = require("../funcs/companiesGetCompanyPscs.js");
+const companiesGetOfficer_js_1 = require("../funcs/companiesGetOfficer.js");
+const companiesGetPerson_js_1 = require("../funcs/companiesGetPerson.js");
+const companiesGetPersonAppointments_js_1 = require("../funcs/companiesGetPersonAppointments.js");
+const companiesGetPersonCluster_js_1 = require("../funcs/companiesGetPersonCluster.js");
+const companiesGetPsc_js_1 = require("../funcs/companiesGetPsc.js");
+const companiesQueryCompanies_js_1 = require("../funcs/companiesQueryCompanies.js");
+const companiesQueryPersons_js_1 = require("../funcs/companiesQueryPersons.js");
+const sdks_js_1 = require("../lib/sdks.js");
+const fp_js_1 = require("./types/fp.js");
+class Companies extends sdks_js_1.ClientSDK {
+    /**
+     * Get companies at a property location
+     *
+     * @remarks
+     * Retrieve all companies registered at a specific property using the UPRN (Unique Property Reference Number). Useful for property-company intelligence and ownership analysis.
+     */
+    async getCompaniesByLocation(request, options) {
+        return (0, fp_js_1.unwrapAsync)((0, companiesGetCompaniesByLocation_js_1.companiesGetCompaniesByLocation)(this, request, options));
+    }
+    /**
+     * Get company by registration number
+     *
+     * @remarks
+     * Retrieve detailed company information using the 8-character Companies House registration number. Optionally includes active officers and PSCs.
+     */
+    async getCompany(request, options) {
+        return (0, fp_js_1.unwrapAsync)((0, companiesGetCompany_js_1.companiesGetCompany)(this, request, options));
+    }
+    /**
+     * Get officers for a company
+     *
+     * @remarks
+     * Retrieve officer appointments (directors, secretaries, LLP members) for a company. By default returns only active officers.
+     */
+    async getCompanyOfficers(request, options) {
+        return (0, fp_js_1.unwrapAsync)((0, companiesGetCompanyOfficers_js_1.companiesGetCompanyOfficers)(this, request, options));
+    }
+    /**
+     * Get persons with significant control for a company
+     *
+     * @remarks
+     * Retrieve PSC (Person with Significant Control) records for a company. PSCs are individuals or entities who hold significant influence over a company, as defined by the Companies Act 2006 Part 21A. Includes individuals, corporate entities, and legal persons. By default, super-secure persons (whose identities are protected by court order) are excluded.
+     */
+    async getCompanyPscs(request, options) {
+        return (0, fp_js_1.unwrapAsync)((0, companiesGetCompanyPscs_js_1.companiesGetCompanyPscs)(this, request, options));
+    }
+    /**
+     * Get officer appointment by ID
+     *
+     * @remarks
+     * Retrieve a specific officer appointment record by its unique identifier.
+     */
+    async getOfficer(request, options) {
+        return (0, fp_js_1.unwrapAsync)((0, companiesGetOfficer_js_1.companiesGetOfficer)(this, request, options));
+    }
+    /**
+     * Get person by ID
+     *
+     * @remarks
+     * Retrieve a deduplicated person record with entity resolution data. Persons are natural individuals linked to officer appointments and PSC notifications.
+     */
+    async getPerson(request, options) {
+        return (0, fp_js_1.unwrapAsync)((0, companiesGetPerson_js_1.companiesGetPerson)(this, request, options));
+    }
+    /**
+     * Get all appointments held by a person
+     *
+     * @remarks
+     * Retrieve all officer appointments held by a person across all companies. Includes company name and status for each appointment.
+     */
+    async getPersonAppointments(request, options) {
+        return (0, fp_js_1.unwrapAsync)((0, companiesGetPersonAppointments_js_1.companiesGetPersonAppointments)(this, request, options));
+    }
+    /**
+     * Get all persons in an entity resolution cluster (Premium)
+     *
+     * @remarks
+     * Retrieve all person records that belong to the same entity resolution cluster. Entity resolution uses probabilistic matching to link records belonging to the same real person. **Requires COMPANIES_HOUSE_PREMIUM product access.**
+     */
+    async getPersonCluster(request, options) {
+        return (0, fp_js_1.unwrapAsync)((0, companiesGetPersonCluster_js_1.companiesGetPersonCluster)(this, request, options));
+    }
+    /**
+     * Get PSC notification by ID
+     *
+     * @remarks
+     * Retrieve a specific PSC (Person with Significant Control) record by its unique identifier.
+     */
+    async getPsc(request, options) {
+        return (0, fp_js_1.unwrapAsync)((0, companiesGetPsc_js_1.companiesGetPsc)(this, request, options));
+    }
+    /**
+     * Search companies with filters
+     *
+     * @remarks
+     * Search for companies using name, status, type, SIC codes, location, and other criteria. Returns paginated results with company summaries.
+     */
+    async queryCompanies(request, options) {
+        return (0, fp_js_1.unwrapAsync)((0, companiesQueryCompanies_js_1.companiesQueryCompanies)(this, request, options));
+    }
+    /**
+     * Search persons with filters
+     *
+     * @remarks
+     * Search for persons using name, date of birth, nationality, and appointment criteria. By default returns only canonical records (deduplicated).
+     */
+    async queryPersons(request, options) {
+        return (0, fp_js_1.unwrapAsync)((0, companiesQueryPersons_js_1.companiesQueryPersons)(this, request, options));
+    }
+}
+exports.Companies = Companies;
+//# sourceMappingURL=companies.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"companies.js","sourceRoot":"","sources":["../../../src/sdk/companies.ts"],"names":[],"mappings":";AAAA;;GAEG;;;AAEH,oGAA8F;AAC9F,4EAAsE;AACtE,4FAAsF;AACtF,oFAA8E;AAC9E,4EAAsE;AACtE,0EAAoE;AACpE,kGAA4F;AAC5F,wFAAkF;AAClF,oEAA8D;AAC9D,oFAA8E;AAC9E,gFAA0E;AAC1E,4CAA2D;AAG3D,yCAA4C;AAE5C,MAAa,SAAU,SAAQ,mBAAS;IACtC;;;;;OAKG;IACH,KAAK,CAAC,sBAAsB,CAC1B,OAAiD,EACjD,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,oEAA+B,EAChD,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,UAAU,CACd,OAAqC,EACrC,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,4CAAmB,EACpC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,kBAAkB,CACtB,OAA6C,EAC7C,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,4DAA2B,EAC5C,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,cAAc,CAClB,OAAyC,EACzC,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,oDAAuB,EACxC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,UAAU,CACd,OAAqC,EACrC,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,4CAAmB,EACpC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,SAAS,CACb,OAAoC,EACpC,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,0CAAkB,EACnC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,qBAAqB,CACzB,OAAgD,EAChD,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,kEAA8B,EAC/C,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,gBAAgB,CACpB,OAA2C,EAC3C,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,wDAAyB,EAC1C,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,MAAM,CACV,OAAiC,EACjC,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,oCAAe,EAChC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,cAAc,CAClB,OAAgD,EAChD,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,oDAAuB,EACxC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,YAAY,CAChB,OAA+C,EAC/C,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,gDAAqB,EACtC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;CACF;AA3LD,8BA2LC"}

package/dist/commonjs/sdk/models/errors/aggregateproperties.d.ts

@@ -33,6 +33,10 @@ export type AggregatePropertiesPropertyError = {
      * Parameter that caused the error
      */
     param?: string | undefined;
+    /**
+     * Suggested corrections (e.g. postcode typo suggestions)
+     */
+    suggestions?: Array<string> | undefined;
     /**
      * Error type category
      */
@@ -87,6 +91,10 @@ export type AggregatePropertiesError = {
      * Parameter that caused the error
      */
     param?: string | undefined;
+    /**
+     * Suggested corrections (e.g. postcode typo suggestions)
+     */
+    suggestions?: Array<string> | undefined;
     /**
      * Error type category
      */

package/dist/commonjs/sdk/models/errors/aggregateproperties.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"aggregateproperties.d.ts","sourceRoot":"","sources":["../../../../../src/sdk/models/errors/aggregateproperties.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAI5B,OAAO,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAChD,OAAO,EAAE,MAAM,IAAI,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAC9D,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AACjD,OAAO,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAC;AAE7D;;GAEG;AACH,eAAO,MAAM,+BAA+B;;;;;CAKlC,CAAC;AACX;;GAEG;AACH,MAAM,MAAM,+BAA+B,GAAG,QAAQ,CACpD,OAAO,+BAA+B,CACvC,CAAC;AAEF,MAAM,MAAM,gCAAgC,GAAG;IAC7C;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC1B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC5B;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC3B;;OAEG;IACH,IAAI,EAAE,+BAA+B,CAAC;CACvC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,2CAA2C,GAAG;IACxD,KAAK,EAAE,gCAAgC,CAAC;CACzC,CAAC;AAEF;;GAEG;AACH,qBAAa,uCAAwC,SAAQ,YAAY;IACvE,KAAK,EAAE,gCAAgC,CAAC;IAExC,gEAAgE;IAChE,KAAK,EAAE,2CAA2C,CAAC;gBAGjD,GAAG,EAAE,2CAA2C,EAChD,QAAQ,EAAE;QAAE,QAAQ,EAAE,QAAQ,CAAC;QAAC,OAAO,EAAE,OAAO,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE;CAUnE;AAED;;GAEG;AACH,eAAO,MAAM,uBAAuB;;;;;CAK1B,CAAC;AACX;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAAG,QAAQ,CAAC,OAAO,uBAAuB,CAAC,CAAC;AAE/E,MAAM,MAAM,wBAAwB,GAAG;IACrC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC1B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC5B;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC3B;;OAEG;IACH,IAAI,EAAE,uBAAuB,CAAC;CAC/B,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,mCAAmC,GAAG;IAChD,KAAK,EAAE,wBAAwB,CAAC;CACjC,CAAC;AAEF;;GAEG;AACH,qBAAa,+BAAgC,SAAQ,YAAY;IAC/D,KAAK,EAAE,wBAAwB,CAAC;IAEhC,gEAAgE;IAChE,KAAK,EAAE,mCAAmC,CAAC;gBAGzC,GAAG,EAAE,mCAAmC,EACxC,QAAQ,EAAE;QAAE,QAAQ,EAAE,QAAQ,CAAC;QAAC,OAAO,EAAE,OAAO,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE;CAUnE;AAED,gBAAgB;AAChB,eAAO,MAAM,6CAA6C,EAAE,CAAC,CAAC,OAAO,CACnE,+BAA+B,EAC/B,CAAC,CAAC,UAAU,EACZ,OAAO,CACmD,CAAC;AAE7D,gBAAgB;AAChB,eAAO,MAAM,8CAA8C,EAAE,CAAC,CAAC,OAAO,CACpE,gCAAgC,EAChC,CAAC,CAAC,UAAU,EACZ,OAAO,CAWP,CAAC;AAEH,wBAAgB,wCAAwC,CACtD,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,gCAAgC,EAAE,kBAAkB,CAAC,CAMvE;AAED,gBAAgB;AAChB,eAAO,MAAM,qDAAqD,EAAE,CAAC,CAAC,OAAO,CAC3E,uCAAuC,EACvC,CAAC,CAAC,UAAU,EACZ,OAAO,CAaL,CAAC;AAEL,gBAAgB;AAChB,eAAO,MAAM,qCAAqC,EAAE,CAAC,CAAC,OAAO,CAC3D,uBAAuB,EACvB,CAAC,CAAC,UAAU,EACZ,OAAO,CAC2C,CAAC;AAErD,gBAAgB;AAChB,eAAO,MAAM,sCAAsC,EAAE,CAAC,CAAC,OAAO,CAC5D,wBAAwB,EACxB,CAAC,CAAC,UAAU,EACZ,OAAO,CAWP,CAAC;AAEH,wBAAgB,gCAAgC,CAC9C,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,wBAAwB,EAAE,kBAAkB,CAAC,CAM/D;AAED,gBAAgB;AAChB,eAAO,MAAM,6CAA6C,EAAE,CAAC,CAAC,OAAO,CACnE,+BAA+B,EAC/B,CAAC,CAAC,UAAU,EACZ,OAAO,CAaL,CAAC"}
+{"version":3,"file":"aggregateproperties.d.ts","sourceRoot":"","sources":["../../../../../src/sdk/models/errors/aggregateproperties.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAI5B,OAAO,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAChD,OAAO,EAAE,MAAM,IAAI,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAC9D,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AACjD,OAAO,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAC;AAE7D;;GAEG;AACH,eAAO,MAAM,+BAA+B;;;;;CAKlC,CAAC;AACX;;GAEG;AACH,MAAM,MAAM,+BAA+B,GAAG,QAAQ,CACpD,OAAO,+BAA+B,CACvC,CAAC;AAEF,MAAM,MAAM,gCAAgC,GAAG;IAC7C;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC1B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC5B;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC3B;;OAEG;IACH,WAAW,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,SAAS,CAAC;IACxC;;OAEG;IACH,IAAI,EAAE,+BAA+B,CAAC;CACvC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,2CAA2C,GAAG;IACxD,KAAK,EAAE,gCAAgC,CAAC;CACzC,CAAC;AAEF;;GAEG;AACH,qBAAa,uCAAwC,SAAQ,YAAY;IACvE,KAAK,EAAE,gCAAgC,CAAC;IAExC,gEAAgE;IAChE,KAAK,EAAE,2CAA2C,CAAC;gBAGjD,GAAG,EAAE,2CAA2C,EAChD,QAAQ,EAAE;QAAE,QAAQ,EAAE,QAAQ,CAAC;QAAC,OAAO,EAAE,OAAO,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE;CAUnE;AAED;;GAEG;AACH,eAAO,MAAM,uBAAuB;;;;;CAK1B,CAAC;AACX;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAAG,QAAQ,CAAC,OAAO,uBAAuB,CAAC,CAAC;AAE/E,MAAM,MAAM,wBAAwB,GAAG;IACrC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC1B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC5B;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC3B;;OAEG;IACH,WAAW,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,SAAS,CAAC;IACxC;;OAEG;IACH,IAAI,EAAE,uBAAuB,CAAC;CAC/B,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,mCAAmC,GAAG;IAChD,KAAK,EAAE,wBAAwB,CAAC;CACjC,CAAC;AAEF;;GAEG;AACH,qBAAa,+BAAgC,SAAQ,YAAY;IAC/D,KAAK,EAAE,wBAAwB,CAAC;IAEhC,gEAAgE;IAChE,KAAK,EAAE,mCAAmC,CAAC;gBAGzC,GAAG,EAAE,mCAAmC,EACxC,QAAQ,EAAE;QAAE,QAAQ,EAAE,QAAQ,CAAC;QAAC,OAAO,EAAE,OAAO,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE;CAUnE;AAED,gBAAgB;AAChB,eAAO,MAAM,6CAA6C,EAAE,CAAC,CAAC,OAAO,CACnE,+BAA+B,EAC/B,CAAC,CAAC,UAAU,EACZ,OAAO,CACmD,CAAC;AAE7D,gBAAgB;AAChB,eAAO,MAAM,8CAA8C,EAAE,CAAC,CAAC,OAAO,CACpE,gCAAgC,EAChC,CAAC,CAAC,UAAU,EACZ,OAAO,CAYP,CAAC;AAEH,wBAAgB,wCAAwC,CACtD,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,gCAAgC,EAAE,kBAAkB,CAAC,CAMvE;AAED,gBAAgB;AAChB,eAAO,MAAM,qDAAqD,EAAE,CAAC,CAAC,OAAO,CAC3E,uCAAuC,EACvC,CAAC,CAAC,UAAU,EACZ,OAAO,CAaL,CAAC;AAEL,gBAAgB;AAChB,eAAO,MAAM,qCAAqC,EAAE,CAAC,CAAC,OAAO,CAC3D,uBAAuB,EACvB,CAAC,CAAC,UAAU,EACZ,OAAO,CAC2C,CAAC;AAErD,gBAAgB;AAChB,eAAO,MAAM,sCAAsC,EAAE,CAAC,CAAC,OAAO,CAC5D,wBAAwB,EACxB,CAAC,CAAC,UAAU,EACZ,OAAO,CAYP,CAAC;AAEH,wBAAgB,gCAAgC,CAC9C,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,wBAAwB,EAAE,kBAAkB,CAAC,CAM/D;AAED,gBAAgB;AAChB,eAAO,MAAM,6CAA6C,EAAE,CAAC,CAAC,OAAO,CACnE,+BAA+B,EAC/B,CAAC,CAAC,UAAU,EACZ,OAAO,CAaL,CAAC"}

package/dist/commonjs/sdk/models/errors/aggregateproperties.js

@@ -98,6 +98,7 @@ exports.AggregatePropertiesPropertyError$inboundSchema = z.object({
     doc_url: z.string().optional(),
     message: z.string(),
     param: z.string().optional(),
+    suggestions: z.array(z.string()).optional(),
     type: exports.AggregatePropertiesPropertyType$inboundSchema,
 }).transform((v) => {
     return (0, primitives_js_1.remap)(v, {
@@ -129,6 +130,7 @@ exports.AggregatePropertiesError$inboundSchema = z.object({
     doc_url: z.string().optional(),
     message: z.string(),
     param: z.string().optional(),
+    suggestions: z.array(z.string()).optional(),
     type: exports.AggregatePropertiesType$inboundSchema,
 }).transform((v) => {
     return (0, primitives_js_1.remap)(v, {

package/dist/commonjs/sdk/models/errors/aggregateproperties.js.map

@@ -1 +1 @@
-{"version":3,"file":"aggregateproperties.js","sourceRoot":"","sources":["../../../../../src/sdk/models/errors/aggregateproperties.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA2KH,4FAQC;AA6CD,4EAQC;AAtOD,0CAA4B;AAC5B,8DAA6D;AAC7D,wDAAoD;AACpD,gEAAkD;AAGlD,uDAAiD;AAGjD;;GAEG;AACU,QAAA,+BAA+B,GAAG;IAC7C,QAAQ,EAAE,WAAW;IACrB,mBAAmB,EAAE,uBAAuB;IAC5C,mBAAmB,EAAE,sBAAsB;IAC3C,cAAc,EAAE,kBAAkB;CAC1B,CAAC;AAsCX;;GAEG;AACH,MAAa,uCAAwC,SAAQ,8BAAY;IAMvE,YACE,GAAgD,EAChD,QAAgE;QAEhE,MAAM,OAAO,GAAG,GAAG,CAAC,KAAK,EAAE,OAAO;eAC7B,uBAAuB,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,EAAE,CAAC;QAClD,KAAK,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;QACzB,IAAI,CAAC,KAAK,GAAG,GAAG,CAAC;QACjB,IAAI,CAAC,KAAK,GAAG,GAAG,CAAC,KAAK,CAAC;QAEvB,IAAI,CAAC,IAAI,GAAG,yCAAyC,CAAC;IACxD,CAAC;CACF;AAlBD,0FAkBC;AAED;;GAEG;AACU,QAAA,uBAAuB,GAAG;IACrC,QAAQ,EAAE,WAAW;IACrB,mBAAmB,EAAE,uBAAuB;IAC5C,mBAAmB,EAAE,sBAAsB;IAC3C,cAAc,EAAE,kBAAkB;CAC1B,CAAC;AAoCX;;GAEG;AACH,MAAa,+BAAgC,SAAQ,8BAAY;IAM/D,YACE,GAAwC,EACxC,QAAgE;QAEhE,MAAM,OAAO,GAAG,GAAG,CAAC,KAAK,EAAE,OAAO;eAC7B,uBAAuB,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,EAAE,CAAC;QAClD,KAAK,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;QACzB,IAAI,CAAC,KAAK,GAAG,GAAG,CAAC;QACjB,IAAI,CAAC,KAAK,GAAG,GAAG,CAAC,KAAK,CAAC;QAEvB,IAAI,CAAC,IAAI,GAAG,iCAAiC,CAAC;IAChD,CAAC;CACF;AAlBD,0EAkBC;AAED,gBAAgB;AACH,QAAA,6CAA6C,GAItD,SAAS,CAAC,aAAa,CAAC,uCAA+B,CAAC,CAAC;AAE7D,gBAAgB;AACH,QAAA,8CAA8C,GAIvD,CAAC,CAAC,MAAM,CAAC;IACX,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC3B,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC9B,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE;IACnB,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC5B,IAAI,EAAE,qDAA6C;CACpD,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE;IACjB,OAAO,IAAA,qBAAM,EAAC,CAAC,EAAE;QACf,SAAS,EAAE,QAAQ;KACpB,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,SAAgB,wCAAwC,CACtD,UAAkB;IAElB,OAAO,IAAA,sBAAS,EACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,sDAA8C,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAC1E,8DAA8D,CAC/D,CAAC;AACJ,CAAC;AAED,gBAAgB;AACH,QAAA,qDAAqD,GAI9D,CAAC,CAAC,MAAM,CAAC;IACX,KAAK,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,sDAA8C,CAAC;IACnE,QAAQ,EAAE,CAAC,CAAC,UAAU,CAAC,OAAO,CAAC;IAC/B,SAAS,EAAE,CAAC,CAAC,UAAU,CAAC,QAAQ,CAAC;IACjC,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;CAClB,CAAC;KACC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE;IACf,OAAO,IAAI,uCAAuC,CAAC,CAAC,EAAE;QACpD,OAAO,EAAE,CAAC,CAAC,QAAQ;QACnB,QAAQ,EAAE,CAAC,CAAC,SAAS;QACrB,IAAI,EAAE,CAAC,CAAC,KAAK;KACd,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEL,gBAAgB;AACH,QAAA,qCAAqC,GAI9C,SAAS,CAAC,aAAa,CAAC,+BAAuB,CAAC,CAAC;AAErD,gBAAgB;AACH,QAAA,sCAAsC,GAI/C,CAAC,CAAC,MAAM,CAAC;IACX,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC3B,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC9B,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE;IACnB,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC5B,IAAI,EAAE,6CAAqC;CAC5C,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE;IACjB,OAAO,IAAA,qBAAM,EAAC,CAAC,EAAE;QACf,SAAS,EAAE,QAAQ;KACpB,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,SAAgB,gCAAgC,CAC9C,UAAkB;IAElB,OAAO,IAAA,sBAAS,EACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,8CAAsC,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAClE,sDAAsD,CACvD,CAAC;AACJ,CAAC;AAED,gBAAgB;AACH,QAAA,6CAA6C,GAItD,CAAC,CAAC,MAAM,CAAC;IACX,KAAK,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,8CAAsC,CAAC;IAC3D,QAAQ,EAAE,CAAC,CAAC,UAAU,CAAC,OAAO,CAAC;IAC/B,SAAS,EAAE,CAAC,CAAC,UAAU,CAAC,QAAQ,CAAC;IACjC,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;CAClB,CAAC;KACC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE;IACf,OAAO,IAAI,+BAA+B,CAAC,CAAC,EAAE;QAC5C,OAAO,EAAE,CAAC,CAAC,QAAQ;QACnB,QAAQ,EAAE,CAAC,CAAC,SAAS;QACrB,IAAI,EAAE,CAAC,CAAC,KAAK;KACd,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}
+{"version":3,"file":"aggregateproperties.js","sourceRoot":"","sources":["../../../../../src/sdk/models/errors/aggregateproperties.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAoLH,4FAQC;AA8CD,4EAQC;AAhPD,0CAA4B;AAC5B,8DAA6D;AAC7D,wDAAoD;AACpD,gEAAkD;AAGlD,uDAAiD;AAGjD;;GAEG;AACU,QAAA,+BAA+B,GAAG;IAC7C,QAAQ,EAAE,WAAW;IACrB,mBAAmB,EAAE,uBAAuB;IAC5C,mBAAmB,EAAE,sBAAsB;IAC3C,cAAc,EAAE,kBAAkB;CAC1B,CAAC;AA0CX;;GAEG;AACH,MAAa,uCAAwC,SAAQ,8BAAY;IAMvE,YACE,GAAgD,EAChD,QAAgE;QAEhE,MAAM,OAAO,GAAG,GAAG,CAAC,KAAK,EAAE,OAAO;eAC7B,uBAAuB,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,EAAE,CAAC;QAClD,KAAK,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;QACzB,IAAI,CAAC,KAAK,GAAG,GAAG,CAAC;QACjB,IAAI,CAAC,KAAK,GAAG,GAAG,CAAC,KAAK,CAAC;QAEvB,IAAI,CAAC,IAAI,GAAG,yCAAyC,CAAC;IACxD,CAAC;CACF;AAlBD,0FAkBC;AAED;;GAEG;AACU,QAAA,uBAAuB,GAAG;IACrC,QAAQ,EAAE,WAAW;IACrB,mBAAmB,EAAE,uBAAuB;IAC5C,mBAAmB,EAAE,sBAAsB;IAC3C,cAAc,EAAE,kBAAkB;CAC1B,CAAC;AAwCX;;GAEG;AACH,MAAa,+BAAgC,SAAQ,8BAAY;IAM/D,YACE,GAAwC,EACxC,QAAgE;QAEhE,MAAM,OAAO,GAAG,GAAG,CAAC,KAAK,EAAE,OAAO;eAC7B,uBAAuB,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,EAAE,CAAC;QAClD,KAAK,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;QACzB,IAAI,CAAC,KAAK,GAAG,GAAG,CAAC;QACjB,IAAI,CAAC,KAAK,GAAG,GAAG,CAAC,KAAK,CAAC;QAEvB,IAAI,CAAC,IAAI,GAAG,iCAAiC,CAAC;IAChD,CAAC;CACF;AAlBD,0EAkBC;AAED,gBAAgB;AACH,QAAA,6CAA6C,GAItD,SAAS,CAAC,aAAa,CAAC,uCAA+B,CAAC,CAAC;AAE7D,gBAAgB;AACH,QAAA,8CAA8C,GAIvD,CAAC,CAAC,MAAM,CAAC;IACX,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC3B,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC9B,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE;IACnB,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC5B,WAAW,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;IAC3C,IAAI,EAAE,qDAA6C;CACpD,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE;IACjB,OAAO,IAAA,qBAAM,EAAC,CAAC,EAAE;QACf,SAAS,EAAE,QAAQ;KACpB,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,SAAgB,wCAAwC,CACtD,UAAkB;IAElB,OAAO,IAAA,sBAAS,EACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,sDAA8C,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAC1E,8DAA8D,CAC/D,CAAC;AACJ,CAAC;AAED,gBAAgB;AACH,QAAA,qDAAqD,GAI9D,CAAC,CAAC,MAAM,CAAC;IACX,KAAK,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,sDAA8C,CAAC;IACnE,QAAQ,EAAE,CAAC,CAAC,UAAU,CAAC,OAAO,CAAC;IAC/B,SAAS,EAAE,CAAC,CAAC,UAAU,CAAC,QAAQ,CAAC;IACjC,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;CAClB,CAAC;KACC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE;IACf,OAAO,IAAI,uCAAuC,CAAC,CAAC,EAAE;QACpD,OAAO,EAAE,CAAC,CAAC,QAAQ;QACnB,QAAQ,EAAE,CAAC,CAAC,SAAS;QACrB,IAAI,EAAE,CAAC,CAAC,KAAK;KACd,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEL,gBAAgB;AACH,QAAA,qCAAqC,GAI9C,SAAS,CAAC,aAAa,CAAC,+BAAuB,CAAC,CAAC;AAErD,gBAAgB;AACH,QAAA,sCAAsC,GAI/C,CAAC,CAAC,MAAM,CAAC;IACX,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC3B,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC9B,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE;IACnB,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC5B,WAAW,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;IAC3C,IAAI,EAAE,6CAAqC;CAC5C,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE;IACjB,OAAO,IAAA,qBAAM,EAAC,CAAC,EAAE;QACf,SAAS,EAAE,QAAQ;KACpB,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,SAAgB,gCAAgC,CAC9C,UAAkB;IAElB,OAAO,IAAA,sBAAS,EACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,8CAAsC,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAClE,sDAAsD,CACvD,CAAC;AACJ,CAAC;AAED,gBAAgB;AACH,QAAA,6CAA6C,GAItD,CAAC,CAAC,MAAM,CAAC;IACX,KAAK,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,8CAAsC,CAAC;IAC3D,QAAQ,EAAE,CAAC,CAAC,UAAU,CAAC,OAAO,CAAC;IAC/B,SAAS,EAAE,CAAC,CAAC,UAAU,CAAC,QAAQ,CAAC;IACjC,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;CAClB,CAAC;KACC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE;IACf,OAAO,IAAI,+BAA+B,CAAC,CAAC,EAAE;QAC5C,OAAO,EAAE,CAAC,CAAC,QAAQ;QACnB,QAAQ,EAAE,CAAC,CAAC,SAAS;QACrB,IAAI,EAAE,CAAC,CAAC,KAAK;KACd,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}