hellosign-ruby-sdk 3.7.0 → 3.7.1

data/lib/hello_sign/api/team.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
@@ -24,16 +24,14 @@
 
 module HelloSign
   module Api
-
     #
-    # Contains all the api calls for the Team resource.
-    # Take a look at our {https://app.hellosign.com/api/reference#Team team api document}
+    # Contains all the API calls for the Team resource.
+    # Take a look at our API Documentation on the Team Resource (https://app.hellosign.com/api/reference#Team)
     # for more information about this.
     #
     # @author [hellosign]
     #
     module Team
-
       #
       # Returns information about your Team as well as a list of its members.
       # If you do not belong to a Team, HelloSign::Error::NotFound will be raised
@@ -48,9 +46,9 @@ module HelloSign
 
       #
       # Creates a new Team and makes you a member. You must not currently belong to a Team to invoke.
-      # @option opts [String] name The name of your Team
+      # @option opts [String] name The name of the Team.
       #
-      # @return [HelloSign::Resource::Team] new created Team
+      # @return [HelloSign::Resource::Team] new created Team object
       #
       # @example
       #   team = @client.create_team :name => 'Team America World Police'
@@ -60,7 +58,7 @@ module HelloSign
 
       #
       # Updates the name of your Team.
-      # @option opts [String] name The name of your Team
+      # @option opts [String] name The name of your Team.
       #
       # @return [HelloSign::Resource::Team] a Team object
       #
@@ -71,7 +69,7 @@ module HelloSign
       end
 
       #
-      # Deletes your Team. Can only be invoked when you have a Team with only one member (yourself).
+      # Deletes your Team. Can only be invoked with a Team with one member (yourself).
       #
       # @example
       #   team = @client.destroy_team
@@ -80,12 +78,13 @@ module HelloSign
       end
 
       #
-      # Adds or invites a user (specified using the email_address parameter) to your Team.
+      # Adds or invites a user (specified using the email_address parameter) to the Team.
       # If the user does not currently have a HelloSign Account, a new one will be created for them.
-      # If the user currently has a paid subscription, they will not automatically join the Team but instead will be sent an invitation to join.
-      # If a user is already a part of another Team, a "team_invite_failed" error will be returned.
-      # @option opts [String] account_id The id of the Account of the user to invite to your Team. The account id prevails if both email_address and acccount_id are provided.
-      # @option opts [String] email_address The email address of the Account of the user to invite to your Team. The account id prevails if both email_address and acccount_id are provided.
+      # If the user currently has a paid subscription, they will be emailed an invitation to join the Team.
+      # If a user is already a part of a Team, a "team_invite_failed" error will be returned.
+      # @option opts [String] account_id The user's Account ID to invite to the Team.
+      # @option opts [String] email_address The user's email address to invite to your Team.
+      # Note: The account_id prevails if both email_address and acccount_id are provided.
       #
       # @return [HelloSign::Resource::Team] updated Team object
       #
@@ -95,11 +94,12 @@ module HelloSign
         HelloSign::Resource::Team.new post('/team/add_member', :body => opts)
       end
 
-
       #
-      # Removes a user from your Team. If the user had an outstanding invitation to your Team the invitation will be expired.
-      # @option opts [String] account_id The id of the Account of the user to invite to your Team. The account id prevails if both email_address and acccount_id are provided.
-      # @option opts [String] email_address The email address of the Account of the user to invite to your Team. The account id prevails if both email_address and acccount_id are provided.
+      # Removes a user from the Team. If the user had an outstanding invitation to your Team, the original invitation will expire.
+      # @option opts [String] account_id The user's Account ID to remove from the Team.
+      # @option opts [String] email_address The user's email address to remove from your Team.
+      # @option opts [String] new_owner_email_address The Account's email address to receive all documents, API Apps (if applicable), and API key from removed account. (optional)
+      # Note: The account_id prevails if both email_address and acccount_id are provided.
       #
       # @return [HelloSign::Resource::Team] updated Team object
       # @example

data/lib/hello_sign/api/template.rb

@@ -26,8 +26,8 @@ module HelloSign
   module Api
 
     #
-    # Contains all the api calls for the Template resource.
-    # Take a look at our {https://app.hellosign.com/api/embeddedTemplatesWalkthrough template form api document}
+    # Contains all the API calls for the Template resource.
+    # Take a look at our API Documentation for Templates (https://app.hellosign.com/api/reference#Template)
     # for more information about this.
     #
     # @author [hellosign]
@@ -36,7 +36,7 @@ module HelloSign
 
       #
       # Retrieves the Template specified by the id parameter.
-      # @option opts [String] template_id The id of the Template to retrieve.
+      # @option opts [String] template_id The Template ID to retrieve.
       #
       # @return [HelloSign::Resource::Template] a Template object
       #
@@ -48,20 +48,23 @@ module HelloSign
       end
 
       #
-      # Deletes the Template specified by the id parameter.
-      # @option opts [String] template_id The id of the Template to delete.
-      ##
+      # Deletes the specified Template.
+      # @option opts [String] template_id The Template ID to delete.
+      #
       # @example
-      #   template = @client.get_template :template_id => 'f57db65d3f933b5316d398057a36176831451a35'
+      #   template = @client.delete_template :template_id => 'f57db65d3f933b5316d398057a36176831451a35'
       #
       def delete_template(opts)
         post("/template/delete/#{opts[:template_id]}")
       end
 
       #
-      # Retrieves the Templates for the current user account.
+      # Retrieves the Templates for the accessible by the current user.
       #
-      # @option opts [Integer] page (1) Which page number of the Template List to return.
+      # @option opts [String] acount_id The Account ID to return Templates for and must be a team member. Use "all" for all team members. Defaults to current 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 Templates returned per page. Defaults to 20. (optional)
+      # @option opts [String] query Search terms and/or fields to filter the Templates. (optional)
       #
       # @return [HelloSign::Resource::ResourceArray] a ResourceArray object
       # @example
@@ -75,11 +78,12 @@ module HelloSign
       end
 
       #
-      # Gives the specified Account on your team access to a Template
+      # Gives the specified Account access to a Template. The Account must be part of your Team.
       #
-      # @option opts [String] template_id The id of the Template to give access to.
-      # @option opts [String] account_id The id of the Account to get access. The account_id prevails if account_id and email_address are both provided.
-      # @option opts [String] email_address The email address of the Account to give access to the Template. The account_id prevails if account_id and email_address are both provided.
+      # @option opts [String] template_id The Template ID to give access to.
+      # @option opts [String] account_id The Account ID to receive access to the Template.
+      # @option opts [String] email_address The email address of the Account to receive access to the Template.
+      # Note: The account_id prevails if both email_address and acccount_id are provided.
       #
       # @return [Template] a Template object
       # @example
@@ -92,11 +96,12 @@ module HelloSign
       end
 
       #
-      # Removes the specified Account's access to the specified Template.
-      # The user can be designated using their account ID or email address.
-      # @option opts [String] template_id The id of the Template to remove the Account access to.
-      # @option opts [String] account_id The id of the Account to remove access to the Template. The account_id prevails if account_id and email_address are both provided.
-      # @option opts [String] email_address The email address of the Account to remove access to the Template. The account_id prevails if account_id and email_address are both provided.
+      # Removes the specified Account access to the specified Template.
+      #
+      # @option opts [String] template_id The Template ID to remove access to.
+      # @option opts [String] account_id The Account ID to remove access to the Template.
+      # @option opts [String] email_address The email address of the Account to remove access to the Template.
+      # Note: The account_id prevails if both email_address and acccount_id are provided.
       #
       # @return [Template] a Template object
       # @example
@@ -109,21 +114,25 @@ module HelloSign
       end
 
       #
-      # Creates a new embedded template draft object that can be launched in an iframe using the claim URL.
-      # @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 default template email subject.
-      # @option opts [String] subject The subject in the email that will be sent to the signers.
-      # @option opts [String] requester_email_address The email address of the requester.
-      # @option opts [String] message The custom message in the email that will be sent to the signers.
-      # @option opts [Array<Hash>] signers List of signer_roles, each item is a Hash with these keys:
-      #   * :name (String) signer's role name
-      #   * :order (Integer) The order the signer is required to sign in (optional)
-      # @option opts [Array<Hash>] cc_roles The email addresses CC roles. Will mean the CC role will be Required when sending the template.
-      # @option opts [Array<Hash>] merge_fields List of fields that can be pre-populated by your application when using the resulting template to send a signature request
-      #   * :name (String) merge field name
-      #   * :type (String) <text|checkbox>
+      # Creates a new embedded template draft object that can be launched in an iFrame using the claim_url.
+      # @option opts [Boolean] test_mode Indicates if this is a test Template draft. SignatureRequests using this Template will not be legally binding if set to 1. Defaults to 0. (optional)
+      # @option opts [String] client_id The API App Client ID associated with the Template draft. (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 default Template title. (optional)
+      # @option opts [String] subject The default Template title alias. (optional)
+      # @option opts [String] message The default message in the email that will be sent to the signer(s). (optional)
+      # @option opts [Array<Hash>] signers List of signers displayed when the Template is used to create a SignatureRequest
+      #   * :name (String) Signer role name
+      #   * :order (Integer) The order the signer role is required to sign in. (optional)
+      # @option opts [Array<Hash>] cc_roles The CC roles that must be assigned when using the 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 Template to send a SignatureRequest. (optional)
+      #   * :name (String) Merge field name
+      #   * :type (String) Field type - either "text" or "checkbox"
+      # @option opts [Boolean] skip_me_now Sets the "Me (Now)" option for the Template preparer. Defaults to 0. (optional)
+      # @option opts [Boolean] use_preexisting_fields Sets the detection of predefined PDF fields. Defaults to 0. (optional)
+      # @option opts [Hash] metadata Key-value data attached to the Template and all SignatureRequests created from the Template. (optional)
+      # @option opts [Boolean] allow_reassign Sets the ability for signers to reassign the SignatureRequest to other signers. Defaults to 0. (optional)
       #
       # @example create_embedded_draft
       #   template_draft = @client.create_embedded_template_draft(
@@ -158,6 +167,17 @@ module HelloSign
         HelloSign::Resource::TemplateDraft.new post("/template/create_embedded_draft", :body => opts)
       end
 
+      #
+      # Downloads the original files of a specified Template.
+      #
+      # @option opts [String] template_id The Template ID to retrieve.
+      # @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 or Zip
+      # @example
+      #   templates = @client.get_template_files :template_id => 'f57db65d3f933b5316d398057a36176831451a35', :file_type => 'zip'
+      #
       def get_template_files(opts)
         path = "/template/files/#{opts[:template_id]}"
         if opts[:file_type]
@@ -171,6 +191,21 @@ module HelloSign
         get(path)
       end
 
+      #
+      # Overlays a new file with the overlay of the specified Template.
+      #
+      # @option opts [String] template_id The Template ID to update.
+      # @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] subject The updated default Template title alias. (optional)
+      # @option opts [String] message The updated default message in the email that will be sent to the signer(s). (optional)
+      # @option opts [String] client_id The API App Client ID associated with the Template draft. (optional)
+      # @option opts [Boolean] test_mode Indicates if this is a test Template draft. SignatureRequests using this Template will not be legally binding if set to 1. Defaults to 0. (optional)
+      #
+      # @return a Template ID
+      # @example
+      #   templates = @client.update_template_files :template_id => 'f57db65d3f933b5316d398057a36176831451a35', :file => '@NDA.pdf'
+      #
       def update_template_files(opts)
         template_id = opts.delete(:template_id)
         path = "/template/update_files/#{template_id}"

data/lib/hello_sign/api/unclaimed_draft.rb

@@ -25,47 +25,52 @@
 module HelloSign
   module Api
 
-    #
-    # Contains all the api calls for the UnclaimedDraft resource.
-    # Take a look at our {https://app.hellosign.com/api/reference#UnclaimedDraft unclaimed draft document}
-    # for more information about this.
-    #
-    # @author [hellosign]
-    #
-    module UnclaimedDraft
-
       #
-      # Creates a new Draft that can be claimed using the claim URL.
-      # The first authenticated user to access the URL will claim the Draft and will be shown either the "Sign and send" or the "Request signature" page with the Draft loaded.
-      # Subsequent access to the claim URL will result in a 404 not found.
-      # If the type is "send_document" then only the file parameter is required.
-      # If the type is "request_signature", then the identities of the signers and optionally
-      # the location of signing elements on the page are also required.
-      # @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] type The type of unclaimed draft to create. Use "send_document" to create a claimable file, and "request_signature" for a claimable signature request. If the type is "request_signature" then signers name and email_address are not optional.
-      # @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)
+      # Contains all the API calls for the UnclaimedDraft resource.
+      # Take a look at our API documentation for creating UnclaimedDrafts (https://app.hellosign.com/api/reference#UnclaimedDraft)
+      # for more information about this.
+      #
+      # @author [hellosign]
+      #
+      module UnclaimedDraft
+
       #
-      # @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 (optional)
-      #   * :pin (Integer) The 4-digit code that will secure this signer's signature page. You must have a business plan to use this feature. (optional)
-      # @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
+      # Creates a new UnclaimedDraft that can be claimed using the claim_url.
+      # The first authenticated user to access the claim_url claims the Draft and will be shown either the "Sign and send" or the "Request signature" page with the Draft loaded.
+      # Subsequent access to the claim_url will result in a 404 not found error.
+      # @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] type The type of UnclaimedDraft to create. Use "send_document" to create a claimable file, and "request_signature" for a claimable signature request.
+      #   * For "send_document," only the file parameter is required.
+      #   * For "request_signature," then signer name and email_address are required.
+      # @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: (optional)
+      #   * :name (String) Signer's name
+      #   * :email_address (String) Signer's email address
+      #   * :order (Integer) The order the signers are required to sign in (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.
+      # @option opts [Array<String>] cc_email_addresses The email addresses that should be CCed. (optional)
+      # @option opts [String] signing_redirect_url The URL you want the signer(s) redirected to after they successfully sign. (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 [Boolean] use_preexisting_fields Sets the detection of predefined PDF fields. 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::UnclaimedDraft] a UnclaimedDraft object
+      # @return [HelloSign::Resource::UnclaimedDraft] an UnclaimedDraft object
       #
-      # @example send_document
+      # @example type: send_document
       #   unclaimed_draft = @client.create_unclaimed_draft(
       #     :test_mode => 1,
       #     :files => ['NDA.pdf', 'AppendixA.pdf']
       #   )
-      # @example request_signature
+      # @example type: request_signature
       #   unclaimed_draft = @client.create_unclaimed_draft(
       #     :test_mode => 1,
       #     :type => 'request_signature',
@@ -102,26 +107,37 @@ module HelloSign
       end
 
       #
-      # Creates a new embedded unclaimed draft object that can be launched in an iframe using the claim URL.
-      # @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 [Integer] is_for_embedded_signing set this to 1 to to mix embedded requesting and embedded signing.
-      # @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] type The type of unclaimed draft to create. Should be "request_signature" for a claimable signature request. If the type is "request_signature" then signers name and email_address are not optional.
-      # @option opts [String] subject The subject in the email that will be sent to the signers.
-      # @option opts [String] requester_email_address The email address of the requester.
-      # @option opts [String] message The custom message in the email that will be sent to the signers.
+      # Creates a new Embedded UnclaimedDraft object that can be launched in an iFrame using the claim_url.
+      # @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 UnclaimedDraft.
+      # @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] requester_email_address The email address of the requester, if "request_signature" type.
+      # @option opts [String] type The type of UnclaimedDraft to create. Use "send_document" to create a claimable file, and "request_signature" for a claimable signature request.
+      #   * For "send_document," only the file parameter is required.
+      #   * For "request_signature," then signer name and email_address are required.
+      # @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: (optional)
+      #   * :name (String) Signer's name
+      #   * :email_address (String) Signer's email address
+      #   * :order (Integer) The order the signers are required to sign in (optional)
+      # @option opts [Array<String>] cc_email_addresses The email addresses that should be CCed. (optional)
       # @option opts [String] signing_redirect_url The URL you want the signer redirected to after they successfully sign. (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.
+      # @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 [Boolean] use_preexisting_fields Sets the detection of predefined PDF fields. Defaults to 0. (optional)
+      # @option opts [Boolean] is_for_embedded_signing Enable the UnclaimedDraft to be used for an Embedded SignatureRequest. Defaults to 0. (optional)
+      # @option opts [Boolean] skip_me_now Disables the "Me (Now)" option for the preparer. Not available for type "send_document." 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)
       #
-      # @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 (optional)
-      #   * :pin (Integer) The 4-digit code that will secure this signer's signature page. You must have a business plan to use this feature. (optional)
-      # @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.
-      #
-      # @return [HelloSign::Resource::UnclaimedDraft] a UnclaimedDraft object
+      # @return [HelloSign::Resource::UnclaimedDraft] an UnclaimedDraft object
       #
       # @example request_signature
       #   unclaimed_draft = @client.create_embedded_unclaimed_draft(
@@ -152,7 +168,7 @@ module HelloSign
         opts[:client_id] ||= self.client_id
         prepare_files opts
         prepare_custom_fields opts
-        
+
         if opts[:type] == 'request_signature' || opts[:type] == 'send_document'
           prepare_signers opts
         end
@@ -160,23 +176,36 @@ module HelloSign
         HelloSign::Resource::UnclaimedDraft.new post('/unclaimed_draft/create_embedded', :body => opts)
       end
 
-
       #
-      # Creates a new embedded unclaimed draft object from a template that can be launched in an iframe using the claim URL.
-      # @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] subject The subject in the email that will be sent to the signers.
-      # @option opts [String] requester_email_address The email address of the requester.
-      # @option opts [String] message The custom message in the email that will be sent to the signers.
+      # Creates a new Embedded UnclaimedDraft object from a Template that can be launched in an iFrame using the claim_url.
+      # @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 UnclaimedDraft.
+      # @option opts [String] template_id The Template ID to use when creating the UnclaimedDraft.
+      #   * Use template_ids[%i%] if using multiple templates, replacing %i% with an integer to indicate the order of the Templates
+      # @option opts [String] requester_email_address The email address of the requester, if "request_signature" type.
+      # @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
+      # @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 [String] signing_redirect_url The URL you want the signer redirected to after they successfully sign. (optional)
+      # @option opts [String] requesting_redirect_url The URL you want the requester redirected to after they successfully request a SignatureRequest. (optional)
+      # @option opts [Hash] metadata Key-value data attached to the SignatureRequest. (optional)
+      # @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.
+      # @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)
+      # @option opts [Boolean] skip_me_now Disables the "Me (Now)" option for the preparer. Not available for type "send_document." Defaults to 0. (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>] 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 (optional)
-      #   * :pin (Integer) The 4-digit code that will secure this signer's signature page. You must have a business plan to use this feature. (optional)
-      # @option opts [Array<String>] cc_email_addresses The email addresses that should be CCed.
-      #
-      # @return [HelloSign::Resource::UnclaimedDraft] a UnclaimedDraft object
+      # @return [HelloSign::Resource::UnclaimedDraft] an UnclaimedDraft object
       #
       # @example request_signature
       #   unclaimed_draft = @client.create_embedded_unclaimed_draft_with_template(
@@ -218,6 +247,25 @@ module HelloSign
         HelloSign::Resource::UnclaimedDraft.new post('/unclaimed_draft/create_embedded_with_template', :body => opts)
       end
 
+      #
+      # Creates a new SignatureRequest from an Embedded UnclaimedDraft. This UnclaimedDraft can be
+      # edited using the claim_url.
+      # @option opts [String] signature_request_id The SignatureRequest ID to edit and resend.
+      # @option opts [String] client_id The API App Client ID associated with the UnclaimedDraft.
+      # @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] requesting_redirect_url The URL you want the requester redirected to after they successfully request a SignatureRequest. (optional)
+      # @option opts [String] signing_redirect_url The URL you want the signer redirected to after they successfully sign. (optional)
+      # @option opts [Boolean] is_for_embedded_signing Enable the UnclaimedDraft to be used for an Embedded SignatureRequest. Defaults to 0. (optional)
+      #
+      # @return [HelloSign::Resource::UnclaimedDraft] an UnclaimedDraft object
+      #
+      # @example
+      #   unclaimed_draft = @client.edit_and_resend_unclaimed_draft(
+      #     :signature_request_id => '75cdf7dc8b323d43b347e4a3614d1f822bd09491',
+      #     :test_mode => 1,
+      #     :client_id => 'b6b8e7deaf8f0b95c029dca049356d4a2cf9710a',
+      #   )
+      #
       def edit_and_resend_unclaimed_draft(opts)
         signature_request_id = opts.delete(:signature_request_id)
         path = "/unclaimed_draft/edit_and_resend/#{signature_request_id}"