@myorb/dhl-express
Version:
DHL Express api client
622 lines (621 loc) • 47.6 kB
JavaScript
;
var __extends = (this && this.__extends) || (function () {
var extendStatics = function (d, b) {
extendStatics = Object.setPrototypeOf ||
({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
return extendStatics(d, b);
};
return function (d, b) {
if (typeof b !== "function" && b !== null)
throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
extendStatics(d, b);
function __() { this.constructor = d; }
d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
};
})();
var __assign = (this && this.__assign) || function () {
__assign = Object.assign || function(t) {
for (var s, i = 1, n = arguments.length; i < n; i++) {
s = arguments[i];
for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
t[p] = s[p];
}
return t;
};
return __assign.apply(this, arguments);
};
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
return new (P || (P = Promise))(function (resolve, reject) {
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
step((generator = generator.apply(thisArg, _arguments || [])).next());
});
};
var __generator = (this && this.__generator) || function (thisArg, body) {
var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
function verb(n) { return function (v) { return step([n, v]); }; }
function step(op) {
if (f) throw new TypeError("Generator is already executing.");
while (_) try {
if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
if (y = 0, t) op = [op[0] & 2, t.value];
switch (op[0]) {
case 0: case 1: t = op; break;
case 4: _.label++; return { value: op[1], done: false };
case 5: _.label++; y = op[1]; op = [0]; continue;
case 7: op = _.ops.pop(); _.trys.pop(); continue;
default:
if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
if (t[2]) _.ops.pop();
_.trys.pop(); continue;
}
op = body.call(thisArg, _);
} catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
}
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.PickupApi = exports.PickupApiFactory = exports.PickupApiFp = exports.PickupApiAxiosParamCreator = void 0;
/* tslint:disable */
/* eslint-disable */
/**
* 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.
*/
var axios_1 = require("axios");
// Some imports not used depending on template conditions
// @ts-ignore
var base_1 = require("../base");
/**
* PickupApi - axios parameter creator
* @export
*/
var PickupApiAxiosParamCreator = function (configuration) {
var _this = this;
return {
/**
* 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: function (body, messageReference, messageReferenceDate, pluginName, pluginVersion, shippingSystemPlatformName, shippingSystemPlatformVersion, webstorePlatformName, webstorePlatformVersion, options) {
if (options === void 0) { options = {}; }
return __awaiter(_this, void 0, void 0, function () {
var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, query, key, key, headersFromBaseOptions, needsSerialization;
return __generator(this, function (_a) {
// verify required parameter 'body' is not null or undefined
if (body === null || body === undefined) {
throw new base_1.RequiredError('body', 'Required parameter body was null or undefined when calling expApiPickups.');
}
localVarPath = "/pickups";
localVarUrlObj = new URL(localVarPath, 'https://example.com');
if (configuration) {
baseOptions = configuration.baseOptions;
}
localVarRequestOptions = __assign(__assign({ method: 'POST' }, baseOptions), options);
localVarHeaderParameter = {};
localVarQueryParameter = {};
// authentication basicAuth required
if (messageReference !== undefined && messageReference !== null) {
localVarHeaderParameter['Message-Reference'] = String(messageReference);
}
if (messageReferenceDate !== undefined && messageReferenceDate !== null) {
localVarHeaderParameter['Message-Reference-Date'] = String(messageReferenceDate);
}
if (pluginName !== undefined && pluginName !== null) {
localVarHeaderParameter['Plugin-Name'] = String(pluginName);
}
if (pluginVersion !== undefined && pluginVersion !== null) {
localVarHeaderParameter['Plugin-Version'] = String(pluginVersion);
}
if (shippingSystemPlatformName !== undefined && shippingSystemPlatformName !== null) {
localVarHeaderParameter['Shipping-System-Platform-Name'] = String(shippingSystemPlatformName);
}
if (shippingSystemPlatformVersion !== undefined && shippingSystemPlatformVersion !== null) {
localVarHeaderParameter['Shipping-System-Platform-Version'] = String(shippingSystemPlatformVersion);
}
if (webstorePlatformName !== undefined && webstorePlatformName !== null) {
localVarHeaderParameter['Webstore-Platform-Name'] = String(webstorePlatformName);
}
if (webstorePlatformVersion !== undefined && webstorePlatformVersion !== null) {
localVarHeaderParameter['Webstore-Platform-Version'] = String(webstorePlatformVersion);
}
localVarHeaderParameter['Content-Type'] = 'application/json';
query = new URLSearchParams(localVarUrlObj.search);
for (key in localVarQueryParameter) {
query.set(key, localVarQueryParameter[key]);
}
for (key in options.params) {
query.set(key, options.params[key]);
}
localVarUrlObj.search = (new URLSearchParams(query)).toString();
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
needsSerialization = (typeof body !== "string") || localVarRequestOptions.headers['Content-Type'] === 'application/json';
localVarRequestOptions.data = needsSerialization ? JSON.stringify(body !== undefined ? body : {}) : (body || "");
return [2 /*return*/, {
url: localVarUrlObj.pathname + localVarUrlObj.search + localVarUrlObj.hash,
options: localVarRequestOptions,
}];
});
});
},
/**
* 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 `PRG999126012345`
* @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: function (dispatchConfirmationNumber, requestorName, reason, messageReference, messageReferenceDate, pluginName, pluginVersion, shippingSystemPlatformName, shippingSystemPlatformVersion, webstorePlatformName, webstorePlatformVersion, options) {
if (options === void 0) { options = {}; }
return __awaiter(_this, void 0, void 0, function () {
var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, query, key, key, headersFromBaseOptions;
return __generator(this, function (_a) {
// verify required parameter 'dispatchConfirmationNumber' is not null or undefined
if (dispatchConfirmationNumber === null || dispatchConfirmationNumber === undefined) {
throw new base_1.RequiredError('dispatchConfirmationNumber', 'Required parameter dispatchConfirmationNumber was null or undefined when calling expApiPickupsCancel.');
}
// verify required parameter 'requestorName' is not null or undefined
if (requestorName === null || requestorName === undefined) {
throw new base_1.RequiredError('requestorName', 'Required parameter requestorName was null or undefined when calling expApiPickupsCancel.');
}
// verify required parameter 'reason' is not null or undefined
if (reason === null || reason === undefined) {
throw new base_1.RequiredError('reason', 'Required parameter reason was null or undefined when calling expApiPickupsCancel.');
}
localVarPath = "/pickups/{dispatchConfirmationNumber}"
.replace("{".concat("dispatchConfirmationNumber", "}"), encodeURIComponent(String(dispatchConfirmationNumber)));
localVarUrlObj = new URL(localVarPath, 'https://example.com');
if (configuration) {
baseOptions = configuration.baseOptions;
}
localVarRequestOptions = __assign(__assign({ method: 'DELETE' }, baseOptions), options);
localVarHeaderParameter = {};
localVarQueryParameter = {};
// authentication basicAuth required
if (requestorName !== undefined) {
localVarQueryParameter['requestorName'] = requestorName;
}
if (reason !== undefined) {
localVarQueryParameter['reason'] = reason;
}
if (messageReference !== undefined && messageReference !== null) {
localVarHeaderParameter['Message-Reference'] = String(messageReference);
}
if (messageReferenceDate !== undefined && messageReferenceDate !== null) {
localVarHeaderParameter['Message-Reference-Date'] = String(messageReferenceDate);
}
if (pluginName !== undefined && pluginName !== null) {
localVarHeaderParameter['Plugin-Name'] = String(pluginName);
}
if (pluginVersion !== undefined && pluginVersion !== null) {
localVarHeaderParameter['Plugin-Version'] = String(pluginVersion);
}
if (shippingSystemPlatformName !== undefined && shippingSystemPlatformName !== null) {
localVarHeaderParameter['Shipping-System-Platform-Name'] = String(shippingSystemPlatformName);
}
if (shippingSystemPlatformVersion !== undefined && shippingSystemPlatformVersion !== null) {
localVarHeaderParameter['Shipping-System-Platform-Version'] = String(shippingSystemPlatformVersion);
}
if (webstorePlatformName !== undefined && webstorePlatformName !== null) {
localVarHeaderParameter['Webstore-Platform-Name'] = String(webstorePlatformName);
}
if (webstorePlatformVersion !== undefined && webstorePlatformVersion !== null) {
localVarHeaderParameter['Webstore-Platform-Version'] = String(webstorePlatformVersion);
}
query = new URLSearchParams(localVarUrlObj.search);
for (key in localVarQueryParameter) {
query.set(key, localVarQueryParameter[key]);
}
for (key in options.params) {
query.set(key, options.params[key]);
}
localVarUrlObj.search = (new URLSearchParams(query)).toString();
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
return [2 /*return*/, {
url: localVarUrlObj.pathname + localVarUrlObj.search + localVarUrlObj.hash,
options: localVarRequestOptions,
}];
});
});
},
/**
* 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 `PRG999126012345`
* @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: function (body, dispatchConfirmationNumber, messageReference, messageReferenceDate, pluginName, pluginVersion, shippingSystemPlatformName, shippingSystemPlatformVersion, webstorePlatformName, webstorePlatformVersion, options) {
if (options === void 0) { options = {}; }
return __awaiter(_this, void 0, void 0, function () {
var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, query, key, key, headersFromBaseOptions, needsSerialization;
return __generator(this, function (_a) {
// verify required parameter 'body' is not null or undefined
if (body === null || body === undefined) {
throw new base_1.RequiredError('body', 'Required parameter body was null or undefined when calling expApiPickupsUpdate.');
}
// verify required parameter 'dispatchConfirmationNumber' is not null or undefined
if (dispatchConfirmationNumber === null || dispatchConfirmationNumber === undefined) {
throw new base_1.RequiredError('dispatchConfirmationNumber', 'Required parameter dispatchConfirmationNumber was null or undefined when calling expApiPickupsUpdate.');
}
localVarPath = "/pickups/{dispatchConfirmationNumber}"
.replace("{".concat("dispatchConfirmationNumber", "}"), encodeURIComponent(String(dispatchConfirmationNumber)));
localVarUrlObj = new URL(localVarPath, 'https://example.com');
if (configuration) {
baseOptions = configuration.baseOptions;
}
localVarRequestOptions = __assign(__assign({ method: 'PATCH' }, baseOptions), options);
localVarHeaderParameter = {};
localVarQueryParameter = {};
// authentication basicAuth required
if (messageReference !== undefined && messageReference !== null) {
localVarHeaderParameter['Message-Reference'] = String(messageReference);
}
if (messageReferenceDate !== undefined && messageReferenceDate !== null) {
localVarHeaderParameter['Message-Reference-Date'] = String(messageReferenceDate);
}
if (pluginName !== undefined && pluginName !== null) {
localVarHeaderParameter['Plugin-Name'] = String(pluginName);
}
if (pluginVersion !== undefined && pluginVersion !== null) {
localVarHeaderParameter['Plugin-Version'] = String(pluginVersion);
}
if (shippingSystemPlatformName !== undefined && shippingSystemPlatformName !== null) {
localVarHeaderParameter['Shipping-System-Platform-Name'] = String(shippingSystemPlatformName);
}
if (shippingSystemPlatformVersion !== undefined && shippingSystemPlatformVersion !== null) {
localVarHeaderParameter['Shipping-System-Platform-Version'] = String(shippingSystemPlatformVersion);
}
if (webstorePlatformName !== undefined && webstorePlatformName !== null) {
localVarHeaderParameter['Webstore-Platform-Name'] = String(webstorePlatformName);
}
if (webstorePlatformVersion !== undefined && webstorePlatformVersion !== null) {
localVarHeaderParameter['Webstore-Platform-Version'] = String(webstorePlatformVersion);
}
localVarHeaderParameter['Content-Type'] = 'application/json';
query = new URLSearchParams(localVarUrlObj.search);
for (key in localVarQueryParameter) {
query.set(key, localVarQueryParameter[key]);
}
for (key in options.params) {
query.set(key, options.params[key]);
}
localVarUrlObj.search = (new URLSearchParams(query)).toString();
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
needsSerialization = (typeof body !== "string") || localVarRequestOptions.headers['Content-Type'] === 'application/json';
localVarRequestOptions.data = needsSerialization ? JSON.stringify(body !== undefined ? body : {}) : (body || "");
return [2 /*return*/, {
url: localVarUrlObj.pathname + localVarUrlObj.search + localVarUrlObj.hash,
options: localVarRequestOptions,
}];
});
});
},
};
};
exports.PickupApiAxiosParamCreator = PickupApiAxiosParamCreator;
/**
* PickupApi - functional programming interface
* @export
*/
var PickupApiFp = function (configuration) {
return {
/**
* 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: function (body, messageReference, messageReferenceDate, pluginName, pluginVersion, shippingSystemPlatformName, shippingSystemPlatformVersion, webstorePlatformName, webstorePlatformVersion, options) {
return __awaiter(this, void 0, void 0, function () {
var localVarAxiosArgs;
return __generator(this, function (_a) {
switch (_a.label) {
case 0: return [4 /*yield*/, (0, exports.PickupApiAxiosParamCreator)(configuration).expApiPickups(body, messageReference, messageReferenceDate, pluginName, pluginVersion, shippingSystemPlatformName, shippingSystemPlatformVersion, webstorePlatformName, webstorePlatformVersion, options)];
case 1:
localVarAxiosArgs = _a.sent();
return [2 /*return*/, function (axios, basePath) {
if (axios === void 0) { axios = axios_1.default; }
if (basePath === void 0) { basePath = base_1.BASE_PATH; }
var axiosRequestArgs = __assign(__assign({}, localVarAxiosArgs.options), { url: basePath + localVarAxiosArgs.url });
return axios.request(axiosRequestArgs);
}];
}
});
});
},
/**
* 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 `PRG999126012345`
* @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: function (dispatchConfirmationNumber, requestorName, reason, messageReference, messageReferenceDate, pluginName, pluginVersion, shippingSystemPlatformName, shippingSystemPlatformVersion, webstorePlatformName, webstorePlatformVersion, options) {
return __awaiter(this, void 0, void 0, function () {
var localVarAxiosArgs;
return __generator(this, function (_a) {
switch (_a.label) {
case 0: return [4 /*yield*/, (0, exports.PickupApiAxiosParamCreator)(configuration).expApiPickupsCancel(dispatchConfirmationNumber, requestorName, reason, messageReference, messageReferenceDate, pluginName, pluginVersion, shippingSystemPlatformName, shippingSystemPlatformVersion, webstorePlatformName, webstorePlatformVersion, options)];
case 1:
localVarAxiosArgs = _a.sent();
return [2 /*return*/, function (axios, basePath) {
if (axios === void 0) { axios = axios_1.default; }
if (basePath === void 0) { basePath = base_1.BASE_PATH; }
var axiosRequestArgs = __assign(__assign({}, localVarAxiosArgs.options), { url: basePath + localVarAxiosArgs.url });
return axios.request(axiosRequestArgs);
}];
}
});
});
},
/**
* 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 `PRG999126012345`
* @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: function (body, dispatchConfirmationNumber, messageReference, messageReferenceDate, pluginName, pluginVersion, shippingSystemPlatformName, shippingSystemPlatformVersion, webstorePlatformName, webstorePlatformVersion, options) {
return __awaiter(this, void 0, void 0, function () {
var localVarAxiosArgs;
return __generator(this, function (_a) {
switch (_a.label) {
case 0: return [4 /*yield*/, (0, exports.PickupApiAxiosParamCreator)(configuration).expApiPickupsUpdate(body, dispatchConfirmationNumber, messageReference, messageReferenceDate, pluginName, pluginVersion, shippingSystemPlatformName, shippingSystemPlatformVersion, webstorePlatformName, webstorePlatformVersion, options)];
case 1:
localVarAxiosArgs = _a.sent();
return [2 /*return*/, function (axios, basePath) {
if (axios === void 0) { axios = axios_1.default; }
if (basePath === void 0) { basePath = base_1.BASE_PATH; }
var axiosRequestArgs = __assign(__assign({}, localVarAxiosArgs.options), { url: basePath + localVarAxiosArgs.url });
return axios.request(axiosRequestArgs);
}];
}
});
});
},
};
};
exports.PickupApiFp = PickupApiFp;
/**
* PickupApi - factory interface
* @export
*/
var PickupApiFactory = function (configuration, basePath, axios) {
return {
/**
* 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: function (body, messageReference, messageReferenceDate, pluginName, pluginVersion, shippingSystemPlatformName, shippingSystemPlatformVersion, webstorePlatformName, webstorePlatformVersion, options) {
return __awaiter(this, void 0, void 0, function () {
return __generator(this, function (_a) {
return [2 /*return*/, (0, exports.PickupApiFp)(configuration).expApiPickups(body, messageReference, messageReferenceDate, pluginName, pluginVersion, shippingSystemPlatformName, shippingSystemPlatformVersion, webstorePlatformName, webstorePlatformVersion, options).then(function (request) { return request(axios, basePath); })];
});
});
},
/**
* 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 `PRG999126012345`
* @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: function (dispatchConfirmationNumber, requestorName, reason, messageReference, messageReferenceDate, pluginName, pluginVersion, shippingSystemPlatformName, shippingSystemPlatformVersion, webstorePlatformName, webstorePlatformVersion, options) {
return __awaiter(this, void 0, void 0, function () {
return __generator(this, function (_a) {
return [2 /*return*/, (0, exports.PickupApiFp)(configuration).expApiPickupsCancel(dispatchConfirmationNumber, requestorName, reason, messageReference, messageReferenceDate, pluginName, pluginVersion, shippingSystemPlatformName, shippingSystemPlatformVersion, webstorePlatformName, webstorePlatformVersion, options).then(function (request) { return request(axios, basePath); })];
});
});
},
/**
* 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 `PRG999126012345`
* @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: function (body, dispatchConfirmationNumber, messageReference, messageReferenceDate, pluginName, pluginVersion, shippingSystemPlatformName, shippingSystemPlatformVersion, webstorePlatformName, webstorePlatformVersion, options) {
return __awaiter(this, void 0, void 0, function () {
return __generator(this, function (_a) {
return [2 /*return*/, (0, exports.PickupApiFp)(configuration).expApiPickupsUpdate(body, dispatchConfirmationNumber, messageReference, messageReferenceDate, pluginName, pluginVersion, shippingSystemPlatformName, shippingSystemPlatformVersion, webstorePlatformName, webstorePlatformVersion, options).then(function (request) { return request(axios, basePath); })];
});
});
},
};
};
exports.PickupApiFactory = PickupApiFactory;
/**
* PickupApi - object-oriented interface
* @export
* @class PickupApi
* @extends {BaseAPI}
*/
var PickupApi = /** @class */ (function (_super) {
__extends(PickupApi, _super);
function PickupApi() {
return _super !== null && _super.apply(this, arguments) || this;
}
/**
* 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
*/
PickupApi.prototype.expApiPickups = function (body, messageReference, messageReferenceDate, pluginName, pluginVersion, shippingSystemPlatformName, shippingSystemPlatformVersion, webstorePlatformName, webstorePlatformVersion, options) {
return __awaiter(this, void 0, void 0, function () {
var _this = this;
return __generator(this, function (_a) {
return [2 /*return*/, (0, exports.PickupApiFp)(this.configuration).expApiPickups(body, messageReference, messageReferenceDate, pluginName, pluginVersion, shippingSystemPlatformName, shippingSystemPlatformVersion, webstorePlatformName, webstorePlatformVersion, options).then(function (request) { return request(_this.axios, _this.basePath); })];
});
});
};
/**
* 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 `PRG999126012345`
* @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
*/
PickupApi.prototype.expApiPickupsCancel = function (dispatchConfirmationNumber, requestorName, reason, messageReference, messageReferenceDate, pluginName, pluginVersion, shippingSystemPlatformName, shippingSystemPlatformVersion, webstorePlatformName, webstorePlatformVersion, options) {
return __awaiter(this, void 0, void 0, function () {
var _this = this;
return __generator(this, function (_a) {
return [2 /*return*/, (0, exports.PickupApiFp)(this.configuration).expApiPickupsCancel(dispatchConfirmationNumber, requestorName, reason, messageReference, messageReferenceDate, pluginName, pluginVersion, shippingSystemPlatformName, shippingSystemPlatformVersion, webstorePlatformName, webstorePlatformVersion, options).then(function (request) { return request(_this.axios, _this.basePath); })];
});
});
};
/**
* 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 `PRG999126012345`
* @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
*/
PickupApi.prototype.expApiPickupsUpdate = function (body, dispatchConfirmationNumber, messageReference, messageReferenceDate, pluginName, pluginVersion, shippingSystemPlatformName, shippingSystemPlatformVersion, webstorePlatformName, webstorePlatformVersion, options) {
return __awaiter(this, void 0, void 0, function () {
var _this = this;
return __generator(this, function (_a) {
return [2 /*return*/, (0, exports.PickupApiFp)(this.configuration).expApiPickupsUpdate(body, dispatchConfirmationNumber, messageReference, messageReferenceDate, pluginName, pluginVersion, shippingSystemPlatformName, shippingSystemPlatformVersion, webstorePlatformName, webstorePlatformVersion, options).then(function (request) { return request(_this.axios, _this.basePath); })];
});
});
};
return PickupApi;
}(base_1.BaseAPI));
exports.PickupApi = PickupApi;