README

这是一个简单的 PHP 客户端，可以连接到 TeamworkDesk API。此软件包是为与 Laravel 5 一起使用而开发的，但也可独立使用。希望这能帮助您自动化并扩展 TeamworkDesk，使其更好地融入您的业务！祝您玩得开心，好运！🤘

此分支还包括对 Laravel 5.5 和 5.6 的更新

安装

只需将其添加到您的 composer.json 文件中，然后运行 composer update。

"nigelheap/teamwork-desk": "1.0.*"

您也可以这样简单添加

composer require "nigelheap/teamwork-desk:1.0.*"

Laravel 设置

此封装器支持 Laravel 5。这包括服务提供程序以及用于轻松访问的 facade。将此软件包拉入您的项目后，只需将其添加到您的 config/app.php 文件中。

'providers' => [
    ...
    'NigelHeap\TeamworkDesk\TeamworkDeskServiceProvider',
],

然后，将 facade 添加到您的 aliases 数组中

'aliases' => [
    ...
    'TeamworkDesk' => 'NigelHeap\TeamworkDesk\Facades\TeamworkDesk',
],

配置

如果您正在使用 Laravel，则需在您的 config/services.php 文件中添加一个 teamwork 数组

...
'teamwork-desk' => [
    'key'  => 'YourSecretKey',
    'url'  => 'YourTeamworkDeskUrl'
],

使用

如果您使用 Laravel Facade，则可以轻松访问 TeamworkDesk，如下所示

TeamworkDesk::customers()->all();

如果您想使用依赖注入来使您的应用程序易于测试，Service Provider 绑定了 NigelHeap\TeamworkDesk\Factory。以下是如何使用依赖注入的示例

Route::get('/test', function(NigelHeap\TeamworkDesk\Factory $teamwork) {
   $customers = $teamwork->customers()->all();
});

非 Laravel 配置

如果您不使用 Laravel，可以像这样实例化类

require "vendor/autoload.php";

use GuzzleHttp\Client as Guzzle;
use NigelHeap\TeamworkDesk\Client;
use NigelHeap\TeamworkDesk\Factory as TeamworkDesk;

$client     = new Client(new Guzzle, 'YourSecretKey', 'YourTeamworkDeskUrl');
$teamwork   = new TeamworkDesk($client);

现在您可以开始使用了！

示例

// get a customer
$teamwork->customers($customerId)->find();

// get a customers
$teamwork->customers()->all();

// get a tickets
$teamwork->tickets()->all();

// get a ticket
$teamwork->tickets($ticketId)->find();

// get a users
$teamwork->users()->all();

路线图

1.0 版本发布

• 添加对 票据 的支持
• 添加对 收件箱 的支持
• 添加对 客户 的支持
• 添加对 用户 的支持

1.1 版本发布

• 添加对 线程 的支持
• 添加对 幸福 的支持
• 添加对 用户 的支持

1.2 版本发布

• 添加对 类别 的支持
• 添加对 人员状态 的支持
• 添加对 文件 的支持
• 添加对 功能 的支持

1.3 版本发布

• 添加对 帮助文档 的支持