@brasil-interface/sdks/dist/core/cep-aberto/cep-aberto.d.ts

## Sumário

import { ICepAbertoAddress, ICepAbertoCity } from "./cep-aberto.types";
export declare class CepAbertoAPI {
    private token;
    private baseUrl;
    constructor(token: string);
    private fetchJson;
    /**
     * PT-BR: Obtém informações de endereço pelo número do CEP.
     * EN-US: Get address information by CEP number.
     *
     * @param cep PT-BR: O número do CEP. EN-US: The CEP number.
     * @returns PT-BR: As informações de endereço para o CEP fornecido. EN-US: The address information for the provided CEP.
     */
    getCepByNumber(cep: string): Promise<ICepAbertoAddress>;
    /**
     * PT-BR: Obtém informações de endereço pelas coordenadas de latitude e longitude.
     * EN-US: Get address information by latitude and longitude coordinates.
     *
     * @param lat PT-BR: A coordenada de latitude. EN-US: The latitude coordinate.
     * @param lng PT-BR: A coordenada de longitude. EN-US: The longitude coordinate.
     * @returns PT-BR: As informações de endereço para as coordenadas fornecidas. EN-US: The address information for the provided coordinates.
     */
    getCepByCoordinates(lat: number, lng: number): Promise<ICepAbertoAddress>;
    /**
     * PT-BR: Obtém informações de endereço pelo estado, cidade, rua e bairro.
     * EN-US: Get address information by state, city, street and neighborhood.
     *
     * @param state PT-BR: A sigla do estado. EN-US: The state abbreviation.
     * @param city PT-BR: O nome da cidade. EN-US: The city name.
     * @param street PT-BR: O nome da rua (opcional). EN-US: The street name (optional).
     * @param neighborhood PT-BR: O nome do bairro (opcional). EN-US: The neighborhood name (optional).
     * @returns PT-BR: As informações de endereço para os parâmetros fornecidos. EN-US: The address information for the provided parameters.
     */
    getCepByAddress(state: string, city: string, street?: string, neighborhood?: string): Promise<ICepAbertoAddress>;
    /**
     * PT-BR: Obtém uma lista de cidades em um determinado estado.
     * EN-US: Get a list of cities in a given state.
     *
     * @param state PT-BR: A sigla do estado. EN-US: The state abbreviation.
     * @returns PT-BR: Uma lista de cidades no estado fornecido. EN-US: A list of cities in the provided state.
     */
    getCitiesByState(state: string): Promise<ICepAbertoCity[]>;
    /**
     * PT-BR: Atualiza uma lista de números de CEP.
     * EN-US: Update a list of CEP numbers.
     *
     * @param ceps PT-BR: Um array de números de CEP. EN-US: An array of CEP numbers.
     * @returns PT-BR: Uma lista de números de CEP atualizados. EN-US: A list of updated CEP numbers.
     */
    updateCeps(ceps: string[]): Promise<string[]>;
}
//# sourceMappingURL=cep-aberto.d.ts.map