UNPKG

terminal-africa

Version:

## Introduction The Terminal Shipping API (TShip) provides a single interface for integrating shipping carriers within your applications. The API allows anyone to programatically get shipping rates and arrange pickup and delivery.

202 lines (201 loc) 9.04 kB
"use strict"; 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 (g && (g = 0, op[0] && (_ = 0)), _) 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 }; } }; var __importDefault = (this && this.__importDefault) || function (mod) { return (mod && mod.__esModule) ? mod : { "default": mod }; }; Object.defineProperty(exports, "__esModule", { value: true }); var terminal_africa_1 = __importDefault(require("../services/terminal_africa")); var Insurance = /** @class */ (function () { function Insurance() { } /** * Get Insurance List - This allows you to fetch insurance lists on Terminal Africa * @param {string} queryParams * @param {string=} queryParams.page * @param {string=} queryParams.perPage * @param {string=} queryParams.status * @returns object * @method GET */ Insurance.getInsuranceList = function (queryParams) { return __awaiter(this, void 0, void 0, function () { var resp, err_1; return __generator(this, function (_a) { switch (_a.label) { case 0: _a.trys.push([0, 2, , 3]); return [4 /*yield*/, terminal_africa_1.default.get("/insurance".concat(queryParams))]; case 1: resp = _a.sent(); return [2 /*return*/, resp.data]; case 2: err_1 = _a.sent(); return [2 /*return*/, err_1.response.data]; case 3: return [2 /*return*/]; } }); }); }; /** * Get Insurance - This allows you to fetch insurance details on Terminal Africa * @param {string} insuranceId * @returns object * @method GET */ Insurance.getInsurance = function (insuranceId) { return __awaiter(this, void 0, void 0, function () { var resp, err_2; return __generator(this, function (_a) { switch (_a.label) { case 0: _a.trys.push([0, 2, , 3]); return [4 /*yield*/, terminal_africa_1.default.get("/insurance/".concat(insuranceId))]; case 1: resp = _a.sent(); return [2 /*return*/, resp.data]; case 2: err_2 = _a.sent(); return [2 /*return*/, err_2.response.data]; case 3: return [2 /*return*/]; } }); }); }; /** * Get Insurance Using Shipment ID - This allows you to fetch insurance details on Terminal Africa * @param {string} shipmentId * @returns object * @method GET */ Insurance.getInsuranceUsingShipment = function (shipmentId) { return __awaiter(this, void 0, void 0, function () { var resp, err_3; return __generator(this, function (_a) { switch (_a.label) { case 0: _a.trys.push([0, 2, , 3]); return [4 /*yield*/, terminal_africa_1.default.get("/insurance/".concat(shipmentId))]; case 1: resp = _a.sent(); return [2 /*return*/, resp.data]; case 2: err_3 = _a.sent(); return [2 /*return*/, err_3.response.data]; case 3: return [2 /*return*/]; } }); }); }; /** * Get Insurance Premium - This allows you to calculate insurance premium on Terminal Africa * @param {string} parcelId * @returns object * @method GET */ Insurance.getInsurancePremium = function (parcelId) { return __awaiter(this, void 0, void 0, function () { var resp, err_4; return __generator(this, function (_a) { switch (_a.label) { case 0: _a.trys.push([0, 2, , 3]); return [4 /*yield*/, terminal_africa_1.default.get("/insurance/premium?parcel=".concat(parcelId))]; case 1: resp = _a.sent(); return [2 /*return*/, resp.data]; case 2: err_4 = _a.sent(); return [2 /*return*/, err_4.response.data]; case 3: return [2 /*return*/]; } }); }); }; /** * Get Insurance Premium Using Parcel Value - This allows you to calculate insurance premium on Terminal Africa * @param {string} parcelData * @returns object * @method POST */ Insurance.getInsurancePremiumUsingParcelValue = function (parcelData) { return __awaiter(this, void 0, void 0, function () { var resp, err_5; return __generator(this, function (_a) { switch (_a.label) { case 0: _a.trys.push([0, 2, , 3]); return [4 /*yield*/, terminal_africa_1.default.post("/insurance/premium", parcelData)]; case 1: resp = _a.sent(); return [2 /*return*/, resp.data]; case 2: err_5 = _a.sent(); return [2 /*return*/, err_5.response.data]; case 3: return [2 /*return*/]; } }); }); }; /** * Purchase Insurance- This allows you to purchase insurance for a shipment on Terminal Africa * @param {string} shipment * @returns object * @method POST */ Insurance.purchaseInsurance = function (shipment) { return __awaiter(this, void 0, void 0, function () { var resp, err_6; return __generator(this, function (_a) { switch (_a.label) { case 0: _a.trys.push([0, 2, , 3]); return [4 /*yield*/, terminal_africa_1.default.post("/insurance/purchase", { shipment: shipment })]; case 1: resp = _a.sent(); return [2 /*return*/, resp.data]; case 2: err_6 = _a.sent(); return [2 /*return*/, err_6.response.data]; case 3: return [2 /*return*/]; } }); }); }; return Insurance; }()); exports.default = Insurance;