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.

42 lines (41 loc) 1.44 kB
export default class Parcel { /** * Create Parcel - This allows you to create a parcel on Terminal Africa * @param {Object[]} parcel_data * @param {object} parcelData[].items * @param {string} parcelData[].packaging * @param {string} parcelData[].weight_unit * @param {string=} parcelData.metadata * @returns object * @method POST */ static createParcel(parcelData: object): Promise<any>; /** * Update Parcel - This allows you to update an existing parcel on Terminal Africa * @param {string} parcelId * @param {Object[]} parcelData * @param {object} parcelData[].items * @param {string} parcelData[].packaging * @param {string} parcelData[].weight_unit * @param {string=} parcelData.metadata * @returns object * @method PUT */ static updateParcel(parcelId: string, parcelData: object): Promise<any>; /** * GET Parcels- This allows you to fetch parcels on Terminal Africa * @param {string} queryParams * @param {string=} queryParams.page * @param {string=} queryParams.perPage * @returns object * @method GET */ static getParcels(queryParams: any): Promise<any>; /** * GET Parcel- This allows you to fetch a parcel on Terminal Africa * @param {string} parcelId * @returns object * @method GET */ static getParcel(parcelId: string): Promise<any>; }