industrious/hellosign-laravel

Description

HelloSign Laravel

![Total Downloads][ico-downloads] , _(*1)

This package acts as a wrapper, for the HelloSign PHP SDK, to inject the relevant credentials and allow you to use the package in the container. Some examples of usage have been provided below., _(*2)

See the HelloSign PHP SDK for full details., _(*3)

Take a look at contributing.md to see a to do list., _(*4)

Installation

Via Composer, _(*5)

``` bash $ composer require industrious/hellosign-laravel, <sub>(*6)</sub>

## Usage

Publish the config, and add the relevant API authentication details to your `.env` file.
```bash
php artisan vendor:publish --tag=laravel-hellosign

Examples

Get client account details

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

    ...

Send a signature request

/**
 * @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();

    ...

Send a signature request using a pre-defined template

/**
 * @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();

    ...

Change log

Please see the changelog for more information on what has changed recently., <sub>(*7)</sub>

Testing

bash $ composer test, <sub>(*8)</sub>

Contributing

Please see contributing.md for details and a todolist., <sub>(*9)</sub>

Security

If you discover any security related issues, please email christian@industrious.agency instead of using the issue tracker., <sub>(*10)</sub>

Credits

• Christian Thomas
• All Contributors

License

MIT. Please see the license file for more information., <sub>(*11)</sub>