Pandadoc::Api  

PandaDoc API is meant to be a simplistic ruby wrapper around the PandaDoc API. It assumes that token management is handled elsewhere and that parsing of the response is up to the user.

All options to the API Methods are available via the PandaDoc API Documentation.

Installation

Add this line to your application's Gemfile:

gem 'pandadoc-api'

And then execute:

$ bundle

Or install it yourself as:

$ gem install pandadoc-api

Usage

Documents

Create a new instance

document_api = Pandadoc::Api::Document.new

Call the API

# List Documents
document_api.list(token, params = {}) # returns JSON

# Create Document from PandaDoc Template
document_api.create(token, params = {}) # returns JSON

# Document Status
document_api.status(token, document_id) # returns JSON

# Document Details
document_api.details(token, document_id) # returns JSON

# Delete a document
document_api.delete(token, document_id) # returns JSON

# Send Document
document_api.send_doc(token, document_id, params = {}) # returns JSON

# Create a Document Link
document_api.link(token, document_id, params = {}) # returns String

# Download Document
document_api.download(token, document_id) # returns PDF File

Templates

Create a new instance

template_api = Pandadoc::Api::Template.new

Call the API

# List Templates
template_api.list(token, params = {}) # returns JSON

# Template Details
template_api.details(token, template_id) # returns JSON

Development

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.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/CatchRelease/pandadoc-api. 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.

License

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

Code of Conduct

Everyone interacting in the Pandadoc::Api project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.