Lightspeed Restaurant API Client

Lightspeed Restaurant API Client is a gem for interacting with Lightspeed Restaurant API. Lightspeed Restaurant is point of sale that helps bars, restaurants, and cafés deliver a better customer experience and run a more profitable business.

Installation

Add this line to your application's Gemfile:

gem 'lightspeed_restaurant'

And then execute:

$ bundle

Or install it yourself as:

$ gem install lightspeed_restaurant

Usage

Basic Usage

First, set your api token:

LightspeedRestaurant.api_token = "YOUR_API_TOKEN_HERE"

Next, make requests using the resource class you need:

customers = LightspeedRestaurant::Customer.all
customer  = customers.first
customer.firstName = 'Tom'
customer.save

That's it!

Available operations

List

LightspeedRestaurant::Customer.all

Find

LightspeedRestaurant::Customer.find(123)

Create

LightspeedRestaurant::Customer.create(...firstName: 'Tom', email: 'tom@brady.com'...)

Update

LightspeedRestaurant::Customer.update(123, { email: 'tom@brady.com' })

Save

customer = LightspeedRestaurant::Customer.find(123)
customer.firstName = 'Micheal'
customer.save

Destroy

customer = LightspeedRestaurant::Customer.find(123)
customer.destroy

Contributing

Pull requests are welcome on GitHub at https://github.com/chronogolf/lightspeed_restaurant.

About Us

Chronogolf's mission is to facilitate the interactions between golf managers and golf players. We are building software that allows golf directors to better manage their course, together with a marketplace to find & book games in real-time. We are constantly innovating and trying to challenge the status quo.

Find more informations at http://www.chronogolf.com/solutions

Future Improvements

• Improve destroy operation to handle destroy by passing an ID (or an array of IDs)
• Add missing resources (Company, Reservation, Floor, Table...)
• Improve test coverage

License

The gem is available as open source under the terms of the MIT License.