@lob/lob-typescript-sdk/dist/api/us-autocompletions-api.d.ts

Lob API wrapper

/**
 * 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 { UsAutocompletions } from "../models";
import { UsAutocompletionsWritable } from "../models";
/**
 * UsAutocompletionsApi - axios parameter creator
 * @export
 */
export declare const UsAutocompletionsApiAxiosParamCreator: (configuration?: Configuration) => {
    /**
     * Given an address prefix consisting of a partial primary line, as well as optional input of city, state, and zip code, this functionality returns up to 10 full US address suggestions. Not all of them will turn out to be valid addresses; they\'ll need to be [verified](#operation/verification_us).
     * @summary autocomplete
     * @param {UsAutocompletionsWritable} usAutocompletionsWritable
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    usAutocompletion: (usAutocompletionsWritable: UsAutocompletionsWritable, options?: AxiosRequestConfig) => Promise<RequestArgs>;
};
/**
 * UsAutocompletionsApi - functional programming interface
 * @export
 */
export declare const UsAutocompletionsApiFp: (configuration?: Configuration) => {
    /**
     * Given an address prefix consisting of a partial primary line, as well as optional input of city, state, and zip code, this functionality returns up to 10 full US address suggestions. Not all of them will turn out to be valid addresses; they\'ll need to be [verified](#operation/verification_us).
     * @summary autocomplete
     * @param {UsAutocompletionsWritable} usAutocompletionsWritable
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    usAutocompletion(usAutocompletionsWritable: UsAutocompletionsWritable, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UsAutocompletions>>;
};
/**
 * UsAutocompletionsApi - object-oriented interface
 * @export
 * @class UsAutocompletionsApi
 * @extends {BaseAPI}
 */
export declare class UsAutocompletionsApi extends BaseAPI {
    /**
     * Given an address prefix consisting of a partial primary line, as well as optional input of city, state, and zip code, this functionality returns up to 10 full US address suggestions. Not all of them will turn out to be valid addresses; they\'ll need to be [verified](#operation/verification_us).
     * @summary autocomplete
     * @param {UsAutocompletionsWritable} usAutocompletionsWritable
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof UsAutocompletionsApi
     */
    autocomplete(usAutocompletionsWritable: UsAutocompletionsWritable, options?: AxiosRequestConfig): Promise<UsAutocompletions>;
}
/**
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
 * https://openapi-generator.tech
 * Do not edit the class manually.
 */