hellosign-ruby-sdk 3.0.0

data/.gitignore

@@ -0,0 +1,18 @@
+*.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

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/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.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 HelloSign, Inc
+
+MIT License
+
+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,58 @@
+# HelloSign Ruby SDK
+
+In addition to this readme, checkout our quickstart guide here:
+https://www.hellosign.com/api/gettingStarted#QuickStart
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'hellosign-ruby-sdk'
+
+And then execute:
+
+    $ bundle
+
+
+## Configuration
+
+Create a config block. At a minimum you'll want to set your [API Key](https://www.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://www.hellosign.com/oauth/createAppForm) and [Client Secret](https://www.hellosign.com/oauth/createAppForma). 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'
+  config.client_id = 'your_cliend_id' #required only when you want to use embedded or OAuth
+  config.client_secret = 'your_cliend_secret' #required only when you want to use OAuth
+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_requests :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
+```
+
+##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>.

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-ruby-sdk.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+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-ruby-sdk"
+  spec.version       = HelloSign::VERSION
+  spec.authors       = "HelloSign"
+  spec.email         = "support@hellosign.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'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'webmock'
+  spec.add_runtime_dependency 'faraday'
+  spec.add_runtime_dependency 'multi_json'
+end

data/lib/hello_sign.rb

@@ -0,0 +1,32 @@
+require 'hello_sign/version'
+require 'hello_sign/configuration'
+require 'hello_sign/client'
+
+module HelloSign
+  extend Configuration
+
+  #
+  # # If HelloSign module don't respond_to? method, then delegate it to HelloSign::Client
+  # @param  method [Symbol] method name
+  # @param  *args [Array] arguments passed into the method
+  # @param  &block [Block] a block passed into the method
+  #
+  def self.method_missing(method, *args, &block)
+    return super unless client.respond_to?(method)
+    client.send(method, *args, &block)
+  end
+
+
+  #
+  # If HelloSign module don't respond_to? method, ask HelloSign::Client whether it respond or not
+  # @param  method [Symbol] method name
+  #
+  def self.respond_to?(method)
+    return super || client.respond_to?(method)
+  end
+
+  private
+  def self.client
+    HelloSign::Client.new
+  end
+end

data/lib/hello_sign/api.rb

@@ -0,0 +1,7 @@
+require 'hello_sign/api/account'
+require 'hello_sign/api/embedded'
+require 'hello_sign/api/template'
+require 'hello_sign/api/signature_request'
+require 'hello_sign/api/team'
+require 'hello_sign/api/unclaimed_draft'
+require 'hello_sign/api/oauth'

data/lib/hello_sign/api/account.rb

@@ -0,0 +1,69 @@
+module HelloSign
+  module Api
+
+
+    #
+    # Contains all the api calls for the Account resource.
+    # Take a look at our {https://www.hellosign.com/api/reference#Account account api document}
+    # 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 still need to validate their email address
+      # to complete the creation process.
+      #
+      # Note: This request does not require authentication.
+      #
+      # @option opts [String] email_address New user's email address
+      # @option opts [String] password New user's password
+      #
+      # @return [HelloSign::Resource::Account] New user's account information
+      #
+      # @example
+      #   account = @client.create_account :email_address => 'newuser@example.com', :password => 'securePW'
+      #
+      def create_account opts
+        HelloSign::Resource::Account.new post("/account/create", :body => opts)
+      end
+
+
+      #
+      # Updates the current user's callback URL
+      # @option opts [String] callback_url New user's callback url
+      #
+      # @return [HelloSign::Resource::Account] Updated user's account information
+      #
+      # @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
+
+
+      #
+      # Check whether an account exists
+      # @option opts [String] email_address user email
+      #
+      # @return [Bool] true if exists, else false
+      def verify opts
+        post("/account/verify", :body => opts).empty? ? false : true
+      end
+    end
+  end
+end

data/lib/hello_sign/api/embedded.rb

@@ -0,0 +1,27 @@
+module HelloSign
+  module Api
+
+    #
+    # HelloSign allows you to embed the signing page on your site in an iFrame
+    # without the need for the end-user to create a HelloSign account.
+    # Take a look at our {https://www.hellosign.com/api/embeddedSigningWalkthrough embedded signing walkthrough}
+    # for more information about this.
+    #
+    # @author [hellosign]
+    #
+    module Embedded
+
+      #
+      # Retrieves the embedded signature request url.
+      # @option opts [String] signature_id The id of the signature to get a signature url for
+      #
+      # @return [HelloSign::Resource::Embedded] Returns an Embedded object
+      # @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
+    end
+  end
+end

data/lib/hello_sign/api/oauth.rb

@@ -0,0 +1,63 @@
+module HelloSign
+  module Api
+
+    #
+    # OAuth allows you to perform actions on behalf of other users after they grant you the authorization to do so.
+    # For example, you could send signature requests on behalf of your users. This page lays out the basic steps to do that.
+    # IMPORTANT
+    #
+    # With OAuth, you (the app owner) will be charged for all signature requests sent on behalf of other users via your app.
+    #
+    # @author [hellosign]
+    #
+    module OAuth
+
+      #
+      # Return the oath url where users can give permission for your application to perform actions on their behalf.
+      # @param  state [String] used for security and must match throughout the flow for a given user.
+      # It can be set to the value of your choice (preferably something random). You should verify it matches the expected value when validating the OAuth callback.
+      # @return [type] [description]
+      def oauth_url state
+        "#{self.oauth_end_point}/oauth/authorize?response_type=code&client_id=#{self.client_id}&state=#{state}"
+      end
+
+      #
+      # Retrieving the OAuth token
+      #
+      # @option opts [String] state variable that was used when you created oauth_url for a specific user
+      # @option opts [String] code The authorization code passed to your callback when the user granted access
+      #
+      # @return [Hash] oauth data of the user
+      def get_oauth_token opts
+        opts[:client_id] = self.client_id
+        opts[:client_secret] = self.client_secret
+        opts[:grant_type] = 'authorization_code'
+        post('/oauth/token', {:body => opts, :oauth_request => true})
+
+      end
+
+
+      #
+      # refresh user oauth token.
+      #
+      # @return [Hash] refreshed oauth info
+      def refresh_oauth_token refresh_token
+        post('/oauth/token', {:body => {:grant_type => 'refresh_token', :refresh_token => refresh_token}, :oauth_request => true})
+      end
+
+
+      #
+      # Create new user and get their OAuth token. The user will receive an email asking them to confirm the access being granted. Your app will not be able to perform actions on behalf of this user until they confirm.
+      # @option opts [String] email_address new user email address
+      # @option opts [String] password new user password
+      #
+      # @return [Hash] details about new user, including oath data
+      def oauth_create_account opts
+        opts[:client_id] = self.client_id
+        opts[:client_secret] = self.client_secret
+
+        HelloSign::Resource::Account.new post('/account/create', {:body => opts})
+      end
+    end
+  end
+end

data/lib/hello_sign/api/signature_request.rb

@@ -0,0 +1,286 @@
+module HelloSign
+  module Api
+
+    #
+    # Contains all the api about the SignatureRequest resource.
+    # Take a look at our {https://www.hellosign.com/api/reference#SignatureRequest signature request api document}
+    # for more information about this.
+    #
+    # @author [hellosign]
+    #
+    module SignatureRequest
+
+      #
+      # Retrieves a Signature Request with the given ID.
+      # @option opts [String] signature_request_id The id of the SignatureRequest to retrieve.
+      #
+      # @return [HelloSign::Resource::SignatureRequest] a SignatureRequest object
+      #
+      # @example
+      #   signature_request = @client.get_signature_request :signature_request_id => '75cdf7dc8b323d43b347e4a3614d1f822bd09491'
+      #
+      def get_signature_request opts
+        HelloSign::Resource::SignatureRequest.new get("/signature_request/#{opts[:signature_request_id]}")
+      end
+
+      #
+      # Returns a list of SignatureRequests that you can access. This includes SignatureRequests you have sent as well as received, but not ones that you have been CCed on.
+      # @option opts [Integer] page (1) Which page number of the Template List to return.
+      #
+      # @return [HelloSign::Resource::ResourceArray]
+      #
+      # @example
+      #   signature_requests = @client.get_signature_requests :page => 1
+      #
+      def get_signature_requests opts={}
+        path = '/signature_request/list'
+        path += opts[:page] ? "?page=#{opts[:page]}" : ""
+        HelloSign::Resource::ResourceArray.new get(path, opts), 'signature_requests',  HelloSign::Resource::SignatureRequest
+      end
+
+      #
+      # Creates and sends a new SignatureRequest with the submitted documents.
+      # If form_fields_per_document is not specified, a signature page will be affixed at the end
+      # and all signers will be required to add their signature there.
+      # @option opts [Integer] test_mode (0) Whether this is a test, the signature request will not be legally binding if set to 1.
+      # @option opts [Array<String>] files Use files to indicate the uploaded file(s) to send for signature. Currently we only support use of either the files parameter or file_urls parameter, not both.
+      # @option opts [Array<String>] file_urls Use file_urls to have HelloSign download the file(s) to send for signature. Currently we only support use of either the files parameter or file_urls parameter, not both.
+      # @option opts [String] title The title you want to assign to the SignatureRequest.
+      # @option opts [String] subject The subject in the email that will be sent to the signers.
+      # @option opts [String] message The custom message in the email that will be sent to the signers.
+      # @option opts [String] signing_redirect_url The URL you want the signer redirected to after they successfully sign. (optional)
+      # @option opts [Array<Hash>] signers List of signers, each item is a Hash with these keys:
+      #   * :name (String) Sender' name
+      #   * :email_address (String) Sender's email address
+      #   * :order (Integer) The order the signer is required to sign in
+      #   * :pin (Integer) The 4- to 12-character access code that will secure this signer's signature page. You must have a business plan to use this feature.
+      # @option opts [Array<String>] cc_email_addresses The email addresses that should be CCed.
+      # @option opts [String] form_fields_per_document
+      #
+      # @return [HelloSign::Resource::SignatureRequest] a SignatureRequest
+      #
+      # @example
+      #   signature_request = @client.send_signature_request(
+      #     :test_mode => 1,
+      #     :title => 'NDA with Acme Co.',
+      #     :subject => 'The NDA we talked about',
+      #     :message => 'Please sign this NDA and then we can discuss more. Let me know if you have any questions.',
+      #     :signers => [{
+      #         :email_address => 'jack@example.com',
+      #         :name => 'Jack',
+      #         :order => 0,
+      #       },{
+      #         :email_address => 'jill@example.com',
+      #         :name => 'Jill',
+      #         :order => 1,
+      #       }
+      #     ],
+      #     :cc_email_addresses => ['lawyer@example.com', 'lawyer@example2.com'],
+      #     :files => ['NDA.pdf', 'AppendixA.pdf']
+      #   )
+      #
+
+      def send_signature_request opts
+        prepare_files opts
+        prepare_signers opts
+
+        HelloSign::Resource::SignatureRequest.new post('/signature_request/send', :body => opts)
+      end
+
+      #
+      # Creates and sends a new SignatureRequest based off of the Template specified with the template_id parameter.
+      # @option opts [Integer] test_mode (0) Whether this is a test, the signature request will not be legally binding if set to 1.
+      # @option opts [String] template_id The id of the Template to use when creating the SignatureRequest.
+      # @option opts [String] title The title you want to assign to the SignatureRequest.
+      # @option opts [String] subject The subject in the email that will be sent to the signers.
+      # @option opts [String] message The custom message in the email that will be sent to the signers.
+      # @option opts [String] signing_redirect_url The URL you want the signer redirected to after they successfully sign. (optional)
+      # @option opts [Array<Hash>] signers List of signers
+      #   * :name (String) Sender' name
+      #   * :email_address (String) Sender's email address
+      #   * :order (Integer) The order the signer is required to sign in
+      #   * :pin (Integer) The 4- to 12-character access code that will secure this signer's signature page. You must have a business plan to use this feature.
+      # @option opts [Array<Hash>] ccs The email addresses CC destinations. Required when a CC role exists for the Template.
+      # @option opts [Array<Hash>] custom_fields The value to fill in for the custom field with the name of CustomFieldName. Required when a CustomField exists in the Template.
+      #
+      # @return [HelloSign::Resource::SignatureRequest] a SignatureRequest
+      # @example
+      #  signature_request = @client.send_signature_request_with_template(
+      #    :test_mode => 1,
+      #    :template_id => 'c26b8a16784a872da37ea946b9ddec7c1e11dff6',
+      #    :title => 'Purchase Order',
+      #    :subject => 'Purchase Order',
+      #    :message => 'Glad we could come to an agreement.',
+      #    :signers => [
+      #      {
+      #        :email_address => 'george@example.com',
+      #        :name => 'George',
+      #        :role => 'Client'
+      #      }
+      #    ],
+      #    :ccs => [
+      #      {
+      #        :email_address =>'accounting@example.com',
+      #        :role => "Accounting"
+      #      }
+      #    ],
+      #    :custom_fields => [
+      #    {
+      #      :CustomFieldName => '$20,000'
+      #    }
+      #    ]
+      #  )
+      #
+      def send_signature_request_with_template opts
+        prepare_signers opts
+        prepare_ccs opts
+        HelloSign::Resource::SignatureRequest.new post('/signature_request/send_with_template', :body => opts)
+      end
+
+      #
+      # Sends an email to the signer reminding them to sign the signature request.
+      # @option opts [String] signature_request_id The id of the SignatureRequest to send a reminder for.
+      # @option opts [String] email_address The email address of the signer to send a reminder to.
+      #
+      # @return [HelloSign::Resource::SignatureRequest] a SignatureRequest
+      # @example
+      #   signature_request = @client.remind_signature_request :signature_request_id => '75cdf7dc8b323d43b347e4a3614d1f822bd09491', :email_address => 'john@example.com'
+      #
+      def remind_signature_request opts
+        HelloSign::Resource::SignatureRequest.new post("/signature_request/remind/#{opts[:signature_request_id]}", :body => opts)
+      end
+
+      #
+      # Cancels a SignatureRequest.
+      # @option opts [String] signature_request_id The id of the SignatureRequest to cancel.
+      #
+      # @example
+      #   @client.cancel_signature_request :signature_request_id => '75cdf7dc8b323d43b347e4a3614d1f822bd09491'
+      def cancel_signature_request opts
+        post("/signature_request/cancel/#{opts[:signature_request_id]}", :body => opts)
+      end
+
+      #
+      # Download the PDF copy of the current documents specified by the signature_request_id parameter.
+      # @option opts [String] file_type Either 'pdf' or 'zip' depending on the file type desired. Defaults to pdf.
+      # @option opts [String] signature_request_id The id of the SignatureRequest to retrieve.
+      #
+      # @return a PDF
+      #
+      # @example
+      #   pdf = @client.signature_request_files :signature_request_id => '75cdf7dc8b323d43b347e4a3614d1f822bd09491'
+      #
+      def signature_request_files opts
+        path = "/signature_request/files/#{opts[:signature_request_id]}"
+        if opts[:file_type]
+          path = path + "?file_type=#{opts[:file_type]}"
+        end
+        get(path)
+      end
+
+      #
+      # Creates a new SignatureRequest with the submitted documents to be signed in an embedded iFrame.
+      # If form_fields_per_document is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents.
+      # Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on HelloSign.
+      # @option opts [Integer] test_mode (0) Whether this is a test, the signature request will not be legally binding if set to 1.
+      # @option opts [String] client_id Client id of the app you're using to create this embedded signature request. Visit our  {https://www.hellosign.com/api/reference#Embedded embedded page} page to learn more about this parameter.
+      # @option opts [Array<String>] files Use files to indicate the uploaded file(s) to send for signature. Currently we only support use of either the files parameter or file_urls parameter, not both.
+      # @option opts [Array<String>] file_urls Use file_urls to have HelloSign download the file(s) to send for signature. Currently we only support use of either the files parameter or file_urls parameter, not both.
+      # @option opts [String] title The title you want to assign to the SignatureRequest.
+      # @option opts [String] subject The subject in the email that will be sent to the signers.
+      # @option opts [String] message The custom message in the email that will be sent to the signers.
+      # @option opts [String] signing_redirect_url The URL you want the signer redirected to after they successfully sign. (optional)
+      # @option opts [Array<Hash>] signers List of signers, each item is a Hash with these keys:
+      #   * :name (String) Sender' name
+      #   * :email_address (String) Sender's email address
+      #   * :order (Integer) The order the signer is required to sign in
+      #   * :pin (Integer) The 4- to 12-character access code that will secure this signer's signature page. You must have a business plan to use this feature.
+      # @option opts [Array<String>] cc_email_addresses The email addresses that should be CCed.
+      # @option opts [String] form_fields_per_document
+      #
+      # @return [HelloSign::Resource::SignatureRequest] a SignatureRequest
+      # @example
+      #   request = @client.create_embedded_signature_request(
+      #     :test_mode => 1,
+      #     :client_id => 'b6b8e7deaf8f0b95c029dca049356d4a2cf9710a',
+      #     :title => 'NDA with Acme Co.',
+      #     :subject => 'The NDA we talked about',
+      #     :message => 'Please sign this NDA and then we can discuss more. Let me know if you have any questions.',
+      #     :signers => [{
+      #         :email_address => 'jack@example.com',
+      #         :name => 'Jack',
+      #         :order => 0,
+      #       },{
+      #         :email_address => 'jill@example.com',
+      #         :name => 'Jill',
+      #         :order => 1,
+      #       }
+      #     ],
+      #     :cc_email_addresses => ['lawyer@example.com', 'lawyer@example2.com'],
+      #     :files => ['NDA.pdf', 'AppendixA.pdf']
+      #   )
+      #
+      def create_embedded_signature_request opts
+        opts[:client_id] ||= self.client_id
+        prepare_files opts
+        prepare_signers opts
+
+        HelloSign::Resource::SignatureRequest.new post('/signature_request/create_embedded', :body => opts)
+      end
+
+      #
+      # Creates a new SignatureRequest based on the given Template to be signed in an embedded iFrame.
+      # Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on HelloSign.
+      # @option opts [Integer] test_mode (0) Whether this is a test, the signature request will not be legally binding if set to 1.
+      # @option opts [String] client_id Client id of the app you're using to create this embedded signature request. Visit our  {https://www.hellosign.com/api/reference#Embedded embedded page} page to learn more about this parameter.
+      # @option opts [String] template_id The id of the Template to use when creating the SignatureRequest.
+      # @option opts [String] title The title you want to assign to the SignatureRequest.
+      # @option opts [String] subject The subject in the email that will be sent to the signers.
+      # @option opts [String] message The custom message in the email that will be sent to the signers.
+      # @option opts [String] signing_redirect_url The URL you want the signer redirected to after they successfully sign. (optional)
+      # @option opts [Integer] hide_text_tags Whether or not your text tags hidden after parsing
+      # @option opts [Integer] use_text_tags Whether or not your document contains parseable text-tags
+      # @option opts [Array<Hash>] signers List of signers, each item is a Hash with these keys:
+      #   * :name (String) Sender' name
+      #   * :email_address (String) Sender's email address
+      #   * :order (Integer) The order the signer is required to sign in
+      #   * :pin (Integer) The 4- to 12-character access code that will secure this signer's signature page. You must have a business plan to use this feature.
+      # @option opts [Hash] ccs The email address of the CC filling the role of RoleName. Required when a CC role exists for the Template.
+      # @option opts [Hash] custom_fields The value to fill in for custom field with the name of CustomFieldName. Required when a CustomField exists in the Template.
+      # @return [HelloSign::Resource::SignatureRequest] a SignatureRequest
+      # @example
+      #   request = @client.create_embedded_signature_request_with_template(
+      #     :test_mode => 1,
+      #     :client_id => 'b6b8e7deaf8f0b95c029dca049356d4a2cf9710a',
+      #     :template_id => 'c26b8a16784a872da37ea946b9ddec7c1e11dff6',
+      #     :title => 'Purchase Order',
+      #     :subject => 'Purchase Order',
+      #     :message => 'Glad we could come to an agreement.',
+      #     :signers => [
+      #       {
+      #         :email_address => 'george@example.com',
+      #         :name => 'George',
+      #         :role => 'Client'
+      #       }
+      #     ],
+      #     :ccs => [
+      #       {
+      #         :email_address =>'accounting@example.com',
+      #         :role => "Accounting"
+      #       }
+      #     ],
+      #     :custom_fields => {
+      #       :Cost => '$20,000'
+      #     }
+      #   )
+      #
+      def create_embedded_signature_request_with_template opts
+        opts[:client_id] ||= self.client_id
+        prepare_signers opts
+        prepare_ccs opts
+
+        HelloSign::Resource::SignatureRequest.new post('/signature_request/create_embedded_with_template', :body => opts)
+      end
+    end
+  end
+end