2017 © Pedro Peláez
 

library orgmanager-api

PHP Client for the OrgManager API

image

orgmanager/orgmanager-api

PHP Client for the OrgManager API

  • Thursday, April 20, 2017
  • by m1guelpf
  • Repository
  • 1 Watchers
  • 3 Stars
  • 19 Installations
  • PHP
  • 1 Dependents
  • 0 Suggesters
  • 1 Forks
  • 0 Open issues
  • 5 Versions
  • 0 % Grown

The README.md

PHP OrgManager API Client

Codacy Badge Latest Version on Packagist Software License Build Status Total Downloads, (*1)

This package makes it easy to interact with the OrgManager API., (*2)

Installation

You can install the package via composer:, (*3)

``` bash composer require orgmanager/orgmanager-api, (*4)


## Usage You must pass a Guzzle client and the API token to the constructor of `OrgManager\ApiClient\OrgManager`. ``` php $orgmanager = new \OrgManager\ApiClient\OrgManager('YOUR_ORGMANAGER_API_TOKEN');

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

``` php $orgmanager = new \OrgManager\ApiClient\OrgManager();, (*6)

$orgmanager->connect('YOUR_ORGMANAGER_API_TOKEN');, (*7)


### Get User info ``` php $orgmanager->getUser();

Get User Orgs

``` php $orgmanager->getOrgs();, (*8)


### Get Org info ``` php $orgmanager->getOrg('ORG_ID');

Change Org Password

``` php $orgmanager->changeOrgPassword('ORG_ID', 'NEW_PASSWORD');, (*9)


### Update Org ``` php $orgmanager->updateOrg('ORG_ID');

Delete Org

``` php $orgmanager->deleteOrg('ORG_ID');, (*10)


### Get Stats ``` php $orgmanager->getStats();

Renenerate Token

``` php $orgmanager->regenerateToken($set);, (*11)

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

### Get the Guzzle Client

``` php
$orgmanager->getClient();

Set the Guzzle Client

``` php $client = new \GuzzleHttp\Client(); // Example Guzzle client $orgmanager->setClient($client);, (*12)

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., (*13)

Security

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

Credits

License

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

The Versions

20/04 2017

dev-master

9999999-dev https://github.com/orgmanager/php-orgmanager-api

PHP Client for the OrgManager API

  Sources   Download

MPL-2.0

The Requires

 

The Development Requires

m1guelpf orgmanager orgmanager-api

20/04 2017

2.0

2.0.0.0 https://github.com/orgmanager/php-orgmanager-api

PHP Client for the OrgManager API

  Sources   Download

MPL-2.0

The Requires

 

The Development Requires

m1guelpf orgmanager orgmanager-api

23/03 2017

1.1

1.1.0.0 https://github.com/orgmanager/php-orgmanager-api

PHP Client for the OrgManager API

  Sources   Download

MPL-2.0

The Requires

 

The Development Requires

m1guelpf orgmanager orgmanager-api

18/03 2017

1.0.1

1.0.1.0 https://github.com/orgmanager/php-orgmanager-api

PHP Client for the OrgManager API

  Sources   Download

MPL-2.0

The Requires

 

The Development Requires

m1guelpf orgmanager orgmanager-api

06/03 2017

1.0.0

1.0.0.0 https://github.com/orgmanager/php-orgmanager-api

PHP Client for the OrgManager API

  Sources   Download

MPL-2.0

The Requires

 

The Development Requires

m1guelpf orgmanager orgmanager-api