Skip to content

ppelgrims/laravel-lightspeed-restaurant

 
 

Repository files navigation

Build Status

Laravel Lightspeed Restaurant

This package makes working with the Lightspeed Restaurant API a breeze. Once installed you can perform all API calls like so:

use Lightspeedresto;

app()->lightspeedresto->core()->getCompanies(); // container

Lightspeedresto::core()->getCompanies(); // or use the facade

Lightspeedresto::core()->getCompany($companyId);

Lightspeedresto::onlineOrdering()->getCustomers();

Lightspeedresto::onlineOrdering()->updateOrderPartial($companyId, $orderId, $data);

Lightspeedresto::inventory()->addProduct($productGroupId, $data);

We recommend using fractals to transform the data that gets passed through to the API.

Installation

Install the package via composer:

composer require antwerpfactory/laravel-lightspeed-restaurant

Unless you're using Laravel 5.5 you need to register the ServiceProvider and Facade:

'providers' => [
    ...
    AntwerpFactory\LightspeedRestaurant\ServiceProvider::class,
];
'aliases' => [
	...
    'Lightspeedresto' => AntwerpFactory\LightspeedRestaurant\Facade::class,
    ...
]

Configuration

Publish the configuration with this command:

php artisan vendor:publish --provider="AntwerpFactory\LightspeedRestaurant\ServiceProvider"

This will publish file called lightspeedrestaurant.php in your config-directory with this content:

<?php

return [

	/*
    |--------------------------------------------------------------------------
    | User Creditentials
    |--------------------------------------------------------------------------
    */

	'username' => env('LIGHTSPEED_RESTAURANT_USER_NAME'),

	'password' => env('LIGHTSPEED_RESTAURANT_PASSWORD'),

	'companyId' => env('LIGHTSPEED_RESTAURANT_COMPANYID'),

	'server' => env('LIGHTSPEED_RESTAURANT_SERVER'),

	'deviceId' => 'api',

];

Tests

$ make sniff test

Contributing

Please see contributing for details.

License

The MIT License (MIT). Please see License File for more information.

About

Laravel package for the Lightspeed Restaurant API

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • PHP 99.6%
  • Makefile 0.4%