eSignLive Client

Gem Version Build Status Code Climate

Usage

Create a client

client = ESignLive::Client.new(api_key: your_api_key, environment: 'sandbox')

For production:

client = ESignLive::Client.new(api_key: your_api_key, environment: 'production')

Make some API calls

Get all packages in your account
packages = client.get_packages
Get a package:
package = client.get_package(package_id: your_package_id)
API Calls
  • authentication_token(package_id:)
  • sender_authentication_token(package_id:)
  • signer_authentication_token(signer_id:,package_id:)
  • get_packages
  • get_package(package_id:)
  • get_signing_status(package_id:)
  • get_document(package_id: document_id:, pdf: false)
  • get_roles(package_id)
  • update_role_signer(package_id:, role_id:, email:, first_name:, last_name:)
  • create_package(opts={})
  • create_package_from_template(template_id:, opts: {})
  • send_package(package_id:)
  • signing_url(package_id:, role_id:)
  • remove_document_from_package(document_id:, package_id:)

Installation

Add this line to your application's Gemfile:

  gem 'esignlive'

And then execute:

$ bundle

Or install it yourself as:

$ gem install esignlive

Contributing

Submit a pull request

  1. Fork the repo.

  2. Push to your fork and submit a pull request.

Syntax:

  • Two spaces, no tabs.
  • No trailing whitespace. Blank lines should not have any space.
  • Prefer &&, || over and, or.
  • MyClass.my_method(my_arg) not my_method( my_arg ) or my_method my_arg.
  • a = b and not a=b.
  • Follow the conventions you see used in the source already.

TODO

  • More API calls

License

The gem is available as open source under the terms of the MIT License.