@vepler/sdk 1.10.1 → 2.3.0

package/dist/esm/sdk/models/operations/getborderingareas.d.ts

@@ -0,0 +1,658 @@
+import * as z from "zod/v3";
+import { ClosedEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+export type GetBorderingAreasRequest = {
+    /**
+     * Include GeoJSON boundary geometry (default: false)
+     */
+    includeGeometry?: string | undefined;
+    /**
+     * Type of areas to find that border the target
+     */
+    sourceType: string;
+    /**
+     * Code of the target area
+     */
+    targetCode: string;
+    /**
+     * Type of the target area
+     */
+    targetType: string;
+};
+/**
+ * Error response format for failed requests
+ */
+export type GetBorderingAreasAreasResponseResponseBody = {
+    /**
+     * Machine-readable error code
+     */
+    code?: string | undefined;
+    /**
+     * Detailed error information for debugging
+     */
+    details?: string | undefined;
+    /**
+     * High-level error category or message
+     */
+    error: string;
+    /**
+     * Always false for error responses
+     */
+    success: boolean;
+};
+/**
+ * Error response format for failed requests
+ */
+export type GetBorderingAreasAreasResponseBody = {
+    /**
+     * Machine-readable error code
+     */
+    code?: string | undefined;
+    /**
+     * Detailed error information for debugging
+     */
+    details?: string | undefined;
+    /**
+     * High-level error category or message
+     */
+    error: string;
+    /**
+     * Always false for error responses
+     */
+    success: boolean;
+};
+export type GetBorderingAreasHierarchy = {
+    /**
+     * Code of the area at this hierarchy level
+     */
+    code: string;
+    /**
+     * Hierarchy level (0 = finest granularity like output_area, higher numbers = broader areas like country)
+     */
+    level: number;
+    /**
+     * Name of the area at this hierarchy level
+     */
+    name: string;
+    /**
+     * Geographic type at this level
+     */
+    type: string;
+};
+export type GetBorderingAreasRelationships = {
+    /**
+     * Nature of the relationship: 'contains' (parent-child), 'borders' (adjacent), 'overlaps' (partial overlap)
+     */
+    relationshipType: string;
+    /**
+     * Code of the related geographic entity
+     */
+    targetId: string;
+    /**
+     * Type of the related geographic entity
+     */
+    targetType: string;
+};
+/**
+ * Geographic hierarchy type - from smallest (output_area) to largest (country)
+ */
+export declare const GetBorderingAreasType: {
+    readonly Postcode: "postcode";
+    readonly Lsoa21: "lsoa21";
+    readonly UkOutputArea: "uk_output_area";
+    readonly Ward: "ward";
+    readonly Country: "country";
+    readonly County: "county";
+    readonly LocalAuthorityDistrict: "local_authority_district";
+    readonly AreaNaturalBeauty: "area_natural_beauty";
+    readonly NationalScenicArea: "national_scenic_area";
+};
+/**
+ * Geographic hierarchy type - from smallest (output_area) to largest (country)
+ */
+export type GetBorderingAreasType = ClosedEnum<typeof GetBorderingAreasType>;
+/**
+ * A geographic entity representing an administrative or statistical area
+ */
+export type BorderingAreas = {
+    /**
+     * Total area in square metres
+     */
+    areaSqm?: number | null | undefined;
+    /**
+     * Unique identifier code for this area (e.g., 'SW1A1AA' for postcode, 'E09000001' for local authority)
+     */
+    code: string;
+    /**
+     * GeoJSON geometry object representing the area boundary (Polygon or MultiPolygon format)
+     */
+    geometry?: any | null | undefined;
+    /**
+     * Geographic hierarchy showing parent areas at different administrative levels
+     */
+    hierarchy?: Array<GetBorderingAreasHierarchy> | null | undefined;
+    /**
+     * Internal database ID for the geographic entity
+     */
+    id?: number | undefined;
+    /**
+     * Latitude of the area's centroid point in WGS84 (EPSG:4326)
+     */
+    lat?: number | null | undefined;
+    /**
+     * Longitude of the area's centroid point in WGS84 (EPSG:4326)
+     */
+    long?: number | null | undefined;
+    /**
+     * Additional metadata about the area in key-value format
+     */
+    metadata?: {
+        [k: string]: any | null;
+    } | null | undefined;
+    /**
+     * Human-readable name of the geographic area
+     */
+    name: string;
+    /**
+     * List of relationships this area has with other geographic entities
+     */
+    relationships?: Array<GetBorderingAreasRelationships> | null | undefined;
+    /**
+     * Current status of the area (e.g., 'active', 'archived')
+     */
+    status?: string | undefined;
+    /**
+     * Geographic hierarchy type - from smallest (output_area) to largest (country)
+     */
+    type: GetBorderingAreasType;
+};
+export type GetBorderingAreasAreasHierarchy = {
+    /**
+     * Code of the area at this hierarchy level
+     */
+    code: string;
+    /**
+     * Hierarchy level (0 = finest granularity like output_area, higher numbers = broader areas like country)
+     */
+    level: number;
+    /**
+     * Name of the area at this hierarchy level
+     */
+    name: string;
+    /**
+     * Geographic type at this level
+     */
+    type: string;
+};
+export type GetBorderingAreasAreasRelationships = {
+    /**
+     * Nature of the relationship: 'contains' (parent-child), 'borders' (adjacent), 'overlaps' (partial overlap)
+     */
+    relationshipType: string;
+    /**
+     * Code of the related geographic entity
+     */
+    targetId: string;
+    /**
+     * Type of the related geographic entity
+     */
+    targetType: string;
+};
+/**
+ * Geographic hierarchy type - from smallest (output_area) to largest (country)
+ */
+export declare const GetBorderingAreasAreasType: {
+    readonly Postcode: "postcode";
+    readonly Lsoa21: "lsoa21";
+    readonly UkOutputArea: "uk_output_area";
+    readonly Ward: "ward";
+    readonly Country: "country";
+    readonly County: "county";
+    readonly LocalAuthorityDistrict: "local_authority_district";
+    readonly AreaNaturalBeauty: "area_natural_beauty";
+    readonly NationalScenicArea: "national_scenic_area";
+};
+/**
+ * Geographic hierarchy type - from smallest (output_area) to largest (country)
+ */
+export type GetBorderingAreasAreasType = ClosedEnum<typeof GetBorderingAreasAreasType>;
+/**
+ * A geographic entity representing an administrative or statistical area
+ */
+export type Target = {
+    /**
+     * Total area in square metres
+     */
+    areaSqm?: number | null | undefined;
+    /**
+     * Unique identifier code for this area (e.g., 'SW1A1AA' for postcode, 'E09000001' for local authority)
+     */
+    code: string;
+    /**
+     * GeoJSON geometry object representing the area boundary (Polygon or MultiPolygon format)
+     */
+    geometry?: any | null | undefined;
+    /**
+     * Geographic hierarchy showing parent areas at different administrative levels
+     */
+    hierarchy?: Array<GetBorderingAreasAreasHierarchy> | null | undefined;
+    /**
+     * Internal database ID for the geographic entity
+     */
+    id?: number | undefined;
+    /**
+     * Latitude of the area's centroid point in WGS84 (EPSG:4326)
+     */
+    lat?: number | null | undefined;
+    /**
+     * Longitude of the area's centroid point in WGS84 (EPSG:4326)
+     */
+    long?: number | null | undefined;
+    /**
+     * Additional metadata about the area in key-value format
+     */
+    metadata?: {
+        [k: string]: any | null;
+    } | null | undefined;
+    /**
+     * Human-readable name of the geographic area
+     */
+    name: string;
+    /**
+     * List of relationships this area has with other geographic entities
+     */
+    relationships?: Array<GetBorderingAreasAreasRelationships> | null | undefined;
+    /**
+     * Current status of the area (e.g., 'active', 'archived')
+     */
+    status?: string | undefined;
+    /**
+     * Geographic hierarchy type - from smallest (output_area) to largest (country)
+     */
+    type: GetBorderingAreasAreasType;
+};
+/**
+ * Response containing target area and its bordering neighbors
+ */
+export type GetBorderingAreasResponseBody = {
+    /**
+     * Array of areas that share a border with the target area
+     */
+    borderingAreas: Array<BorderingAreas>;
+    /**
+     * Optional message providing additional context about the response
+     */
+    message?: string | undefined;
+    /**
+     * Indicates whether the request was successful
+     */
+    success: boolean;
+    /**
+     * A geographic entity representing an administrative or statistical area
+     */
+    target: Target;
+    /**
+     * Total number of bordering areas
+     */
+    total: number;
+};
+export type GetBorderingAreasResponse = GetBorderingAreasResponseBody | GetBorderingAreasAreasResponseBody | GetBorderingAreasAreasResponseResponseBody;
+/** @internal */
+export declare const GetBorderingAreasRequest$inboundSchema: z.ZodType<GetBorderingAreasRequest, z.ZodTypeDef, unknown>;
+/** @internal */
+export type GetBorderingAreasRequest$Outbound = {
+    includeGeometry?: string | undefined;
+    sourceType: string;
+    targetCode: string;
+    targetType: string;
+};
+/** @internal */
+export declare const GetBorderingAreasRequest$outboundSchema: z.ZodType<GetBorderingAreasRequest$Outbound, z.ZodTypeDef, GetBorderingAreasRequest>;
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export declare namespace GetBorderingAreasRequest$ {
+    /** @deprecated use `GetBorderingAreasRequest$inboundSchema` instead. */
+    const inboundSchema: z.ZodType<GetBorderingAreasRequest, z.ZodTypeDef, unknown>;
+    /** @deprecated use `GetBorderingAreasRequest$outboundSchema` instead. */
+    const outboundSchema: z.ZodType<GetBorderingAreasRequest$Outbound, z.ZodTypeDef, GetBorderingAreasRequest>;
+    /** @deprecated use `GetBorderingAreasRequest$Outbound` instead. */
+    type Outbound = GetBorderingAreasRequest$Outbound;
+}
+export declare function getBorderingAreasRequestToJSON(getBorderingAreasRequest: GetBorderingAreasRequest): string;
+export declare function getBorderingAreasRequestFromJSON(jsonString: string): SafeParseResult<GetBorderingAreasRequest, SDKValidationError>;
+/** @internal */
+export declare const GetBorderingAreasAreasResponseResponseBody$inboundSchema: z.ZodType<GetBorderingAreasAreasResponseResponseBody, z.ZodTypeDef, unknown>;
+/** @internal */
+export type GetBorderingAreasAreasResponseResponseBody$Outbound = {
+    code?: string | undefined;
+    details?: string | undefined;
+    error: string;
+    success: boolean;
+};
+/** @internal */
+export declare const GetBorderingAreasAreasResponseResponseBody$outboundSchema: z.ZodType<GetBorderingAreasAreasResponseResponseBody$Outbound, z.ZodTypeDef, GetBorderingAreasAreasResponseResponseBody>;
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export declare namespace GetBorderingAreasAreasResponseResponseBody$ {
+    /** @deprecated use `GetBorderingAreasAreasResponseResponseBody$inboundSchema` instead. */
+    const inboundSchema: z.ZodType<GetBorderingAreasAreasResponseResponseBody, z.ZodTypeDef, unknown>;
+    /** @deprecated use `GetBorderingAreasAreasResponseResponseBody$outboundSchema` instead. */
+    const outboundSchema: z.ZodType<GetBorderingAreasAreasResponseResponseBody$Outbound, z.ZodTypeDef, GetBorderingAreasAreasResponseResponseBody>;
+    /** @deprecated use `GetBorderingAreasAreasResponseResponseBody$Outbound` instead. */
+    type Outbound = GetBorderingAreasAreasResponseResponseBody$Outbound;
+}
+export declare function getBorderingAreasAreasResponseResponseBodyToJSON(getBorderingAreasAreasResponseResponseBody: GetBorderingAreasAreasResponseResponseBody): string;
+export declare function getBorderingAreasAreasResponseResponseBodyFromJSON(jsonString: string): SafeParseResult<GetBorderingAreasAreasResponseResponseBody, SDKValidationError>;
+/** @internal */
+export declare const GetBorderingAreasAreasResponseBody$inboundSchema: z.ZodType<GetBorderingAreasAreasResponseBody, z.ZodTypeDef, unknown>;
+/** @internal */
+export type GetBorderingAreasAreasResponseBody$Outbound = {
+    code?: string | undefined;
+    details?: string | undefined;
+    error: string;
+    success: boolean;
+};
+/** @internal */
+export declare const GetBorderingAreasAreasResponseBody$outboundSchema: z.ZodType<GetBorderingAreasAreasResponseBody$Outbound, z.ZodTypeDef, GetBorderingAreasAreasResponseBody>;
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export declare namespace GetBorderingAreasAreasResponseBody$ {
+    /** @deprecated use `GetBorderingAreasAreasResponseBody$inboundSchema` instead. */
+    const inboundSchema: z.ZodType<GetBorderingAreasAreasResponseBody, z.ZodTypeDef, unknown>;
+    /** @deprecated use `GetBorderingAreasAreasResponseBody$outboundSchema` instead. */
+    const outboundSchema: z.ZodType<GetBorderingAreasAreasResponseBody$Outbound, z.ZodTypeDef, GetBorderingAreasAreasResponseBody>;
+    /** @deprecated use `GetBorderingAreasAreasResponseBody$Outbound` instead. */
+    type Outbound = GetBorderingAreasAreasResponseBody$Outbound;
+}
+export declare function getBorderingAreasAreasResponseBodyToJSON(getBorderingAreasAreasResponseBody: GetBorderingAreasAreasResponseBody): string;
+export declare function getBorderingAreasAreasResponseBodyFromJSON(jsonString: string): SafeParseResult<GetBorderingAreasAreasResponseBody, SDKValidationError>;
+/** @internal */
+export declare const GetBorderingAreasHierarchy$inboundSchema: z.ZodType<GetBorderingAreasHierarchy, z.ZodTypeDef, unknown>;
+/** @internal */
+export type GetBorderingAreasHierarchy$Outbound = {
+    code: string;
+    level: number;
+    name: string;
+    type: string;
+};
+/** @internal */
+export declare const GetBorderingAreasHierarchy$outboundSchema: z.ZodType<GetBorderingAreasHierarchy$Outbound, z.ZodTypeDef, GetBorderingAreasHierarchy>;
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export declare namespace GetBorderingAreasHierarchy$ {
+    /** @deprecated use `GetBorderingAreasHierarchy$inboundSchema` instead. */
+    const inboundSchema: z.ZodType<GetBorderingAreasHierarchy, z.ZodTypeDef, unknown>;
+    /** @deprecated use `GetBorderingAreasHierarchy$outboundSchema` instead. */
+    const outboundSchema: z.ZodType<GetBorderingAreasHierarchy$Outbound, z.ZodTypeDef, GetBorderingAreasHierarchy>;
+    /** @deprecated use `GetBorderingAreasHierarchy$Outbound` instead. */
+    type Outbound = GetBorderingAreasHierarchy$Outbound;
+}
+export declare function getBorderingAreasHierarchyToJSON(getBorderingAreasHierarchy: GetBorderingAreasHierarchy): string;
+export declare function getBorderingAreasHierarchyFromJSON(jsonString: string): SafeParseResult<GetBorderingAreasHierarchy, SDKValidationError>;
+/** @internal */
+export declare const GetBorderingAreasRelationships$inboundSchema: z.ZodType<GetBorderingAreasRelationships, z.ZodTypeDef, unknown>;
+/** @internal */
+export type GetBorderingAreasRelationships$Outbound = {
+    relationshipType: string;
+    targetId: string;
+    targetType: string;
+};
+/** @internal */
+export declare const GetBorderingAreasRelationships$outboundSchema: z.ZodType<GetBorderingAreasRelationships$Outbound, z.ZodTypeDef, GetBorderingAreasRelationships>;
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export declare namespace GetBorderingAreasRelationships$ {
+    /** @deprecated use `GetBorderingAreasRelationships$inboundSchema` instead. */
+    const inboundSchema: z.ZodType<GetBorderingAreasRelationships, z.ZodTypeDef, unknown>;
+    /** @deprecated use `GetBorderingAreasRelationships$outboundSchema` instead. */
+    const outboundSchema: z.ZodType<GetBorderingAreasRelationships$Outbound, z.ZodTypeDef, GetBorderingAreasRelationships>;
+    /** @deprecated use `GetBorderingAreasRelationships$Outbound` instead. */
+    type Outbound = GetBorderingAreasRelationships$Outbound;
+}
+export declare function getBorderingAreasRelationshipsToJSON(getBorderingAreasRelationships: GetBorderingAreasRelationships): string;
+export declare function getBorderingAreasRelationshipsFromJSON(jsonString: string): SafeParseResult<GetBorderingAreasRelationships, SDKValidationError>;
+/** @internal */
+export declare const GetBorderingAreasType$inboundSchema: z.ZodNativeEnum<typeof GetBorderingAreasType>;
+/** @internal */
+export declare const GetBorderingAreasType$outboundSchema: z.ZodNativeEnum<typeof GetBorderingAreasType>;
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export declare namespace GetBorderingAreasType$ {
+    /** @deprecated use `GetBorderingAreasType$inboundSchema` instead. */
+    const inboundSchema: z.ZodNativeEnum<{
+        readonly Postcode: "postcode";
+        readonly Lsoa21: "lsoa21";
+        readonly UkOutputArea: "uk_output_area";
+        readonly Ward: "ward";
+        readonly Country: "country";
+        readonly County: "county";
+        readonly LocalAuthorityDistrict: "local_authority_district";
+        readonly AreaNaturalBeauty: "area_natural_beauty";
+        readonly NationalScenicArea: "national_scenic_area";
+    }>;
+    /** @deprecated use `GetBorderingAreasType$outboundSchema` instead. */
+    const outboundSchema: z.ZodNativeEnum<{
+        readonly Postcode: "postcode";
+        readonly Lsoa21: "lsoa21";
+        readonly UkOutputArea: "uk_output_area";
+        readonly Ward: "ward";
+        readonly Country: "country";
+        readonly County: "county";
+        readonly LocalAuthorityDistrict: "local_authority_district";
+        readonly AreaNaturalBeauty: "area_natural_beauty";
+        readonly NationalScenicArea: "national_scenic_area";
+    }>;
+}
+/** @internal */
+export declare const BorderingAreas$inboundSchema: z.ZodType<BorderingAreas, z.ZodTypeDef, unknown>;
+/** @internal */
+export type BorderingAreas$Outbound = {
+    areaSqm?: number | null | undefined;
+    code: string;
+    geometry?: any | null | undefined;
+    hierarchy?: Array<GetBorderingAreasHierarchy$Outbound> | null | undefined;
+    id?: number | undefined;
+    lat?: number | null | undefined;
+    long?: number | null | undefined;
+    metadata?: {
+        [k: string]: any | null;
+    } | null | undefined;
+    name: string;
+    relationships?: Array<GetBorderingAreasRelationships$Outbound> | null | undefined;
+    status?: string | undefined;
+    type: string;
+};
+/** @internal */
+export declare const BorderingAreas$outboundSchema: z.ZodType<BorderingAreas$Outbound, z.ZodTypeDef, BorderingAreas>;
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export declare namespace BorderingAreas$ {
+    /** @deprecated use `BorderingAreas$inboundSchema` instead. */
+    const inboundSchema: z.ZodType<BorderingAreas, z.ZodTypeDef, unknown>;
+    /** @deprecated use `BorderingAreas$outboundSchema` instead. */
+    const outboundSchema: z.ZodType<BorderingAreas$Outbound, z.ZodTypeDef, BorderingAreas>;
+    /** @deprecated use `BorderingAreas$Outbound` instead. */
+    type Outbound = BorderingAreas$Outbound;
+}
+export declare function borderingAreasToJSON(borderingAreas: BorderingAreas): string;
+export declare function borderingAreasFromJSON(jsonString: string): SafeParseResult<BorderingAreas, SDKValidationError>;
+/** @internal */
+export declare const GetBorderingAreasAreasHierarchy$inboundSchema: z.ZodType<GetBorderingAreasAreasHierarchy, z.ZodTypeDef, unknown>;
+/** @internal */
+export type GetBorderingAreasAreasHierarchy$Outbound = {
+    code: string;
+    level: number;
+    name: string;
+    type: string;
+};
+/** @internal */
+export declare const GetBorderingAreasAreasHierarchy$outboundSchema: z.ZodType<GetBorderingAreasAreasHierarchy$Outbound, z.ZodTypeDef, GetBorderingAreasAreasHierarchy>;
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export declare namespace GetBorderingAreasAreasHierarchy$ {
+    /** @deprecated use `GetBorderingAreasAreasHierarchy$inboundSchema` instead. */
+    const inboundSchema: z.ZodType<GetBorderingAreasAreasHierarchy, z.ZodTypeDef, unknown>;
+    /** @deprecated use `GetBorderingAreasAreasHierarchy$outboundSchema` instead. */
+    const outboundSchema: z.ZodType<GetBorderingAreasAreasHierarchy$Outbound, z.ZodTypeDef, GetBorderingAreasAreasHierarchy>;
+    /** @deprecated use `GetBorderingAreasAreasHierarchy$Outbound` instead. */
+    type Outbound = GetBorderingAreasAreasHierarchy$Outbound;
+}
+export declare function getBorderingAreasAreasHierarchyToJSON(getBorderingAreasAreasHierarchy: GetBorderingAreasAreasHierarchy): string;
+export declare function getBorderingAreasAreasHierarchyFromJSON(jsonString: string): SafeParseResult<GetBorderingAreasAreasHierarchy, SDKValidationError>;
+/** @internal */
+export declare const GetBorderingAreasAreasRelationships$inboundSchema: z.ZodType<GetBorderingAreasAreasRelationships, z.ZodTypeDef, unknown>;
+/** @internal */
+export type GetBorderingAreasAreasRelationships$Outbound = {
+    relationshipType: string;
+    targetId: string;
+    targetType: string;
+};
+/** @internal */
+export declare const GetBorderingAreasAreasRelationships$outboundSchema: z.ZodType<GetBorderingAreasAreasRelationships$Outbound, z.ZodTypeDef, GetBorderingAreasAreasRelationships>;
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export declare namespace GetBorderingAreasAreasRelationships$ {
+    /** @deprecated use `GetBorderingAreasAreasRelationships$inboundSchema` instead. */
+    const inboundSchema: z.ZodType<GetBorderingAreasAreasRelationships, z.ZodTypeDef, unknown>;
+    /** @deprecated use `GetBorderingAreasAreasRelationships$outboundSchema` instead. */
+    const outboundSchema: z.ZodType<GetBorderingAreasAreasRelationships$Outbound, z.ZodTypeDef, GetBorderingAreasAreasRelationships>;
+    /** @deprecated use `GetBorderingAreasAreasRelationships$Outbound` instead. */
+    type Outbound = GetBorderingAreasAreasRelationships$Outbound;
+}
+export declare function getBorderingAreasAreasRelationshipsToJSON(getBorderingAreasAreasRelationships: GetBorderingAreasAreasRelationships): string;
+export declare function getBorderingAreasAreasRelationshipsFromJSON(jsonString: string): SafeParseResult<GetBorderingAreasAreasRelationships, SDKValidationError>;
+/** @internal */
+export declare const GetBorderingAreasAreasType$inboundSchema: z.ZodNativeEnum<typeof GetBorderingAreasAreasType>;
+/** @internal */
+export declare const GetBorderingAreasAreasType$outboundSchema: z.ZodNativeEnum<typeof GetBorderingAreasAreasType>;
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export declare namespace GetBorderingAreasAreasType$ {
+    /** @deprecated use `GetBorderingAreasAreasType$inboundSchema` instead. */
+    const inboundSchema: z.ZodNativeEnum<{
+        readonly Postcode: "postcode";
+        readonly Lsoa21: "lsoa21";
+        readonly UkOutputArea: "uk_output_area";
+        readonly Ward: "ward";
+        readonly Country: "country";
+        readonly County: "county";
+        readonly LocalAuthorityDistrict: "local_authority_district";
+        readonly AreaNaturalBeauty: "area_natural_beauty";
+        readonly NationalScenicArea: "national_scenic_area";
+    }>;
+    /** @deprecated use `GetBorderingAreasAreasType$outboundSchema` instead. */
+    const outboundSchema: z.ZodNativeEnum<{
+        readonly Postcode: "postcode";
+        readonly Lsoa21: "lsoa21";
+        readonly UkOutputArea: "uk_output_area";
+        readonly Ward: "ward";
+        readonly Country: "country";
+        readonly County: "county";
+        readonly LocalAuthorityDistrict: "local_authority_district";
+        readonly AreaNaturalBeauty: "area_natural_beauty";
+        readonly NationalScenicArea: "national_scenic_area";
+    }>;
+}
+/** @internal */
+export declare const Target$inboundSchema: z.ZodType<Target, z.ZodTypeDef, unknown>;
+/** @internal */
+export type Target$Outbound = {
+    areaSqm?: number | null | undefined;
+    code: string;
+    geometry?: any | null | undefined;
+    hierarchy?: Array<GetBorderingAreasAreasHierarchy$Outbound> | null | undefined;
+    id?: number | undefined;
+    lat?: number | null | undefined;
+    long?: number | null | undefined;
+    metadata?: {
+        [k: string]: any | null;
+    } | null | undefined;
+    name: string;
+    relationships?: Array<GetBorderingAreasAreasRelationships$Outbound> | null | undefined;
+    status?: string | undefined;
+    type: string;
+};
+/** @internal */
+export declare const Target$outboundSchema: z.ZodType<Target$Outbound, z.ZodTypeDef, Target>;
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export declare namespace Target$ {
+    /** @deprecated use `Target$inboundSchema` instead. */
+    const inboundSchema: z.ZodType<Target, z.ZodTypeDef, unknown>;
+    /** @deprecated use `Target$outboundSchema` instead. */
+    const outboundSchema: z.ZodType<Target$Outbound, z.ZodTypeDef, Target>;
+    /** @deprecated use `Target$Outbound` instead. */
+    type Outbound = Target$Outbound;
+}
+export declare function targetToJSON(target: Target): string;
+export declare function targetFromJSON(jsonString: string): SafeParseResult<Target, SDKValidationError>;
+/** @internal */
+export declare const GetBorderingAreasResponseBody$inboundSchema: z.ZodType<GetBorderingAreasResponseBody, z.ZodTypeDef, unknown>;
+/** @internal */
+export type GetBorderingAreasResponseBody$Outbound = {
+    borderingAreas: Array<BorderingAreas$Outbound>;
+    message?: string | undefined;
+    success: boolean;
+    target: Target$Outbound;
+    total: number;
+};
+/** @internal */
+export declare const GetBorderingAreasResponseBody$outboundSchema: z.ZodType<GetBorderingAreasResponseBody$Outbound, z.ZodTypeDef, GetBorderingAreasResponseBody>;
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export declare namespace GetBorderingAreasResponseBody$ {
+    /** @deprecated use `GetBorderingAreasResponseBody$inboundSchema` instead. */
+    const inboundSchema: z.ZodType<GetBorderingAreasResponseBody, z.ZodTypeDef, unknown>;
+    /** @deprecated use `GetBorderingAreasResponseBody$outboundSchema` instead. */
+    const outboundSchema: z.ZodType<GetBorderingAreasResponseBody$Outbound, z.ZodTypeDef, GetBorderingAreasResponseBody>;
+    /** @deprecated use `GetBorderingAreasResponseBody$Outbound` instead. */
+    type Outbound = GetBorderingAreasResponseBody$Outbound;
+}
+export declare function getBorderingAreasResponseBodyToJSON(getBorderingAreasResponseBody: GetBorderingAreasResponseBody): string;
+export declare function getBorderingAreasResponseBodyFromJSON(jsonString: string): SafeParseResult<GetBorderingAreasResponseBody, SDKValidationError>;
+/** @internal */
+export declare const GetBorderingAreasResponse$inboundSchema: z.ZodType<GetBorderingAreasResponse, z.ZodTypeDef, unknown>;
+/** @internal */
+export type GetBorderingAreasResponse$Outbound = GetBorderingAreasResponseBody$Outbound | GetBorderingAreasAreasResponseBody$Outbound | GetBorderingAreasAreasResponseResponseBody$Outbound;
+/** @internal */
+export declare const GetBorderingAreasResponse$outboundSchema: z.ZodType<GetBorderingAreasResponse$Outbound, z.ZodTypeDef, GetBorderingAreasResponse>;
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export declare namespace GetBorderingAreasResponse$ {
+    /** @deprecated use `GetBorderingAreasResponse$inboundSchema` instead. */
+    const inboundSchema: z.ZodType<GetBorderingAreasResponse, z.ZodTypeDef, unknown>;
+    /** @deprecated use `GetBorderingAreasResponse$outboundSchema` instead. */
+    const outboundSchema: z.ZodType<GetBorderingAreasResponse$Outbound, z.ZodTypeDef, GetBorderingAreasResponse>;
+    /** @deprecated use `GetBorderingAreasResponse$Outbound` instead. */
+    type Outbound = GetBorderingAreasResponse$Outbound;
+}
+export declare function getBorderingAreasResponseToJSON(getBorderingAreasResponse: GetBorderingAreasResponse): string;
+export declare function getBorderingAreasResponseFromJSON(jsonString: string): SafeParseResult<GetBorderingAreasResponse, SDKValidationError>;
+//# sourceMappingURL=getborderingareas.d.ts.map