import { GeoType } from './geo-type';

/**
 * Универсальная модель для представления географических объектов (города, регионы,
 * страны). Модель содержит в себе описания, сокращения и идентификатор.
 */
export interface Geo {
  /**
   * Уникальный ID Geo-объекта
   */
  id: number;

  /**
   * Объект, который содержит в себе данные о типе Geo-объекта.
   */
  type: GeoType;

  /**
   * Полное имя гео-объекта
   */
  name: string;

  /**
   * Центральная точка расположения Geо-объекта
   */
  coordinates?: Array<number>;

  /**
   * Расстояние от центральной точки этого региона до центральной точки региона, в
   * котором расположен дилерский центр, ID которого указан в параметре `dealerId`.
   */
  distance?: number;

  /**
   * Общее количество объявлений в этом регионе.
   */
  count?: number;
}
