@lob/lob-typescript-sdk/dist/api/intl-verifications-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 { IntlVerification } from "../models";
import { IntlVerificationWritable } from "../models";
import { IntlVerifications } from "../models";
import { IntlVerificationsPayload } from "../models";
/**
 * IntlVerificationsApi - axios parameter creator
 * @export
 */
export declare const IntlVerificationsApiAxiosParamCreator: (configuration?: Configuration) => {
    /**
     * Verify a list of international (except US or US territories) address with a live API key.
     * @summary verifyBulk
     * @param {IntlVerificationsPayload} intlVerificationsPayload
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    bulkIntlVerifications: (intlVerificationsPayload: IntlVerificationsPayload, options?: AxiosRequestConfig) => Promise<RequestArgs>;
    /**
     * Verify an international (except US or US territories) address with a live API key.
     * @summary verifySingle
     * @param {IntlVerificationWritable} intlVerificationWritable
     * @param {'native' | 'match'} [xLangOutput] * &#x60;native&#x60; - Translate response to the native language of the country in the request * &#x60;match&#x60; - match the response to the language in the request  Default response is in English.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    intlVerification: (intlVerificationWritable: IntlVerificationWritable, xLangOutput?: "native" | "match", options?: AxiosRequestConfig) => Promise<RequestArgs>;
};
/**
 * IntlVerificationsApi - functional programming interface
 * @export
 */
export declare const IntlVerificationsApiFp: (configuration?: Configuration) => {
    /**
     * Verify a list of international (except US or US territories) address with a live API key.
     * @summary verifyBulk
     * @param {IntlVerificationsPayload} intlVerificationsPayload
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    bulkIntlVerifications(intlVerificationsPayload: IntlVerificationsPayload, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<IntlVerifications>>;
    /**
     * Verify an international (except US or US territories) address with a live API key.
     * @summary verifySingle
     * @param {IntlVerificationWritable} intlVerificationWritable
     * @param {'native' | 'match'} [xLangOutput] * &#x60;native&#x60; - Translate response to the native language of the country in the request * &#x60;match&#x60; - match the response to the language in the request  Default response is in English.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    intlVerification(intlVerificationWritable: IntlVerificationWritable, xLangOutput?: "native" | "match", options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<IntlVerification>>;
};
/**
 * IntlVerificationsApi - object-oriented interface
 * @export
 * @class IntlVerificationsApi
 * @extends {BaseAPI}
 */
export declare class IntlVerificationsApi extends BaseAPI {
    /**
     * Verify a list of international (except US or US territories) address with a live API key.
     * @summary verifyBulk
     * @param {IntlVerificationsPayload} intlVerificationsPayload
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof IntlVerificationsApi
     */
    verifyBulk(intlVerificationsPayload: IntlVerificationsPayload, options?: AxiosRequestConfig): Promise<IntlVerifications>;
    /**
     * Verify an international (except US or US territories) address with a live API key.
     * @summary verifySingle
     * @param {IntlVerificationWritable} intlVerificationWritable
     * @param {'native' | 'match'} [xLangOutput] * &#x60;native&#x60; - Translate response to the native language of the country in the request * &#x60;match&#x60; - match the response to the language in the request  Default response is in English.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof IntlVerificationsApi
     */
    verifySingle(intlVerificationWritable: IntlVerificationWritable, xLangOutput?: "native" | "match", options?: AxiosRequestConfig): Promise<IntlVerification>;
}
/**
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
 * https://openapi-generator.tech
 * Do not edit the class manually.
 */