<?php
/**
 * Copyright © Magento, Inc. All rights reserved.
 * See COPYING.txt for license details.
 */
declare(strict_types=1);

namespace Magento\InventoryInStorePickupApi\Api\Data\SearchRequest;

/**
 * Filter by Distance to the Address.
 * Pickup Locations will be filtered by distance according to the geo-position of the entered address.
 * Required fields for the address are country and one of the field: region or city or postcode.
 *
 * @api
 */
interface AreaInterface
{
    // TODO: try to move constant from interface
    public const DISTANCE_FIELD = 'distance';

    /**
     * Get search radius in KM.
     *
     * @return int
     */
    public function getRadius(): int;

    /**
     * Get search term string.
     *
     * @return string
     */
    public function getSearchTerm() : string;
}