@myorb/dhl-express/dist/apis/pickup-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 { SupermodelIoLogisticsExpressPickupRequest } from '../models';
import { SupermodelIoLogisticsExpressPickupResponse } from '../models';
import { SupermodelIoLogisticsExpressUpdatePickupRequest } from '../models';
import { SupermodelIoLogisticsExpressUpdatePickupResponse } from '../models';
/**
 * PickupApi - axios parameter creator
 * @export
 */
export declare const PickupApiAxiosParamCreator: (configuration?: Configuration) => {
    /**
     * The Pickup service creates a DHL Express pickup booking request
     * @summary Create a DHL Express pickup booking request
     * @param {SupermodelIoLogisticsExpressPickupRequest} body Details about the requested pickup
     * @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}
     */
    expApiPickups: (body: SupermodelIoLogisticsExpressPickupRequest, messageReference?: string, messageReferenceDate?: string, pluginName?: string, pluginVersion?: string, shippingSystemPlatformName?: string, shippingSystemPlatformVersion?: string, webstorePlatformName?: string, webstorePlatformVersion?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
    /**
     * The Cancel Pickup service can be used to cancel a DHL Express pickup booking request
     * @summary Cancel a DHL Express pickup booking request
     * @param {string} dispatchConfirmationNumber Shipment pickup confirmation number for example &#x60;PRG999126012345&#x60;
     * @param {string} requestorName Name of the person requesting to cancel the scheduled pickup
     * @param {string} reason Provide why scheduled pickup is being cancelled
     * @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}
     */
    expApiPickupsCancel: (dispatchConfirmationNumber: string, requestorName: string, reason: string, messageReference?: string, messageReferenceDate?: string, pluginName?: string, pluginVersion?: string, shippingSystemPlatformName?: string, shippingSystemPlatformVersion?: string, webstorePlatformName?: string, webstorePlatformVersion?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
    /**
     * The Update Pickup service can be used to update pickup information for an existing DHL Express pickup booking request
     * @summary Update pickup information for an existing DHL Express pickup booking request
     * @param {SupermodelIoLogisticsExpressUpdatePickupRequest} body Details about the requested pickup updates
     * @param {string} dispatchConfirmationNumber Shipment pickup confirmation number for example &#x60;PRG999126012345&#x60;
     * @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}
     */
    expApiPickupsUpdate: (body: SupermodelIoLogisticsExpressUpdatePickupRequest, dispatchConfirmationNumber: string, messageReference?: string, messageReferenceDate?: string, pluginName?: string, pluginVersion?: string, shippingSystemPlatformName?: string, shippingSystemPlatformVersion?: string, webstorePlatformName?: string, webstorePlatformVersion?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
};
/**
 * PickupApi - functional programming interface
 * @export
 */
export declare const PickupApiFp: (configuration?: Configuration) => {
    /**
     * The Pickup service creates a DHL Express pickup booking request
     * @summary Create a DHL Express pickup booking request
     * @param {SupermodelIoLogisticsExpressPickupRequest} body Details about the requested pickup
     * @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}
     */
    expApiPickups(body: SupermodelIoLogisticsExpressPickupRequest, 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<SupermodelIoLogisticsExpressPickupResponse>>>;
    /**
     * The Cancel Pickup service can be used to cancel a DHL Express pickup booking request
     * @summary Cancel a DHL Express pickup booking request
     * @param {string} dispatchConfirmationNumber Shipment pickup confirmation number for example &#x60;PRG999126012345&#x60;
     * @param {string} requestorName Name of the person requesting to cancel the scheduled pickup
     * @param {string} reason Provide why scheduled pickup is being cancelled
     * @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}
     */
    expApiPickupsCancel(dispatchConfirmationNumber: string, requestorName: string, reason: string, 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<void>>>;
    /**
     * The Update Pickup service can be used to update pickup information for an existing DHL Express pickup booking request
     * @summary Update pickup information for an existing DHL Express pickup booking request
     * @param {SupermodelIoLogisticsExpressUpdatePickupRequest} body Details about the requested pickup updates
     * @param {string} dispatchConfirmationNumber Shipment pickup confirmation number for example &#x60;PRG999126012345&#x60;
     * @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}
     */
    expApiPickupsUpdate(body: SupermodelIoLogisticsExpressUpdatePickupRequest, dispatchConfirmationNumber: string, 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<SupermodelIoLogisticsExpressUpdatePickupResponse>>>;
};
/**
 * PickupApi - factory interface
 * @export
 */
export declare const PickupApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
    /**
     * The Pickup service creates a DHL Express pickup booking request
     * @summary Create a DHL Express pickup booking request
     * @param {SupermodelIoLogisticsExpressPickupRequest} body Details about the requested pickup
     * @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}
     */
    expApiPickups(body: SupermodelIoLogisticsExpressPickupRequest, messageReference?: string, messageReferenceDate?: string, pluginName?: string, pluginVersion?: string, shippingSystemPlatformName?: string, shippingSystemPlatformVersion?: string, webstorePlatformName?: string, webstorePlatformVersion?: string, options?: AxiosRequestConfig): Promise<AxiosResponse<SupermodelIoLogisticsExpressPickupResponse>>;
    /**
     * The Cancel Pickup service can be used to cancel a DHL Express pickup booking request
     * @summary Cancel a DHL Express pickup booking request
     * @param {string} dispatchConfirmationNumber Shipment pickup confirmation number for example &#x60;PRG999126012345&#x60;
     * @param {string} requestorName Name of the person requesting to cancel the scheduled pickup
     * @param {string} reason Provide why scheduled pickup is being cancelled
     * @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}
     */
    expApiPickupsCancel(dispatchConfirmationNumber: string, requestorName: string, reason: string, messageReference?: string, messageReferenceDate?: string, pluginName?: string, pluginVersion?: string, shippingSystemPlatformName?: string, shippingSystemPlatformVersion?: string, webstorePlatformName?: string, webstorePlatformVersion?: string, options?: AxiosRequestConfig): Promise<AxiosResponse<void>>;
    /**
     * The Update Pickup service can be used to update pickup information for an existing DHL Express pickup booking request
     * @summary Update pickup information for an existing DHL Express pickup booking request
     * @param {SupermodelIoLogisticsExpressUpdatePickupRequest} body Details about the requested pickup updates
     * @param {string} dispatchConfirmationNumber Shipment pickup confirmation number for example &#x60;PRG999126012345&#x60;
     * @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}
     */
    expApiPickupsUpdate(body: SupermodelIoLogisticsExpressUpdatePickupRequest, dispatchConfirmationNumber: string, messageReference?: string, messageReferenceDate?: string, pluginName?: string, pluginVersion?: string, shippingSystemPlatformName?: string, shippingSystemPlatformVersion?: string, webstorePlatformName?: string, webstorePlatformVersion?: string, options?: AxiosRequestConfig): Promise<AxiosResponse<SupermodelIoLogisticsExpressUpdatePickupResponse>>;
};
/**
 * PickupApi - object-oriented interface
 * @export
 * @class PickupApi
 * @extends {BaseAPI}
 */
export declare class PickupApi extends BaseAPI {
    /**
     * The Pickup service creates a DHL Express pickup booking request
     * @summary Create a DHL Express pickup booking request
     * @param {SupermodelIoLogisticsExpressPickupRequest} body Details about the requested pickup
     * @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 PickupApi
     */
    expApiPickups(body: SupermodelIoLogisticsExpressPickupRequest, messageReference?: string, messageReferenceDate?: string, pluginName?: string, pluginVersion?: string, shippingSystemPlatformName?: string, shippingSystemPlatformVersion?: string, webstorePlatformName?: string, webstorePlatformVersion?: string, options?: AxiosRequestConfig): Promise<AxiosResponse<SupermodelIoLogisticsExpressPickupResponse>>;
    /**
     * The Cancel Pickup service can be used to cancel a DHL Express pickup booking request
     * @summary Cancel a DHL Express pickup booking request
     * @param {string} dispatchConfirmationNumber Shipment pickup confirmation number for example &#x60;PRG999126012345&#x60;
     * @param {string} requestorName Name of the person requesting to cancel the scheduled pickup
     * @param {string} reason Provide why scheduled pickup is being cancelled
     * @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 PickupApi
     */
    expApiPickupsCancel(dispatchConfirmationNumber: string, requestorName: string, reason: string, messageReference?: string, messageReferenceDate?: string, pluginName?: string, pluginVersion?: string, shippingSystemPlatformName?: string, shippingSystemPlatformVersion?: string, webstorePlatformName?: string, webstorePlatformVersion?: string, options?: AxiosRequestConfig): Promise<AxiosResponse<void>>;
    /**
     * The Update Pickup service can be used to update pickup information for an existing DHL Express pickup booking request
     * @summary Update pickup information for an existing DHL Express pickup booking request
     * @param {SupermodelIoLogisticsExpressUpdatePickupRequest} body Details about the requested pickup updates
     * @param {string} dispatchConfirmationNumber Shipment pickup confirmation number for example &#x60;PRG999126012345&#x60;
     * @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 PickupApi
     */
    expApiPickupsUpdate(body: SupermodelIoLogisticsExpressUpdatePickupRequest, dispatchConfirmationNumber: string, messageReference?: string, messageReferenceDate?: string, pluginName?: string, pluginVersion?: string, shippingSystemPlatformName?: string, shippingSystemPlatformVersion?: string, webstorePlatformName?: string, webstorePlatformVersion?: string, options?: AxiosRequestConfig): Promise<AxiosResponse<SupermodelIoLogisticsExpressUpdatePickupResponse>>;
}