nikitin/yclients-laravel-sdk

yclients laravel sdk

, _(*1)

Laravel YClients SDK

Install

``` bash $ composer require e-nikitin/yclients-laravel-sdk, <sub>(*2)</sub>

**Publish config file**

``` bash
$ php artisan vendor:publish --tag=yclients-laravel-sdk

Laravel 5.5+, <sub>(*3)</sub>

If you don't use auto-discovery, add the ServiceProvider to the providers array in config/app.php, <sub>(*4)</sub>

``` php ... nikitin\YClientsSDK\YClientsSDKServiceProvider::class ..., <sub>(*5)</sub>

**Set configs\yclients-laravel-sdk**

``` php
'accounts' => [
     'default' => [
     // Login and password are required to receive USER TOKEN. 
     // If you have them you do not have to fill in these fields
     'login' => '',
     'password' => '',
      // Used in all requests and is mandatory
     'bearer_token' => '',
     'user_token' => ''
   ],
]

Obtain TOKENS

Bearer token can be recived from yclients support., <sub>(*6)</sub>

To obtain user token set login, password and bearer token in configs and run, <sub>(*7)</sub>

``` php use nikitin\YClientsSDK\Facades\YClientsSDK; ... YClientsSDK::authorization()->get() // return USER TOKEN, <sub>(*8)</sub>

## Supported API methods
  - Authorization
  - Clients
  - Companies
  - Goods
  - Records
  - Salons
  - Services
  - ServiceCategory
  - Staff
  - Visits
    - VisitDetails

## Examples

**Clients**
``` php
use nikitin\YClientsSDK\Facades\YClientsSDK;
...
$clients = YClientsSDK::clients()->setCompany($companyId)->get();

Companies ``` php use nikitin\YClientsSDK\Facades\YClientsSDK; ... $companies = YClientsSDK::companies()->setSalonId($salonId)->get();, <sub>(*9)</sub>

**Goods**
``` php
use nikitin\YClientsSDK\Facades\YClientsSDK;
...
$goods = YClientsSDK::goods()->setCompany($companyId)->get();

Records, <sub>(*10)</sub>

``` php use nikitin\YClientsSDK\Facades\YClientsSDK; ... $records = YClientsSDK::records()->setCompany($companyId)->setChangedAfter(Carbon::today())->get();, <sub>(*11)</sub>

**Groups**

``` php
use nikitin\YClientsSDK\Facades\YClientsSDK;
...
$salons = YClientsSDK::groups()->get();

ServiceCategory, <sub>(*12)</sub>

``` php use nikitin\YClientsSDK\Facades\YClientsSDK; ... $serviceCategory = YClientsSDK::serviceCategory()->setCompany($companyId)->get();, <sub>(*13)</sub>

**Staff**

``` php
use nikitin\YClientsSDK\Facades\YClientsSDK;
...
$staff = YClientsSDK::staff()->setCompany($companyId)->get();

Visits ``` php use nikitin\YClientsSDK\Facades\YClientsSDK; ... $visits = YClientsSDK::visits()->setVisitId($visitId)->get();, <sub>(*14)</sub>

**VisitDetails**
``` php
use nikitin\YClientsSDK\Facades\YClientsSDK;
...
$visitDetails = YClientsSDK::visitDetails()->setVisitId($visitId)->setSalonId($salonId)->setRecordId($recordId)->get();

License

The MIT License (MIT). Please see License File for more information., <sub>(*15)</sub>