@lob/lob-typescript-sdk/dist/api/identity-validation-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 { IdentityValidation } from "../models";
import { MultiLineAddress } from "../models";
/**
 * IdentityValidationApi - axios parameter creator
 * @export
 */
export declare const IdentityValidationApiAxiosParamCreator: (configuration?: Configuration) => {
    /**
     * Validates whether a given name is associated with an address.
     * @summary validate
     * @param {MultiLineAddress} multiLineAddress
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    identityValidation: (multiLineAddress: MultiLineAddress, options?: AxiosRequestConfig) => Promise<RequestArgs>;
};
/**
 * IdentityValidationApi - functional programming interface
 * @export
 */
export declare const IdentityValidationApiFp: (configuration?: Configuration) => {
    /**
     * Validates whether a given name is associated with an address.
     * @summary validate
     * @param {MultiLineAddress} multiLineAddress
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    identityValidation(multiLineAddress: MultiLineAddress, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<IdentityValidation>>;
};
/**
 * IdentityValidationApi - object-oriented interface
 * @export
 * @class IdentityValidationApi
 * @extends {BaseAPI}
 */
export declare class IdentityValidationApi extends BaseAPI {
    /**
     * Validates whether a given name is associated with an address.
     * @summary validate
     * @param {MultiLineAddress} multiLineAddress
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof IdentityValidationApi
     */
    validate(multiLineAddress: MultiLineAddress, options?: AxiosRequestConfig): Promise<IdentityValidation>;
}
/**
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
 * https://openapi-generator.tech
 * Do not edit the class manually.
 */