README

This package makes it easy to interact with the OrgManager API.

Installation

You can install the package via composer:

composer require orgmanager/orgmanager-api

Usage

You must pass a Guzzle client and the API token to the constructor of OrgManager\ApiClient\OrgManager.

$orgmanager = new \OrgManager\ApiClient\OrgManager('YOUR_ORGMANAGER_API_TOKEN');

or you can skip the token and use the connect() method later

$orgmanager = new \OrgManager\ApiClient\OrgManager();

$orgmanager->connect('YOUR_ORGMANAGER_API_TOKEN');

Get User info

$orgmanager->getUser();

Get User Orgs

$orgmanager->getOrgs();

Get Org info

$orgmanager->getOrg('ORG_ID');

Change Org Password

$orgmanager->changeOrgPassword('ORG_ID', 'NEW_PASSWORD');

Update Org

$orgmanager->updateOrg('ORG_ID');

Delete Org

$orgmanager->deleteOrg('ORG_ID');

Get Stats

$orgmanager->getStats();

Renenerate Token

$orgmanager->regenerateToken($set);

where $set is false if you don't want to use the new token on future requests.

Get the Guzzle Client

$orgmanager->getClient();

Set the Guzzle Client

$client = new \GuzzleHttp\Client(); // Example Guzzle client
$orgmanager->setClient($client);

where $client is an instance of \GuzzleHttp\Client.

Changelog

Please see CHANGELOG for more information what has changed recently.

Testing

$ composer test

Contributing

Please see CONTRIBUTING for details.

Security

If you discover any security related issues, please email soy@miguelpiedrafita.com instead of using the issue tracker.

Credits

License

The Mozilla Public License 2.0 (MPL-2.0). Please see License File for more information.

orgmanager / orgmanager-api

Maintainers

Details