@vepler/http-sdk/dist/services/safety/routes/query-geography-metrics.d.ts

The definitive TypeScript SDK for UK property technology. Access comprehensive property data, school metrics, demographics, planning applications, and more through a single, powerful API.

import { GetMetricsQueryParams, GetMetricsResponse } from '@vepler/safety-types';
export declare const queryGeographyMetricsValidation: {
    query: {
        geographicCodes: {
            required: boolean;
            description: string;
        };
        periods: {
            description: string;
            custom: (value: string) => string | Error;
        };
        startDate: {
            description: string;
            custom: (value: string) => string | Error;
        };
        endDate: {
            description: string;
            custom: (value: string) => string | Error;
        };
        mergeAreas: {
            default: boolean;
            description: string;
        };
        includeTimeSeries: {
            default: boolean;
            description: string;
        };
        months: {
            min: number;
            max: number;
            default: number;
            description: string;
        };
    };
    validationRules: {
        type: string;
        fields: string[];
    }[];
};
export declare function queryGeographyMetrics(params: GetMetricsQueryParams): Promise<GetMetricsResponse[]>;