@myorb/dhl-express/dist/apis/address-api.d.ts

DHL Express api client

/**
 * DHL Express APIs (MyDHL API)
 * Welcome to the official DHL Express APIs (MyDHL API) below are the published API Documentation to fulfill your shipping needs with DHL Express.       Please follow the process described [here](https://developer.dhl.com/api-reference/dhl-express-mydhl-api#get-started-section/user-guide--get-access) to request access to the DHL Express - MyDHL API services    In case you already have DHL Express - MyDHL API Service credentials please ensure to use the endpoints/environments listed  [here](https://developer.dhl.com/api-reference/dhl-express-mydhl-api#get-started-section/user-guide--environments)
 *
 * OpenAPI spec version: 2.4.0
 *
 *
 * NOTE: This class is auto generated by the swagger code generator program.
 * https://github.com/swagger-api/swagger-codegen.git
 * Do not edit the class manually.
 */
import { AxiosResponse, AxiosInstance, AxiosRequestConfig } from 'axios';
import { Configuration } from '../configuration';
import { RequestArgs, BaseAPI } from '../base';
import { SupermodelIoLogisticsExpressAddressValidateResponse } from '../models';
/**
 * AddressApi - axios parameter creator
 * @export
 */
export declare const AddressApiAxiosParamCreator: (configuration?: Configuration) => {
    /**
     * Validates if DHL Express has got pickup/delivery capabilities at origin/destination
     * @summary Validate DHL Express pickup/delivery capabilities at origin/destination
     * @param {string} type
     * @param {string} countryCode A short text string code (see values defined in ISO 3166) specifying the shipment origin country. https://gs1.org/voc/Country, Alpha-2 Code
     * @param {string} [postalCode] Text specifying the postal code for an address. https://gs1.org/voc/postalCode
     * @param {string} [cityName] Text specifying the city name
     * @param {boolean} [strictValidation] If set to true service will return no records when exact valid match not found
     * @param {string} [messageReference] Please provide message reference
     * @param {string} [messageReferenceDate] Optional reference date in the  HTTP-date format https://tools.ietf.org/html/rfc7231#section-7.1.1.2
     * @param {string} [pluginName] Please provide name of the plugin (applicable to 3PV only)
     * @param {string} [pluginVersion] Please provide version of the plugin (applicable to 3PV only)
     * @param {string} [shippingSystemPlatformName] Please provide name of the shipping platform(applicable to 3PV only)
     * @param {string} [shippingSystemPlatformVersion] Please provide version of the shipping platform (applicable to 3PV only)
     * @param {string} [webstorePlatformName] Please provide name of the webstore platform (applicable to 3PV only)
     * @param {string} [webstorePlatformVersion] Please provide version of the webstore platform (applicable to 3PV only)
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    expApiAddressValidate: (type: string, countryCode: string, postalCode?: string, cityName?: string, strictValidation?: boolean, messageReference?: string, messageReferenceDate?: string, pluginName?: string, pluginVersion?: string, shippingSystemPlatformName?: string, shippingSystemPlatformVersion?: string, webstorePlatformName?: string, webstorePlatformVersion?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
};
/**
 * AddressApi - functional programming interface
 * @export
 */
export declare const AddressApiFp: (configuration?: Configuration) => {
    /**
     * Validates if DHL Express has got pickup/delivery capabilities at origin/destination
     * @summary Validate DHL Express pickup/delivery capabilities at origin/destination
     * @param {string} type
     * @param {string} countryCode A short text string code (see values defined in ISO 3166) specifying the shipment origin country. https://gs1.org/voc/Country, Alpha-2 Code
     * @param {string} [postalCode] Text specifying the postal code for an address. https://gs1.org/voc/postalCode
     * @param {string} [cityName] Text specifying the city name
     * @param {boolean} [strictValidation] If set to true service will return no records when exact valid match not found
     * @param {string} [messageReference] Please provide message reference
     * @param {string} [messageReferenceDate] Optional reference date in the  HTTP-date format https://tools.ietf.org/html/rfc7231#section-7.1.1.2
     * @param {string} [pluginName] Please provide name of the plugin (applicable to 3PV only)
     * @param {string} [pluginVersion] Please provide version of the plugin (applicable to 3PV only)
     * @param {string} [shippingSystemPlatformName] Please provide name of the shipping platform(applicable to 3PV only)
     * @param {string} [shippingSystemPlatformVersion] Please provide version of the shipping platform (applicable to 3PV only)
     * @param {string} [webstorePlatformName] Please provide name of the webstore platform (applicable to 3PV only)
     * @param {string} [webstorePlatformVersion] Please provide version of the webstore platform (applicable to 3PV only)
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    expApiAddressValidate(type: string, countryCode: string, postalCode?: string, cityName?: string, strictValidation?: boolean, messageReference?: string, messageReferenceDate?: string, pluginName?: string, pluginVersion?: string, shippingSystemPlatformName?: string, shippingSystemPlatformVersion?: string, webstorePlatformName?: string, webstorePlatformVersion?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<SupermodelIoLogisticsExpressAddressValidateResponse>>>;
};
/**
 * AddressApi - factory interface
 * @export
 */
export declare const AddressApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
    /**
     * Validates if DHL Express has got pickup/delivery capabilities at origin/destination
     * @summary Validate DHL Express pickup/delivery capabilities at origin/destination
     * @param {string} type
     * @param {string} countryCode A short text string code (see values defined in ISO 3166) specifying the shipment origin country. https://gs1.org/voc/Country, Alpha-2 Code
     * @param {string} [postalCode] Text specifying the postal code for an address. https://gs1.org/voc/postalCode
     * @param {string} [cityName] Text specifying the city name
     * @param {boolean} [strictValidation] If set to true service will return no records when exact valid match not found
     * @param {string} [messageReference] Please provide message reference
     * @param {string} [messageReferenceDate] Optional reference date in the  HTTP-date format https://tools.ietf.org/html/rfc7231#section-7.1.1.2
     * @param {string} [pluginName] Please provide name of the plugin (applicable to 3PV only)
     * @param {string} [pluginVersion] Please provide version of the plugin (applicable to 3PV only)
     * @param {string} [shippingSystemPlatformName] Please provide name of the shipping platform(applicable to 3PV only)
     * @param {string} [shippingSystemPlatformVersion] Please provide version of the shipping platform (applicable to 3PV only)
     * @param {string} [webstorePlatformName] Please provide name of the webstore platform (applicable to 3PV only)
     * @param {string} [webstorePlatformVersion] Please provide version of the webstore platform (applicable to 3PV only)
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    expApiAddressValidate(type: string, countryCode: string, postalCode?: string, cityName?: string, strictValidation?: boolean, messageReference?: string, messageReferenceDate?: string, pluginName?: string, pluginVersion?: string, shippingSystemPlatformName?: string, shippingSystemPlatformVersion?: string, webstorePlatformName?: string, webstorePlatformVersion?: string, options?: AxiosRequestConfig): Promise<AxiosResponse<SupermodelIoLogisticsExpressAddressValidateResponse>>;
};
/**
 * AddressApi - object-oriented interface
 * @export
 * @class AddressApi
 * @extends {BaseAPI}
 */
export declare class AddressApi extends BaseAPI {
    /**
     * Validates if DHL Express has got pickup/delivery capabilities at origin/destination
     * @summary Validate DHL Express pickup/delivery capabilities at origin/destination
     * @param {string} type
     * @param {string} countryCode A short text string code (see values defined in ISO 3166) specifying the shipment origin country. https://gs1.org/voc/Country, Alpha-2 Code
     * @param {string} [postalCode] Text specifying the postal code for an address. https://gs1.org/voc/postalCode
     * @param {string} [cityName] Text specifying the city name
     * @param {boolean} [strictValidation] If set to true service will return no records when exact valid match not found
     * @param {string} [messageReference] Please provide message reference
     * @param {string} [messageReferenceDate] Optional reference date in the  HTTP-date format https://tools.ietf.org/html/rfc7231#section-7.1.1.2
     * @param {string} [pluginName] Please provide name of the plugin (applicable to 3PV only)
     * @param {string} [pluginVersion] Please provide version of the plugin (applicable to 3PV only)
     * @param {string} [shippingSystemPlatformName] Please provide name of the shipping platform(applicable to 3PV only)
     * @param {string} [shippingSystemPlatformVersion] Please provide version of the shipping platform (applicable to 3PV only)
     * @param {string} [webstorePlatformName] Please provide name of the webstore platform (applicable to 3PV only)
     * @param {string} [webstorePlatformVersion] Please provide version of the webstore platform (applicable to 3PV only)
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof AddressApi
     */
    expApiAddressValidate(type: string, countryCode: string, postalCode?: string, cityName?: string, strictValidation?: boolean, messageReference?: string, messageReferenceDate?: string, pluginName?: string, pluginVersion?: string, shippingSystemPlatformName?: string, shippingSystemPlatformVersion?: string, webstorePlatformName?: string, webstorePlatformVersion?: string, options?: AxiosRequestConfig): Promise<AxiosResponse<SupermodelIoLogisticsExpressAddressValidateResponse>>;
}