maxng-nodejs

maxdotng

A NodeJS Wrapper for MaxNG

Overview

This project provides an easy-to-use object-oriented API to access endpoints delineated at https://maxv1.docs.apiary.io/

Installation

Install from the NPM Registry

  npm i --save maxng-nodejs

Usage

let MaxNg = require('maxng-nodejs')

const APIKEY = 'pk_1IkXmSWOlE4y9Inhgyd6g5f2R7'
const environment = process.env.NODE_ENV
const isProduction = (environment === 'production')

const maxdotng = new MaxNg(APIKEY, isProduction);

let response = {body:{}};
const date_time = new Date('2019-12-30')

try {
  response = await maxdotng.getPickUpWindow({
    pickup_datetime: date_time
  });
}catch(err){
    console.error(err);
}

API Resources

• maxdotng.getDeliveryRequestStatus()
• maxdotng.getOrderPickupWindows()
• maxdotng.scheduleDeliveryRequest()
• maxdotng.getDeliveryRequest()
• maxdotng.getPickUpWindow()

License

MIT

Contributing

You are welcome to contribute to this project. Just before sending us a PR, do the following below:

Firstly, clone the project

git clone https://www.github.com/stitchng/maxdotng

Then, lint the code to conform to our code style

npm run lint

Finally, add tests to the test folder to test your code and run tests locally

npm run test

Credits

• Ifeora Okechukwu

Contributing

See the CONTRIBUTING.md file for info