Сервис работы с подсказками Dadata

using Yambr.Dadata.Models;

namespace Yambr.Dadata.Services
{
    /// <summary>
    /// Сервис работы с подсказками Dadata
    /// </summary>
    public interface ISuggestionsService
    {
        /// <summary>
        /// Получить подсказки адреса по строке
        /// </summary>
        /// <param name="address">поисковая строка</param>
        /// <returns></returns>
        SuggestAddressResponse QueryAddress(string address);
        /// <summary>
        ///  Получить подсказки адреса по запросу
        /// </summary>
        /// <param name="query">структурированный запрос адреса</param>
        /// <returns></returns>
        SuggestAddressResponse QueryAddress(AddressSuggestQuery query);
        /// <summary>
        /// Получить подсказки банка по строке
        /// </summary>
        /// <param name="bank">поисковая строка</param>
        /// <returns></returns>
        SuggestBankResponse QueryBank(string bank);
        /// <summary>
        ///  Получить подсказки банка по запросу
        /// </summary>
        /// <param name="query">структурированный запрос банка</param>
        /// <returns></returns>
        SuggestBankResponse QueryBank(BankSuggestQuery query);
        /// <summary>
        /// Получить подсказки email по строке
        /// </summary>
        /// <param name="email">поисковая строка</param>
        /// <returns></returns>
        SuggestEmailResponse QueryEmail(string email);
        /// <summary>
        /// Получить подсказки ФИО по строке
        /// </summary>
        /// <param name="fio">поисковая строка</param>
        /// <returns></returns>
        SuggestFioResponse QueryFio(string fio);
        /// <summary>
        ///  Получить подсказки банка по запросу
        /// </summary>
        /// <param name="query">структурированный запрос банка</param>
        /// <returns></returns>
        SuggestFioResponse QueryFio(FioSuggestQuery query);
        /// <summary>
        /// Получить подсказки организации (ИП или Юридическое лицо) по строке
        /// </summary>
        /// <param name="query">поисковая строка</param>
        /// <returns></returns>
        SuggestPartyResponse QueryParty(string query);
        /// <summary>
        /// Получить подсказки организации (ИП или Юридическое лицо) по строке
        /// </summary>
        /// <param name="query">структурированный запрос (можно указать ограничения)</param>
        /// <returns></returns>
        SuggestPartyResponse QueryParty(PartySuggestQuery query);
    }
}