hellosign-ruby-sdk 3.7.0 → 3.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5d224546529e45bbf240730e4c079b9cccf010dd
-  data.tar.gz: 15db47269ee84594c900b3ed9d58716f86bc233b
+  metadata.gz: f0cc3e4f7c32e8b3350b2859e11d67afe4015934
+  data.tar.gz: 61b340752b75b9fca5171b5fc9f7178c591e0f61
 SHA512:
-  metadata.gz: bc509aaec300240195a8901ff3cd6f0569301fb6e5bee023e2908c1ba90d753dfe3b5e3bc17484f55700841b6f2fee3c1df6b810c683b5c153b0b866dfafa441
-  data.tar.gz: 25c883d15ba8404abdfbb00974cf4d57f78881902514c1aef0cd3ee00e75e1836179b8becf161cc1ca5b826e53963ed02a60697d4a5e78ee355066a75fd8dd47
+  metadata.gz: c90e577bee0dc8ecbd2f9875faf53b851ff8eeca7ff126bd3480cdb9b3c082144c1a0c93c81bbf0152a51603540988fd4e12aca0f20ad7e8550d1b75a5de86bc
+  data.tar.gz: eca005244bfe6735a00181d89d855fa6dba5fc7877bd9c1d4c5149667c3ed293dddc0590e44e66495406341a667d0c610c6df10cfcc4dee2142608b6a5d4ca60

data/lib/hello_sign.rb

@@ -1,8 +1,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
@@ -28,9 +28,8 @@ require 'hello_sign/client'
 
 module HelloSign
   extend Configuration
-
   #
-  # # If HelloSign module don't respond_to? method, then delegate it to HelloSign::Client
+  # # If HelloSign module doesn't respond to method, then delegates 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
@@ -41,7 +40,7 @@ module HelloSign
   end
 
   #
-  # If HelloSign module don't respond_to? method, ask HelloSign::Client whether it respond or not
+  # If HelloSign module don't respond to method, asks HelloSign::Client whether it responded or not
   # @param  method [Symbol] method name
   #
   def self.respond_to?(method, include_all=false)

data/lib/hello_sign/api/account.rb

@@ -26,14 +26,13 @@ module HelloSign
   module Api
 
     #
-    # Contains all the api calls for the Account resource.
-    # Take a look at our {https://app.hellosign.com/api/reference#Account account api document}
+    # 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.
       #
@@ -47,7 +46,7 @@ module HelloSign
       end
 
       #
-      # Creates a new HelloSign account. The user will still need to confirm their email address
+      # Creates a new HelloSign account. The user will still need to confirm the email address
       # to complete the creation process.
       #
       # Note: This request does not require authentication.

data/lib/hello_sign/api/api_app.rb

@@ -24,10 +24,9 @@
 
 module HelloSign
   module Api
-
     #
-    # Contains all the api calls for the ApiApp resource.
-    # Take a look at our {https://app.hellosign.com/api/reference#Team team api document}
+    # Contains all the API calls for the ApiApp resource.
+    # Take a look at our API Documentation for ApiApps (https://app.hellosign.com/api/reference#ApiApp)
     # for more information about this.
     #
     # @author [hellosign]
@@ -36,8 +35,9 @@ module HelloSign
 
       #
       # Retrieves information about a specific API App by a given ID
+      # @option opts [String] client_id The Client ID of the ApiApp.
       #
-      # @return [HelloSign::Resource::ApiApp] the API App
+      # @return [HelloSign::Resource::ApiApp] the ApiApp
       #
       # @example
       #   app = @client.get_api_app :client_id => 'fa5c8a0b0f492d768749333ad6fcc214c111e967'
@@ -48,8 +48,8 @@ module HelloSign
 
       #
       # Returns a list of ApiApps that you currently have access to on your account
-      # @option opts [Integer] page (1) Which page number of the list to return.
-      # @option opts [Integer] page_size (5) Number of results for each page
+      # @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]
       #
@@ -65,12 +65,14 @@ module HelloSign
 
       #
       # Creates a new API Application on your account
-      # @option opts [String] name The name you want to assign to the ApiApp.
-      # @option opts [String] domain The domain name the ApiApp will be associated with.
-      # @option opts [String] callback_url (optional) The URL at which the ApiApp should receive event callbacks.
-      # @option opts [String] custom_logo_file (optional) An image file to use as a custom logo in embedded contexts. (Only applies to some API plans)
-      # @option opts [String] oauth[callback_url] (optional) The callback URL to be used for OAuth flows. (Required if oauth[scopes] is provided)
-      # @option opts [String] oauth[scopes] (optional) A comma-separated list of OAuth scopes to be granted to the app. (Required if oauth[callback_url] is provided)
+      # @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 object
       #
@@ -81,14 +83,16 @@ module HelloSign
       end
 
       #
-      # Updates parameters for a specific API Application on your account, referenced by ID
-      # @oprion opts [String] client_id (REQUIRED) The ID of the app you want to update
-      # @option opts [String] name (optional) The name you want to assign to the ApiApp.
-      # @option opts [String] domain (optional) The domain name the ApiApp will be associated with.
-      # @option opts [String] callback_url (optional) The URL at which the ApiApp should receive event callbacks.
-      # @option opts [String] custom_logo_file (optional) An image file to use as a custom logo in embedded contexts. (Only applies to some API plans)
-      # @option opts [String] oauth[callback_url] (optional) The callback URL to be used for OAuth flows. (Required if oauth[scopes] is provided)
-      # @option opts [String] oauth[scopes] (optional) A comma-separated list of OAuth scopes to be granted to the app. (Required if oauth[callback_url] is provided)
+      # Updates settings for a specific ApiApp on your account
+      # @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
       #
@@ -101,10 +105,11 @@ module HelloSign
       end
 
       #
-      # Deletes an API App. Can only be invoked for apps you own.
+      # Deletes an ApiApp. Only available for ApiApps you own.
+      # @option opts [String] client_id The Client ID of the ApiApp you want to delete.
       #
       # @example
-      #   result = @client.delete_api_app :client_id => 'hdialuhfilaudshfa'
+      #   result = @client.delete_api_app :client_id => 'fa5c8a0b0f492d768749333ad6fcc214c111e967'
       def delete_api_app(opts)
         path = '/api_app/' + opts[:client_id]
         delete(path)

data/lib/hello_sign/api/embedded.rb

@@ -24,11 +24,10 @@
 
 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://app.hellosign.com/api/embeddedSigningWalkthrough embedded signing walkthrough}
+    # without the need for the signer/preparer to create a HelloSign account.
+    # Take a look at our Embedded Signing Walkthrough (https://app.hellosign.com/api/embeddedSigningWalkthrough)
     # for more information about this.
     #
     # @author [hellosign]
@@ -36,8 +35,9 @@ module 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
+      # Retrieves the embedded signature sign_url.
+      #
+      # @option opts [String] signature_id The Signature ID to retrieve the embedded sign_url for.
       #
       # @return [HelloSign::Resource::Embedded] Returns an Embedded object
       # @example
@@ -47,11 +47,15 @@ module HelloSign
         HelloSign::Resource::Embedded.new get("/embedded/sign_url/#{opts[:signature_id]}")
       end
       #
-      # Retrieves the edit url for an embedded template.
-      # @option opts [String] template_id The id of the template to get a edit url for
-      # @option opts [Integer] skip_signer_roles Whether editing signer roles should be skipped
-      # @option opts [Integer] skip_subject_message Whether editing subject/message should be skipped
-      # @option opts [Array<Hash>] merge_fields Merge fields that can be placed in the template
+      # Retrieves the edit_url for an embedded template.
+      # @option opts [Boolean] test_mode Indicates if this is a test Embedded Template. A boolean value is also accepted. Defaults to 0. (optional)
+      # @option opts [String] template_id The Template ID to retreive 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] Returns an Embedded object
       # @example

data/lib/hello_sign/api/oauth.rb

@@ -27,18 +27,19 @@ module HelloSign
 
     #
     # 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
+    # For example, you could send signature requests on behalf of your users.
+    # For more information, see our OAuth API documentation (https://app.hellosign.com/api/oauthWalkthrough).
     #
-    # With OAuth, you (the app owner) will be charged for all signature requests sent on behalf of other users via your app.
+    # IMPORTANT: With some OAuth scopes, 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.
+      # Returns the OAuth 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)
@@ -46,12 +47,14 @@ module HelloSign
       end
 
       #
-      # Retrieving the OAuth token
+      # Retrieves 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
+      # @option opts [String] state Random value that was used when you created oauth_url for a specific user.
+      # @option opts [String] code The code passed to your callback when the user granted access.
+      # @option opts [String] client_id The API App Client ID.
+      # @option opts [String] client_secret The secret token of your API App.
       #
-      # @return [Hash] oauth data of the user
+      # @return [Hash] OAuth data of the user
       #
       # @example
       #   client = HelloSign::Client.new :api_key => '%apikey%', :client_id => 'cc91c61d00f8bb2ece1428035716b', :client_secret => '1d14434088507ffa390e6f5528465'
@@ -64,11 +67,11 @@ module HelloSign
       end
 
       #
-      # refresh user oauth token.
+      # Refreshes the user's OAuth token.
       #
-      # @return [Hash] refreshed oauth info
-      # @example
-      #   client = HelloSign::Client.new :api_key => '%apikey%', :client_id => 'cc91c61d00f8bb2ece1428035716b', :client_secret => '1d14434088507ffa390e6f5528465'
+      # @option opts [String] refresh_token The refresh provided when the access token has expired.
+      #
+      # @return [Hash] Refreshed OAuth info
       #
       # @example
       #   client.refresh_oauth_token :refresh_token => 'hNTI2MTFmM2VmZDQxZTZjOWRmZmFjZmVmMGMyNGFjMzI2MGI5YzgzNmE3'
@@ -79,12 +82,16 @@ module HelloSign
         post('/oauth/token', { :body => opts, :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
+      # 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.
+      #
+      # @example
+      #   client.oauth_create_account :email_address => 'new_user@example.com'
       #
-      # @return [Hash] details about new user, including oath data
+      # @return [Hash] details about new user, including OAuth data
       def oauth_create_account(opts)
         opts[:client_id] = self.client_id
         opts[:client_secret] = self.client_secret

data/lib/hello_sign/api/signature_request.rb

@@ -26,8 +26,8 @@ module HelloSign
   module Api
 
     #
-    # Contains all the api about the SignatureRequest resource.
-    # Take a look at our {https://app.hellosign.com/api/reference#SignatureRequest signature request api document}
+    # Contains all the API calls for the SignatureRequest resource.
+    # Take a look at our API Documentation for sending Signature Requests (https://app.hellosign.com/api/reference#SignatureRequest)
     # for more information about this.
     #
     # @author [hellosign]
@@ -37,7 +37,6 @@ module HelloSign
       #
       # Retrieves a Signature Request with the given ID.
       # @option opts [String] signature_request_id The id of the SignatureRequest to retrieve.
-      # @option opts [Integer] ux_version sets the version of the signer page to use
       #
       # @return [HelloSign::Resource::SignatureRequest] a SignatureRequest object
       #
@@ -52,10 +51,11 @@ module HelloSign
       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[:page] [Integer] page (1) Which page number of the Template List to return.
-      # @option opts[:ux_version] [Integer] ux_version sets the version of the signer page to use
-      # @option opts[:query] [String] query string to search on, such as "title:Field Trip Release AND from:me"
+      # 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 CC'd on.
+      # @option opts [String] account_id Indicates which account to return SignatureRequests for. Defaults to your account. (optional)
+      # @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 SignatureRequests returned per page. Defaults to 20. (optional)
+      # @option opts [String] query Search terms and/or fields to filter the SignatureRequests. (optional)
       #
       # @return [HelloSign::Resource::ResourceArray]
       #
@@ -72,23 +72,33 @@ module HelloSign
 
       #
       # 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
+      # If form_fields_per_document is not specified or use_text_tags is not enabled, 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 [Boolean] test_mode Indicates if this is a test SignatureRequest, it will not be legally binding if set to 1. A boolean value is also accepted. Defaults to 0. (optional)
+      # @option opts [Array<String>] files Specified file path(s) to upload 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 URL(s) for HelloSign to 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. (optional)
+      # @option opts [String] subject The subject in the email that will be sent to the signer(s). (optional)
+      # @option opts [String] message The custom message in the email that will be sent to the signer(s). (optional)
+      # @option opts [String] signing_redirect_url The URL you want the signer(s) 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 [Array<Hash>] custom_fields An array of custom merge fields, representing those present on the document with Text Tags.
-      # @option opts [String] form_fields_per_document
+      #   * :name (String) Signer's name
+      #   * :email_address (String) Signer's email address
+      #   * :order (Integer) The order the signers are required to sign in (optional)
+      #   * :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. (optional)
+      # @option opts [Array<Hash>] custom_fields An array of custom merge fields, representing those present on the document with Text Tags or form_fields_per_document (optional)
+      #   * :name (String) Custom field name or "Field Label"
+      #   * :value (String) The value of the field. This data will appear on the SignatureRequest.
+      #   * :editor (String) The signer name indicated on the Text Tag or form_fields_per_document that can edit the value of the field. (optional)
+      #   * :required (Boolean) Determines if the field is required or not. (optional)
+      # @option opts [Array<String>] cc_email_addresses The email addresses that should be CCed on the SignatureRequest. (optional)
+      # @option opts [Boolean] use_text_tags Indicates whether the SignatureRequest should have Text Tags enabled. Defaults to 0. (optional)
+      # @option opts [Boolean] hide_text_tags Indicates whether the Text Tags should be removed automatically. Note that this is not the preferred method. Defaults to 0. (optional)
+      # @option opts [Hash] metadata Key-value data attached to the SignatureRequest. (optional)
+      # @option opts [String] client_id The API App Client ID associated with the SignatureRequest. (optional)
+      # @option opts [Boolean] allow_decline Allows signers to decline the SignatureRequest. Defaults to 0. (optional)
+      # @option opts [Boolean] allow_reassign Allows signers to reassign the SignatureRequest to another signer. Defaults to 0. (optional)
+      # @option opts [Array<Hash>] form_fields_per_document The fields that should appear on the document. (optional)
       #
       # @return [HelloSign::Resource::SignatureRequest] a SignatureRequest
       #
@@ -114,7 +124,31 @@ module HelloSign
       #       }
       #     ],
       #     :cc_email_addresses => ['lawyer@example.com', 'lawyer@example2.com'],
-      #     :files => ['NDA.pdf', 'AppendixA.pdf']
+      #     :files => ['NDA.pdf', 'AppendixA.pdf'],
+      #     :form_fields_per_document => [
+            #   [
+            #     {
+            #       "name": "address",
+            #       "type": "text",
+            #       "x": 160,
+            #       "y": 80,
+            #       "width": 206,
+            #       "height": 32,
+            #       "signer": 0
+            #     }
+            #   ],
+            #   [
+            #     {
+            #       "name": "phone",
+            #       "type": "text",
+            #       "x": 160,
+            #       "y": 150,
+            #       "width": 206,
+            #       "height": 32,
+            #       "signer": 1
+            #       }
+            #   ]
+            # ]
       #   )
       #
 
@@ -129,22 +163,30 @@ module HelloSign
 
       #
       # 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 [Boolean] test_mode Indicates if this is a test SignatureRequest, it will not be legally binding if set to 1. A boolean value is also accepted. Defaults to 0. (optional)
+      # @option opts [String] template_id The Template ID to use when creating the SignatureRequest.
+      #   * Use template_ids[%i%] if using multiple templates, replacing %i% with an integer to indicate the order of the Templates
+      # @option opts [String] title The title you want to assign to the SignatureRequest. (optional)
+      # @option opts [String] subject The subject in the email that will be sent to the signer(s). (optional)
+      # @option opts [String] message The custom message in the email that will be sent to the signer(s). (optional)
+      # @option opts [String] signing_redirect_url The URL you want the signer(s) 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 [Hash] custom_fields (deprecated) The value to fill in for the custom field with the name of CustomFieldName.
-      # @option opts [Array<Hash>] custom_fields An array of custom merge fields, representing those present in the template. Only specify this when NOT specifying custom_fields by hash (the old way).
-      # @option opts [Integer] ux_version sets the version of the signer page to use
-      #
+      #   * :role (String) The signer role indicated on the Template. Note that the role name is case sensitive.
+      #   * :name (String) Signer's name
+      #   * :email_address (String) Signer's email address
+      #   * :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. (optional)
+      # @option opts [Array<Hash>] ccs The individual(s) to be CC'd on the SignatureRequest. Required when a CC role exists for the Template.
+      #   * :role (String) The CC role indicated on the Template. Note that the role name is case sensitive.
+      #   * :email_address (String) CC Recipient's email address
+      # @option opts [Array<Hash>] custom_fields An array of custom merge fields, representing those present in the Template. (optional)
+      #   * :name (String) Custom field name or "Field Label"
+      #   * :value (String) The value of the field. This data will appear on the SignatureRequest.
+      #   * :editor (String) The signer name indicated on the Text Tag or form_fields_per_document that can edit the value of the field. (optional)
+      #   * :required (Boolean) Determines if the field is required or not. (optional)
+      # @option opts [Hash] metadata Key-value data attached to the SignatureRequest. (optional)
+      # @option opts [String] client_id The API App Client ID associated with the SignatureRequest. (optional)
+      # @option opts [Array<String>] files Use files to indicate the uploaded file(s) to append to the SignatureRequest. (optional)
+      # @option opts [Array<String>] file_urls Use file_urls to have HelloSign download the file(s) to append to the SignatureRequest. (optional)
       # @return [HelloSign::Resource::SignatureRequest] a SignatureRequest
       # @example
       #  signature_request = @client.send_signature_request_with_template(
@@ -200,10 +242,11 @@ module HelloSign
       #        :role => "Accounting"
       #      }
       #    ],
-      #    :custom_fields =>
-      #    {
-      #      :CustomFieldName => '$20,000'
-      #    }
+      #    :custom_fields => [
+      #     {
+      #       :CustomFieldName => '$20,000'
+      #     }
+      #   ]
       #  )
       #
       def send_signature_request_with_template(opts)
@@ -218,9 +261,9 @@ module HelloSign
 
       #
       # 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.
-      # @option opts [Integer] ux_version sets the version of the signer page to use
+      # @option opts [String] signature_request_id Indicates the ID of the SignatureRequest to send a reminder.
+      # @option opts [String] email_address The email address of the signer who will receive a reminder.
+      # @option opts [String] name The name of the signer who will receive a reminder. (optional)
       #
       # @return [HelloSign::Resource::SignatureRequest] a SignatureRequest
       # @example
@@ -232,7 +275,7 @@ module HelloSign
 
       #
       # Cancels a SignatureRequest.
-      # @option opts [String] signature_request_id The id of the SignatureRequest to cancel.
+      # @option opts [String] signature_request_id The ID of the incomplete SignatureRequest to cancel.
       #
       # @example
       #   @client.cancel_signature_request :signature_request_id => '75cdf7dc8b323d43b347e4a3614d1f822bd09491'
@@ -242,7 +285,7 @@ module HelloSign
 
       #
       # Removes your access to a completed a SignatureRequest.
-      # @option opts [String] signature_request_id The id of the SignatureRequest to remove.
+      # @option opts [String] signature_request_id The ID of the completed SignatureRequest to remove access.
       #
       # @example
       #   @client.remove_signature_request :signature_request_id => '75cdf7dc8b323d43b347e4a3614d1f822bd09491'
@@ -251,12 +294,12 @@ module HelloSign
       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] get_url Boolean. If true, the response will contain a url link to the file instead. Links are only available for PDFs and have a TTL of 3 days.Either 'pdf' or 'zip' depending on the file type desired. Defaults to false.
-      # @option opts [String] signature_request_id The id of the SignatureRequest to retrieve.
+      # Download a copy of the SignatureRequest documents specified by the signature_request_id parameter.
+      # @option opts [String] signature_request_id The ID of the SignatureRequest to download.
+      # @option opts [String] file_type Determines the format of the file - either 'pdf' or 'zip' depending on the file type desired. Defaults to pdf. (optional)
+      # @option opts [Boolean] get_url Response contains a URL link to the file if set to true. Links are only available for PDFs and have a TTL of 3 days. Defaults to false. (optional)
       #
-      # @return a PDF
+      # @return a PDF or Zip
       #
       # @example
       #   pdf = @client.signature_request_files :signature_request_id => '75cdf7dc8b323d43b347e4a3614d1f822bd09491'
@@ -275,25 +318,34 @@ module HelloSign
 
       #
       # 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://app.hellosign.com/api/reference#Embedded embedded page} page to learn more about this parameter.
+      # If form_fields_per_document is not specified or use_text_tags is not enabled, a signature page will be affixed at the end
+      # and all signers will be required to add their signature there.
+      # Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on HelloSign.com.
+      # See our Embedded Signing Walkthrough for more information on Embedded Signing: https://app.hellosign.com/api/embeddedSigningWalkthrough
+      # @option opts [Boolean] test_mode Indicates if this is a test SignatureRequest, it will not be legally binding if set to 1. A boolean value is also accepted. Defaults to 0. (optional)
+      # @option opts [String] client_id The API App Client ID associated with the this embedded SignatureRequest.
       # @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 [String] title The title you want to assign to the SignatureRequest. (optional)
+      # @option opts [String] subject The subject in the email that will be sent to the signer(s). (optional)
+      # @option opts [String] message The custom message in the email that will be sent to the signer(s). (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 [Array<Hash>] custom_fields An array of custom merge fields, representing those present on the document with Text Tags.
-      # @option opts [String] form_fields_per_document
-      # @option opts [Integer] ux_version sets the version of the signer page to use
+      #   * :name (String) Signer's name
+      #   * :email_address (String) Signer's email address
+      #   * :order (Integer) The order the signers are required to sign in (optional)
+      #   * :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. (optional)
+      # @option opts [Array<Hash>] custom_fields An array of custom merge fields, representing those present on the document with Text Tags or form_fields_per_document (optional)
+      #   * :name (String) Custom field name or "Field Label"
+      #   * :value (String) The value of the field. This data will appear on the SignatureRequest
+      #   * :editor (String) The signer name indicated on the Text Tag or form_fields_per_document that can edit the value of the field. (optional)
+      #   * :required (Boolean) Determines if the field is required or not. (optional)
+      # @option opts [Array<String>] cc_email_addresses The email addresses that should be CCed on the SignatureRequest. (optional)
+      # @option opts [Boolean] use_text_tags Indicates whether the SignatureRequest should have Text Tags enabled. Defaults to 0. (optional)
+      # @option opts [Boolean] hide_text_tags Indicates whether the Text Tags should be removed automatically. Note that this is not the preferred method. Defaults to 0. (optional)
+      # @option opts [Hash] metadata Key-value data attached to the SignatureRequest. (optional)
+      # @option opts [Boolean] allow_decline Allows signers to decline the SignatureRequest. Defaults to 0. (optional)
+      # @option opts [Boolean] allow_reassign Allows signers to reassign the SignatureRequest to another signer. Defaults to 0. (optional)
+      # @option opts [Array<Hash>] form_fields_per_document The fields that should appear on the document. (optional)
       #
       # @return [HelloSign::Resource::SignatureRequest] a SignatureRequest
       # @example
@@ -335,24 +387,29 @@ module HelloSign
       #
       # 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://app.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 (deprecated) The value to fill in for custom field with the name of CustomFieldName.
-      # @option opts [Array<Hash>] custom_fields An array of custom merge fields, representing those present in the template. Only specify this when NOT specifying custom_fields by hash (the old way)
-      # @option opts [Integer] ux_version sets the version of the signer page to use
+      # @option opts [Boolean] test_mode Indicates if this is a test SignatureRequest, it will not be legally binding if set to 1. A boolean value is also accepted. Defaults to 0. (optional)
+      # @option opts [String] client_id The API App Client ID associated with the this embedded SignatureRequest.
+      # @option opts [String] template_id The Template ID to use when creating the SignatureRequest.
+      #   * Use template_ids[%i%] if using multiple templates, replacing %i% with an integer to indicate the order of the Templates
+      # @option opts [String] title The title you want to assign to the SignatureRequest. (optional)
+      # @option opts [String] subject The subject in the email that will be sent to the signer(s). (optional)
+      # @option opts [String] message The custom message in the email that will be sent to the signer(s). (optional)
+      # @option opts [Array<Hash>] signers List of signers
+      #   * :role (String) The signer role indicated on the Template. Note that the role name is case sensitive.
+      #   * :name (String) Signer's name
+      #   * :email_address (String) Signer's email address
+      #   * :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. (optional)
+      # @option opts [Array<Hash>] ccs The individual(s) to be CC'd on the SignatureRequest. Required when a CC role exists for the Template.
+      #   * :role (String) The CC role indicated on the Template. Note that the role name is case sensitive.
+      #   * :email_address (String) CC Recipient's email address
+      # @option opts [Array<Hash>] custom_fields An array of custom merge fields, representing those present in the Template. (optional)
+      #   * :name (String) Custom field name or "Field Label"
+      #   * :value (String) The value of the field. This data will appear on the SignatureRequest.
+      #   * :editor (String) The signer name indicated on the Text Tag or form_fields_per_document that can edit the value of the field. (optional)
+      #   * :required (Boolean) Determines if the field is required or not. (optional)
+      # @option opts [Hash] metadata Key-value data attached to the SignatureRequest. (optional)
+      # @option opts [Array<String>] files Use files to indicate the uploaded file(s) to append to the SignatureRequest. (optional)
+      # @option opts [Array<String>] file_urls Use file_urls to have HelloSign download the file(s) to append to the SignatureRequest. (optional)
       #
       # @return [HelloSign::Resource::SignatureRequest] a SignatureRequest
       # @example
@@ -398,6 +455,19 @@ module HelloSign
         HelloSign::Resource::SignatureRequest.new post('/signature_request/create_embedded_with_template', :body => opts)
       end
 
+      #
+      # Updates the email address on a SignatureRequest.
+      # @option opts [String] signature_request_id The ID of the SignatureRequest to update.
+      # @option opts [String] signature_id The Signature ID of the recipient to update.
+      # @option opts [String] email_address The new email address of the recipient.
+      #
+      # @example
+      #   @client.update_signature_request(
+      #   :signature_request_id => '75cdf7dc8b323d43b347e4a3614d1f822bd09491',
+      #   :signature_id => '5064ca698bde9581ad75f6d62450eb4b',
+      #   :email_address => 'newEmail@example.com'
+      #   )
+
       def update_signature_request(opts)
         signature_request_id = opts.delete(:signature_request_id)
         path = "/signature_request/update/#{signature_request_id}"