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.
66 lines (65 loc) • 2.47 kB
TypeScript
export default class Carrier {
/**
* Get Carriers - This allows you to fetch list of carriers on Terminal Africa
* @param {string} queryParams
* @param {string=} queryParams.page
* @param {string=} queryParams.perPage
* @param {boolean} queryParams.active
* @returns object
* @method GET
*/
static getCarriers(queryParams: string): Promise<any>;
/**
* Get Carrier - This allows you to fetch a carrier on Terminal Africa
* @param {string} carrierId
* @returns object
* @method GET
*/
static getCarrier(carrierId: string): Promise<any>;
/**
* Enable Carrier - This allows you to enable a carrier on Terminal Africa
* @param {string} carrierId
* @param {string} queryParams
* @param {boolean} queryParams.domestic
* @param {boolean} queryParams.regional
* @param {boolean} queryParams.international
* @returns object
* @method POST
*/
static enableCarrier(carrierId: string, queryParams: string): Promise<any>;
/**
* Disable Carrier - This allows you to disable a carrier on Terminal Africa
* @param {string} carrierId
* * @param {string} queryParams
* @param {boolean} queryParams.domestic
* @param {boolean} queryParams.regional
* @param {boolean} queryParams.international
* @returns object
* @method POST
*/
static disableCarrier(carrierId: string, queryParams: string): Promise<any>;
/**
* Enable Multiple Carrier - This allows you to enable multiple carriers on Terminal Africa
* @param {array} carriers
* @param {object} carriers.carrier
* @param {string} carriers.carrier.carrier_id
* @param {boolean} carriers.carrier.domestic
* @param {boolean} carriers.carrier.regional
* @param {boolean} carriers.carrier.international
* @returns object
* @method POST
*/
static enableMultipleCarrier(carriers: any): Promise<any>;
/**
* Disable Multiple Carrier - This allows you to disable multiple carriers on Terminal Africa
* @param {array} carriers
* @param {object} carriers.carrier
* @param {string} carriers.carrier.carrier_id
* @param {boolean} carriers.carrier.domestic
* @param {boolean} carriers.carrier.regional
* @param {boolean} carriers.carrier.international
* @returns object
* @method POST
*/
static disableMultipleCarrier(carriers: any): Promise<any>;
}