Porter Delivery

Porter Delivery is a TypeScript-based library designed to simplify interactions with delivery APIs. This library allows you to easily send and receive data from the Porter Delivery API, manage orders, track deliveries, and handle errors efficiently.

Features

• Set up a base API URL by default
• Common API key for all requests
• Easily send GET, POST, and other types of requests
• Handles errors effectively

Installation

To install the library, use npm:

npm install porter-delivery

Authors

• @BalramYadav00

Usage/Examples

First, import the library into your project:

import PORTER from 'porter-delivery';

Initialize the Library

Initialize the library with a base URL and API key for all API requests:

const porter = new PORTER({
    apiUrl: 'https://api.example.com',
    apiKey: 'your-api-key-here',
});

Set Base URL

You can set or update the base URL at any time using:

porter.setBaseUrl('https://new-api-url.com');

Send a Request

You can send requests using the various methods provided by the library:

const quoteData = {
    data: {
        // Your request data here
    }
};

const quote = await porter.getQuote(quoteData);
console.log(quote);

Example: Create Order

const orderData = {
    data: {
        pickup_details: {
            address: {
                street_address1: '123 Main St',
                lat: 37.7749,
                lng: -122.4194,
                contact_details: {
                    name: 'John Doe',
                    phone_number: '+1234567890',
                },
            },
        },
        drop_details: {
            address: {
                street_address1: '456 Elm St',
                lat: 37.7749,
                lng: -122.4194,
                contact_details: {
                    name: 'Jane Doe',
                    phone_number: '+0987654321',
                },
            },
        },
    },
};

await porter.createOrder(orderData);

Track Order

You can track the status of an order by providing the order ID:

const orderId = 'your-order-id-here';
await porter.trackOrder({ data: orderId });

Cancel Order

You can cancel an order by providing the order ID:

const orderId = 'your-order-id-here';
await porter.cancelOrder({ data: orderId });

Error Handling

Errors can be caught and handled as follows:

try {
    const response = await porter.createOrder(orderData);
    console.log(response);
} catch (error) {
    console.error('Error:', error);
}

Contributing

Feel free to contribute by submitting issues, creating pull requests, or improving the documentation.