@myorb/dhl-express/dist/apis/product-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 { SupermodelIoLogisticsExpressProducts } from '../models';
/**
 * ProductApi - axios parameter creator
 * @export
 */
export declare const ProductApiAxiosParamCreator: (configuration?: Configuration) => {
    /**
     * The GET Products API will return DHL's product capabilities for a certain set of input data.  Using the shipper and receiver address as well as the dimension and weight of the piece belonging to a shipment, this operation returns the available products.
     * @summary Retrieve available DHL Express products for a one piece Shipment
     * @param {string} accountNumber DHL Express customer account number
     * @param {string} originCountryCode 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} originCityName Text specifying the city name
     * @param {string} destinationCountryCode A short text string code (see values defined in ISO 3166) specifying the shipment destination country. https://gs1.org/voc/Country, Alpha-2 Code
     * @param {string} destinationCityName Text specifying the city name
     * @param {number} weight Gross weight of the shipment including packaging.
     * @param {number} length Total length of the shipment including packaging.
     * @param {number} width Total width of the shipment including packaging.
     * @param {number} height Total height of the shipment including packaging.
     * @param {string} plannedShippingDate Timestamp represents the date you plan to ship your prospected shipment
     * @param {boolean} isCustomsDeclarable
     * @param {string} unitOfMeasurement The UnitOfMeasurement node conveys the unit of measurements used in the operation. This single value corresponds to the units of weight and measurement which are used throughout the message processing.
     * @param {string} [originPostalCode] Text specifying the postal code for an address. https://gs1.org/voc/postalCode
     * @param {string} [destinationPostalCode] Text specifying the postal code for an address. https://gs1.org/voc/postalCode
     * @param {boolean} [nextBusinessDay] When set to true and there are no products available for given plannedShippingDate then products available for the next possible pickup date are returned
     * @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}
     */
    expApiProducts: (accountNumber: string, originCountryCode: string, originCityName: string, destinationCountryCode: string, destinationCityName: string, weight: number, length: number, width: number, height: number, plannedShippingDate: string, isCustomsDeclarable: boolean, unitOfMeasurement: string, originPostalCode?: string, destinationPostalCode?: string, nextBusinessDay?: boolean, messageReference?: string, messageReferenceDate?: string, pluginName?: string, pluginVersion?: string, shippingSystemPlatformName?: string, shippingSystemPlatformVersion?: string, webstorePlatformName?: string, webstorePlatformVersion?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
};
/**
 * ProductApi - functional programming interface
 * @export
 */
export declare const ProductApiFp: (configuration?: Configuration) => {
    /**
     * The GET Products API will return DHL's product capabilities for a certain set of input data.  Using the shipper and receiver address as well as the dimension and weight of the piece belonging to a shipment, this operation returns the available products.
     * @summary Retrieve available DHL Express products for a one piece Shipment
     * @param {string} accountNumber DHL Express customer account number
     * @param {string} originCountryCode 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} originCityName Text specifying the city name
     * @param {string} destinationCountryCode A short text string code (see values defined in ISO 3166) specifying the shipment destination country. https://gs1.org/voc/Country, Alpha-2 Code
     * @param {string} destinationCityName Text specifying the city name
     * @param {number} weight Gross weight of the shipment including packaging.
     * @param {number} length Total length of the shipment including packaging.
     * @param {number} width Total width of the shipment including packaging.
     * @param {number} height Total height of the shipment including packaging.
     * @param {string} plannedShippingDate Timestamp represents the date you plan to ship your prospected shipment
     * @param {boolean} isCustomsDeclarable
     * @param {string} unitOfMeasurement The UnitOfMeasurement node conveys the unit of measurements used in the operation. This single value corresponds to the units of weight and measurement which are used throughout the message processing.
     * @param {string} [originPostalCode] Text specifying the postal code for an address. https://gs1.org/voc/postalCode
     * @param {string} [destinationPostalCode] Text specifying the postal code for an address. https://gs1.org/voc/postalCode
     * @param {boolean} [nextBusinessDay] When set to true and there are no products available for given plannedShippingDate then products available for the next possible pickup date are returned
     * @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}
     */
    expApiProducts(accountNumber: string, originCountryCode: string, originCityName: string, destinationCountryCode: string, destinationCityName: string, weight: number, length: number, width: number, height: number, plannedShippingDate: string, isCustomsDeclarable: boolean, unitOfMeasurement: string, originPostalCode?: string, destinationPostalCode?: string, nextBusinessDay?: 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<SupermodelIoLogisticsExpressProducts>>>;
};
/**
 * ProductApi - factory interface
 * @export
 */
export declare const ProductApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
    /**
     * The GET Products API will return DHL's product capabilities for a certain set of input data.  Using the shipper and receiver address as well as the dimension and weight of the piece belonging to a shipment, this operation returns the available products.
     * @summary Retrieve available DHL Express products for a one piece Shipment
     * @param {string} accountNumber DHL Express customer account number
     * @param {string} originCountryCode 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} originCityName Text specifying the city name
     * @param {string} destinationCountryCode A short text string code (see values defined in ISO 3166) specifying the shipment destination country. https://gs1.org/voc/Country, Alpha-2 Code
     * @param {string} destinationCityName Text specifying the city name
     * @param {number} weight Gross weight of the shipment including packaging.
     * @param {number} length Total length of the shipment including packaging.
     * @param {number} width Total width of the shipment including packaging.
     * @param {number} height Total height of the shipment including packaging.
     * @param {string} plannedShippingDate Timestamp represents the date you plan to ship your prospected shipment
     * @param {boolean} isCustomsDeclarable
     * @param {string} unitOfMeasurement The UnitOfMeasurement node conveys the unit of measurements used in the operation. This single value corresponds to the units of weight and measurement which are used throughout the message processing.
     * @param {string} [originPostalCode] Text specifying the postal code for an address. https://gs1.org/voc/postalCode
     * @param {string} [destinationPostalCode] Text specifying the postal code for an address. https://gs1.org/voc/postalCode
     * @param {boolean} [nextBusinessDay] When set to true and there are no products available for given plannedShippingDate then products available for the next possible pickup date are returned
     * @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}
     */
    expApiProducts(accountNumber: string, originCountryCode: string, originCityName: string, destinationCountryCode: string, destinationCityName: string, weight: number, length: number, width: number, height: number, plannedShippingDate: string, isCustomsDeclarable: boolean, unitOfMeasurement: string, originPostalCode?: string, destinationPostalCode?: string, nextBusinessDay?: boolean, messageReference?: string, messageReferenceDate?: string, pluginName?: string, pluginVersion?: string, shippingSystemPlatformName?: string, shippingSystemPlatformVersion?: string, webstorePlatformName?: string, webstorePlatformVersion?: string, options?: AxiosRequestConfig): Promise<AxiosResponse<SupermodelIoLogisticsExpressProducts>>;
};
/**
 * ProductApi - object-oriented interface
 * @export
 * @class ProductApi
 * @extends {BaseAPI}
 */
export declare class ProductApi extends BaseAPI {
    /**
     * The GET Products API will return DHL's product capabilities for a certain set of input data.  Using the shipper and receiver address as well as the dimension and weight of the piece belonging to a shipment, this operation returns the available products.
     * @summary Retrieve available DHL Express products for a one piece Shipment
     * @param {string} accountNumber DHL Express customer account number
     * @param {string} originCountryCode 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} originCityName Text specifying the city name
     * @param {string} destinationCountryCode A short text string code (see values defined in ISO 3166) specifying the shipment destination country. https://gs1.org/voc/Country, Alpha-2 Code
     * @param {string} destinationCityName Text specifying the city name
     * @param {number} weight Gross weight of the shipment including packaging.
     * @param {number} length Total length of the shipment including packaging.
     * @param {number} width Total width of the shipment including packaging.
     * @param {number} height Total height of the shipment including packaging.
     * @param {string} plannedShippingDate Timestamp represents the date you plan to ship your prospected shipment
     * @param {boolean} isCustomsDeclarable
     * @param {string} unitOfMeasurement The UnitOfMeasurement node conveys the unit of measurements used in the operation. This single value corresponds to the units of weight and measurement which are used throughout the message processing.
     * @param {string} [originPostalCode] Text specifying the postal code for an address. https://gs1.org/voc/postalCode
     * @param {string} [destinationPostalCode] Text specifying the postal code for an address. https://gs1.org/voc/postalCode
     * @param {boolean} [nextBusinessDay] When set to true and there are no products available for given plannedShippingDate then products available for the next possible pickup date are returned
     * @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 ProductApi
     */
    expApiProducts(accountNumber: string, originCountryCode: string, originCityName: string, destinationCountryCode: string, destinationCityName: string, weight: number, length: number, width: number, height: number, plannedShippingDate: string, isCustomsDeclarable: boolean, unitOfMeasurement: string, originPostalCode?: string, destinationPostalCode?: string, nextBusinessDay?: boolean, messageReference?: string, messageReferenceDate?: string, pluginName?: string, pluginVersion?: string, shippingSystemPlatformName?: string, shippingSystemPlatformVersion?: string, webstorePlatformName?: string, webstorePlatformVersion?: string, options?: AxiosRequestConfig): Promise<AxiosResponse<SupermodelIoLogisticsExpressProducts>>;
}