@lob/lob-typescript-sdk
Version:
Lob API wrapper
70 lines (69 loc) • 3.24 kB
TypeScript
/**
* Lob
* The Lob API is organized around REST. Our API is designed to have predictable, resource-oriented URLs and uses HTTP response codes to indicate any API errors. <p> Looking for our [previous documentation](https://lob.github.io/legacy-docs/)?
*
* The version of the OpenAPI document: 1.3.0
* Contact: lob-openapi@lob.com
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from "axios";
import { Configuration } from "../configuration";
import { RequestArgs, BaseAPI } from "../base";
import { Location } from "../models";
import { ReverseGeocode } from "../models";
/**
* ReverseGeocodeLookupsApi - axios parameter creator
* @export
*/
export declare const ReverseGeocodeLookupsApiAxiosParamCreator: (configuration?: Configuration) => {
/**
* Reverse geocode a valid US location with a live API key.
* @summary lookup
* @param {Location} location
* @param {number} [size] Determines the number of locations returned. Possible values are between 1 and 50 and any number higher will be rounded down to 50. Default size is a list of 5 reverse geocoded locations.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
reverseGeocodeLookup: (location: Location, size?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>;
};
/**
* ReverseGeocodeLookupsApi - functional programming interface
* @export
*/
export declare const ReverseGeocodeLookupsApiFp: (configuration?: Configuration) => {
/**
* Reverse geocode a valid US location with a live API key.
* @summary lookup
* @param {Location} location
* @param {number} [size] Determines the number of locations returned. Possible values are between 1 and 50 and any number higher will be rounded down to 50. Default size is a list of 5 reverse geocoded locations.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
reverseGeocodeLookup(location: Location, size?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReverseGeocode>>;
};
/**
* ReverseGeocodeLookupsApi - object-oriented interface
* @export
* @class ReverseGeocodeLookupsApi
* @extends {BaseAPI}
*/
export declare class ReverseGeocodeLookupsApi extends BaseAPI {
/**
* Reverse geocode a valid US location with a live API key.
* @summary lookup
* @param {Location} location
* @param {number} [size] Determines the number of locations returned. Possible values are between 1 and 50 and any number higher will be rounded down to 50. Default size is a list of 5 reverse geocoded locations.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ReverseGeocodeLookupsApi
*/
lookup(location: Location, size?: number, options?: AxiosRequestConfig): Promise<ReverseGeocode>;
}
/**
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/