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.
57 lines (56 loc) • 2.1 kB
TypeScript
export default class Packaging {
/**
* Create Packaging - This allows you to create a packaging on Terminal Africa
* @param {Object[]} packagingData
* @param {int} packagingData[].height
* @param {int} packagingData[].length
* @param {string} packagingData[].name
* @param {string} packagingData[].size_unit
* @param {string} packagingData[].type
* @param {int} packagingData[].width
* @param {int} packagingData[].weight
* @param {string} packagingData[].weight_unit
* @returns object
* @method POST
*/
static createPackaging(packagingData: object): Promise<any>;
/**
* Update Packaging - This allows you to update an existing packaging on Terminal Africa
* @param {string} packagingId
* @param {Object[]} packagingData
* @param {int} packagingData[].height
* @param {int} packagingData[].length
* @param {string} packagingData[].name
* @param {string} packagingData[].size_unit
* @param {string} packagingData[].type
* @param {int} packagingData[].width
* @param {int} packagingData[].weight
* @param {string} packagingData[].weight_unit
* @returns object
* @method PUT
*/
static updatePackaging(packagingId: string, packagingData: object): Promise<any>;
/**
* GET Packagings- This allows you to fetch packagings on Terminal Africa
* @param {string} queryParams
* @param {string=} queryParams.page
* @param {string=} queryParams.perPage
* @param {string=} queryParams.type
* @returns object
* @method GET
*/
static getPackagings(queryParams: any): Promise<any>;
/**
* GET Packaging- This allows you to fetch a packaging on Terminal Africa
* @param {string} packagingId
* @returns object
* @method GET
*/
static getPackaging(packagingId: string): Promise<any>;
/**
* Get Terminal Default Packaging - This allows you to get the default terminal packaging
* @returns object
* @method GET
*/
static terminalDefaultPackaging(): Promise<any>;
}