testmonitor/custify-client

The TestMonitor Custify Client.

v2.0.0 2021-11-15 09:04 UTC

Requires

• php: ^8.0
• ext-json: *
• guzzlehttp/guzzle: ^6.4|^7.0

Requires (Dev)

• friendsofphp/php-cs-fixer: ^v3.1
• mockery/mockery: ~1.0
• phpunit/phpunit: ^9.5
• scrutinizer/ocular: ^1.8.1
• squizlabs/php_codesniffer: ^3.5.2

MIT

• Thijs Kok
• Stephan Grootveld
• Frank Keulen
• Muriël Nooder

• client
• testmonitor
• custify

README

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

Table of Contents

• Installation
• Usage
• Examples
• Tests
• Changelog
• Contributing
• Credits
• License

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' => '[e-mail]',
    'phone' => '[phone]',
    '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

• Thijs Kok - Lead developer - ThijsKok
• Stephan Grootveld - Developer - Stefanius
• Frank Keulen - Developer - FrankIsGek
• Muriel Nooder - Developer - ThaNoodle

License

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