@vepler/http-sdk
Version:
The definitive TypeScript SDK for UK property technology. Access comprehensive property data, school metrics, demographics, planning applications, and more through a single, powerful API.
204 lines (203 loc) • 13.8 kB
TypeScript
/**
* @license
* Vepler HTTP SDK
* Copyright (c) 2023-2025 Vepler Limited. All rights reserved.
* Licensed under the MIT License (the "License"); you may not use this
* file except in compliance with the License. You may obtain a copy of the
* License at https://opensource.org/licenses/MIT
*/
import { initializeSDK as initSDK, reset } from './config';
export type { QueryByTypeParams } from './services/area-reference/routes/query-by-type';
export type { BorderAreasParams } from './services/area-reference/routes/border-areas';
export type { WithinAreasParams } from './services/area-reference/routes/within-areas';
export type { GetAreasParams } from './services/area-reference/routes/get-areas';
export type { ResolveGeographyParams, GetGeographyTypesParams, CheckResolutionCapabilityParams, CoverageQualityType, TargetGeographyWithCoverage, EnhancedResolvedGeography, EnhancedResolveGeographyResponse, } from './services/area-reference/routes/resolve-geography';
export type { Areas, Metrics, Geographic, } from '@vepler/area-reference-types';
export type { GetCatalogQueryParams, GetCatalogResponse, GetCrimeDataQueryParams, GetCrimeDataResponse, GetAreaStatsQueryParams, GetAreaStatsResponse, GetCategoryStatsQueryParams, GetCategoryStatsResponse, GetMetricsQueryParams, GetMetricsResponse, GetByLocationQueryParams, GetByLocationResponse, GetByAreaQueryParams, GetByAreaResponse, GetSchemeDetailsQueryParams, NeighborhoodWatchSchemeResponse, } from '@vepler/safety-types';
export type { SchoolsQueryParams, SchoolsResponse, } from '@vepler/schools-types/api/endpoints/schools';
export type { SchoolByIdResponse } from '@vepler/schools-types/api/endpoints/schools-by-id';
export type { GetSchoolByIdParams } from './services/schools/routes/get-school-by-id';
export type { SchoolSearchQueryParams, SchoolSearchResponse, } from '@vepler/schools-types/api/endpoints/search';
export type { SchoolAutocompleteQueryParams, SchoolAutocompleteResponse, } from '@vepler/schools-types/api/endpoints/search';
export type { MetricsQueryParams, MetricsResponse, } from '@vepler/schools-types/api/endpoints/metrics';
export type { MetricsGeographicRequestBody, MetricsGeographicResponse, } from '@vepler/schools-types/api/endpoints/metrics-geographic';
export type { ApplicationQuery, QueryApplicationResponse, GetApplicationParams, GetApplicationResponse, GetTilesParams, PlanningApplication, PlanningStatus, } from '@vepler/planning-register-types';
export type { UnifiedSearchInput, UnifiedSearchResponse, } from '@vepler/search-types';
export type { IMultiTargetPredictionRequest, IMultiTargetPredictionResponse, } from '@vepler/property-predictor-types';
export type { AutocompleteQueryParams, AddressSearchResponse, SuccessResponse, AutocompleteResult, IAddressResponse, CanonicalAutocompleteQueryParams, CanonicalSuccessResponse, CanonicalAutocompleteResult, } from '@vepler/locations-types';
export type { AddressLookupRequest, AddressLookupResponse, AddressLookupResult, AddressLookupOptions, AddressMatch, ProcessingStep, AddressLookupMetadata, } from '@vepler/locations-types';
export type { PropertyRequestParams, PropertyResponse, PropertyInfo, PropertyTaxBand, } from '@vepler/council-register-types';
export type { GetPropertyByPropertyIdParams, PropertyEntity, PropertyResponse as PropertyServiceResponse, } from './services/property/routes/get-property';
export type { QueryPropertyResult, GetPropertyBySourceParams, } from './services/property/routes/query-property';
export type { DemographicsQueryParams, GetDemographicsResponse, } from './services/demographics/routes/query-demographics';
export type { GetConnectivityScoresParams, ConnectivityScore, GetConnectivityScoresResponse, } from './services/connectivity/routes/get-connectivity-scores';
export type { GetPOITilesQueryParams, GetPOITilesMetadata, GetPOITilesGeoJSONResponse, TileCoordinate, GetNearestPOIQueryParams, GetNearestPOIResponse, } from '@vepler/area-reference-types/routes/poi';
export type { GetH3AggregationsParams } from './services/h3/routes/get-h3-aggregations';
export { initSDK as initializeSDK, reset };
declare const routes: {
property: {
getProperty: typeof import("./services/property/routes/get-property").getProperty;
getPropertyById: typeof import("./services/property/routes/get-property-by-location-id").getPropertyById;
queryProperty: typeof import("./services/property/routes/query-property").queryProperty;
};
areaReference: {
get: typeof import("./services/area-reference/routes/get-areas").getAreas;
within: typeof import("./services/area-reference/routes/within-areas").withinAreas;
children: typeof import("./services/area-reference/routes/get-child-areas").getChildAreas;
border: typeof import("./services/area-reference/routes/border-areas").borderAreas;
coverage: typeof import("./services/area-reference/routes/coverage").coverage;
metrics: {
query: typeof import("./services/area-reference/routes/query-metrics").queryMetrics;
};
query: {
byType: typeof import("./services/area-reference/routes/query-by-type").queryByType;
};
resolver: {
resolve: typeof import("./services/area-reference/routes/resolve-geography").resolveGeography;
getTypes: typeof import("./services/area-reference/routes/resolve-geography").getGeographyTypes;
checkCapability: typeof import("./services/area-reference/routes/resolve-geography").checkResolutionCapability;
};
};
safety: {
catalog: typeof import("./services/safety/routes/get-catalog").getCatalog;
crime: {
getData: typeof import("./services/safety/routes/get-crime-data").getCrimeData;
getAreaStats: typeof import("./services/safety/routes/get-area-stats").getAreaStats;
getCategoryStats: typeof import("./services/safety/routes/get-category-stats").getCategoryStats;
};
geography: {
getMetrics: typeof import("./services/safety/routes/query-geography-metrics").queryGeographyMetrics;
};
neighborhoodWatch: {
getByLocation: typeof import("./services/safety/routes/get-neighborhood-watch-by-location").getNeighborhoodWatchByLocation;
getByArea: typeof import("./services/safety/routes/get-neighborhood-watch-by-area").getNeighborhoodWatchByArea;
getSchemeDetails: typeof import("./services/safety/routes/get-neighborhood-watch-scheme-details").getNeighborhoodWatchSchemeDetails;
};
};
rover: {
query: typeof import("./services/demographics/routes/query-demographics").queryDemographics;
};
schools: {
getSchools: typeof import("./services/schools/routes/get-schools").getSchools;
getSchoolById: typeof import("./services/schools/routes/get-school-by-id").getSchoolById;
search: typeof import("./services/schools/routes/search-schools").searchSchools;
metrics: {
get: typeof import("./services/schools/routes/get-metrics").getMetrics;
timeSeries: typeof import("./services/schools/routes/get-timeseries-metrics").getTimeSeriesMetrics;
geographic: typeof import("./services/schools/routes/get-geographic-metrics").getGeographicMetrics;
};
autocomplete: typeof import("./services/schools/routes/autocomplete-schools").autocompleteSchools;
};
planningRegister: {
queryApplications: typeof import("./services/planning-register/routes/query-applications").queryApplications;
getApplicationById: typeof import("./services/planning-register/routes/get-application-by-id").getApplicationById;
getMapTile: typeof import("./services/planning-register/routes/get-map-tile").getMapTile;
};
search: {
search: typeof import("./services/search/routes/search").search;
};
propertyPredictor: {
predictMultiTarget: typeof import("./services/property-predictor/routes/predict-multi-target").predictMultiTarget;
};
location: {
autocomplete: typeof import("./services/location/routes/autocomplete-location").autocompleteLocation;
autocompleteAddress: typeof import("./services/location/routes/autocomplete-address").autocompleteAddress;
lookup: typeof import("./services/location/routes/address-lookup").addressLookup;
};
councilRegister: {
getProperty: typeof import("./services/council-tax-register/routes/get-property").getProperty;
};
connectivity: {
scores: typeof import("./services/connectivity/routes/get-connectivity-scores").getConnectivityScores;
};
poi: {
nearest: typeof import("./services/poi/routes/get-nearest-poi").getNearestPoi;
tiles: typeof import("./services/poi/routes/get-poi-tiles").getPoiTiles;
};
h3: {
aggregations: typeof import("./services/h3/routes/get-h3-aggregations").getH3Aggregations;
};
};
export declare const property: {
getProperty: typeof import("./services/property/routes/get-property").getProperty;
getPropertyById: typeof import("./services/property/routes/get-property-by-location-id").getPropertyById;
queryProperty: typeof import("./services/property/routes/query-property").queryProperty;
};
export declare const areaReference: {
get: typeof import("./services/area-reference/routes/get-areas").getAreas;
within: typeof import("./services/area-reference/routes/within-areas").withinAreas;
children: typeof import("./services/area-reference/routes/get-child-areas").getChildAreas;
border: typeof import("./services/area-reference/routes/border-areas").borderAreas;
coverage: typeof import("./services/area-reference/routes/coverage").coverage;
metrics: {
query: typeof import("./services/area-reference/routes/query-metrics").queryMetrics;
};
query: {
byType: typeof import("./services/area-reference/routes/query-by-type").queryByType;
};
resolver: {
resolve: typeof import("./services/area-reference/routes/resolve-geography").resolveGeography;
getTypes: typeof import("./services/area-reference/routes/resolve-geography").getGeographyTypes;
checkCapability: typeof import("./services/area-reference/routes/resolve-geography").checkResolutionCapability;
};
};
export declare const safety: {
catalog: typeof import("./services/safety/routes/get-catalog").getCatalog;
crime: {
getData: typeof import("./services/safety/routes/get-crime-data").getCrimeData;
getAreaStats: typeof import("./services/safety/routes/get-area-stats").getAreaStats;
getCategoryStats: typeof import("./services/safety/routes/get-category-stats").getCategoryStats;
};
geography: {
getMetrics: typeof import("./services/safety/routes/query-geography-metrics").queryGeographyMetrics;
};
neighborhoodWatch: {
getByLocation: typeof import("./services/safety/routes/get-neighborhood-watch-by-location").getNeighborhoodWatchByLocation;
getByArea: typeof import("./services/safety/routes/get-neighborhood-watch-by-area").getNeighborhoodWatchByArea;
getSchemeDetails: typeof import("./services/safety/routes/get-neighborhood-watch-scheme-details").getNeighborhoodWatchSchemeDetails;
};
};
export declare const rover: {
query: typeof import("./services/demographics/routes/query-demographics").queryDemographics;
};
export declare const schools: {
getSchools: typeof import("./services/schools/routes/get-schools").getSchools;
getSchoolById: typeof import("./services/schools/routes/get-school-by-id").getSchoolById;
search: typeof import("./services/schools/routes/search-schools").searchSchools;
metrics: {
get: typeof import("./services/schools/routes/get-metrics").getMetrics;
timeSeries: typeof import("./services/schools/routes/get-timeseries-metrics").getTimeSeriesMetrics;
geographic: typeof import("./services/schools/routes/get-geographic-metrics").getGeographicMetrics;
};
autocomplete: typeof import("./services/schools/routes/autocomplete-schools").autocompleteSchools;
};
export declare const planningRegister: {
queryApplications: typeof import("./services/planning-register/routes/query-applications").queryApplications;
getApplicationById: typeof import("./services/planning-register/routes/get-application-by-id").getApplicationById;
getMapTile: typeof import("./services/planning-register/routes/get-map-tile").getMapTile;
};
export declare const search: {
search: typeof import("./services/search/routes/search").search;
};
export declare const propertyPredictor: {
predictMultiTarget: typeof import("./services/property-predictor/routes/predict-multi-target").predictMultiTarget;
};
export declare const location: {
autocomplete: typeof import("./services/location/routes/autocomplete-location").autocompleteLocation;
autocompleteAddress: typeof import("./services/location/routes/autocomplete-address").autocompleteAddress;
lookup: typeof import("./services/location/routes/address-lookup").addressLookup;
};
export declare const councilRegister: {
getProperty: typeof import("./services/council-tax-register/routes/get-property").getProperty;
};
export declare const connectivity: {
scores: typeof import("./services/connectivity/routes/get-connectivity-scores").getConnectivityScores;
};
export declare const poi: {
nearest: typeof import("./services/poi/routes/get-nearest-poi").getNearestPoi;
tiles: typeof import("./services/poi/routes/get-poi-tiles").getPoiTiles;
};
export declare const h3: {
aggregations: typeof import("./services/h3/routes/get-h3-aggregations").getH3Aggregations;
};
export default routes;