🚀 Quick start

Installation

Install the package using npm or yarn:

npm install shipbubble

or yarn

yarn add shipbubble

Usage

After installing the package, you simply need to import the package and initialize it with your API key using the init method.

import Shipbubble from 'shipbubble';

Shipbubble.init({
  apiKey: 'SHIPBUBBLE_API_KEY',
});

Making requests

After initializing the SDK, you can start making requests to the Shipbubble API.

const response = await Shipbubble.wallet.walletBalance();
console.log(response);

Response types

The Shipbubble SDK returns two types of responses: raw and formatted. The raw response returns the data as it is from the API, while the formatted response converts the response to camel case for camel case lovers and also formats date strings and returns the date object.

const response = await Shipbubble.address.validateAddress({
  address: '62 Old yaba road, yaba, Lagos',
  email: '[email protected]',
  phone: '08123456789',
  name: 'John Doe',
});
console.log(response.raw);
console.log(response.formatted);

Pagination

The Shipbubble SDK handles pagination for you. If a response has a next link, you can use the next methods to fetch the next page of the response. you can also use the hasNext method to check if there is a next page. The pagination object is also available on the response object, and it contains the metadata for the pagination if you wish to handle next page calls manually.

const response = await Shipbubble.address.getValidatedAddresses({
  Page: 1,
  PerPage: 5,
});

if (response.hasNext()) {
  const nextPage = await response.next();
  console.log(nextPage);
}

📦 Available methods

The Shipbubble SDK provides methods to interact with the Shipbubble API. Below are some of the available methods:

All these methods are available on the Shipbubble object and can be accessed like so:

Shipbubble.[module].[method](Options);

• wallet
  • walletBalance
• address
  • getValidatedAddresses
  • validateAddress
  • editAddress
  • getSingleAddress
• misc
  • getPackageCategories
  • getPackageDimensions
  • getCouriers
• insurance
  • getInsuranceRates
• rates
  • requestShippingRates
  • requestShippingRatesFromCouriers
  • editRequestTokenDetails
• shipments
  • createShipment
  • cancelShipment
• tracking
  • getShipments

📝 TypeScript support

The Shipbubble SDK is written in TypeScript and provides types for all the methods and their options. You can import the method options and return interface from the package and use them in your application.

import { GetValidatedAddressRequest, GetValidatedAddressResponseAdapter } from 'shipbubble';

const options: GetValidatedAddressRequest = {
  Page: 1,
  PerPage: 5,
};

const response = await Shipbubble.address.getValidatedAddresses(options);

📚 Documentation

For more information on how to use the Shipbubble SDK, check out the official documentation.