antwerpfactory/laravel-lightspeed-restaurant

A Laravel 5 package for the Lightspeed restaurant API

, _(*1)

Laravel Lightspeed Restaurant

This package makes working with the Lightspeed Restaurant API a breeze. Once installed you can perform all API calls like so:, _(*2)

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., _(*3)

Installation

Install the package via composer:, _(*4)

composer require antwerpfactory/laravel-lightspeed-restaurant

Unless you're using Laravel 5.5 you need to register the ServiceProvider and Facade:, _(*5)

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

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

Configuration

Publish the configuration with this command:, _(*6)

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

This will publish file called lightspeedrestaurant.php in your config-directory with this content:, _(*7)

<?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., _(*8)

License

The MIT License (MIT). Please see License File for more information., _(*9)