Skip to content

README.md

Latest commit

 

History

History
83 lines (52 loc) · 1.54 KB

README.md

File metadata and controls

83 lines (52 loc) · 1.54 KB

Laravel Simplicate API Client

For communicating with the Simplicate API.

Version Compatibility

Laravel Package
^9.x 0.9.1

Installation

Via Composer:

$ composer require moddit/laravel-simplicate

If you don't use auto-discover, register the Service Provider in your config/app.php:

<?php
    'providers' => [
        // ...
        Moddit\Simplicate\Providers\SimplicateServiceProvider::class,
    ],

Publish the configuration file:

php artisan vendor:publish --provider="Moddit\Simplicate\Providers\SimplicateServiceProvider"

Configuration

Set up your .env file for the following values:

SIMPLICATE_DOMAIN=yoursimplicatesubdomain
SIMPLICATE_API_KEY=yoursimplicateapikey
SIMPLICATE_API_SECRET=yoursimplicateapisecret

Usage

To Do.

Fluent list syntax

For filterable, orderable listings, you can use fluent syntax to set parameters:

<?php
/** @var \Moddit\Simplicate\Services\SimplicateService $service */
$leaveRecords = $service->hrm()
    ->offset(2)
    ->limit(10)
    ->sort('start_date')->descending()
    ->filter(['employee.id' => 'employee:aa24f3857730be716d44e34a3f0f8c3a'])
    ->allLeave();

Contributing

Please see CONTRIBUTING for details.

Credits

License

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