Skip to content

testmonitor/custify-client

Repository files navigation

TestMonitor Custify Client

Latest Stable Version CircleCI StyleCI codecov License

This package provides a very basic, convenient, and unified wrapper for Custify.

Table of Contents

Installation

To install the client you need to require the package using composer:

$ composer require testmonitor/custify-client

Use composer's autoload:

require __DIR__.'/../vendor/autoload.php';

You're all set up now!

Usage

You'll have to instantiate the client using your credentials:

$custify = new \TestMonitor\Custify\Client('token');

Next, you can start interacting with Custify.

Examples

Get a list of Custify people:

$people = $custify->people();

Create a new person:

$person = $custify->createPerson(new \TestMonitor\Custify\Resources\Person([
    'user_id' => 25,
    'email' => '[email protected]',
    'phone' => '+44 7911 123456',
    'name' => 'John Doe',
]);

Tests

The package contains integration tests. You can run them using PHPUnit.

$ vendor/bin/phpunit

Changelog

Refer to CHANGELOG for more information.

Contributing

Refer to CONTRIBUTING for contributing details.

Credits

License

The MIT License (MIT). Refer to the License for more information.