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.

github.com/danielozeh/node-terminal-africa

danielozeh/node-terminal-africa

83 lines (82 loc) • 3.13 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
export default class Address { /** * Create Address - This allows you to create an address on Terminal Africa * @param {Object[]} addressData * @param {string} addressData[].country * @param {string} addressData[].state * @param {string} addressData[].city * @param {string=} addressData[].first_name * @param {string=} addressData[].last_name * @param {string=} addressData[].email * @param {boolean=} addressData[].is_residential * @param {string=} addressData[].line1 * @param {string=} addressData[].line2 * @param {object=} addressData[].metadata * @param {string=} addressData[].phone * @param {string=} addressData[].zip * @returns object * @method POST */ static createAddress(addressData: object): Promise<any>; /** * Update Address - This allows you to update an existing address on Terminal Africa * @param {string} addressId * @param {Object[]} addressData * @param {string} addressData[].country * @param {string} addressData[].state * @param {string} addressData[].city * @param {string=} addressData[].first_name * @param {string=} addressData[].last_name * @param {string=} addressData[].email * @param {boolean=} addressData[].is_residential * @param {string=} addressData[].line1 * @param {string=} addressData[].line2 * @param {object=} addressData[].metadata * @param {string=} addressData[].phone * @param {string=} addressData[].zip * @returns object * @method PUT */ static updateAddress(addressId: string, addressData: object): Promise<any>; /** * GET Addresses- This allows you to fetch addresses on Terminal Africa * @param {string} queryParams * @param {string=} queryParams.page * @param {string=} queryParams.perPage * @returns object * @method GET */ static getAddresses(queryParams: any): Promise<any>; /** * GET Addresses- This allows you to fetch an address on Terminal Africa * @param {string} addressId * @returns object * @method GET */ static getAddress(addressId: string): Promise<any>; /** * Validate Address - This allows you to validate an address on Terminal Africa * @param {Object[]} addressData * @param {string} addressData[].country * @param {string} addressData[].state * @param {string} addressData[].city * @param {string=} addressData[].zip * @returns object * @method POST */ static validateAddress(addressData: object): Promise<any>; /** * Set Sender Default Address - This allows you to set an address on Terminal Africa as default * @param {Object[]} addressData * @param {string} addressData[].address_id * @returns object * @method POST */ static setDefaultSenderAddress(addressData: object): Promise<any>; /** * Set Default Sender Address - This allows you to get default sender address on Terminal Africa * @returns object * @method GET */ static getDefaultSenderAddress(): Promise<any>; }