mitquinn/heap-helper

This composer package assists with the Heap server side API.

v1.0.1 2021-11-30 06:34 UTC

Requires

• php: ^8.0
• ext-json: *
• ext-openssl: *
• guzzlehttp/guzzle: ^7.4

Requires (Dev)

• phpunit/phpunit: ^9.5
• symfony/dotenv: ^5.3

GPL-3.0-or-later

• Mitchell Quinn

README

Description

Heap Helper is a simple wrapper for the Heap server side API.

Heap Helper provides:

• simple integration with the Heap server side API.
• wrapper for the Heap API endpoints.
• individual resources that the API is expecting to be provided.

You can learn more about Heap here: https://heapanalytics.com/

$configuration = new \Mitquinn\HeapHelper\HeapConfiguration('apiKey', 'appId');
$heapHelper = new \Mitquinn\HeapHelper\HeapHelper($configuration);

$event = new \Mitquinn\HeapHelper\Resources\HeapEvent(
    'eventName', 
    '[e-mail]', 
    ['propertyKey' => 'propertyValue']
);

$heapResponse = $heapHelper->track($event);

Installation

The recommended way to install Heap Helper is through Composer.

composer require mitquinn/heap-helper

License

Heap Helper is made available under the GNU General Public License (GNU). Please see the License File for more information.

Contributors

• Sponsor - Mitchell Quinn - [e-mail]