Download the PHP package getsno/relesys-users without Composer
On this page you can find all versions of the php package getsno/relesys-users. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download getsno/relesys-users
More information about getsno/relesys-users
Files in getsno/relesys-users
Package relesys-users
Short Description Relesys User Management API client for Laravel
License MIT
Homepage https://github.com/getsno/relesys-users
Informations about the package relesys-users
Relesys User Management API client for Laravel
This Laravel package provides a simple and crisp way to access the Relesys User Management API endpoints, query data and update existing entries.
Installation
This version requires PHP ^8.1 and supports Laravel 10.
-
Install the package via composer:
-
Get your Relesys API access credentials like explained in their documentation (to work with User Management API you must have access to
relesys.api.users
scope). - Add to your .env file:
Usage
The package supports all the endpoints from "User Management" documentation section (including sorting, filtering and pagination).
The package interface is very similar to documentation sections (customFields
, departments
, userGroups
, users
, communication
),
method names are the same as endpoint names.
Examples
You can find even more usage examples by checking out the package tests in the /tests
directory.
Testing
Tests are based on testbench package, which means that the tests can be run right away, with Laravel automatically bootstrapped.
Tests support two modes: in isolation (faking requests) or with real credentials
(real requests to the API).
By default, tests are running in isolation,
to use real requests: copy phpunit.xml.dist
to phpunit.xml
, uncomment lines with RELESYS_CLIENT_ID
RELESYS_CLIENT_SECRET
and set the correspondent values there.
There's a docker configuration available here. I highly recommend using it for running the tests.
Changelog
Please see RELEASES for more information what has changed recently.
Credits
License
The MIT License (MIT). Please see License File for more information.