@myorb/dhl-express
Version:
DHL Express api client
220 lines (219 loc) • 20.5 kB
TypeScript
/**
* 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 { SupermodelIoLogisticsExpressTrackingResponse } from '../models';
/**
* TrackingApi - axios parameter creator
* @export
*/
export declare const TrackingApiAxiosParamCreator: (configuration?: Configuration) => {
/**
* The Tracking service retrieves tracking statuses for a single DHL Express Shipment
* @summary Track a single DHL Express Shipment
* @param {string} shipmentTrackingNumber DHL Express shipment identification number
* @param {string} [trackingView]
* @param {string} [levelOfDetail]
* @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} [acceptLanguage]
* @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}
*/
expApiShipmentsTracking: (shipmentTrackingNumber: string, trackingView?: string, levelOfDetail?: string, messageReference?: string, messageReferenceDate?: string, acceptLanguage?: string, pluginName?: string, pluginVersion?: string, shippingSystemPlatformName?: string, shippingSystemPlatformVersion?: string, webstorePlatformName?: string, webstorePlatformVersion?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
/**
* The Tracking service retrieves tracking statuses for a single or multiple DHL Express Shipments
* @summary Track a single or multiple DHL Express Shipments
* @param {Array<string>} [shipmentTrackingNumber] DHL Express shipment identification number
* @param {Array<string>} [pieceTrackingNumber] DHL Express shipment piece tracking number
* @param {string} [shipmentReference] Shipment reference which was provided during the shipment label creation
* @param {string} [shipmentReferenceType] Shipment reference type which was provided during the shipment label creation
* @param {string} [shipperAccountNumber] Shipper DHL Express Account number under which the shipment label was created
* @param {string} [dateRangeFrom] When tracking by Shipment reference you need to restrict the search by timeframe. Please provide the start of the period.
* @param {string} [dateRangeTo] When tracking by Shipment reference you need to restrict the search by timeframe. Please provide the end of the period.
* @param {string} [trackingView]
* @param {string} [levelOfDetail]
* @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} [acceptLanguage]
* @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}
*/
expApiShipmentsTrackingMulti: (shipmentTrackingNumber?: Array<string>, pieceTrackingNumber?: Array<string>, shipmentReference?: string, shipmentReferenceType?: string, shipperAccountNumber?: string, dateRangeFrom?: string, dateRangeTo?: string, trackingView?: string, levelOfDetail?: string, messageReference?: string, messageReferenceDate?: string, acceptLanguage?: string, pluginName?: string, pluginVersion?: string, shippingSystemPlatformName?: string, shippingSystemPlatformVersion?: string, webstorePlatformName?: string, webstorePlatformVersion?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
};
/**
* TrackingApi - functional programming interface
* @export
*/
export declare const TrackingApiFp: (configuration?: Configuration) => {
/**
* The Tracking service retrieves tracking statuses for a single DHL Express Shipment
* @summary Track a single DHL Express Shipment
* @param {string} shipmentTrackingNumber DHL Express shipment identification number
* @param {string} [trackingView]
* @param {string} [levelOfDetail]
* @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} [acceptLanguage]
* @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}
*/
expApiShipmentsTracking(shipmentTrackingNumber: string, trackingView?: string, levelOfDetail?: string, messageReference?: string, messageReferenceDate?: string, acceptLanguage?: string, pluginName?: string, pluginVersion?: string, shippingSystemPlatformName?: string, shippingSystemPlatformVersion?: string, webstorePlatformName?: string, webstorePlatformVersion?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<SupermodelIoLogisticsExpressTrackingResponse>>>;
/**
* The Tracking service retrieves tracking statuses for a single or multiple DHL Express Shipments
* @summary Track a single or multiple DHL Express Shipments
* @param {Array<string>} [shipmentTrackingNumber] DHL Express shipment identification number
* @param {Array<string>} [pieceTrackingNumber] DHL Express shipment piece tracking number
* @param {string} [shipmentReference] Shipment reference which was provided during the shipment label creation
* @param {string} [shipmentReferenceType] Shipment reference type which was provided during the shipment label creation
* @param {string} [shipperAccountNumber] Shipper DHL Express Account number under which the shipment label was created
* @param {string} [dateRangeFrom] When tracking by Shipment reference you need to restrict the search by timeframe. Please provide the start of the period.
* @param {string} [dateRangeTo] When tracking by Shipment reference you need to restrict the search by timeframe. Please provide the end of the period.
* @param {string} [trackingView]
* @param {string} [levelOfDetail]
* @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} [acceptLanguage]
* @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}
*/
expApiShipmentsTrackingMulti(shipmentTrackingNumber?: Array<string>, pieceTrackingNumber?: Array<string>, shipmentReference?: string, shipmentReferenceType?: string, shipperAccountNumber?: string, dateRangeFrom?: string, dateRangeTo?: string, trackingView?: string, levelOfDetail?: string, messageReference?: string, messageReferenceDate?: string, acceptLanguage?: string, pluginName?: string, pluginVersion?: string, shippingSystemPlatformName?: string, shippingSystemPlatformVersion?: string, webstorePlatformName?: string, webstorePlatformVersion?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<SupermodelIoLogisticsExpressTrackingResponse>>>;
};
/**
* TrackingApi - factory interface
* @export
*/
export declare const TrackingApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
/**
* The Tracking service retrieves tracking statuses for a single DHL Express Shipment
* @summary Track a single DHL Express Shipment
* @param {string} shipmentTrackingNumber DHL Express shipment identification number
* @param {string} [trackingView]
* @param {string} [levelOfDetail]
* @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} [acceptLanguage]
* @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}
*/
expApiShipmentsTracking(shipmentTrackingNumber: string, trackingView?: string, levelOfDetail?: string, messageReference?: string, messageReferenceDate?: string, acceptLanguage?: string, pluginName?: string, pluginVersion?: string, shippingSystemPlatformName?: string, shippingSystemPlatformVersion?: string, webstorePlatformName?: string, webstorePlatformVersion?: string, options?: AxiosRequestConfig): Promise<AxiosResponse<SupermodelIoLogisticsExpressTrackingResponse>>;
/**
* The Tracking service retrieves tracking statuses for a single or multiple DHL Express Shipments
* @summary Track a single or multiple DHL Express Shipments
* @param {Array<string>} [shipmentTrackingNumber] DHL Express shipment identification number
* @param {Array<string>} [pieceTrackingNumber] DHL Express shipment piece tracking number
* @param {string} [shipmentReference] Shipment reference which was provided during the shipment label creation
* @param {string} [shipmentReferenceType] Shipment reference type which was provided during the shipment label creation
* @param {string} [shipperAccountNumber] Shipper DHL Express Account number under which the shipment label was created
* @param {string} [dateRangeFrom] When tracking by Shipment reference you need to restrict the search by timeframe. Please provide the start of the period.
* @param {string} [dateRangeTo] When tracking by Shipment reference you need to restrict the search by timeframe. Please provide the end of the period.
* @param {string} [trackingView]
* @param {string} [levelOfDetail]
* @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} [acceptLanguage]
* @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}
*/
expApiShipmentsTrackingMulti(shipmentTrackingNumber?: Array<string>, pieceTrackingNumber?: Array<string>, shipmentReference?: string, shipmentReferenceType?: string, shipperAccountNumber?: string, dateRangeFrom?: string, dateRangeTo?: string, trackingView?: string, levelOfDetail?: string, messageReference?: string, messageReferenceDate?: string, acceptLanguage?: string, pluginName?: string, pluginVersion?: string, shippingSystemPlatformName?: string, shippingSystemPlatformVersion?: string, webstorePlatformName?: string, webstorePlatformVersion?: string, options?: AxiosRequestConfig): Promise<AxiosResponse<SupermodelIoLogisticsExpressTrackingResponse>>;
};
/**
* TrackingApi - object-oriented interface
* @export
* @class TrackingApi
* @extends {BaseAPI}
*/
export declare class TrackingApi extends BaseAPI {
/**
* The Tracking service retrieves tracking statuses for a single DHL Express Shipment
* @summary Track a single DHL Express Shipment
* @param {string} shipmentTrackingNumber DHL Express shipment identification number
* @param {string} [trackingView]
* @param {string} [levelOfDetail]
* @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} [acceptLanguage]
* @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 TrackingApi
*/
expApiShipmentsTracking(shipmentTrackingNumber: string, trackingView?: string, levelOfDetail?: string, messageReference?: string, messageReferenceDate?: string, acceptLanguage?: string, pluginName?: string, pluginVersion?: string, shippingSystemPlatformName?: string, shippingSystemPlatformVersion?: string, webstorePlatformName?: string, webstorePlatformVersion?: string, options?: AxiosRequestConfig): Promise<AxiosResponse<SupermodelIoLogisticsExpressTrackingResponse>>;
/**
* The Tracking service retrieves tracking statuses for a single or multiple DHL Express Shipments
* @summary Track a single or multiple DHL Express Shipments
* @param {Array<string>} [shipmentTrackingNumber] DHL Express shipment identification number
* @param {Array<string>} [pieceTrackingNumber] DHL Express shipment piece tracking number
* @param {string} [shipmentReference] Shipment reference which was provided during the shipment label creation
* @param {string} [shipmentReferenceType] Shipment reference type which was provided during the shipment label creation
* @param {string} [shipperAccountNumber] Shipper DHL Express Account number under which the shipment label was created
* @param {string} [dateRangeFrom] When tracking by Shipment reference you need to restrict the search by timeframe. Please provide the start of the period.
* @param {string} [dateRangeTo] When tracking by Shipment reference you need to restrict the search by timeframe. Please provide the end of the period.
* @param {string} [trackingView]
* @param {string} [levelOfDetail]
* @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} [acceptLanguage]
* @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 TrackingApi
*/
expApiShipmentsTrackingMulti(shipmentTrackingNumber?: Array<string>, pieceTrackingNumber?: Array<string>, shipmentReference?: string, shipmentReferenceType?: string, shipperAccountNumber?: string, dateRangeFrom?: string, dateRangeTo?: string, trackingView?: string, levelOfDetail?: string, messageReference?: string, messageReferenceDate?: string, acceptLanguage?: string, pluginName?: string, pluginVersion?: string, shippingSystemPlatformName?: string, shippingSystemPlatformVersion?: string, webstorePlatformName?: string, webstorePlatformVersion?: string, options?: AxiosRequestConfig): Promise<AxiosResponse<SupermodelIoLogisticsExpressTrackingResponse>>;
}