Using modules - omneo/omneo-php GitHub Wiki

For ease-of-use, the client is organised into a series of modules. Each module contains a series of public methods to interact with.

• Accessing a module
• BREAD structure

Accessing a module

All modules are accessed by calling their respective accessor method on the Omneo\Client instance.

$omneo->profiles();

Once you have resolved a module, you may call any of it's respective methods to interact with the underlying API endpoints.

$profiles = $omneo->profiles()->browse();

BREAD structure

Although there may be other methods available, typically modules are organised into a BREAD structure.

• Browse – Returns a paginated collection of the entity
• Read – Returns a single entity matching the given ID
• Edit – Updates the given entity
• Add – Creates the given entity
• Delete – Deletes the given entity