testmonitor/topdesk-client

TestMonitor TOPdesk 客户端。

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

This package is auto-updated.

Last update: 2024-09-15 11:56:54 UTC


README

Latest Stable Version CircleCI StyleCI codecov License

此包提供对 TOPdesk REST API 的非常基本、方便和统一的包装。

目录

安装

要安装客户端,您需要使用 composer 引入该包

$ composer require testmonitor/topdesk-client

使用 composer 的自动加载

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

现在您已经设置好了!

用法

您需要使用您的凭据实例化客户端

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

接下来,您可以开始与 TOPdesk 交互。

示例

从 TOPdesk 获取事件列表

$topdesk->incidents();

或在 TOPdesk 中创建新事件

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

测试

该包包含集成测试。您可以使用 PHPUnit 运行它们。

$ vendor/bin/phpunit

变更日志

有关更多信息,请参阅 CHANGELOG

贡献

有关贡献详情,请参阅 CONTRIBUTING

致谢

许可

MIT 许可证 (MIT)。有关更多信息,请参阅 许可