hellosign-api 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 15ab87c5fd112e345b597a6003f2614a14e1823e8e797f55b782e8ed2d1d5228
+  data.tar.gz: ed736391c8754d83803b8c3af891b6769febee68d24bad1877c959f942597711
+SHA512:
+  metadata.gz: 9f280d46b5e049341a2ff061753f382c7b687850868ea5d4042ae8b03feff053f61e1c0fc173a9a563f6b78dc8cb814b97234bc5d61b49dadae8f1bf6e75746b
+  data.tar.gz: 63e5a92a49eadcabaa3397b8c7b6895f8ffaf0717eeebeedb2c5ae67944e92c588c11b36196ca1472e4f1d09d62a7b30f89991e6a6ed96bcb66c05f390e79d78

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+.idea
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.DS_Store

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/.travis.yml

@@ -0,0 +1,15 @@
+language: ruby
+rvm:
+  - 2.1.1
+  - 2.1.0
+  - 2.0.0
+  - 1.9.3
+  - jruby-19mode
+  - ruby-head
+  - jruby-head
+
+matrix:
+  allow_failures:
+    - rvm: jruby-head
+    - rvm: ruby-head
+  fast_finish: true

data/CONTRIBUTING.md

@@ -0,0 +1,42 @@
+# How to contribute
+
+We're excited you're considering contributing to our project! Your patches are essential to keeping our SDKs bug free and up-to-date. We want to keep it as easy as possible to contribute. There are only a few guidelines you must follow that will allow us to keep up with pull requests and maintain a high quality code base.
+
+## Getting Started
+
+* Make sure you have a [GitHub account](https://github.com/signup/free)
+* Make sure you have a [HelloSign account](http://www.hellosign.com)
+* Submit a new [issue ticket](https://github.com/HelloFax/hellosign-ruby-sdk/issues), assuming one does not already exist.
+  * Clearly describe the issue including steps to reproduce when it is a bug.
+  * Make sure to include the version you are using which has the issue (and confirm that the issue you are having has not been fixed in a later version)
+* Fork the repository on GitHub
+
+## Making Changes
+
+* Make commits of logical units.
+* Check for unnecessary whitespace with `git diff --check` before committing.
+* Make sure your commit messages are in [the proper format](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html).
+* Make sure you have added any necessary tests for your changes.
+* Run all unit tests, if available, to ensure nothing else was accidentally broken.
+
+### Making trivial changes
+
+For changes of a trivial nature to comments and documentation, it is not
+always necessary to create a new issue ticket.
+
+## Submitting Changes
+
+* Push your changes to your fork of the repository.
+* Submit a pull request to the repository in the HelloFax organization.
+* Update your issue ticket to mark that you have submitted code and are ready for it to be reviewed (Status: Ready for Merge).
+  * Include a link to the pull request in the ticket.
+* The HelloSign dev team looks at Pull Requests on a regular basis.
+* After feedback has been given we expect responses within two weeks. After two
+  weeks we may close the pull request if it isn't showing any activity.
+
+# Additional Resources
+
+* [General GitHub documentation](http://help.github.com/)
+* [GitHub pull request documentation](http://help.github.com/send-pull-requests/)
+* [HelloSign API documentation](https://app.hellosign.com/api/documentation)
+* [HelloSign API HipChat room](https://www.hipchat.com/gq4BMFKt1)

data/Gemfile

@@ -0,0 +1,13 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in hello_sign.gemspec
+gemspec
+
+group :development, :spec do
+  gem 'pry'
+  gem 'growl' if `uname` =~ /Darwin/
+  gem 'guard'
+  gem 'guard-bundler'
+  gem 'guard-rspec'
+  gem 'coveralls', :require => false
+end

data/Guardfile

@@ -0,0 +1,14 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+notification :growl if `uname` =~ /Darwin/
+
+guard :bundler do
+  watch('Gemfile')
+end
+
+guard :rspec do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (C) 2014 hellosign.com
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,112 @@
+# HelloSign Ruby SDK
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'hellosign'
+
+And then execute:
+
+    $ bundle
+
+## Configuration
+
+Create a config block. At a minimum you'll want to set your [API Key](https://app.hellosign.com/home/myAccount/current_tab/integrations#api) but depending on your usage you'll possibly
+want to set your app's [Client ID](https://app.hellosign.com/oauth/createAppForm) and [Client Secret](https://app.hellosign.com/oauth/createAppForm). In Rails you can place it in `config/initializers/hello_sign.rb`
+
+```ruby
+require 'hello_sign'
+HelloSign.configure do |config|
+  config.api_key = 'api_key'
+  # You can use email_address and password instead of api_key. But api_key is recommended
+  # If api_key, email_address and password are all present, api_key will be used
+  # config.email_address = 'email_address'
+  # config.password = 'password'
+end
+```
+
+## Usage
+When you have configured your app like above, you can start using it:
+
+```ruby
+# get your account
+my_account = HelloSign.get_account
+
+# get your signature requests
+my_signature_requests = HelloSign.get_signature_requests
+
+# view a specific signature request
+signature_request = HelloSign.get_signature_request signature_request_id: '42383e7327eda33f4b8b91217cbe95408cc1285f'
+```
+
+If you need to authenticate for multiple users and you want a separated client for them, you can run:
+```ruby
+client2 = HelloSign::Client.new api_key: 'your_user_api_key'
+user_account = client2.get_account
+```
+### Specifying files
+
+When using request endpoints that send files, such as a signature request, you can specify files either as
+1. A string representing the path
+2. A Ruby File Object (File.open, then assign to a variable)
+3. A Rails ActionDispatch::Http::UploadedFile
+
+## Testing
+
+Testing relies on built in hard-coded fixtures. You can run the tests without affecting your actual account data. To do so
+from the root of your project run <code>rake spec</code>.
+
+## Additional notes
+
+## Warnings
+Any warnings returned from the API can be accessed by using the 'warnings' accessor on a returned object or list:
+
+````ruby
+my_signature_requests = client.get_signature_requests
+puts my_signature_requests.warnings
+````
+
+and will give output of warnings in the following format (as an array of hashes):
+
+````
+[
+    [0] {
+         "warning_msg" => "Parameter hodor was ignored. Hodor.",
+        "warning_name" => "parameter_ignored"
+    },
+    [1] {
+         "warning_msg" => "Email address sirjorah@targarian.org is unconfirmed. Please pledge your allegiance to the queen first.",
+        "warning_name" => "unconfirmed"
+    }
+]
+````
+
+### Local callbacks
+We do not allow app callbacks (event or OAuth) to be set to localhost. However it is still possible to test callbacks against a local server. Tunneling services such as ngrok (http://ngrok.com) can help you set this up.
+
+## License
+
+```
+The MIT License (MIT)
+
+Copyright (C) 2014 hellosign.com
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+```

data/Rakefile

@@ -0,0 +1,16 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new
+
+task :default => :spec
+task :test => :spec
+
+task :console do
+  require 'irb'
+  require 'irb/completion'
+  require 'hello_sign' # You know what to do.
+  @client = HelloSign::Client.new :email_address => 'testuser@example.com', :password => '12345678', :client_id => '7f91612ee160dd56bd899cd1688bbefc', :client_secret => 'a403773af1e1aee206976257a47249cf'
+  ARGV.clear
+  IRB.start
+end

data/hellosign-api.gemspec

@@ -0,0 +1,54 @@
+# coding: utf-8
+
+#
+# The MIT License (MIT)
+#
+# Copyright (C) 2014 hellosign.com
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+#
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'hello_sign/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'hellosign-api'
+  spec.version       = HelloSign::VERSION
+  spec.authors       = 'HelloSign, Aubrey Holland'
+  spec.email         = 'aubrey@withgrayce.com'
+  spec.summary       = 'A Ruby SDK for the HelloSign API.'
+  spec.description   = ''
+  spec.homepage      = 'http://www.hellosign.com'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.5'
+  spec.add_development_dependency 'rake', '~> 13.0.0'
+  spec.add_development_dependency 'rspec', '~> 3.0.0'
+  spec.add_development_dependency 'webmock', '~> 3.0.0'
+  spec.add_runtime_dependency 'faraday', '~> 2.2.0'
+  spec.add_runtime_dependency 'faraday-multipart', '~> 1.0.0'
+  spec.add_runtime_dependency 'multi_json', '~> 1.0.0'
+  spec.add_runtime_dependency 'mime-types', '~> 3.0.0'
+end

data/lib/hello_sign/api/account.rb

@@ -0,0 +1,78 @@
+# The MIT License (MIT)
+#
+# Copyright (C) 2014 hellosign.com
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+module HelloSign
+  module Api
+    # Contains all the API calls for the Account resource.
+    # Take a look at our API Documentation on the Account resource (https://app.hellosign.com/api/reference#Account)
+    # for more information about this.
+    #
+    # @author [hellosign]
+
+    module Account
+
+      # Returns the current user's account information.
+      #
+      # @return [HelloSign::Resource::Account] Current user's Account
+      #
+      # @example
+      #   account = @client.get_account
+      def get_account
+        HelloSign::Resource::Account.new get('/account')
+      end
+
+      # Creates a new HelloSign account. The user will need to confirm the email address
+      # to complete the creation process.
+      # @option opts [String] email_address New user's email address
+      #
+      # @return [HelloSign::Resource::Account] New user's Account
+      #
+      # @example
+      #   account = @client.create_account email_address: 'newuser@example.com'
+      def create_account(opts)
+        HelloSign::Resource::Account.new post('/account/create', body: opts)
+      end
+
+      # Updates the current user's Account Callback URL.
+      # @option opts [String] callback_url New callback URL
+      #
+      # @return [HelloSign::Resource::Account] Updated Account
+      #
+      # @example
+      #   account = @client.update_account callback_url: 'https://www.example.com/callback'
+      def update_account(opts)
+        HelloSign::Resource::Account.new post('/account', body: opts)
+      end
+
+      # Checks whether an Account exists
+      # @option opts [String] email_address User's email address
+      #
+      # @return [Bool] true if exists, else false
+      #
+      # @example
+      #   account = @client.verify email_address: 'newuser@example.com'
+      def verify(opts)
+        post('/account/verify', body: opts).empty? ? false : true
+      end
+    end
+  end
+end

data/lib/hello_sign/api/api_app.rb

@@ -0,0 +1,121 @@
+# The MIT License (MIT)
+#
+# Copyright (C) 2014 hellosign.com
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+module HelloSign
+  module Api
+    # Contains all the API calls for the ApiApp resource.
+    # Take a look at our API Documentation on ApiApps (https://app.hellosign.com/api/reference#ApiApp)
+    # for more information about this.
+    #
+    # @author [hellosign]
+
+    module ApiApp
+
+      # Retrieves an ApiApp with a given ID
+      # @option opts [String] client_id The Client ID of the ApiApp.
+      #
+      # @return [HelloSign::Resource::ApiApp]
+      #
+      # @example
+      #   app = @client.get_api_app client_id: 'fa5c8a0b0f492d768749333ad6fcc214c111e967'
+      def get_api_app(opts)
+        HelloSign::Resource::ApiApp.new get("/api_app/#{opts[:client_id]}")
+      end
+
+      # Returns a list of ApiApps that your Account can access.
+      # @option opts [Integer] page Sets the page number of the list to return. Defaults to 1. (optional)
+      # @option opts [Integer] page_size Determines the number of ApiApps returned per page. Defaults to 20. (optional)
+      #
+      # @return [HelloSign::Resource::ResourceArray]
+      #
+      # @example
+      #   apps = @client.get_api_apps page: 1
+      def get_api_apps(opts={})
+        path = '/api_app/list'
+        path += opts[:page] ? "?page=#{opts[:page]}" : ''
+        path += opts[:page_size] ? "&page_size=#{opts[:page_size]}" : ''
+        HelloSign::Resource::ResourceArray.new get(path, opts), 'api_apps',  HelloSign::Resource::ApiApp
+      end
+
+      # Creates a new ApiApp on your Account
+      # @option opts [String] name The name assigned to the ApiApp.
+      # @option opts [String] domain The domain associated with the ApiApp.
+      # @option opts [String] callback_url The URL that will receive callback events for the ApiApp. (optional)
+      # @option opts [String] custom_logo_file An image file to use as a custom logo in embedded workflows, if available in the API subscription. (optional)
+      # @option opts [String] oauth[callback_url] The callback URL to be used for OAuth flows. (optional)
+      # @option opts [String] oauth[scopes] A comma-separated list of OAuth scopes to be granted to the app. (optional)
+      # @option opts [String<Hash>] white_labeling_options Object with elements and values serialized to a string to customize the signer page, if available in the API subscription. (optional)
+      # @option opts [Boolean] options[can_insert_everywhere] Determines if signers can "Insert Everywhere" when signing a document. (optional)
+      #
+      # @return [HelloSign::Resource::ApiApp] newly created ApiApp
+      #
+      # @example
+      #   app = @client.create_api_app(
+      #     name: 'My Production App',
+      #     domain: 'example.com',
+      #     'oauth[callback_url]': 'https://example.com/oauth',
+      #     'oauth[scopes]': 'basic_account_info,request_signature'
+      #   )
+      def create_api_app(opts)
+        HelloSign::Resource::ApiApp.new post('/api_app', body: opts)
+      end
+
+      # Updates the ApiApp settings.
+      # @option opts [String] client_id The Client ID of the ApiApp you want to update.
+      # @option opts [String] name The name assigned to the ApiApp. (optional)
+      # @option opts [String] domain The domain associated with the ApiApp. (optional)
+      # @option opts [String] callback_url The URL that will receive callback events for the ApiApp. (optional)
+      # @option opts [String] custom_logo_file An image file to use as a custom logo in embedded workflows, if available in the API subscription. (optional)
+      # @option opts [String] oauth[callback_url] The callback URL to be used for OAuth flows. (optional)
+      # @option opts [String] oauth[scopes] A comma-separated list of OAuth scopes to be granted to the app. (optional)
+      # @option opts [String<Hash>] white_labeling_options Object with elements and values serialized to a string to customize the signer page, if available in the API subscription. (optional)
+      # @option opts [Boolean] options[can_insert_everywhere] Determines if signers can "Insert Everywhere" when signing a document. (optional)
+      #
+      # @return [HelloSign::Resource::ApiApp] an ApiApp object
+      #
+      # @example
+      #   app = @client.update_api_app(
+      #     name: 'My Newly Renamed App',
+      #     domain: 'example2.com',
+      #     'oauth[callback_url]': 'https://example2.com/oauth',
+      #     'oauth[scopes]': 'basic_account_info, request_signature'
+      #   )
+      def update_api_app(opts)
+        id = opts.delete(:client_id)
+        path = '/api_app/' + id
+        HelloSign::Resource::ApiApp.new post(path, body: opts)
+      end
+
+      # Deletes an ApiApp. Only available for ApiApps you own.
+      # @option opts [String] client_id The Client ID of the ApiApp you want to delete.
+      #
+      # @return [HTTP::Status] 204 No Content
+      #
+      # @example
+      #   response = @client.delete_api_app client_id: 'fa5c8a0b0f492d768749333ad6fcc214c111e967'
+      def delete_api_app(opts)
+        path = '/api_app/' + opts[:client_id]
+        delete(path)
+      end
+    end
+  end
+end

data/lib/hello_sign/api/bulk_send_job.rb

@@ -0,0 +1,62 @@
+# The MIT License (MIT)
+#
+# Copyright (C) 2014 hellosign.com
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+module HelloSign
+  module Api
+    # Contains all the API calls for the BulkSendJob resource.
+    # Take a look at our API Documentation on BulkSendJobs (https://app.hellosign.com/api/reference#BulkSendJob)
+    # for more information about this.
+    #
+    # @author [hellosign]
+
+    module BulkSendJob
+
+      # Retrieves a BulkSendJob with a given ID
+      # @option opts [String] bulk_send_job_id The BulkSendJob ID to retrieve.
+      #
+      # @return [HelloSign::Resource::BulkSendJob]
+      #
+      # @example
+      #   bulk_send_job = @client.get_bulk_send_job bulk_send_job_id: 'af299494bdcad318b4856aa34aa263dbdaaee9ab'
+      def get_bulk_send_job(opts)
+        path = "/bulk_send_job/#{opts[:bulk_send_job_id]}"
+
+        HelloSign::Resource::BulkSendJob.new get(path)
+      end
+
+      # Returns a list of BulkSendJobs that your Account can access.
+      # @option opts [Integer] page Sets the page number of the list to return. Defaults to 1. (optional)
+      # @option opts [Integer] page_size Determines the number of BulkSendJobs returned per page. Defaults to 20. (optional)
+      #
+      # @return [HelloSign::Resource::ResourceArray]
+      #
+      # @example
+      #   bulk_send_jobs = @client.get_bulk_send_jobs page: 1
+      def get_bulk_send_jobs(opts={})
+        path = '/bulk_send_job/list'
+        path += opts[:page] ? "?page=#{opts[:page]}" : ''
+        path += opts[:page_size] ? "&page_size=#{opts[:page_size]}" : ''
+        HelloSign::Resource::ResourceArray.new get(path, opts), 'bulk_send_jobs', HelloSign::Resource::BulkSendJob
+      end
+    end
+  end
+end

data/lib/hello_sign/api/embedded.rb

@@ -0,0 +1,68 @@
+# The MIT License (MIT)
+#
+# Copyright (C) 2014 hellosign.com
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+module HelloSign
+  module Api
+    # Contains all the API calls for Embedded SignatureRequests.
+    # Take a look at our Embedded Signing Walkthrough (https://app.hellosign.com/api/embeddedSigningWalkthrough)
+    # for more information about this.
+    #
+    # @author [hellosign]
+
+    module Embedded
+
+      # Retrieves the sign_url for an Embedded SignatureRequest.
+      # @option opts [String] signature_id The Signature ID to retrieve the embedded sign_url for.
+      #
+      # @return [HelloSign::Resource::Embedded]
+      #
+      # @example
+      #   embedded = @client.get_embedded_sign_url signature_id: '50e3542f738adfa7ddd4cbd4c00d2a8ab6e4194b'
+      def get_embedded_sign_url(opts)
+        HelloSign::Resource::Embedded.new get("/embedded/sign_url/#{opts[:signature_id]}")
+      end
+
+      # Retrieves the edit_url for an Embedded Template.
+      # @option opts [Boolean] test_mode Indicates if this is a test SignatureRequest, it will not be legally binding if set to 1. Defaults to 0. (optional)
+      # @option opts [String] template_id The Template ID to retrieve the embedded edit_url for.
+      # @option opts [Array<Hash>] cc_roles The CC roles that must be assigned when using the Embedded Template to create a SignatureRequest. (optional)
+      # @option opts [String<Array><Hash>] merge_fields List of fields that can be pre-populated by your application when using the Embedded Template to send a SignatureRequest. (optional)
+      #   * name (String) Merge field name
+      #   * type (String) Field type - either "text" or "checkbox"
+      # @option opts [Boolean] skip_signer_roles Removes the prompt to edit signer roles, if already provided. Defaults to 0. (optional)
+      # @option opts [Boolean] skip_subject_message Removes the prompt to edit the subject and message, if already provided. Defaults to 0. (optional)
+      #
+      # @return [HelloSign::Resource::Embedded]
+      #
+      # @example
+      #   edit_url = @client.get_embedded_template_edit_url template_id: '39e3387f738adfa7ddd4cbd4c00d2a8ab6e4194b'
+      def get_embedded_template_edit_url(opts)
+        defaults = { skip_signer_roles: 0, skip_subject_message: 0, test_mode: 0 }
+        opts = defaults.merge(opts)
+
+        prepare_merge_fields opts
+
+        HelloSign::Resource::Embedded.new post("/embedded/edit_url/#{opts[:template_id]}", body: opts)
+      end
+    end
+  end
+end