checkfront v0.0.3

Checkfront

This project is an open source node module for the Checkfront API

Installation

npm install -g checkfront
npm install --save checkfront

Getting Started

In order to call the Checkfront API, you will need to be setup with:

• endpoint
• key
• secret

const checkfront = require('checkfront')({
    endpoint,
    key,
    secret,
});

Methods

Bookings

checkfront.bookings.list()

Documentation

Retrieve a listing of bookings in the system.

const bookings = await checkfront.bookings.list({
    status_id: '',
});

checkfront.bookings.retrieve()

Documentation

Retrieve extended information on a specific booking.

const booking = await checkfront.bookings.retrieve(bookingId);

Items

checkfront.items.list()

Documentation

Retrieve a list of the enabled items in the system.

const items = await checkfront.items.list();

checkfront.items.retrieve()

Documentation

Retrieve details for a single item.

const item = await checkfront.items.retrieve(itemId);

Contribution Guidelines

Fork the respository and install all the dependencies:

yarn install

Run the setup script in the project root directory:

yarn setup

Make sure to run the unit tests and linting before committing. Obviously, add to the tests as you make changes:

yarn test

For watch:

yarn testing

You can also run the scenario tests against the live API:

yarn test-scenario