@lob/lob-typescript-sdk
Version:
Lob API wrapper
70 lines (69 loc) • 4.45 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 { IntlAutocompletions } from "../models";
import { IntlAutocompletionsWritable } from "../models";
/**
* IntlAutocompletionsApi - axios parameter creator
* @export
*/
export declare const IntlAutocompletionsApiAxiosParamCreator: (configuration?: Configuration) => {
/**
* Given an address prefix consisting of a partial primary line and country, as well as optional input of city, state, and zip code, this functionality returns up to 10 full International address suggestions. Not all of them will turn out to be valid addresses; they\'ll need to be [verified](#operation/intl_verification).
* @summary autocomplete
* @param {IntlAutocompletionsWritable} intlAutocompletionsWritable
* @param {'native' | 'match'} [xLangOutput] * `native` - Translate response to the native language of the country in the request * `match` - match the response to the language in the request Default response is in English.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
intlAutocompletion: (intlAutocompletionsWritable: IntlAutocompletionsWritable, xLangOutput?: "native" | "match", options?: AxiosRequestConfig) => Promise<RequestArgs>;
};
/**
* IntlAutocompletionsApi - functional programming interface
* @export
*/
export declare const IntlAutocompletionsApiFp: (configuration?: Configuration) => {
/**
* Given an address prefix consisting of a partial primary line and country, as well as optional input of city, state, and zip code, this functionality returns up to 10 full International address suggestions. Not all of them will turn out to be valid addresses; they\'ll need to be [verified](#operation/intl_verification).
* @summary autocomplete
* @param {IntlAutocompletionsWritable} intlAutocompletionsWritable
* @param {'native' | 'match'} [xLangOutput] * `native` - Translate response to the native language of the country in the request * `match` - match the response to the language in the request Default response is in English.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
intlAutocompletion(intlAutocompletionsWritable: IntlAutocompletionsWritable, xLangOutput?: "native" | "match", options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<IntlAutocompletions>>;
};
/**
* IntlAutocompletionsApi - object-oriented interface
* @export
* @class IntlAutocompletionsApi
* @extends {BaseAPI}
*/
export declare class IntlAutocompletionsApi extends BaseAPI {
/**
* Given an address prefix consisting of a partial primary line and country, as well as optional input of city, state, and zip code, this functionality returns up to 10 full International address suggestions. Not all of them will turn out to be valid addresses; they\'ll need to be [verified](#operation/intl_verification).
* @summary autocomplete
* @param {IntlAutocompletionsWritable} intlAutocompletionsWritable
* @param {'native' | 'match'} [xLangOutput] * `native` - Translate response to the native language of the country in the request * `match` - match the response to the language in the request Default response is in English.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof IntlAutocompletionsApi
*/
autocomplete(intlAutocompletionsWritable: IntlAutocompletionsWritable, xLangOutput?: "native" | "match", options?: AxiosRequestConfig): Promise<IntlAutocompletions>;
}
/**
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/