testmonitor/topdesk-client

The TestMonitor TOPdesk client.

v2.2.0 2024-07-01 13:06 UTC

Requires

• php: ^8.1
• ext-json: *
• guzzlehttp/guzzle: ^7.0

Requires (Dev)

• friendsofphp/php-cs-fixer: ^3.1
• mockery/mockery: ~1.0
• phpunit/phpunit: ^10.0
• scrutinizer/ocular: ^1.9
• squizlabs/php_codesniffer: ^3.7
• symfony/console: ^6.0
• symfony/event-dispatcher: ^6.0
• symfony/finder: ^6.0

MIT

• Thijs Kok
• Stephan Grootveld
• Frank Keulen

• client
• topdesk
• testmonitor

README

This package provides a very basic, convenient, and unified wrapper for the TOPdesk REST API.

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/topdesk-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:

$topdesk = new \TestMonitor\TOPdesk\Client('https://mytopdesk.topdesk.net', 'username', 'password');

Next, you can start interacting with TOPdesk.

Examples

Get a list of incidents out of TOPdesk:

$topdesk->incidents();

or create a new incident in TOPdesk:

$incident = $topdesk->createIncident(new \TestMonitor\TOPdesk\Resources\Incident([
    'callerName' => 'John Doe',
    'callerEmail' => '[e-mail]',
    'status' => 'firstLine',
    'number' => 'I1234',
    'briefDescription' => 'Some Request',
    'request' => 'Some Request Description'
]));

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.