@lob/lob-typescript-sdk
Version:
Lob API wrapper
100 lines (99 loc) • 5.68 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 { MultipleComponentsList } from "../models";
import { UsVerification } from "../models";
import { UsVerifications } from "../models";
import { UsVerificationsWritable } from "../models";
/**
* UsVerificationsApi - axios parameter creator
* @export
*/
export declare const UsVerificationsApiAxiosParamCreator: (configuration?: Configuration) => {
/**
* Verify a list of US or US territory addresses with a live API key.
* @summary verifyBulk
* @param {MultipleComponentsList} multipleComponentsList
* @param {'upper' | 'proper'} [_case] Casing of the verified address. Possible values are `upper` and `proper` for uppercased (e.g. \"PO BOX\") and proper-cased (e.g. \"PO Box\"), respectively.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
bulkUsVerifications: (multipleComponentsList: MultipleComponentsList, _case?: "upper" | "proper", options?: AxiosRequestConfig) => Promise<RequestArgs>;
/**
* Verify a US or US territory address with a live API key.
* @summary verifySingle
* @param {UsVerificationsWritable} usVerificationsWritable
* @param {'upper' | 'proper'} [_case] Casing of the verified address. Possible values are `upper` and `proper` for uppercased (e.g. \"PO BOX\") and proper-cased (e.g. \"PO Box\"), respectively.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
usVerification: (usVerificationsWritable: UsVerificationsWritable, _case?: "upper" | "proper", options?: AxiosRequestConfig) => Promise<RequestArgs>;
};
/**
* UsVerificationsApi - functional programming interface
* @export
*/
export declare const UsVerificationsApiFp: (configuration?: Configuration) => {
/**
* Verify a list of US or US territory addresses with a live API key.
* @summary verifyBulk
* @param {MultipleComponentsList} multipleComponentsList
* @param {'upper' | 'proper'} [_case] Casing of the verified address. Possible values are `upper` and `proper` for uppercased (e.g. \"PO BOX\") and proper-cased (e.g. \"PO Box\"), respectively.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
bulkUsVerifications(multipleComponentsList: MultipleComponentsList, _case?: "upper" | "proper", options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UsVerifications>>;
/**
* Verify a US or US territory address with a live API key.
* @summary verifySingle
* @param {UsVerificationsWritable} usVerificationsWritable
* @param {'upper' | 'proper'} [_case] Casing of the verified address. Possible values are `upper` and `proper` for uppercased (e.g. \"PO BOX\") and proper-cased (e.g. \"PO Box\"), respectively.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
usVerification(usVerificationsWritable: UsVerificationsWritable, _case?: "upper" | "proper", options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UsVerification>>;
};
/**
* UsVerificationsApi - object-oriented interface
* @export
* @class UsVerificationsApi
* @extends {BaseAPI}
*/
export declare class UsVerificationsApi extends BaseAPI {
/**
* Verify a list of US or US territory addresses with a live API key.
* @summary verifyBulk
* @param {MultipleComponentsList} multipleComponentsList
* @param {'upper' | 'proper'} [_case] Casing of the verified address. Possible values are `upper` and `proper` for uppercased (e.g. \"PO BOX\") and proper-cased (e.g. \"PO Box\"), respectively.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof UsVerificationsApi
*/
verifyBulk(multipleComponentsList: MultipleComponentsList, _case?: "upper" | "proper", options?: AxiosRequestConfig): Promise<UsVerifications>;
/**
* Verify a US or US territory address with a live API key.
* @summary verifySingle
* @param {UsVerificationsWritable} usVerificationsWritable
* @param {'upper' | 'proper'} [_case] Casing of the verified address. Possible values are `upper` and `proper` for uppercased (e.g. \"PO BOX\") and proper-cased (e.g. \"PO Box\"), respectively.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof UsVerificationsApi
*/
verifySingle(usVerificationsWritable: UsVerificationsWritable, _case?: "upper" | "proper", options?: AxiosRequestConfig): Promise<UsVerification>;
}
/**
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/