rflex/nominus

There is no license information available for the latest version (dev-develop) of this package.

Control client's and user's structures.

dev-develop 2022-08-05 16:45 UTC

Requires

• illuminate/support: ^8.0

Requires (Dev)

• nunomaduro/larastan: ^1.0
• orchestra/testbench: ^6.0
• phpunit/phpunit: ^9.0
• styleci/cli: ^1.2

Unknown License

• David Miranda

• rflex
• nominus

README

Welcome to Nominus.

Installation & Usage

Install package via composer:

composer require rflex/nominus

Set environment variable:

NOMINUS_URL=https://nominus.example.com

Import class and instantiate it:

use Rflex/Nominus;

public function test(string $bearerToken, string $holdingUUID) {
    $nominus = new Nominus($bearerToken, $holdingUUID);
}

Available methods

Holding

Current holding

Retrieve the holding with which you are working.

$nominus->holding->current();

Holding branches

Get the list of the holding's branches.

$nominus->holding->branches();

Holding organizations

Get the list of the holding's organizations.

$nominus->holding->organizations();

Holding information

Retrieve the complete list of information from a holding.

$nominus->holding->info();

Branches

By Id

Get one branch by its id.

$nominus->holding->branch->getById($branchId);

Branch areas

Get all branches of an area.

$nominus->holding->branch->areas($branchId);

Organizations

By id

Get organization by its id.

$nominus->holding->organization->getById($organizationId);

By code

Get organization by its code.

$nominus->holding->organization->getByCode($organizationCode);

Organization companies

$nominus->holding->organization->companies($organizationId);

Organization areas

$nominus->holding->organization->areas($organizationId);

Organization products

Get the activated rFlex products for this organization.

$nominus->holding->organization->products($organizationId);

Organization product integrations

Check if a rFlex product for the organization has any integration with another platform.

$nominus->holding->organization->productIntegrations($organizationId, $productId);

Areas

By id

Get area by its id.

$nominus->holding->organization->areas->getById($organizationId, $areaId);

By multiple ids

Get areas by them ids.

$nominus->holding->organization->areas->getByIds($organizationId, [$areaId1, $areaId2, $areaId3]);

Area branches

Get the branches of an area.

$nominus->holding->organization->areas->branches($organizationId, $areaId);