Company Service ​

The Company Service exposes methods to create, update, delete, get, list companies, also some other operations related to companies.

Usage ​

use \Lordjoo\Apigee\Facades\Apigee;
$companyService = Apigee::edge()->company();

use \Lordjoo\Apigee\Facades\Apigee;
$companyService = Apigee::edge()->company();

List all companies ​

Using the get() method, you can get a collection of all companies.

$companies = $companyService->get();

$companies = $companyService->get();

$companies is a Laravel Collection of Company objects.

Get a company by name ​

Using the find() method, you can get a company by name.

$company = $companyService->find($companyName);

$company = $companyService->find($companyName);

$company is an instance of Company object.

Create a company ​

Using the create() method, you can create a company, the create() method accepts one parameter $data where $data is an array of the company properties CompanyRequest

$company = $companyService->create($data);

$company = $companyService->create($data);

Update a company ​

Using the update() method, you can update a company, the update() method accepts two parameters $companyName and $data where $companyName is the name of the company you want to update and $data is an array of the company properties CompanyRequest

$company = $companyService->update($companyName, $data);

$company = $companyService->update($companyName, $data);

Delete a company ​

Using the delete() method, you can delete a company by it's name.

$companyService->delete($companyName);

$companyService->delete($companyName);

Update a company's status ​

Using the updateStatus() method, you can change a company's status by it's name. the updateStatus() method accepts two parameters $companyName and $status where $companyName is the name of the company you want to change the status of and $status is the new status of the company, it can be active or inactive

$companyService->updateStatus($companyName, $status);

$companyService->updateStatus($companyName, $status);

Entity ​

Properties ​

Methods ​

getApps() ​

Get a collection of all apps of the company.

$apps = $company->getApps();

$apps = $company->getApps();

$apps is a Laravel Collection of CompanyApp objects.

activate() ​

Activate the company.

$company->activate();

$company->activate();

deactivate() ​

Deactivate the company.

$company->deactivate();

$company->deactivate();

update($data) ​

Update the company, the update() method accepts one parameter $data where $data is an array of the company properties CompanyRequest

$company->update($data);

$company->update($data);

delete() ​

Delete the company.

$company->delete();

$company->delete();