@vepler/area-reference-types/routes/geographic/get-types.d.ts

TypeScript type definitions for Vepler Area Reference API

/**
 * Get Geographic Types API Types
 *
 * /geographic/types endpoint
 */
import { GeographicEntityType } from '../../common';
/**
 * Geographic type information
 */
export interface GeographicTypeInfo {
    /**
     * Geographic type identifier
     */
    type: GeographicEntityType;
    /**
     * Human-readable display name
     */
    displayName: string;
    /**
     * Type description
     */
    description: string;
    /**
     * Administrative level (0-10)
     */
    adminLevel: number;
    /**
     * Whether this type supports direct querying
     */
    queryable: boolean;
    /**
     * Example codes for this type
     */
    examples?: string[];
}
/**
 * Geographic hierarchy level
 */
export interface GeographicHierarchyLevel {
    /**
     * Hierarchy level number
     */
    level: number;
    /**
     * Types at this level
     */
    types: GeographicEntityType[];
    /**
     * Level description
     */
    description: string;
}
/**
 * Geographic types response metadata
 */
export interface GeographicTypesMetadata {
    /**
     * Total number of supported types
     */
    totalTypes: number;
    /**
     * Geographic hierarchy information
     */
    hierarchy: GeographicHierarchyLevel[];
}
/**
 * Geographic types response
 */
export interface GeographicTypesResponse {
    /**
     * Array of all supported geographic types
     */
    types: GeographicTypeInfo[];
    /**
     * Response metadata
     */
    meta: GeographicTypesMetadata;
}