Laraccess API Client
, (*1)
This package makes it easy to interact with Laraccess., (*2)
Installation
You can install the package via composer:, (*3)
``` bash
composer require m1guelpf/laraccess-api, (*4)
## Usage
You must pass a the API token to the constructor of `M1guelpf\LaraccessApi\Laraccess`.
``` php
$laraccess = new \M1guelpf\LaraccessApi\Laraccess('YOUR_LARACCESS_API_TOKEN');
or you can skip the token and use the connect()
method later, (*5)
``` php
$laraccess = new \M1guelpf\LaraccessApi\Laraccess();, (*6)
$laraccess->connect('YOUR_LARACCESS_API_TOKEN');, (*7)
### Get User info
``` php
$laraccess->getUser();
Create User
``` php
$laraccess->createUser($user);, (*8)
### Edit User
``` php
$laraccess->editUser($user);
Delete User
``` php
$laraccess->deleteUser();, (*9)
### Get User Campaigns
``` php
$laraccess->getUserCampaigns();
Get Campaign
``` php
$laraccess->getCampaign($id);, (*10)
### Create Campaign
``` php
$laraccess->createCampaign($campaign);
Edit Campaign
``` php
$laraccess->editCampaign($id, $campaign);, (*11)
### Delete Campaign
``` php
$laraccess->deleteCampaign($id);
Get Campaign Leads
``` php
$laraccess->getCampaignLeads($id);, (*12)
### Get Lead
``` php
$laraccess->getLead($id);
Create Lead
``` php
$laraccess->createLead($id, $lead);, (*13)
### Edit Lead
``` php
$laraccess->editLead($id, $lead);
Delete Lead
``` php
$laraccess->deleteLead($id, $lead);, (*14)
### Invite Lead
``` php
$laraccess->inviteLead($id);
Renenerate Token
``` php
$laraccess->regenerateToken($set);, (*15)
where `$set` is false if you don't want to use the new token on future requests.
### Get the Guzzle Client
``` php
$laraccess->getClient();
Set the Guzzle Client
``` php
$client = new \GuzzleHttp\Client(); // Example Guzzle client
$laraccess->setClient($client);, (*16)
where $client is an instance of `\GuzzleHttp\Client`.
## Changelog
Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently.
## Testing
``` bash
$ composer test
Contributing
Please see CONTRIBUTING for details., (*17)
Security
If you discover any security related issues, please email soy@miguelpiedrafita.com instead of using the issue tracker., (*18)
Credits
License
The Mozilla Public License 2.0 (MPL-2.0). Please see License File for more information., (*19)