/** * Emil PublicAPI * The Emil Public API description * * The version of the OpenAPI document: 1.0 * Contact: kontakt@emil.de * * 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 { AddressCompletionResponseClass } from '../models'; import { ValidateAddressResponseClass } from '../models'; /** * AddressCompletionsValidationsApi - axios parameter creator * @export */ export declare const AddressCompletionsValidationsApiAxiosParamCreator: (configuration?: Configuration) => { /** * This will return a list of address completions based on the provided partial address. * @summary Retrieve the address * @param {string} partialAddress Partial address for completion * @param {string} [authorization] Bearer Token * @param {'Germany' | 'Spain' | 'Austria' | 'Switzerland' | 'UnitedStates' | 'Italy' | 'Norway' | 'CzechRepublic' | 'Australia'} [country] This property can be used to filter addresses by country * @param {number} [limit] The number of results to fetch * @param {*} [options] Override http request option. * @throws {RequiredError} */ listAddressCompletions: (partialAddress: string, authorization?: string, country?: 'Germany' | 'Spain' | 'Austria' | 'Switzerland' | 'UnitedStates' | 'Italy' | 'Norway' | 'CzechRepublic' | 'Australia', limit?: number, options?: AxiosRequestConfig) => Promise; /** * This will return a response whether the provided address is valid or not. * @summary Retrieve the Address validation * @param {string} city The city of the address * @param {string} country The country of the address * @param {string} postalCode The postal code of the address. Must be a number and between 4 and 10 characters long * @param {string} street The street of the address * @param {string} houseNumber The house number of the address * @param {string} [authorization] Bearer Token * @param {string} [completeAddress] The complete address to validate * @param {*} [options] Override http request option. * @throws {RequiredError} */ validateAddress: (city: string, country: string, postalCode: string, street: string, houseNumber: string, authorization?: string, completeAddress?: string, options?: AxiosRequestConfig) => Promise; }; /** * AddressCompletionsValidationsApi - functional programming interface * @export */ export declare const AddressCompletionsValidationsApiFp: (configuration?: Configuration) => { /** * This will return a list of address completions based on the provided partial address. * @summary Retrieve the address * @param {string} partialAddress Partial address for completion * @param {string} [authorization] Bearer Token * @param {'Germany' | 'Spain' | 'Austria' | 'Switzerland' | 'UnitedStates' | 'Italy' | 'Norway' | 'CzechRepublic' | 'Australia'} [country] This property can be used to filter addresses by country * @param {number} [limit] The number of results to fetch * @param {*} [options] Override http request option. * @throws {RequiredError} */ listAddressCompletions(partialAddress: string, authorization?: string, country?: 'Germany' | 'Spain' | 'Austria' | 'Switzerland' | 'UnitedStates' | 'Italy' | 'Norway' | 'CzechRepublic' | 'Australia', limit?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * This will return a response whether the provided address is valid or not. * @summary Retrieve the Address validation * @param {string} city The city of the address * @param {string} country The country of the address * @param {string} postalCode The postal code of the address. Must be a number and between 4 and 10 characters long * @param {string} street The street of the address * @param {string} houseNumber The house number of the address * @param {string} [authorization] Bearer Token * @param {string} [completeAddress] The complete address to validate * @param {*} [options] Override http request option. * @throws {RequiredError} */ validateAddress(city: string, country: string, postalCode: string, street: string, houseNumber: string, authorization?: string, completeAddress?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * AddressCompletionsValidationsApi - factory interface * @export */ export declare const AddressCompletionsValidationsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * This will return a list of address completions based on the provided partial address. * @summary Retrieve the address * @param {string} partialAddress Partial address for completion * @param {string} [authorization] Bearer Token * @param {'Germany' | 'Spain' | 'Austria' | 'Switzerland' | 'UnitedStates' | 'Italy' | 'Norway' | 'CzechRepublic' | 'Australia'} [country] This property can be used to filter addresses by country * @param {number} [limit] The number of results to fetch * @param {*} [options] Override http request option. * @throws {RequiredError} */ listAddressCompletions(partialAddress: string, authorization?: string, country?: 'Germany' | 'Spain' | 'Austria' | 'Switzerland' | 'UnitedStates' | 'Italy' | 'Norway' | 'CzechRepublic' | 'Australia', limit?: number, options?: any): AxiosPromise; /** * This will return a response whether the provided address is valid or not. * @summary Retrieve the Address validation * @param {string} city The city of the address * @param {string} country The country of the address * @param {string} postalCode The postal code of the address. Must be a number and between 4 and 10 characters long * @param {string} street The street of the address * @param {string} houseNumber The house number of the address * @param {string} [authorization] Bearer Token * @param {string} [completeAddress] The complete address to validate * @param {*} [options] Override http request option. * @throws {RequiredError} */ validateAddress(city: string, country: string, postalCode: string, street: string, houseNumber: string, authorization?: string, completeAddress?: string, options?: any): AxiosPromise; }; /** * Request parameters for listAddressCompletions operation in AddressCompletionsValidationsApi. * @export * @interface AddressCompletionsValidationsApiListAddressCompletionsRequest */ export interface AddressCompletionsValidationsApiListAddressCompletionsRequest { /** * Partial address for completion * @type {string} * @memberof AddressCompletionsValidationsApiListAddressCompletions */ readonly partialAddress: string; /** * Bearer Token * @type {string} * @memberof AddressCompletionsValidationsApiListAddressCompletions */ readonly authorization?: string; /** * This property can be used to filter addresses by country * @type {'Germany' | 'Spain' | 'Austria' | 'Switzerland' | 'UnitedStates' | 'Italy' | 'Norway' | 'CzechRepublic' | 'Australia'} * @memberof AddressCompletionsValidationsApiListAddressCompletions */ readonly country?: 'Germany' | 'Spain' | 'Austria' | 'Switzerland' | 'UnitedStates' | 'Italy' | 'Norway' | 'CzechRepublic' | 'Australia'; /** * The number of results to fetch * @type {number} * @memberof AddressCompletionsValidationsApiListAddressCompletions */ readonly limit?: number; } /** * Request parameters for validateAddress operation in AddressCompletionsValidationsApi. * @export * @interface AddressCompletionsValidationsApiValidateAddressRequest */ export interface AddressCompletionsValidationsApiValidateAddressRequest { /** * The city of the address * @type {string} * @memberof AddressCompletionsValidationsApiValidateAddress */ readonly city: string; /** * The country of the address * @type {string} * @memberof AddressCompletionsValidationsApiValidateAddress */ readonly country: string; /** * The postal code of the address. Must be a number and between 4 and 10 characters long * @type {string} * @memberof AddressCompletionsValidationsApiValidateAddress */ readonly postalCode: string; /** * The street of the address * @type {string} * @memberof AddressCompletionsValidationsApiValidateAddress */ readonly street: string; /** * The house number of the address * @type {string} * @memberof AddressCompletionsValidationsApiValidateAddress */ readonly houseNumber: string; /** * Bearer Token * @type {string} * @memberof AddressCompletionsValidationsApiValidateAddress */ readonly authorization?: string; /** * The complete address to validate * @type {string} * @memberof AddressCompletionsValidationsApiValidateAddress */ readonly completeAddress?: string; } /** * AddressCompletionsValidationsApi - object-oriented interface * @export * @class AddressCompletionsValidationsApi * @extends {BaseAPI} */ export declare class AddressCompletionsValidationsApi extends BaseAPI { /** * This will return a list of address completions based on the provided partial address. * @summary Retrieve the address * @param {AddressCompletionsValidationsApiListAddressCompletionsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AddressCompletionsValidationsApi */ listAddressCompletions(requestParameters: AddressCompletionsValidationsApiListAddressCompletionsRequest, options?: AxiosRequestConfig): Promise>; /** * This will return a response whether the provided address is valid or not. * @summary Retrieve the Address validation * @param {AddressCompletionsValidationsApiValidateAddressRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AddressCompletionsValidationsApi */ validateAddress(requestParameters: AddressCompletionsValidationsApiValidateAddressRequest, options?: AxiosRequestConfig): Promise>; }