README

这个库作为Smartsheet暴露的REST API的便捷包装器。它还使用Illuminate库中的Collections库来代替数组，所以如果你不熟悉它，可以查看一下。

目录

• 安装
• 使用方法
  • 工作表
  • 工作空间
  • 文件夹
• 问题
• 路线图
• 贡献

安装

安装此库的首选方法是使用Composer，从项目根目录运行以下命令

composer require infamoustrey/smartsheet

使用方法

此库提供了与Smartsheet交互的流畅API。

$smartsheetClient = new \Smartsheet\SmartsheetClient([ 'token' => 'yourapitoken' ]);

$smartsheetClient->getSheet('sheetid');

工作表

获取工作表列表

$smartsheetClient = new \Smartsheet\SmartsheetClient([ 'token' => 'yourapitoken' ]);

$smartsheetClient->listSheets(); // Collection<Sheet>

访问工作表，查看工作表对象以获取可能属性的列表。

$smartsheetClient = new \Smartsheet\SmartsheetClient([ 'token' => 'yourapitoken' ]);

$sheet = $smartsheetClient->getSheet('4583173393803140');

// Access some fields
$sheet->getId(); // '4583173393803140'
$sheet->getName(); // 'sheet 1'

// Add some rows
$sheet->addRow([
    'ID' => "39424808324",
    'Transaction Desc' => "Toys",
    'Amount' => 754.23,
]);

工作空间

获取工作空间及其属性。查看工作空间对象以获取可能属性的列表。

$smartsheetClient = new \Smartsheet\SmartsheetClient([ 'token' => 'yourapitoken' ]);

$workspace = $smartsheetClient->getWorkspace('7116448184199044'); // \Smartsheet\Resources\Workspace

$workspace->getId(); // '7116448184199044'
$workspace->getName(); // 'New workspace'

$workspace->listSheets(); // Collection<Sheet>

// Fetch a sheet by name
$workspace->getSheet('sheet name'); // Sheet

// Create a sheet with some columns
$workspace->createSheet('sheet name', [
    [
        "title" => "Primary",
        "type" => "TEXT_NUMBER",
        "primary" => true
    ]
]);

文件夹

获取文件夹及其属性。查看文件夹对象以获取可能属性的列表。

$smartsheetClient = new \Smartsheet\Client([ 'token' => 'yourapitoken' ]);

$folder = $smartsheetClient->getFolder('7116448184199044'); // Folder

// Access some fields
$folder->getId(); // '7116448184199044'
$folder->getName(); // 'Projects'
$sheet = $folder->getSheet('sheet name');

问题

使用此存储库的问题跟踪器解决问题和提问。

路线图

全面API覆盖！如果看到缺失的内容，请提交PR！您的帮助将受到赞赏！

贡献

请随时提交PR，只需在提交时说明您尝试修复或添加的内容。如果您决定添加功能，则必须通过测试进行覆盖。有关更多信息，请参阅贡献指南。

要运行测试，只需运行，您需要添加一个.env文件（参见.env.example），其中包含有效的API令牌值，变量为SMARTSHEET_API_TOKEN。测试还会在pull requests上运行。

./vendor/bin/phpunit