@myorb/dhl-express
Version:
DHL Express api client
616 lines • 60.9 kB
JavaScript
"use strict";
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.RatingApi = exports.RatingApiFactory = exports.RatingApiFp = exports.RatingApiAxiosParamCreator = 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");
/**
* RatingApi - axios parameter creator
* @export
*/
var RatingApiAxiosParamCreator = function (configuration) {
var _this = this;
return {
/**
* The Landed Cost section allows further information around products being sold to be provided. In return the duty, tax and shipping charges are calculated in real time and provides transparency about any extra costs the buyer may have to pay before they reach them.
* @summary Landed Cost
* @param {SupermodelIoLogisticsExpressLandedCostRequest} body Details about the requested shipment
* @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}
*/
expApiLandedCost: 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 expApiLandedCost.');
}
localVarPath = "/landed-cost";
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 Rate request will return DHL's product capabilities and prices (where applicable) based on the input data. Using the shipper and receiver address as well as the dimension and weights of the pieces belonging to a shipment, this operation returns the available products including the shipping price (where applicable)
* @summary Retrieve Rates 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}
*/
expApiRates: function (accountNumber, originCountryCode, originCityName, destinationCountryCode, destinationCityName, weight, length, width, height, plannedShippingDate, isCustomsDeclarable, unitOfMeasurement, originPostalCode, destinationPostalCode, nextBusinessDay, 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 'accountNumber' is not null or undefined
if (accountNumber === null || accountNumber === undefined) {
throw new base_1.RequiredError('accountNumber', 'Required parameter accountNumber was null or undefined when calling expApiRates.');
}
// verify required parameter 'originCountryCode' is not null or undefined
if (originCountryCode === null || originCountryCode === undefined) {
throw new base_1.RequiredError('originCountryCode', 'Required parameter originCountryCode was null or undefined when calling expApiRates.');
}
// verify required parameter 'originCityName' is not null or undefined
if (originCityName === null || originCityName === undefined) {
throw new base_1.RequiredError('originCityName', 'Required parameter originCityName was null or undefined when calling expApiRates.');
}
// verify required parameter 'destinationCountryCode' is not null or undefined
if (destinationCountryCode === null || destinationCountryCode === undefined) {
throw new base_1.RequiredError('destinationCountryCode', 'Required parameter destinationCountryCode was null or undefined when calling expApiRates.');
}
// verify required parameter 'destinationCityName' is not null or undefined
if (destinationCityName === null || destinationCityName === undefined) {
throw new base_1.RequiredError('destinationCityName', 'Required parameter destinationCityName was null or undefined when calling expApiRates.');
}
// verify required parameter 'weight' is not null or undefined
if (weight === null || weight === undefined) {
throw new base_1.RequiredError('weight', 'Required parameter weight was null or undefined when calling expApiRates.');
}
// verify required parameter 'length' is not null or undefined
if (length === null || length === undefined) {
throw new base_1.RequiredError('length', 'Required parameter length was null or undefined when calling expApiRates.');
}
// verify required parameter 'width' is not null or undefined
if (width === null || width === undefined) {
throw new base_1.RequiredError('width', 'Required parameter width was null or undefined when calling expApiRates.');
}
// verify required parameter 'height' is not null or undefined
if (height === null || height === undefined) {
throw new base_1.RequiredError('height', 'Required parameter height was null or undefined when calling expApiRates.');
}
// verify required parameter 'plannedShippingDate' is not null or undefined
if (plannedShippingDate === null || plannedShippingDate === undefined) {
throw new base_1.RequiredError('plannedShippingDate', 'Required parameter plannedShippingDate was null or undefined when calling expApiRates.');
}
// verify required parameter 'isCustomsDeclarable' is not null or undefined
if (isCustomsDeclarable === null || isCustomsDeclarable === undefined) {
throw new base_1.RequiredError('isCustomsDeclarable', 'Required parameter isCustomsDeclarable was null or undefined when calling expApiRates.');
}
// verify required parameter 'unitOfMeasurement' is not null or undefined
if (unitOfMeasurement === null || unitOfMeasurement === undefined) {
throw new base_1.RequiredError('unitOfMeasurement', 'Required parameter unitOfMeasurement was null or undefined when calling expApiRates.');
}
localVarPath = "/rates";
localVarUrlObj = new URL(localVarPath, 'https://example.com');
if (configuration) {
baseOptions = configuration.baseOptions;
}
localVarRequestOptions = __assign(__assign({ method: 'GET' }, baseOptions), options);
localVarHeaderParameter = {};
localVarQueryParameter = {};
// authentication basicAuth required
if (accountNumber !== undefined) {
localVarQueryParameter['accountNumber'] = accountNumber;
}
if (originCountryCode !== undefined) {
localVarQueryParameter['originCountryCode'] = originCountryCode;
}
if (originPostalCode !== undefined) {
localVarQueryParameter['originPostalCode'] = originPostalCode;
}
if (originCityName !== undefined) {
localVarQueryParameter['originCityName'] = originCityName;
}
if (destinationCountryCode !== undefined) {
localVarQueryParameter['destinationCountryCode'] = destinationCountryCode;
}
if (destinationPostalCode !== undefined) {
localVarQueryParameter['destinationPostalCode'] = destinationPostalCode;
}
if (destinationCityName !== undefined) {
localVarQueryParameter['destinationCityName'] = destinationCityName;
}
if (weight !== undefined) {
localVarQueryParameter['weight'] = weight;
}
if (length !== undefined) {
localVarQueryParameter['length'] = length;
}
if (width !== undefined) {
localVarQueryParameter['width'] = width;
}
if (height !== undefined) {
localVarQueryParameter['height'] = height;
}
if (plannedShippingDate !== undefined) {
localVarQueryParameter['plannedShippingDate'] = plannedShippingDate;
}
if (isCustomsDeclarable !== undefined) {
localVarQueryParameter['isCustomsDeclarable'] = isCustomsDeclarable;
}
if (unitOfMeasurement !== undefined) {
localVarQueryParameter['unitOfMeasurement'] = unitOfMeasurement;
}
if (nextBusinessDay !== undefined) {
localVarQueryParameter['nextBusinessDay'] = nextBusinessDay;
}
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 Rate request will return DHL's product capabilities and prices (where applicable) based on the input data. Using the shipper and receiver address as well as the dimension and weights of the pieces belonging to a shipment, this operation returns the available products including the shipping price (where applicable)
* @summary Retrieve Rates for Multi-piece Shipments
* @param {SupermodelIoLogisticsExpressRateRequest} body Details about the requested shipment
* @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}
*/
expApiRatesMany: 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 expApiRatesMany.');
}
localVarPath = "/rates";
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,
}];
});
});
},
};
};
exports.RatingApiAxiosParamCreator = RatingApiAxiosParamCreator;
/**
* RatingApi - functional programming interface
* @export
*/
var RatingApiFp = function (configuration) {
return {
/**
* The Landed Cost section allows further information around products being sold to be provided. In return the duty, tax and shipping charges are calculated in real time and provides transparency about any extra costs the buyer may have to pay before they reach them.
* @summary Landed Cost
* @param {SupermodelIoLogisticsExpressLandedCostRequest} body Details about the requested shipment
* @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}
*/
expApiLandedCost: 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.RatingApiAxiosParamCreator)(configuration).expApiLandedCost(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 Rate request will return DHL's product capabilities and prices (where applicable) based on the input data. Using the shipper and receiver address as well as the dimension and weights of the pieces belonging to a shipment, this operation returns the available products including the shipping price (where applicable)
* @summary Retrieve Rates 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}
*/
expApiRates: function (accountNumber, originCountryCode, originCityName, destinationCountryCode, destinationCityName, weight, length, width, height, plannedShippingDate, isCustomsDeclarable, unitOfMeasurement, originPostalCode, destinationPostalCode, nextBusinessDay, 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.RatingApiAxiosParamCreator)(configuration).expApiRates(accountNumber, originCountryCode, originCityName, destinationCountryCode, destinationCityName, weight, length, width, height, plannedShippingDate, isCustomsDeclarable, unitOfMeasurement, originPostalCode, destinationPostalCode, nextBusinessDay, 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 Rate request will return DHL's product capabilities and prices (where applicable) based on the input data. Using the shipper and receiver address as well as the dimension and weights of the pieces belonging to a shipment, this operation returns the available products including the shipping price (where applicable)
* @summary Retrieve Rates for Multi-piece Shipments
* @param {SupermodelIoLogisticsExpressRateRequest} body Details about the requested shipment
* @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}
*/
expApiRatesMany: 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.RatingApiAxiosParamCreator)(configuration).expApiRatesMany(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);
}];
}
});
});
},
};
};
exports.RatingApiFp = RatingApiFp;
/**
* RatingApi - factory interface
* @export
*/
var RatingApiFactory = function (configuration, basePath, axios) {
return {
/**
* The Landed Cost section allows further information around products being sold to be provided. In return the duty, tax and shipping charges are calculated in real time and provides transparency about any extra costs the buyer may have to pay before they reach them.
* @summary Landed Cost
* @param {SupermodelIoLogisticsExpressLandedCostRequest} body Details about the requested shipment
* @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}
*/
expApiLandedCost: 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.RatingApiFp)(configuration).expApiLandedCost(body, messageReference, messageReferenceDate, pluginName, pluginVersion, shippingSystemPlatformName, shippingSystemPlatformVersion, webstorePlatformName, webstorePlatformVersion, options).then(function (request) { return request(axios, basePath); })];
});
});
},
/**
* The Rate request will return DHL's product capabilities and prices (where applicable) based on the input data. Using the shipper and receiver address as well as the dimension and weights of the pieces belonging to a shipment, this operation returns the available products including the shipping price (where applicable)
* @summary Retrieve Rates 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}
*/
expApiRates: function (accountNumber, originCountryCode, originCityName, destinationCountryCode, destinationCityName, weight, length, width, height, plannedShippingDate, isCustomsDeclarable, unitOfMeasurement, originPostalCode, destinationPostalCode, nextBusinessDay, 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.RatingApiFp)(configuration).expApiRates(accountNumber, originCountryCode, originCityName, destinationCountryCode, destinationCityName, weight, length, width, height, plannedShippingDate, isCustomsDeclarable, unitOfMeasurement, originPostalCode, destinationPostalCode, nextBusinessDay, messageReference, messageReferenceDate, pluginName, pluginVersion, shippingSystemPlatformName, shippingSystemPlatformVersion, webstorePlatformName, webstorePlatformVersion, options).then(function (request) { return request(axios, basePath); })];
});
});
},
/**
* The Rate request will return DHL's product capabilities and prices (where applicable) based on the input data. Using the shipper and receiver address as well as the dimension and weights of the pieces belonging to a shipment, this operation returns the available products including the shipping price (where applicable)
* @summary Retrieve Rates for Multi-piece Shipments
* @param {SupermodelIoLogisticsExpressRateRequest} body Details about the requested shipment
* @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 pro