Vepler logo
v3.1.0

Designations, admission areas and search retrieve in the TypeScript SDK, plus a search guide

@vepler/sdk 3.0.0 adds typed clients for heritage, conservation and land constraint designations, school admission areas and search retrieve, plus a new search guide.

Added

  • Heritage, conservation and land constraint designations are reachable from the TypeScript SDK through the sdk.heritage, sdk.conservation and sdk.landConstraint namespaces, each exposing query, get, types and snapshots over POST /v1/heritage/designations/query, POST /v1/conservation/designations/query and POST /v1/land-constraint/designations/query.
  • search.searchRetrieve() performs the charged selection step of the search flow: pass the uprn from a chosen suggest row, optionally with its search_id, to receive the full address record with address lines, postcode, coordinates and classification.
  • schoolsCatchment.getAdmissionArea() returns a school's admission boundary as a single GeoJSON FeatureCollection, pairing designated catchment polygons with a distance radius feature when the furthest admitted distance is known.
  • granularity and searchId are typed on search.searchSuggest(), so street level results and candidate-set narrowing are reachable from the SDK. See GET /v1/search/suggest for the full parameter set.
  • A Search and Autocomplete guide on the documentation site walks through the free suggest step and the charged selection step, geo bias and restrict, source, classification, granularity, candidate-set narrowing, autocomplete patterns such as debounce and abort on supersede, and the X-Credits-* response headers. The Address Billing and Sessions guide joins it in the Guides navigation.

Changed

  • The published package moves to @vepler/sdk 3.0.0, and its version tracks the API version it is generated against.
  • Title deed extraction models carry a Title prefix: TitleExtractionPayload, TitleProprietor, TitleRestriction, TitleNotice, TitleDocumentSummary and TitleSummaryCounts, alongside MortgageCharge, OtherCharge, TitleCovenant and TitleScheduleNoticeOfLease. Point imports at the new names when you upgrade from the earlier Extraction* exports.
  • Generated models cover the property, listing and search fields the API serves today, including countryCode on PropertyAddress, nation on SaleRecord, PropertyAssessments, StreetMatch on search results, and RegisteredCharges.

Affected endpoints