https://github.com/testmonitor/custify-client
The TestMonitor Custify Client.
https://github.com/testmonitor/custify-client
custify testmonitor
Last synced: 20 days ago
JSON representation
The TestMonitor Custify Client.
- Host: GitHub
- URL: https://github.com/testmonitor/custify-client
- Owner: testmonitor
- License: mit
- Created: 2021-02-26T16:04:13.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-10-04T13:32:19.000Z (9 months ago)
- Last Synced: 2025-03-24T10:56:28.369Z (4 months ago)
- Topics: custify, testmonitor
- Language: PHP
- Homepage: https://docs.custify.com/
- Size: 66.4 KB
- Stars: 1
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
# TestMonitor Custify Client
[](https://packagist.org/packages/testmonitor/custify-client)
[](https://circleci.com/gh/testmonitor/custify-client)
[](https://styleci.io/repos/342627557)
[](https://codecov.io/gh/testmonitor/custify-client)
[](https://packagist.org/packages/testmonitor/custify-client)
This package provides a very basic, convenient, and unified wrapper for [Custify](https://docs.custify.com/).
## Table of Contents
- [Installation](#installation)
- [Usage](#usage)
- [Examples](#examples)
- [Tests](#tests)
- [Changelog](#changelog)
- [Contributing](#contributing)
- [Credits](#credits)
- [License](#license)
## Installation
To install the client you need to require the package using composer:
$ composer require testmonitor/custify-client
Use composer's autoload:
```php
require __DIR__.'/../vendor/autoload.php';
```
You're all set up now!
## Usage
You'll have to instantiate the client using your credentials:
```php
$custify = new \TestMonitor\Custify\Client('token');
```
Next, you can start interacting with Custify.
## Examples
Get a list of Custify people:
```php
$people = $custify->people();
```
Create a new person:
```php
$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](CHANGELOG.md) for more information.
## Contributing
Refer to [CONTRIBUTING](CONTRIBUTING.md) for contributing details.
## Credits
* **Thijs Kok** - *Lead developer* - [ThijsKok](https://github.com/thijskok)
* **Stephan Grootveld** - *Developer* - [Stefanius](https://github.com/stefanius)
* **Frank Keulen** - *Developer* - [FrankIsGek](https://github.com/frankisgek)
* **Muriel Nooder** - *Developer* - [ThaNoodle](https://github.com/thanoodle)
## License
The MIT License (MIT). Refer to the [License](LICENSE.md) for more information.