Weave Code
Code Weaver
Helps Laravel developers discover, compare, and choose open-source packages. See popularity, security, maintainers, and scores at a glance to make better decisions.
Feedback
Share your thoughts, report bugs, or suggest improvements.
Subject
Message

Relesys Users Laravel Package

getsno/relesys-users

Laravel 10 (PHP 8.1+) client for the Relesys User Management API. Access endpoints for users, departments, user groups, custom fields and communication with support for filtering, sorting and pagination, plus create/update users and status changes.

View on GitHub
Deep Wiki
Context7

Relesys User Management API client for Laravel

Latest Version on Packagist Total Downloads Made in Ukraine

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.

  1. Install the package via composer:

    composer require getsno/relesys-api
    
  2. 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).

  3. Add to your .env file:

     RELESYS_CLIENT_ID=""
     RELESYS_CLIENT_SECRET=""
    

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

use \Relesys;
use \Getsno\Relesys\Api\UserManagement\Entities\User;
use \Getsno\Relesys\Api\UserManagement\Enums\UserStatus;
use \Getsno\Relesys\Api\ApiQueryParams;
use \Getsno\Relesys\Api\UserManagement\Entities\Patches\UserPatch;

// create user
$user = User::fromArray([
    'name'                => 'Anton',
    'primaryDepartmentId' => '0956339c-f3db-4a58-b6b3-d04a56dc85f6',
    'phoneNumber'         => [
        'countryCode' => 47,
        'number'      => '777777',
    ],
    'userGroups'          => [
        [
            'id': 'bfab8670-b3a4-4a6b-bc3a-1d1c7c13a636',
            'dataSource': 'RelesysAPI',
        ],
        [
            'id': 'a213e04f-0860-4449-80a3-5e19771ae57b',
            'dataSource': 'RelesysAPI',
        ]
    ],
]);
$newUser = Relesys::users()->createUser($newUser);

// get user
$user = Relesys::users()->getUser('1cb8e33e-32d6-4353-9b15-93115d96580a');

// change user status
Relesys::users()->changeUserStatus(UserStatus::Disabled);

// get users (with filtering, sorting and pagination)
$queryParams = (new ApiQueryParams)
    ->addFilter('status', UserStatus::Activated->value)
    ->sortBy('name')
    ->limit(10);
$usersBatchResponse = Relesys::users()->getUsers(queryParams: $queryParams, page: 2);

// update user
$userPatch = (new UserPatch())
    ->title('Test title')
    ->birthDate(Carbon::parse('05-02-1991'))
    ->secondaryPhoneNumber(PhoneNumber::fromArray(['countryCode' => 47, 'number' => '777777']));
$user = Relesys::users()->updateUser('1cb8e33e-32d6-4353-9b15-93115d96580a', $userPatch);

// get department
Relesys::departments()->getDepartment('ef6a9dfe-b216-4303-829f-cf2e64bf72a1');

// get user group
Relesys::userGroups()->getUserGroup('f2610cc5-8466-4c9f-aa07-0175290e4f37');

// get custom fields
$customFieldsBatchResponse = Relesys::customFields()->getCustomFields();

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.

cd docker

docker compose up -d

docker exec -it relesys bash

# (optional) to debug a test with xdebug - there's an alias to activate it
# call the alias again to disable it 
xdebug_cli_toggle

composer test

Changelog

Please see RELEASES for more information what has changed recently.

Credits

License

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

Weaver

How can I help you explore Laravel packages today?

Conversation history is not saved when not logged in.
Prompt
Add packages to context
No packages found.
besmartand-pro/php-quality-config
sentix/ai-chatbot
terminal42/code-quality-tools
codifyo/ts-generator-bundle
testo/fiber
mintobit/jobqueue
a4sex/maintenance-bundle
a4sex/entity-date-update
a4sex/client-identifier
a4sex/base-utilites
a4sex/key-value-storage
a4sex/micro-status
chilldev/dependency-injection-extra
datinglibre/datinglibre-app-api
biberltd/corebundle
bricre/symfony-bundle-test
biberltd/logbundle
dominium/http-adapter-bundle
dominium/google-analytics
a4sex/auto-clean-entity