hellosign-api 1.0.0

data/lib/hello_sign/api/team.rb

@@ -0,0 +1,107 @@
+# The MIT License (MIT)
+#
+# Copyright (C) 2014 hellosign.com
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+module HelloSign
+  module Api
+    # Contains all the API calls for the 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 member list and information about your Team.
+      # If you do not belong to a Team, HelloSign::Error::NotFound will be raised
+      #
+      # @return [HelloSign::Resource::Team] Current Team
+      #
+      # @example
+      #   team = @client.get_team
+      def get_team
+        HelloSign::Resource::Team.new get('/team')
+      end
+
+      # Creates a new Team and adds you as a member. You must not currently belong to a Team.
+      # @option opts [String] name The name of the Team.
+      #
+      # @return [HelloSign::Resource::Team] a Team
+      #
+      # @example
+      #   team = @client.create_team name: 'Team America World Police'
+      def create_team(opts)
+        HelloSign::Resource::Team.new post('/team/create', body: opts)
+      end
+
+      # Updates the name of your Team.
+      # @option opts [String] name The name of your Team.
+      #
+      # @return [HelloSign::Resource::Team]
+      #
+      # @example
+      #   team = @client.update_team name: 'New Team Name'
+      def update_team(opts)
+        HelloSign::Resource::Team.new post('/team', body: opts)
+      end
+
+      # Deletes your Team. Can only be invoked with a Team with one member (yourself).
+      #
+      # @return [HTTP::Status] 200 OK
+      #
+      # @example
+      #   team = @client.destroy_team
+      def destroy_team
+        post('/team/destroy')
+      end
+
+      # Adds or invites a user 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 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] a Team
+      #
+      # @example
+      #   team = @client.add_member_to_team email_address: 'george@example.com'
+      def add_member_to_team(opts)
+        HelloSign::Resource::Team.new post('/team/add_member', body: opts)
+      end
+
+      # 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
+      #
+      # @example
+      #   team = @client.remove_member_from_team email_address: 'george@example.com'
+      def remove_member_from_team(opts)
+        HelloSign::Resource::Team.new post('/team/remove_member', body: opts)
+      end
+    end
+  end
+end

data/lib/hello_sign/api/template.rb

@@ -0,0 +1,227 @@
+# The MIT License (MIT)
+#
+# Copyright (C) 2014 hellosign.com
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+module HelloSign
+  module Api
+    # Contains all the API calls for the 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]
+
+    module Template
+
+      # Retrieves the Template with the given ID.
+      # @option opts [String] template_id The ID of the Template to retrieve.
+      #
+      # @return [HelloSign::Resource::Template] a Template
+      #
+      # @example
+      #   template = @client.get_template template_id: 'f57db65d3f933b5316d398057a36176831451a35'
+      def get_template(opts)
+        HelloSign::Resource::Template.new get("/template/#{opts[:template_id]}")
+      end
+
+      # Deletes the specified Template.
+      # @option opts [String] template_id The ID of the Template to delete.
+      #
+      # @return [HTTP::Status] 200 OK
+      #
+      # @example
+      #   template = @client.delete_template template_id: 'f57db65d3f933b5316d398057a36176831451a35'
+      def delete_template(opts)
+        post("/template/delete/#{opts[:template_id]}")
+      end
+
+      # Retrieves the Templates for the accessible by the current user.
+      # @option opts [String] account_id The Account ID to return Templates for. 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
+      #
+      # @example
+      #   templates = @client.get_templates page: 1
+      def get_templates(opts={})
+        path = '/template/list'
+        opts[:query] = create_search_string(opts[:query]) if opts[:query]
+        query = create_query_string(opts, [:page, :page_size, :query])
+        path += query
+        HelloSign::Resource::ResourceArray.new get(path, opts), 'templates', HelloSign::Resource::Template
+      end
+
+      # Gives the specified Account access to a Template. The Account must be part of your Team.
+      # @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 [HelloSign::Resource::Template] a Template
+      #
+      # @example
+      #   templates = @client.add_user_to_template template_id: 'f57db65d3f933b5316d398057a36176831451a35', email_address: 'george@example.com'
+      def add_user_to_template(opts)
+        path = "/template/add_user/#{opts[:template_id]}"
+        opts.delete(:template_id)
+        HelloSign::Resource::Template.new post(path, body: opts)
+      end
+
+      # 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 [HelloSign::Resource::Template] a Template
+      #
+      # @example
+      #   templates = @client.remove_user_from_template template_id: 'f57db65d3f933b5316d398057a36176831451a35', email_address: 'george@example.com'
+      def remove_user_from_template(opts)
+        path = "/template/remove_user/#{opts[:template_id]}"
+        opts.delete(:template_id)
+        HelloSign::Resource::Template.new post(path, body: opts)
+      end
+
+      # 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>] attachments Sets a list of attachments signers can upload
+      #   * name (String) Attachment name
+      #   * instructions (String) Instructions for uploading the attachment. (optional)
+      #   * signer_index (Integer) The signer's unique number.
+      #   * required (Boolean) Determines if the signer is required to upload this attachment. Defaults to 0. (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)
+      #
+      # @return [HelloSign::Resource::Template] a Template
+      #
+      # @example
+      #   template_draft = @client.create_embedded_template_draft(
+      #     test_mode: 1,
+      #     subject: 'The NDA we talked about',
+      #     requester_email_address: 'requester@example.com',
+      #     message: 'Please sign this NDA and then we can discuss more. Let me know if you have any questions.',
+      #     signer_roles: [
+      #       {
+      #         name: 'Manager',
+      #         order: 0
+      #       },
+      #       {
+      #         name: 'Client',
+      #         order: 1
+      #       }
+      #     ],
+      #     attachments: [{
+      #       name: 'Passport',
+      #       instructions: 'Upload your US Passport',
+      #       signer_index: 0,
+      #       required: true
+      #       },
+      #       {
+      #       name: 'Driver's License',
+      #       instructions: 'Upload your CA Driver's License',
+      #       signer_index: 1,
+      #       required: false
+      #       }
+      #     ],
+      #     cc_roles: ['HRManager'],
+      #     files: ['NDA.pdf', 'AppendixA.pdf'],
+      #     merge_fields: '[
+      #       {
+      #         name: 'contract_id',
+      #         type: 'text'
+      #       },
+      #       {
+      #         name: 'purchase_price',
+      #         order: 'text'
+      #       }
+      #     ]'
+      #   )
+      def create_embedded_template_draft(opts)
+        opts[:client_id] ||= self.client_id
+        prepare_files opts
+        prepare_signer_roles opts
+        prepare_attachments opts
+        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
+      #   file = @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]
+          path = path + "?file_type=#{opts[:file_type]}"
+        end
+        if opts[:get_url]
+          separator = opts[:file_type].nil? ? '?' : '&'
+          path = path + "#{separator}get_url=#{opts[:get_url]}"
+        end
+
+        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. (optional)
+      # @option opts [Boolean] test_mode Indicates if this is a test Template. 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}"
+        prepare_files opts
+
+        HelloSign::Resource::Template.new post(path, body: opts)
+      end
+    end
+  end
+end

data/lib/hello_sign/api/unclaimed_draft.rb

@@ -0,0 +1,328 @@
+# The MIT License (MIT)
+#
+# Copyright (C) 2014 hellosign.com
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+module HelloSign
+  module Api
+    # Contains all the API calls for the 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
+
+      # 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. Defaults to 0. (optional)
+      # @option opts [Array<String>] files Specifies the file path(s) to send for the SignatureRequest.
+      # @option opts [Array<String>] file_urls Specifies the URL(s) for the file(s) to send for the SignatureRequest.
+      # @option opts [String] type The type of UnclaimedDraft to create. Use "send_document" to create a claimable file, and "request_signature" for a claimable SignatureRequest.
+      #   * 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 Sets a list of signers, each item is a Hash with these keys:
+      #   * 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>] attachments Sets a list of attachments signers can upload
+      #   * name (String) Attachment name
+      #   * instructions (String) Instructions for uploading the attachment. (optional)
+      #   * signer_index (Integer) The signer's unique number.
+      #   * required (Boolean) Determines if the signer is required to upload this attachment. Defaults to 0. (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 on the SignatureRequest. (optional)
+      # @option opts [String] signing_redirect_url Redirects the signer(s) to this URL after completing 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 [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)
+      # @option opts [Hash] signing_options Specifies the types allowed for creating a signature. (optional)
+      #
+      # @return [HelloSign::Resource::UnclaimedDraft] an UnclaimedDraft
+      #
+      # @example type: send_document
+      #   unclaimed_draft = @client.create_unclaimed_draft(
+      #     test_mode: 1,
+      #     files: ['NDA.pdf', 'AppendixA.pdf']
+      #   )
+      #
+      # @example type: request_signature
+      #   unclaimed_draft = @client.create_unclaimed_draft(
+      #     test_mode: 1,
+      #     type: 'request_signature',
+      #     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.',
+      #     metadata: {
+      #       client_id: '1234',
+      #       custom_text: 'NDA #9'
+      #     },
+      #     signers: [
+      #       {
+      #         email_address: 'jack@example.com',
+      #         name: 'Jack',
+      #         order: 0
+      #       },
+      #       {
+      #         email_address: 'jill@example.com',
+      #         name: 'Jill',
+      #         order: 1
+      #       }
+      #     ],
+      #     attachments: [{
+      #       name: 'Passport',
+      #       instructions: 'Upload your US Passport',
+      #       signer_index: 0,
+      #       required: true
+      #       },
+      #       {
+      #       name: 'Driver's License',
+      #       instructions: 'Upload your CA Driver's License',
+      #       signer_index: 1,
+      #       required: false
+      #       }
+      #     ],
+      #     cc_email_addresses: ['lawyer@example.com', 'lawyer@example2.com'],
+      #     files: ['NDA.pdf', 'AppendixA.pdf'],
+      #     signing_options: {
+      #       draw: true,
+      #       type: true,
+      #       upload: false,
+      #       phone: true,
+      #       default: 'phone'
+      #     }
+      #   )
+      #
+      def create_unclaimed_draft opts
+        prepare_files opts
+        prepare_signers opts
+        prepare_form_fields opts
+        prepare_custom_fields opts
+        prepare_attachments opts
+
+        HelloSign::Resource::UnclaimedDraft.new post('/unclaimed_draft/create', body: opts)
+      end
+
+      # Creates a new Embedded UnclaimedDraft that can be opened in an embedded iFrame.
+      # @option opts [Boolean] test_mode Indicates if this is a test SignatureRequest, it will not be legally binding if set to 1. Defaults to 0. (optional)
+      # @option opts [String] client_id The API App Client ID associated with this Embedded UnclaimedDraft.
+      # @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] 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 Sets the subject in the email sent to the signer(s). (optional)
+      # @option opts [String] message Sets the message in the email sent to the signer(s). (optional)
+      # @option opts [Array<Hash>] signers Sets a list of signers, each item is a Hash with these keys:
+      #   * 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>] attachments Sets a list of attachments signers can upload
+      #   * name (String) Attachment name
+      #   * instructions (String) Instructions for uploading the attachment. (optional)
+      #   * signer_index (Integer) The signer's unique number.
+      #   * required (Boolean) Determines if the signer is required to upload this attachment. Defaults to 0. (Optional)
+      # @option opts [Array<String>] cc_email_addresses The email addresses that should be CCed on the SignatureRequest. (optional)
+      # @option opts [String] signing_redirect_url Redirects the signer(s) to this URL after completing the SignatureRequest. (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 [Hash] signing_options Specifies the types allowed for creating a signature. (optional)
+      #
+      # @return [HelloSign::Resource::UnclaimedDraft] an UnclaimedDraft
+      #
+      # @example type: request_signature
+      #   unclaimed_draft = @client.create_embedded_unclaimed_draft(
+      #     test_mode: 1,
+      #     type: 'request_signature',
+      #     subject: 'The NDA we talked about',
+      #     requester_email_address: 'requester@example.com',
+      #     message: 'Please sign this NDA and then we can discuss more. Let me know if you have any questions.',
+      #     metadata: {
+      #       client_id: '1234',
+      #       custom_text: 'NDA #9'
+      #     },
+      #     signers: [
+      #       {
+      #         email_address: 'jack@example.com',
+      #         name: 'Jack',
+      #         order: 0
+      #       },
+      #       {
+      #         email_address: 'jill@example.com',
+      #         name: 'Jill',
+      #         order: 1
+      #       }
+      #     ],
+      #     attachments: [{
+      #       name: 'Passport',
+      #       instructions: 'Upload your US Passport',
+      #       signer_index: 0,
+      #       required: true
+      #       },
+      #       {
+      #       name: 'Driver's License',
+      #       instructions: 'Upload your CA Driver's License',
+      #       signer_index: 1,
+      #       required: false
+      #       }
+      #     ],
+      #     cc_email_addresses: ['lawyer@example.com', 'lawyer@example2.com'],
+      #     files: ['NDA.pdf', 'AppendixA.pdf'],
+      #     signing_options: {
+      #       draw: true,
+      #       type: true,
+      #       upload: false,
+      #       phone: true,
+      #       default: 'phone'
+      #     }
+      #   )
+      def create_embedded_unclaimed_draft(opts)
+        opts[:client_id] ||= self.client_id
+        prepare_files opts
+        prepare_signers opts
+        prepare_form_fields opts
+        prepare_custom_fields opts
+        prepare_attachments opts
+
+        HelloSign::Resource::UnclaimedDraft.new post('/unclaimed_draft/create_embedded', body: opts)
+      end
+
+      # Creates a new Embedded UnclaimedDraft from a Template that can be opened in an embedded iFrame.
+      # @option opts [Boolean] test_mode Indicates if this is a test SignatureRequest, it will not be legally binding if set to 1. Defaults to 0. (optional)
+      # @option opts [String] 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 Assigns a title to the SignatureRequest. (optional)
+      # @option opts [String] subject Sets the subject in the email sent to the signer(s). (optional)
+      # @option opts [String] message Sets the message in the email sent to the signer(s). (optional)
+      # @option opts [Array<Hash>] signers List of signers
+      #   * role (String) The signer role indicated on the Template.
+      #   * 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 Redirects the signer(s) to this URL after completing the SignatureRequest. (optional)
+      # @option opts [String] requesting_redirect_url Redirects the requester to this URL after sending 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 Specifies the file path(s) to append to the SignatureRequest. (optional)
+      # @option opts [Array<String>] file_urls Specifies the URL(s) for 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 [Hash] signing_options Specifies the types allowed for creating a signature. (optional)
+      #
+      # @return [HelloSign::Resource::UnclaimedDraft] an UnclaimedDraft
+      #
+      # @example type: request_signature
+      #   unclaimed_draft = @client.create_embedded_unclaimed_draft_with_template(
+      #     test_mode: 1,
+      #     subject: 'The NDA we talked about',
+      #     template_id: 'c26b8a16784a872da37ea946b9ddec7c1e11dff6',
+      #     requester_email_address: 'requester@example.com',
+      #     message: 'Please sign this NDA and then we can discuss more. Let me know if you have any questions.',
+      #     files: ['NDA.pdf', 'AppendixA.pdf'],
+      #     metadata: {
+      #       client_id: '1234',
+      #       custom_text: 'NDA #9'
+      #     },
+      #     signers: [
+      #       {
+      #         email_address: 'george@example.com',
+      #         name: 'George',
+      #         role: 'Client'
+      #       }
+      #     ],
+      #     ccs: [
+      #       {
+      #         email_address:'accounting@example.com',
+      #         role: 'Accounting'
+      #       }
+      #     ],
+      #     custom_fields: {
+      #       Cost: '$20,000'
+      #     },
+      #     signing_options: {
+      #       draw: true,
+      #       type: true,
+      #       upload: false,
+      #       phone: true,
+      #       default: 'phone'
+      #    }
+      #   )
+      def create_embedded_unclaimed_draft_with_template(opts)
+        opts[:client_id] ||= self.client_id
+        prepare_signers opts
+        prepare_custom_fields opts
+        prepare_ccs opts
+        prepare_templates opts
+        prepare_files opts
+
+        HelloSign::Resource::UnclaimedDraft.new post('/unclaimed_draft/create_embedded_with_template', body: opts)
+      end
+
+      # Creates a new SignatureRequest from an Embedded UnclaimedDraft.
+      # @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. Defaults to 0. (optional)
+      # @option opts [String] requesting_redirect_url Redirects the requester to this URL after sending a SignatureRequest. (optional)
+      # @option opts [String] signing_redirect_url Redirects the signer(s) to this URL after completing the SignatureRequest. (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
+      #
+      # @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}"
+
+        HelloSign::Resource::UnclaimedDraft.new post(path, body: opts)
+      end
+    end
+  end
+end