Eversign Ruby SDK

Ruby SDK for eversign API

Add this line to your application's Gemfile:

gem 'eversign'

And then execute:

$ bundle

Or install it yourself as:

$ gem install eversign

	Eversign.configure do |c|
	  c.api_base = '<YOUR_BASE_API>|https://api.eversign.com/api'
	  c.access_key = '<YOUR_API_KEY>'
	  c.business_id = <YOUR_BUISINESS_ID>
	end

OR directly set on client if needed

	client.business_id = <YOUR_BUISINESS_ID>

	client = Eversign::Client.new

Using the gwt_businesses function all businesses on the eversign account will be fetched and listed along with their Business IDs.

	businesses = client.get_businesses()
	p businesses[0]

Using the following functions required documents on the eversign account associated with given business id will be fetched and listed.

	documents = client.get_all_ocuments()
	p documents

	documents = client.get_completed_documents()
	p documents

	documents = client.get_draft_documents()
	p documents

	documents = client.get_cancelled_documents()
	p documents

	documents = client.get_action_required_documents()
	p documents

	documents = client.get_waiting_for_others_documents()
	p documents

Using the following functions required templates on the eversign account associated with given business id will be fetched and listed.

	templates = client.get_templates
	p templates

	templates = client.get_archived_templates()
	p templates

	templates = client.get_draft_templates()
	p templates

Using the get_document function specific document on the eversign account associated with given business id and document hash will be fetched and listed.

	document = client.get_document(<DOCUMENT_HASH>)
	p document

	file = client.upload_file(<FILE_PATH>)
	p file.file_id

	client.download_raw_document_to_path(<DOCUMENT_HASH>,<FILE_PATH>)

	client.download_final_document_to_path(<DOCUMENT_HASH>,<FILE_PATH>)

	send_reminder_for_document(<DOCUMENT_HASH>,<SIGNER_ID>)

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

	bundle exec COVERAGE=1 rspec

Bug reports and pull requests are welcome on GitHub at https://github.com/workatbest/eversign. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

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