勤劳/hellosign-laravel

dev-master 2018-07-23 16:51 UTC

This package is auto-updated.

Last update: 2024-09-29 05:02:02 UTC


README

Latest Version on Packagist Total Downloads Build Status StyleCI

此包作为HelloSign PHP SDK的包装器,用于注入相关凭证,允许您在容器中使用该包。下面提供了一些使用示例。

有关详细信息,请参阅HelloSign PHP SDK

查看contributing.md以查看待办事项列表。

安装

通过Composer

$ composer require industrious/hellosign-laravel

使用方法

发布配置,并将相关的API认证详细信息添加到您的.env文件中。

php artisan vendor:publish --tag=laravel-hellosign

示例

获取客户端账户详情

/**
 * @param  HelloSignLaravel\Client $client
 */
public function client(Client $client)
{
    $client = $client->getAccount();
    
    ...

发送签名请求

/**
 * @param  HelloSignLaravel\Classes\SignatureRequest $signature_request
 */
public function sign(SignatureRequest $signature_request)
{
    $request = $signature_request
        ->setTitle('Title')
        ->setSubject('Subject')
        ->setMessage('Message')
        ->addSigner('email@address.com', 'Client name');

    $file = storage_path('app/file.pdf');

    $request->addFile($file);

    $response = $request->send();
    
    ...

使用预定义模板发送签名请求

/**
 * @param  HelloSignLaravel\Classes\SignatureRequest $signature_request
 */
public function templateSign(TemplateSignatureRequest $signature_request)
{
    $request = $signature_request
        ->setTemplateId(config('hellosign.templates.contract'))
        ->setTitle('Title')
        ->setSubject('Subject')
        ->setMessage('Message')
        ->setSigner('Client', 'email@address.com', 'Test User');

    $request->setCustomFieldValue('Name', 'Test User');

    $response = $request->send();

    ...

变更日志

请参阅changelog以获取有关最近更改的更多信息。

测试

$ composer test

贡献

请参阅contributing.md以获取详细信息及待办事项列表。

安全性

如果您发现任何与安全相关的问题,请通过电子邮件christian@industrious.agency联系,而不是使用问题跟踪器。

致谢

许可证

MIT. 请参阅许可证文件以获取更多信息。