antwerpfactory/laravel-lightspeed-restaurant

This package is abandoned and no longer maintained. No replacement package was suggested.

A Laravel 5 package for the Lightspeed restaurant API

v1.0.0 2017-12-01 12:46 UTC

Requires

• php: >=5.6.4
• guzzlehttp/guzzle: ~6.0
• laravel/framework: ~5.4

Requires (Dev)

• phpunit/phpunit: ~5.7
• squizlabs/php_codesniffer: ^3.0.2

MIT

• Pieter Pelgrims

• laravel
• restaurant
• lightspeed
• lightspeedhq
• posios

README

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.