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.

65 lines (64 loc) 3.88 kB
export default class TerminalAfrica { static createAddress(addressData: object): Promise<any>; static updateAddress(addressId: string, addressData: object): Promise<any>; static getAddresses(queryParams: any): Promise<any>; static getAddress(addressId: string): Promise<any>; static validateAddress(addressData: object): Promise<any>; static setDefaultSenderAddress(addressData: object): Promise<any>; static getDefaultSenderAddress(): Promise<any>; static getCarriers(queryParams: any): Promise<any>; static getCarrier(carrierId: string): Promise<any>; static enableCarrier(carrierId: string, queryParams: string): Promise<any>; static disableCarrier(carrierId: string, queryParams: string): Promise<any>; static enableMultipleCarrier(carriers: any): Promise<any>; static disableMultipleCarrier(carriers: any): Promise<any>; static createPackaging(packagingData: object): Promise<any>; static updatePackaging(packagingId: string, packagingData: object): Promise<any>; static getPackagings(queryParams: any): Promise<any>; static getPackaging(packagingId: string): Promise<any>; static terminalDefaultPackaging(): Promise<any>; static createParcel(parcelData: object): Promise<any>; static updateParcel(parcelId: string, parcelData: object): Promise<any>; static getParcels(queryParams: any): Promise<any>; static getParcel(parcelId: string): Promise<any>; static getShipmentRates(queryParams: string): Promise<any>; static getQuotesForShipment(quotesData: object): Promise<any>; static getMultiPieceShipmentRates(rateData: object): Promise<any>; static getRates(queryParams: any): Promise<any>; static getRate(rateId: string): Promise<any>; static createShipment(shipmentData: object): Promise<any>; static createQuickShipment(shipmentData: object): Promise<any>; static updateShipment(shipmentId: string, shipmentData: object): Promise<any>; static getShipments(queryParams: any): Promise<any>; static getShipment(shipmentId: string): Promise<any>; static trackShipment(shipmentId: string): Promise<any>; static cancelShipment(shipmentId: string): Promise<any>; static deleteShipment(shipmentId: string): Promise<any>; static duplicateShipment(shipmentId: string): Promise<any>; static arrangePickup(shipmentData: object): Promise<any>; static getInsuranceList(queryParams: string): Promise<any>; static getInsurance(insuranceId: string): Promise<any>; static getInsuranceUsingShipment(shipmentId: string): Promise<any>; static getInsurancePremium(parcelId: string): Promise<any>; static getInsurancePremiumUsingParcelValue(parcelData: object): Promise<any>; static purchaseInsurance(shipment: string): Promise<any>; static getClaims(queryParams: string): Promise<any>; static getClaim(claimId: string): Promise<any>; static fileClaim(claimData: object): Promise<any>; static getTransactions(queryParams: string): Promise<any>; static getTransaction(transactionId: string): Promise<any>; static getUser(userId: string): Promise<any>; static walletInfo(userId: string): Promise<any>; static walletBalance(userId: string): Promise<any>; static carriers(): Promise<any>; static createWebhook(webhookData: object): Promise<any>; static updateWebhook(webhookId: string, webhookData: object): Promise<any>; static getWebhooks(queryParams: any): Promise<any>; static getWebhook(webhookId: string): Promise<any>; static deleteWebhook(webhookId: string): Promise<any>; static enableWebhook(webhookId: string): Promise<any>; static disableWebhook(webhookId: string): Promise<any>; static countries(): Promise<any>; static states(countryCode: string): Promise<any>; static cities(countryCode: string, stateCode?: string): Promise<any>; }